10: API Beneficiários: acesso funcionalidade

1 Método "beneficiarios”
- 1.1 Endpoint
- 1.2 Parâmetros de entrada
- 1.3 Exemplo request
- 1.4 Descrição dos objetos e atributos de retorno - Sucesso
- 1.5 Retorno da API - Sucesso
- 1.6 Retorno da API - Falha

Só são suportadas integrações no padrão REST.

Método "beneficiarios”

Caso implementado este método é obrigatório;
Atente-se aos critérios de preenchimento;
Atente-se as mensagens de retorno para cada HTTPS Status Code;

Endpoint

Endpoint	Método	Header Content-Type	Descrição

Endpoint	Método	Header Content-Type	Descrição
http://exemplo.com/ beneficiarios Atenção O endpoint obrigatoriamente deve terminar com “/beneficiarios”.	POST	application/json	Endpoint lista os beneficiários agrupados por contrato.

Parâmetros de entrada

Serão enviados no HEADER os headers estáticos definidos ao configurar a integração, combinado com os tokens retornados pela configuração de autorização da integração (caso seja vinculada) e os headers de segurança retornado no login do beneficiário.

Serão enviados no BODY os seguintes parâmetros:

Atributo	Obrigatoriedade	Tipo	Descrição

Atributo	Obrigatoriedade	Tipo	Descrição
chaveUnica	M	String	Chave de identificação do usuário retornada no login
integracao	M	Objeto	nó integração retornado no login do beneficiário
idFuncionalidade	M	String	Chave interna de identificação da funcionalidade na aplicação.

Exemplo request

url: 
https://www.operadoradesaude.com.br/mobilesaude/beneficiarios

Body:
{
    "integracao": {
        "xpto": "voluptatibus",
        "xyz": "quibusdam",
        "abcdef": 9288701
    },
    "chaveUnica": "string",
    "idFuncionalidade": "string"
}

Descrição dos objetos e atributos de retorno - Sucesso

Está indicado abaixo a estrutura de retorno do método. Esse método deve obedecer as regras indicadas no objeto principal e em seus desdobramentos.

Objeto principal

Atributo	Critério	Tipo	Descrição	Regra de preenchimento

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
contratos	M	Array de objetos”contrato”	Retorna um array de objetos “contratos”	Deve retornar um array de objetos

Objeto contratos

Atributo	Critério	Tipo	Descrição	Regra de preenchimento

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
numeroContrato	M	String	Número que identifica a qual contrato esse débito está vinculado	Texto livre
beneficiarios	M	Array	Array de objetos do tipo "beneficiario"	Precisa ser preenchido com pelo menos um item.

Objeto beneficiario

Atributo	Critério	Tipo	Descrição	Regra de preenchimento

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
chaveUnica	M	String	chave de identificação do beneficiário.	Texto livre

Retorno da API - Sucesso

[
  {
    "numeroContrato": "001",
    "beneficiarios": [
      {
        "chaveUnica": "110101"
      },
      {
        "chaveUnica": "110102"
      },
      {
        "chaveUnica": "110103"
      }
    ]
  },
  {
    "numeroContrato": "002",
    "beneficiarios": [
      {
        "chaveUnica": "210101",
      },
      {
        "chaveUnica": "210102"
      },
      {
        "chaveUnica": "210103"
      }
    ]
  },
  {
    "numeroContrato": "003",
    "beneficiarios": [
      {
        "chaveUnica": "310101"
      },
      {
        "chaveUnica": "310102"
      },
      {
        "chaveUnica": "310103"
      }
    ]
  }
]