API Guide

Orientações Para Integração Com A Plataforma

API Guide

Trilha de Integração

Abaixo apresentamos a Trilha de Integração: Um passo a passo pra que você saiba como ser promovido pra os ambientes de certificação e posteriormente de produção e assim se tornar um parceiro certificado com o Pottencial API´s.

Pré-requisitos

Antes de começar a utilizar a API, é fundamental compreender os requisitos de autenticação e obter as credenciais necessárias.
Certifique-se de revisar a seção de autenticação para garantir uma integração segura e bem-sucedida.

Jornadas

As APIs da Pottencial permitem que sua empresa realize cotações, propostas e emissões de apólices para os produtos da Pottencial de forma integrada, rápida e segura.

O fluxo para emissão de uma apólice está descrito em passos simples abaixo:

Fluxo de emissão de apólice
  • Passo 1 - Autenticação: Gere um token de autenticação a partir de sua chave de acesso. Esse token será necessário nas demais operações.
  • Passo 2 - Solicitar cotação: Envie os dados da cotação e receba os valores do prêmio para os dados informados.
  • Passo 3 - Enviar proposta: Quando a cotação estiver pronta, envie os dados para criar uma proposta.
  • Passo 4 - Aceitar proposta: Aceite a proposta criada.
  • Passo 5 - Emitir apólice: Com a proposta aceita, emita sua apólice.

Resposta 429 Limites de taxa

Se a Empresa fizer muitas solicitações no Pottencial API´s em um curto período, ela poderá receber uma resposta de erro 429 , controlando tráfego e gerenciando a saúde e comportamento da API, fornecendo e melhorando a experiencia do consumo dela.

Regras aplicadas nas Rotas

  • Auth: 60 solicitações por minuto. Tempo de espera: 1 hora.
  • Policy Management: 100 solicitações por minuto.
  • Financial: 600 solicitações por minuto.
  • Para as demais rotas aplica-se 150 solicitações por minuto. Tempo de espera (Policy Management, Financial e outras): 1 minuto
  • Garantia

    O seguro Pottencial Garantia é uma solução para empresas dos setores públicos e privados que precisam garantir o cumprimento das obrigações contratuais de uma parte. A Pottencial oferece todas as modalidades do Seguro Garantia, confira cada uma delas na página do produto no site da Pottencial.

    Garantia Judicial

    Com o seguro Pottencial Garantia Judicial é possível dar continuidade às obrigações judiciais sem a necessidade de descapitalizar o patrimônio das empresas, otimizando custos e melhorando o fluxo de caixa, em substituição dos depósitos judiciais em dinheiro, penhora de bens e fianças bancárias.

    Sobre o produto

    Garantia Judicial Depósito Recursal

    O depósito recursal trabalhista é depositado por empresas condenadas em processos jurídicos que desejam entrar com um recurso no processo. Ou seja, não se trata de um pagamento para alguém, mas de um depósito que garantirá que a empresa será capaz de pagar o valor referente a condenação, caso ela se confirme.

    Api do produto

    Sobre o produto

    Garantia do Licitante (BID)

    Modalidade do Seguro Garantia direcionada a licitações públicas ou privadas, assegurando que ao final da licitação o tomador vencedor do certame mantenha sua proposta e assine o contrato nas condições apresentadas e dentro do prazo estabelecido no edital. Ideal para empresas do ramo da construção, fornecimento e prestação de serviço.

    Api do produto

    Sobre o produto

    Garantia do Executante (Performance)

    Garantia para Construção, Fornecimento ou Prestação de Serviços

    Garante o cumprimento de todas as obrigações assumidas no contrato para construção, fornecimento ou prestação de serviços, protegendo o segurado contra o risco de inadimplência do tomador.

    Ideal para empresas do ramo da construção, fornecimento e prestação de serviço.

    Api do produto

    Sobre o produto

    Garantia Estendida

    O seguro garantia estendida proporciona tranquilidade ao segurado, aumentando o tempo de proteção ao bem adquirido contra defeitos de funcionamento, cobrindo custos de peças e mão-de-obra utilizados em seu conserto. Sua contratação opcional, é feita no momento em que se adquire o produto, e sua cobertura se inicia após o término da garantia do fabricante.

    Api do produto

    Garantia Judicial Trabalhista

    O Seguro Garantia Judicial é uma modalidade de seguro específica para processos judiciais, tais como processos cíveis, trabalhistas, cautelares, dentre outros. Possui ampla aplicação como alternativa ao pagamento de cauções, depósitos judiciais em dinheiro, penhora de bens e fianças bancárias.

    Api do produto

    Garantia Judicial Civel

    Com o seguro Pottencial Garantia Judicial é possível dar continuidade às obrigações judiciais sem a necessidade de descapitalizar o patrimônio das empresas, otimizando custos e melhorando o fluxo de caixa, em substituição dos depósitos judiciais em dinheiro, penhora de bens e fianças bancárias.

    Api do produto

    Sobre o produto

    Aluguel

    O Seguro Aluguel é o seguro fiança locatícia da Pottencial que substitui o fiador e outras garantias na locação de imóveis, protegendo o proprietário em caso de não pagamento de aluguel e encargos por parte do inquilino.

    Sobre o produto

    Imobiliário

    O Seguro Imobiliário é o seguro incêndio feito para as imobiliárias e destinado às locações residenciais, protegendo o patrimônio do proprietário e oferecendo tranquilidade ao inquilino.

    Api do produto

    Sobre o produto

    Residencial

    O Seguro Residencial é a nossa solução para você que quer proteger e cuidar do seu lar! Com o seguro Pottencial Residencial você conta com assistência emergencial 24 horas. Afinal, situações inusitadas não acontecem apenas no horário comercial... Proporcionamos a você a facilidade de personalizar o seu seguro, com diversas opções de coberturas, de acordo com a sua realidade.

    Api do produto

    Sobre o produto

    Empresarial

    O Seguro Empresarial O seguro Pottencial Empresarial foi feito para proteger o patrimônio de sua empresa, dando continuidade aos negócios e proporcionando tranquilidade até nos momentos inesperados. O Seguro Pottencial Empresarial é indicado para empresas de pequeno e médio porte e oferece coberturas que podem ser personalizadas no momento da contratação.

    Api do produto

    Sobre o produto

    Riscos Diversos

    Máquinas e Equipamentos

    O seguro Pottencial Máquinas e Equipamentos foi desenvolvido para proteger os mais diversos tipos de equipamentos, seja qual for o negócio ou atividade da empresa – agronegócio, indústria ou serviços.

    Api do produto

    Sobre o produto

    Riscos de Engenharia

    O Seguro Riscos de Engenharia foi desenvolvido para proporcionar a tranquilidade necessária na condução dos projetos de engenharia. Tem cobertura ampla e diversificada, garantindo o pagamento de indenização de prejuízos decorrentes de acidentes ocorridos durante a fase de execução da obra e/ ou de serviços de instalação e montagem. O seguro pode ser contratado para construções, reformas e ampliações.

    Sobre o produto

    Vida

    O Seguro de Vida que cuida do futuro financeiro da sua família quando você não estiver mais presente!.

    Api do produto

    Sobre o produto

    Jornada de Cancelamento

    O principal objetivo desta API é proporcionar uma solução robusta e flexível para a realização de cancelamentos de apólices, oferecendo uma interface de programação de aplicativos (API) consistente e de fácil utilização. Ao utilizar esta API, os parceiros terão a capacidade de integrar funcionalidades de cancelamento diretamente em seus aplicativos e sistemas, proporcionando uma experiência mais eficiente e automatizada .

    Api do Serviço

    Onboarding

    A API onboarding permite que os parceiros possam realizar cadastro de segurados, tomadores, beneficiarios e consultar analise de credito.

    Limite e taxa

    Api do Serviço

    Risk Object

    A API Risk Object permite que os parceiros possam realizar operações necessárias e consultar dados específicos do Objeto de risco

    Api do Serviço

    Financial

    A API Financial permite que os parceiros possam realizar consulta de tiulos a receber, prorrogação de boletos, emissão de 2a. via, etc. assuntos de contexto financeiro

    Api do Serviço

    Policy Management

    A Policy Management permite realizar a consulta e Listagem de Apólices e Endossos Emitidos na Pottencial. Criar novos endossos.

    Api do Serviço

    Partners

    A API Partners permite a gestão dos parceiros cadastro, consultas, extratos de comissões e afins.

    Api do Serviço

    Webhook

    permite realizar o cadastro para obter a Listagem de Apólices e Endossos Emitidos na Pottencial.

    Api do Serviço

    Português, Brasil