Documentação WebService Beneficiários
Padrão utilizado
O webservice dos dados do beneficiário 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.
- CODIGO ou ID: Código ou ID do beneficiário para buscar.
- PAGE: Páginação das carteirinhas.
Métodos
Detalhamento
Listagem de beneficiarios autorizados.
GET:
https://autorizador.humanasaude.com.br/solusweb_5_0/webservice/beneficiario/listagem?token={TOKEN}&page={PAGE}
Retorno e status HTTP: 200
{
"beneficiarios":
[
{
"id": "00000",
"codigo": "0000000000",
"nome": "NOME EXEMPLO",
"cpf": "00000000000000",
"sexo": "MASCULINO",
"nascimento": "00/00/0000",
"email": "[email protected]",
"end_correspondecia": "RUA EXEMPLO",
"num_correspondecia": "000",
"bairro_correspondecia": "BAIRRO EXEMPLO",
"compl_correspondecia": "AP EXEMPLO",
"cep_correspondecia": "00000000",
"cidade_correspondecia": "CIDADE EXEMPLO",
"estado_correspondecia": "ESTADO EXEMPLO",
"ibge": "CODIGO IBGE EXEMPLO",
"telefones": "ARRAY TELEFONES EXEMPLO {00000000000,000000000}",
"empresa": "NOME FANTASIA EMPRESA CONTRATOS PJ e PFF"
}
],
"page":"1"
}
Listagem de informações do Beneficiário.
GET:
https://autorizador.humanasaude.com.br/solusweb_5_0/webservice/beneficiario?token={TOKEN}&ccodiusua={CODIGO}&nnumeusua={ID}
ou
POST:
Parametros:
{
"token":"{TOKEN}",
"ccodiusua":"{CODIGO}",
"nnumeusua":"{ID}"
}
Retorno e status HTTP: 200
{
"id": "00000",
"codigo": "0000000000",
"nome": "NOME EXEMPLO",
"cpf": "00000000000000",
"sexo": "MASCULINO",
"nascimento": "00/00/0000",
"email": "[email protected]",
"end_correspondecia": "RUA EXEMPLO",
"num_correspondecia": "000",
"bairro_correspondecia": "BAIRRO EXEMPLO",
"compl_correspondecia": "AP EXEMPLO",
"cep_correspondecia": "00000000",
"cidade_correspondecia": "CIDADE EXEMPLO",
"estado_correspondecia": "ESTADO EXEMPLO",
"ibge": "CODIGO IBGE EXEMPLO",
"telefones": "ARRAY TELEFONES EXEMPLO {00000000000,000000000}",
"empresa": "NOME FANTASIA EMPRESA CONTRATOS PJ e PFF"
}
Remoção
Remove beneficiário da lista de autorizados.
POST: https://autorizador.humanasaude.com.br/solusweb_5_0/webservice/beneficiario/atualizar
Parametros:
{
"token": "{TOKEN}",
"ccodiusua": "{CODIGO}",
"nnumeusua":"{ID}",
"operacao": "R"
}
Retorno e status HTTP: 200
{
"mensagem": "Beneficiário(s) atualizado(s) com sucesso!"
}