API - Corpe Saúde
Descrição

Informações gerais referentes aos planos de saúde/odontológico e emissão de boletos.

Autenticação API Key e PIN/Keyword

A autenticaçao é realizada por meio de API Key que deve ser enviada no header de todas as requisições.
No corpo da requisição deve ser enviada a Keyword (token obtido ao realizar o login).
Para as requisições que não dependem de login, deve ser enviado o PIN (será enviado instruções de como gerar o PIN).

Códigos de Sucesso

200 - Requisição realizada com sucesso.
201 - Cadastro realizado com sucesso.

Códigos de Erro

400 - Erro genérico na requisição (ex.: parâmetros não enviados).
401 - Não autenticado (API Key ou PIN/Keyword inválidos).
403 - Acesso não autorizado (ex.: cadastro pendente de ativação).
404 - Cadastro não encontrado ou Credenciais inválidas (ex.: erro ao realizar o login).
500 - Erro do servidor (ex.: falha de conexão com o banco de dados).

* Para todos os códigos de erros, será retornado uma mensagem com a descrição do erro. Exemplo:

Índice
Recursos

usercontact POST

Descrição: Retorna as informações de contato do cliente (email e celular)
Endpoint: url/usercontact

Body raw (json)

Response (exemplos)

Status code: 200

Status code: 401

Status code: 404

adduser POST

Descrição: Cadastra novo acesso do cliente e gera código de verificação. Após o cadastro, o acesso deve ser ativado pelo recurso activateuser.
Endpoint: url/adduser

Body raw (json)

Response (exemplos)

Status code: 201

Status code: 400

Status code: 404

activateuser POST

Descrição: Ativa o cadastro do cliente.
Endpoint: url/activateuser

Body raw (json)

Response (exemplos)

Status code: 200

Status code: 401

Status code: 404

login POST

Descrição: Realiza o login do cliente.
Endpoint: url/login

Body raw (json)

Response (exemplos)

Status code: 200

Status code: 403

Status code: 404

changepass POST

Descrição: Altera a senha de acesso do cliente.
Endpoint: url/changepass

Body raw (json)

Response (exemplos)

Status code: 200

Status code: 400

Status code: 401

Status code: 404

resetpass POST

Descrição: Reseta o acesso, registra nova senha do cliente e gera um novo código de ativação. Após o cadastro, o acesso deve ser ativado pelo recurso activateuser.
Endpoint: url/resetpass

Body raw (json)

Response (exemplos)

Status code: 200

Status code: 400

Status code: 404

beneficiario POST

Descrição: Retorna informações detalhadas referente aos planos do cliente.
Endpoint: url/beneficiario

Body raw (json)

Response (exemplos)

Status code: 200

Status code: 401

Status code: 404

cobrancas POST

Descrição: Retorna as cobranças em aberto do cliente.
Endpoint: url/cobrancas

Body raw (json)

Response (exemplos)

Status code: 200

Status code: 400

Status code: 401

boleto POST

Descrição: Retorna a 2ª via do boleto (codificado em Base64).
Endpoint: url/boleto

Body raw (json)

Response (exemplos)

Status code: 200

Status code: 401

Status code: 404

informerendimentoslista POST

Descrição: Retorna a lista de Informe de Rendimentos do cliente.
Endpoint: url/informerendimentoslista

Body raw (json)

Response (exemplos)

Status code: 200

Status code: 400

Status code: 401

informerendimentosdoc POST

Descrição: Retorna o PDF do Informe de Rendimentos (codificado em Base64).
Endpoint: url/informerendimentosdoc

Body raw (json)

Response (exemplos)

Status code: 200

Status code: 401

Status code: 404