| Índice |
|---|
| Dica |
|---|
Só são suportadas integrações no padrão REST. |
Método "beneficiarios”
| Informações |
|---|
|
...
Endpoint
Endpoint | Método | Header Content-Type | Descrição | ||
|---|---|---|---|---|---|
http://exemplo.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.
...
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
| Bloco de código | ||
|---|---|---|
| ||
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.
...
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
| Bloco de código | ||
|---|---|---|
| ||
[
{
"numeroContrato": "001",
"beneficiarios": [
{
"chaveUnica": "10102110101"
},
{
"chaveUnica": "10102110102"
},
{
"chaveUnica": "10102110103"
}
]
},
{
"numeroContrato": "001002",
"beneficiarios": [
{
"chaveUnica": "10102210101",
},
{
"chaveUnica": "10102210102"
},
{
"chaveUnica": "10102210103"
}
]
},
{
"numeroContrato": "001003",
"beneficiarios": [
{
"chaveUnica": "10102310101"
},
{
"chaveUnica": "10102310102"
},
{
"chaveUnica": "10102310103"
}
]
}
] |
Retorno da API - Falha
| Aviso |
|---|
|
...