| Índice |
|---|
| Dica |
|---|
Só são suportadas integrações no padrão REST. |
Método "registroPdf"
| Informações |
|---|
|
...
Prioriza-se a URL em relação ao base64
O método construído por sua empresa deverá validar se a declaração existe.
Será adicionado ao corpo da requisição as informações enviadas no atributo
integracaoechaveUnica
Endpoint
Endpoint | Método | Header Content-Type | Descrição | ||
|---|---|---|---|---|---|
| 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.
...
Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
integracao | M | Objeto |
|
chaveUnica | M | String |
|
idRegistro | M | String | Código do registro, o mesmo que é retornado na listagem de registros. |
Exemplo request:
| Bloco de código | ||
|---|---|---|
| ||
url:
https://www.operadoradesaude.com.br/mobilesaude/detalheRegistroPdf
Body:
{
"integracao": {
"xpto": "voluptatibus",
"xyz": "quibusdam",
"abcdef": 9288701
},
"chaveUnica": "101012",
"idRegistro": "2020:CQ:3020170703122545",
} |
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 |
|---|---|---|---|---|
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/declaracoes/declaracaoIR.pdf",
"base64": null
} |
Retorno da API - Falha
| Aviso |
|---|
|