Caso sua empresa deseje exibir informações de coparticipação do beneficiário e de seu grupo familiar, esta API deverá ser implementada.
...
Endpoint | Método | Header Content-Type | Descrição | ||
|---|---|---|---|---|---|
/extratoCoparticipacao/extrato
| POST | application/json | Endpoint para listar os registros de coparticipação relacionadas ao localizador (chaveUnica) |
...
| Aviso |
|---|
|
Método "extratoPdf"
| Informações |
|---|
|
Este método irá retornar o pdf do extrato de Coparticipação referente à competência selecionada pelo beneficiário.
Prioriza-se a URL em relação ao base64
O método construído por sua empresa deverá validar se existem lançamentos na competência selecionada.
Será adicionado ao corpo da requisição as informações enviadas no atributo
integracaoechaveUnica.
Endpoint
Endpoint | Método | Header Content-Type | Descrição | ||
|---|---|---|---|---|---|
http://exemplo.com/ extratPdf
| POST | application/json |
|
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:
Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
integracao | M | Objeto |
|
chaveUnica | M | String |
|
dataInicial | M | String | Data inicial do periodo desejado. |
dataFinal | M | String | Data final do periodo. desejado. |
Exemplo request:
| Bloco de código |
|---|
url:
https://www.operadoradesaude.com.br/mobilesaude/coparticipacao/extratoPdf
Body:
{
"integracao": {
"xpto": "voluptatibus",
"xyz": "quibusdam",
"abcdef": 9288701
},
"chaveUnica": "101012",
"dataInicial": "YYYY/MM/DD",
"dataFinal": "YYYY/MM/DD"
} |
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 |
|---|---|---|---|---|
url | C | String | url do documento em .pdf | Formato: texto livre |
base64 | C | String | base64 do documento em .pdf | Formato: texto livre |
Retorno da API- Sucesso
| Bloco de código |
|---|
{
"url": "https://ms-publico.s3-sa-east-1.amazonaws.com/mockups/extrato/extratoCoparticipacaoModelo.pdf",
"base64": null
} |
Retorno da API - Falha
| Aviso |
|---|
|