Informe rendimentos: Detalhe do Registro PDF

1 Método "registroPdf"
- 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 "registroPdf"

Este método é obrigatório;
Atente-se aos critérios de preenchimento;
Atente-se as mensagens de retorno para cada HTTPS Status Code;
Os parâmetros de entrada têm relação direta com o método listarDeclaracoes

Este método irá retornar o pdf das declarações relacionadas ao beneficiário.

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 integracao e chaveUnica

Endpoint

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

Endpoint	Método	Header Content-Type	Descrição
exemplo.com Atenção O endpoint obrigatoriamente deve terminar com “/registroPdf”.	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

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:

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.

Objeto principal

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

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
url	C	String	url do documento em .pdf	Formato: texto livre Obrigatório quando “base64" não for preenchido.
base64	C	String	base64 do documento em .pdf	Formato: texto livre regra: Obrigatório quando “url" não for preenchido.

Retorno da API- Sucesso

{
    "url": "https://ms-publico.s3-sa-east-1.amazonaws.com/mockups/declaracoes/declaracaoIR.pdf",
    "base64": null
}