Guia da API

Introdução

O portal Liberty Seguros Developers é um portal interativo que lhe permite ver a documentação da API, registar as suas aplicações, recuperar as chaves da API e experimentar as APIs em tempo real.

Documentação da API

A Documentação irá levá-lo para uma lista de todas as APIs. Clicar em um nome de API na lista irá levá-lo para uma página que lista os recursos e métodos para essa API. Você pode então clicar em um método, que o levará a uma página interativa que fornecerá um conjunto mais completo de documentação, incluindo uma Descrição, URL, Parâmetros de Cabeçalho, Parâmetros de Corpo, Detalhes de Erro de Resposta e Resumo de Recursos, etc.

Observação: Embora você sempre possa ver a documentação da API, não poderá usar ou tentar APIs sem fazer login com uma conta de desenvolvedor registrada.

Documentação Swagger

Documentação detalhada dos contratos

Exemplo - Collection Test Postman

SandBox

Para experimentar as APIs em tempo real, você poderá acessar o ambiente SandBox. A Liberty Seguros disponibiliza um ambiente para o desenvolvimento e testes não comprometendo seu ambiente produtivo.

SandBox - Experimente as APIs

FAQ

O FAQ possui as principais perguntas e respostas sobre o desenvolvimento das APIs, a classificação foi definida por produto e frequentemente estará sendo atualizada com as principais dúvidas dos desenvolvedores. Nesta área você encontrará os Comunicados técnicos sobre as mudanças e novas funcionalidades disponibilizadas. Ainda tenho dúvidas.

FAQ - Acesse as principais dúvidas sobre as APIs

Comunicados - Últimas novidades

Registro

Para usar as APIs, primeiro você precisa Registrar para uma conta de desenvolvedor. Essa conta de desenvolvedor permitirá que você faça login no portal e acesse a página Chaves, onde você registrará seus aplicativos e obter as chaves necessárias para acessar as APIs.

Conheça o processo de registro

Homologação

Após finalizar o desenvolvimento, disponibilizamos o roteiro de testes para que possamos validar sua integração. O objetivo é validar se todos os casos estão sendo executado com sucesso, realizamos o processo junto com você.

Homologação - Roteiro de testes

Guia visual

O Guia de Design & Experiência Digital foi desenvolvido para entregar serviços digitais com foco em Experiência do Usuário e com a identidade visual Liberty..

Nele é possível encontrar os objetivos da nossa cultura digital e conhecer os métodos de aplicação da marca, cores e fontes, pode também baixar um pacote mais completo de elementos de interface incluindo menus, campos de formulários, botões e muito mais.

Tem também acesso a diversos códigos front-end e pode utilizar os templates em formato PSD para desktop e mobile disponíveis para download.

Acesse o guia

Chaves

As chaves são necessárias para chamar as APIs e são geradas ao criar um aplicativo selecionando o produto. Uma vez criado, é muito importante que você proteger essas chaves e gerenciá-los adequadamente. As chaves podem ser regeneradas, revogadas ou excluídas, se necessário. As APIs utilizam o padrão de autenticação OAuth com a combinação da (Chave de consumidor / client_id e Segredo de consumidor / client_secret). Para considerar como aprovada o produto deverá constar em cor verde.

Esta seção também fornece informações adicionais e inclui as seguintes guias:

• Detalhes
• Produtos
• Chaves
• Analytics
• Editar aplicação
• Excluir aplicativo

Produtos

Um produto é uma coleção de APIs e seus recursos. Um produto API agrupa os recursos da API e fornece um nível específico de acesso e funcionalidade para desenvolvedores de aplicativos. Um produto API tipicamente especifica uma lista de recursos de API, juntamente com limites de acesso, planos de taxa, método de aprovação de chave de API e outras informações específicas do produto.

Analytics

O Analytics Services coleta e analisa amplamente os dados que flui através de APIs. Por exemplo, enquanto a API é implantada, o sistema analítico está constantemente contando e analisando métricas como o número de mensagens recebidas, número de desenvolvedores, tempos de resposta, erros, número de aplicativos em uso, tamanho da solicitação e muitos outros.

Para ver as análises específicas do seu aplicativo, acesse seu aplicativo na página Chaves e selecione o separador Analytics:

• Taxa de transferência
• Tempo máximo de resposta
• Tempo de resposta mínimo
• Tempo de resposta do ponto final
• Contagem de mensagens
• Contagem de erros
• Contagem de usuários