O que precisa de saber para utilizar a API

Comece por configurar a sua conta do Libax para aceitar pedidos da API.

Assim, nas permissões, adicione o utilizador que pretende autorizar para utilização da API. O nível de permissões atribuído não tem influência no sistema de permissões da API e por isso, se for um utilizador só para ter acesso à API, é aconselhável atribuir a permissão de “Nenhuma” para que não possa entrar na sua conta do Libax Seguros pela via normal.

Finalmente defina no utilizador o tipo de permissões especificamente para a API.

  • Permissão de escrita - o utilizador poderá executar métodos de escrita (POST).
  • Permissão de leitura - o utilizador poderá executar métodos de leitura (GET).

O endereço base de utilização da API é https://segurosapi.libax.com e por questões de segurança, apenas serão aceites acessos através de uma ligação segura.

O envio de parâmetros para pedidos GET é feito através do queryString.
Como formato de envio de parâmetro para pedidos POST, pode utilizar os seguintes formatos:

  • Json (application/json)
  • Html (form-data)

Respostas e erros comuns

O formato de resposta será sempre Json (application/json)
É usado o "ponto" como separador decimal. Ex: 1234.56
As datas são retornadas na hora de Lisboa no formato ISO 8601: yyyy-MM-ddTHH:mm:ss

Os códigos HTTP de sucesso são o 200 e o 201

HTTP: 400, quando não enviou todos os parâmetros obrigatórios num pedido

        { "Message": "Bad request" }
        
HTTP: 401, quando o token já expirou ou é inválido

        { "Message": "Invalid token" }
        
HTTP: 403, quando não tem permissões para ver/executar o recurso pretendido

        { "Message": "Forbidden" }
        
HTTP: 404, quando o recurso não existe

        { "Message": "NotFound" }