Documentação WebService Carteirinha
Padrão utilizado
O webservice dos dados da carteirinha utilizam o padrão REST e o formato JSON codificado em UTF-8 para expor os recursos disponíveis.
Convenções utilizadas
Nas documentações, são utilizadas algumas variáveis, entre elas:
- TOKEN: Token para autenticação no webservice.
- ID: ID da carteirinha.
- PAGE: Páginação das carteirinhas.
Métodos
Listagem
Listagem de todas as carteirinhas de beneficiários autorizados.
GET: https://autorizador.humanasaude.com.br/solusweb_5_0/webservice/carteirinha?token={TOKEN}&page={PAGE}
Retorno e status HTTP: 200
{
"beneficiarios":
[
{
"codigo":"0000000000000",
"nome":"NOME EXEMPLO",
"carteirinhas":
[
{
"id":"1",
"solicitacao":"00/00/0000",
"validade":"00/00/0000",
},
{
"id":"2",
"solicitacao":"00/00/0000",
"validade":"00/00/0000",
}
]
}
],
"page":"1"
}
Listar dados carteirinha por ID.
POST: https://autorizador.humanasaude.com.br/solusweb_5_0/webservice/carteirinha
Parametros:
{
"token":"{TOKEN}",
"carteirinha":"{ID}"
}
Retorno e status HTTP: 200
{
"beneficiario": "NOME EXEMPLO",
"codigo": "000000000000",
"cpf": "00000000000",
"email": "[email protected]",
"dt_inclusao": "00/00/0000",
"dt_nascimento": "00/00/0000",
"csus": "000000000000",
"titular": "NOME TITULAR EXEMPLO",
"codigo_titular": "000000000000",
"cpf_titular": "00000000000",
"contrato": "0000",
"codigo_plano": "0000",
"plano": "DESC PLANO",
"natureza_juridica_plano": "NATUREZA PLANO",
"acomodacao": "ACOMODACAO",
"empresa": "NOME FANTASIA EMPRESA CONTRATOS PJ e PFF",
"cnpj_empresa": "CNPJ EMPRESA CONTRATOS PJ e PFF",
"texto_carencia": "TEXTO CARENCIAS"
}