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" }
HTTP: 429, quando excedeu o número de requests por minuto 

        { "Message": "Too Many Requests" }

Limites de utilização

A API está protegida com um número de requests por minutos:

  • 400 requests por minuto todos os dias entre as 9h e as 19h (hora de Portugal continental)
  • 1000 requests por minuto todos os dias entre as 19h e as 9h (hora de Portugal continental) ou fim-de-semana (todo o dia)

Em todos os requests, irá obter os seguintes headers:

  • X-Rate-Limit - indica quantos requests já fez desde que o contador voltou a zero
  • X-Rate-Limit-Remaining - indica quantos requests ainda pode fazer dentro do minuto a decorrer

Dica: Utilize estes headers para não exceder o número de requests permitidos por minuto.

Se exceder o limite de requests por minuto, irá obter um erro 429 com o header Retry-After que indica o tempo no formato delta-seconds que tem de esperar para que possa fazer um novo request.

Limites por página

Pode solicitar até 400 registos por página com o parametro Take. Caso não forneça esse parametro, será assumido 10 registos por página.