Brick API

A Brick API está organizada em uma forma de REST API. A nossa API possui predictable resource-oriented URLs, aceita form-encoded request bodies, retorna JSON-encoded como resposta e usa o protocolo HTTP como padrão de respostas, verbos e autenticações.

URL Base

  https://api.brickseguros.com.br/v2

Como funciona?

O objetivo da API é permitir a consulta de antecedentes de um dado CPF ou CNPJ de forma programática para clientes Enterprise. A API foi confeccionada utilizando a filosofia CRUD, e as respostas das consultas são dadas de forma assíncrona.

Authenticação

A autenticação da API é feita utilizando-se Basic Auth. Primeiramente, faz-se um request GET para o endpoint de autenticação, com as credenciasis codificadas em base64, no seguinte padrão: 'username:password'

A resposta desta chamada será seu Bearer Token, a ser utilizado em requests posteriores. Cada Bearer Token tem uma validade de 24 horas (86400s)

Boas Práticas

Por se tratar de uma API de acesso a dados públicos através de técnicas de webcrawling, algumas solicitações podem levar até 2 minutos para serem concluidas, bem como algumas consultas podem falhar devido à instabilidades nos servidores, especialmente das bases de dados governamentais. Por este motivo, recomenda-se que as chamadas GET das solicitações sejam feitas em um intervalo superior a 15 segundos para não sobrecarregar nossos WebServices. Para as solicitações que tiverem algum tipo de consulta com erro ou Timeout, recomenda-se que se faça mais uma tentativa nos endpoints de retry, porém aguardar o tempo usual de resposta da consulta para fazer a chamada novamente, lembre-se que nosso WebService já é programado internamente para fazer o retry automático das consultas que não tiveram sucesso.