Pular para o conteúdo principal

Guia de Integração bem-te-vi

A bem-te-vi disponibiliza APIs para integrar seguros nas jornadas dos clientes de forma plug & play. Este guia fornece informações detalhadas sobre nossas APIs.

Para referência técnica mais aprofundada acerca das APIs e endpoints disponíveis, acesse a nossa documentação baseada em OpenAPI aqui.

Organização​

Estrutura das APIs​

As nossas APIs são organizadas de forma modular, permitindo que você acesse diferentes funcionalidades de acordo com a sua necessidade.

Os módulos são segmentados por tipos de produto de seguro como:

  • Seguro Prestamista: lender
  • Seguro Prestamista voltado a Educação Básica: lender-education
  • Seguro Residencial Habitacional: homeowners

Autenticação​

Uma vez concluído o processo de onboarding, você receberá um token de acesso que identifica a sua organização no nosso sistema.

A autenticação é feita através do header X-Api-Key, o qual deve conter o seu token de acesso.

Exemplo de Requisição​


curl --request GET \
--url https://api.bemteviseguros.com/lender/policies \
--header 'X-Api-Key: ******'

Práticas Sugeridas​

  • Prefira requisições em lote: Endpoints de envio de registros permitem envio em massa, prefira enviar dados em lote para economizar requisições e garantir maior eficiência.
  • Utilize filtros: Endpoints que listam recursos permitem filtros para refinar a busca, prefira utilizar filtros em vez de retornar todos os registros.