API
Introdução
Bem-vindo ao guia de referência das APIs da 88i!
Através destas APIs você será capaz de integrar sua plataforma à nossa. Nossas API estão no padrão REST, e todas suas respostas são em formato JSON.
Princípios Básicos
Listas, Domínios e Enumerados
I. Todas as listas estão agrupadas dentro da API “Commons”.
II. Cada conjunto de informações possui um Endpoint específico.
III. Os Endpoints podem possuir filtros para pegar um subconjunto específico de dados ou não. Caso não tenha, simplesmente traz todos os valores referentes ao assunto que estão contidos na base da 88i.
Payload dos Endpoints
I. A documentação e exemplos dos playloads está nos quadros “Example Model” e “Model”, na descrição dos Endpoints.
Ambientes de teste e produção
01
Códigos de Resposta
| Código | Significado |
|---|---|
| 200 | Sua requisição foi processada com sucesso. |
| 201 | Requisição processada e item criado. |
| 204 | Nenhum item encontrado. |
| 400 | Algum parâmetro obrigatório não foi passado, ou os parâmetros informados estão incorretos. |
| 401 | Falta de autorização para acessar este endpoint. |
| 403 | Não autorizado. |
| 404 | Endpoint não encontrado, revise a URL passada. |
| 422 | Objeto inválido. |
| 500 | Erro interno da 88i, tente novamente sua requisição. Caso o erro persista, entre em contato. |
Erros
03
PRODUTO
CAMPANHHA
APARELHOS
PARENTESCO
COTAÇÃO
PROPOSTA
APÓLICE
CANCELAMENTO
CORRIDA/DELIVERY
CEP
TELEMEDICINA
Serviços
Financeiro
RECORRENCIA
BANCOS
CARTÕES
MEIO DE PAGAMENTO
Sinistro