Aqui poderá encontrar toda a documentação relacionada com a API do Libax Seguros para o ajudar a ligar a sua aplicação com o seu software de faturação. Com esta integração poderá facilmente:

• Registar clientes
• Consultar apólices, recibos, participações
• Pesquisar comissões
• e muito mais...

É uma excelente solução para adicionar as funcionalidade de faturação às suas aplicações mais específicas como por exemplo landing pages ou o seu site.

Nota importante

Esta API é a nova versão da API do Libax Seguros, no entanto, ainda não tem todas as funcionalidades que existem na versão anterior. Caso verifique que alguma funcionalidade não está nesta API, poderá utilizar também a versão anterior, disponível em https://segurosapi.libax.com/

Em resumo, caso pretenda ter acesso a todas as funcionalidades, terá de utilizar as duas APIs. De facto, no futuro, a versão antiga será descontinuada e os métodos vão ser migrados para esta nova versão, mas ainda não há data definida para esse desenvolvimento. Assim, pode utilizar a versão antiga caso necessário sem restrições de tempo.

Obter o ClientID

Para utilizar a API é preciso criar um clientID para utilizar na fase de autenticação.

Esta funcionalidade está disponível Seguros -> Configurações (roda dentada em cima à direita) -> Cliente API

Após entrar nesta opção, pressione o botão Criar conforme imagem seguinte:

Após criação do ID de cliente, será mostrado o ID e o seacret conforme imagem seguinte:

O secret não será mostrado novamente. Assim, guarde esta informação num local seguro e partilhe apenas com que vai utilizar a API. Caso perca informação terá de gerar novo secret.

A qualquer momento poderá voltar a esta configuração se pretender remover esta funcionalidade.

Utilizar a API

A API está disponível no endereço https://api.libax.com/seguros/v1/

Neste endereço está também disponível a documentação Swagger onde pode também autenticar-se e invocar os métodos de forma a facilitar o desenvolvimento.

Para a autenticação ser completa é necessário escolher o scope seguros_public_api conforme imagem seguinte:

Restrições de utilização

Se o client_id foi configurado com uma restrição de parceiros ou escritórios, não irá ter autorização para utilizar os métodos seguintes: Brands, CompanyNotes, ContasEvents, métodos search deletes (contracts e documents), SellerGroups e Simulations

Exemplos em C# e documentação sobre filtros

Esta API partilha da mesma tecnologia utilizada na API do Libax Business. Assim, sugerimos que leia o artigo sobre a API do Libax Business de forma a assimilar os exemplos de código em C# e a documentação de como pode aplicar filtros sobre a API.

Visualizar documentação sobre API do Libax Business