9: API para customizar o PINS-SS Cadastral

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

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
exemplo.com PINSS/detalhePINSS Atenção O endpoint obrigatoriamente deve terminar com “PINSS/detalhePINSS”.	POST	application/json	Endpoint para listar o detalhe do PINSS relacionado ao beneficiário selecionado

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
Beneficiário	M	Objeto	Objeto relacionado ao beneficiário

Objeto beneficiario

Parâmetro	Obrigatório	Tipo	Descrição

Parâmetro	Obrigatório	Tipo	Descrição
chaveUnica	M	String	chave única do beneficiário
numeroContrato	M	String	numero do contrato do beneficiário
integracao	M	Objeto	Objeto de integração do beneficiário

Exemplo request

url: 
https://www.operadoradesaude.com.br/mobilesaude/PINSS/detalhePINSS

Body:
{
    "integracao": {
        "xpto": "voluptatibus",
        "xyz": "quibusdam",
        "abcdef": 9288701
    },
    "beneficiario": {
        "chaveUnica": "geraldo@mobilesaude.com.br",
        "numeroContrato": "00100200300400500609",
        "integracao": {
            "numero_cartao_benef": "00010002000001000",
            "cpf_benef": "07805206708",
            "abcdef": 9288701
        }
    }
}

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
urlDocumentoTecnico	M	String	URL do documento técnico do PINSS
pinss	M	Array	Array de objetos PINSS

{
    "urlDocumentoTecnico": "string",
    "pinss": [Array-objetos]
}

Objeto PINSS

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

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
titulo	M	String	Titulo da informação	Texto livre
valores	M	Array	Array de objetos valores, contendo descrição e valor

{
    "urlDocumentoTecnico": "string",
    "pinss": [
        {
            "titulo": "string",
            "valores": [Array-objetos]
        }
}

Objeto valores

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

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
descricao	M	String	Descrição da informação	Texto livre
valor	M	String	Valor da informação	Texto livre