A utilização da API da ADVBOX se dá por meio de parceiros homologados ou através da contratação deste opcional, diretamente na conta do seu escritório.
Autenticação #
Utilizamos um método de validação das requisições por Bearer token , que é obtido diretamente com o parceiro ou diretamente em sua conta ADVBOX, após a ativação da API em sua conta.
Exemplo de curl para consulta de clientes.
curl -X ‘GET’ \ ‘https://app.advbox.com.br/api/v1/customers’ \ -H ‘accept: application/json’ \ -H ‘Authorization: Bearer {bearer_token}’
Rate limit #
O limite de consumo da API é de 30 requisições por minuto (1.800 requisições por hora).
Documentação #
A documentação pode ser acessada diretamente pelo Swagger Hub , onde poderão ser realizados testes com os respectivos endpoints disponíveis para consumo.
API Status #
Os status apresentados nesta página são atualizados automaticamente a cada 15 minutos.
/customers
Copiar cURL curl -X GET "https://app.advbox.com.br/api/v1/customers?name=Joao&identification=123456789&limit=10&offset=0" \
-H "accept: application/json" \
-H "Authorization: Bearer {seu_token_aqui}"
Operational
Older Now
/customers/birthdays
Copiar cURL curl -X GET "https://app.advbox.com.br/api/v1/customers/birthdays" \
-H "accept: application/json" \
-H "Authorization: Bearer {seu_token_aqui}"
Operational
Older Now
/customers/{id}
Copiar cURL curl -X GET "https://app.advbox.com.br/api/v1/customers/123" \
-H "accept: application/json" \
-H "Authorization: Bearer {seu_token_aqui}"
Operational
Older Now
/history/{lawsuit_id}
Copiar cURL curl -X GET "https://app.advbox.com.br/api/v1/history/123/?status=pending" \
-H "accept: application/json" \
-H "Authorization: Bearer {seu_token_aqui}"
Operational
Older Now
/lawsuits
Copiar cURL curl -X GET "https://app.advbox.com.br/api/v1/lawsuits?name=Cobranca&process_number=123456789&protocol_number=987654321&customer_id=45&limit=10&offset=0" \
-H "accept: application/json" \
-H "Authorization: Bearer {seu_token_aqui}"
Operational
Older Now
/lawsuits/{id}
Copiar cURL curl -X GET "https://app.advbox.com.br/api/v1/lawsuits/123" \
-H "accept: application/json" \
-H "Authorization: Bearer {seu_token_aqui}"
Operational
Older Now
/movements/{lawsuit_id}
Copiar cURL curl -X GET "https://app.advbox.com.br/api/v1/movements/123" \
-H "accept: application/json" \
-H "Authorization: Bearer {seu_token_aqui}"
Operational
Older Now
/publications/{lawsuit_id}
Copiar cURL curl -X GET "https://app.advbox.com.br/api/v1/publications/123" \
-H "accept: application/json" \
-H "Authorization: Bearer {seu_token_aqui}"
Operational
Older Now
Legenda: Disponível para consulta
Erro na tentativa de consultar os dados
Funcionamento parcial
Sem histórico