Documentação API

Arthur • 03/07/2025

Navegação Interna

A API ADVBOX oferece um conjunto abrangente de rotas para integração com sistemas externos, permitindo automação e otimização de processos em escritórios de advocacia. Para utilizar a API de forma eficiente:

  • Documentação: Consulte este guia e a documentação oficial para referência
  • Autenticação: Sempre inclua o token Bearer no cabeçalho de autorização
  • Limites de requisição: Respeite os limites para evitar bloqueios temporários
  • Tratamento de erros: Implemente tratamento adequado para os códigos de erro retornados
  • Formato de resposta: Todas as rotas retornam dados em formato JSON

Para suporte técnico ou dúvidas sobre a API, entre em contato com a equipe de suporte da ADVBOX.

Autenticação

Utilizamos um método de validação das requisições por Bearer token, que é obtido diretamente em sua conta ADVBOX no menu Configurações > Integrações e API.

Base URL

https://app.advbox.com.br/api/v1

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

Limites por Método HTTP:

GET 30 requisições por minuto
POST 100 requisições por dia para cada rota
PUT 500 requisições por dia para cada rota

Documentação

A documentação completa pode ser acessada diretamente pelo Swagger Hub da ADVBOX.

Rotas Disponíveis

Gerenciamento de Clientes

Listar Clientes

GET /customers

Descrição: Ideal para buscar clientes cadastrados no sistema, permitindo filtragem por diferentes critérios. Útil para verificar se um cliente já existe antes de criar um novo registro ou para localizar informações de contato rapidamente.

Funcionalidade: Recupera uma lista de clientes com base em filtros como nome ou CPF/CNPJ.

Parâmetros de Query
Parâmetro Tipo Descrição
name string (query) Nome do cliente ou parte dele. Você pode usar um nome completo ou termo de busca parcial (ex: nome ou sobrenome).
phone string (query) Telefone do cliente (ex: 48991234567 ou (48)99123-4567).
identification string (query) Identificação do cliente (CPF/CNPJ).
limit integer (query) Número de itens na resposta, entre 1 e 1000.
offset integer (query) Número de itens a pular antes de iniciar a resposta (paginação).
Exemplo de Requisição
curl -X 'GET' \
'https://app.advbox.com.br/api/v1/customers?name=John&limit=10' \
-H 'accept: application/json' \
-H 'Authorization: Bearer {bearer_token}'

Importante: Sempre substitua {bearer_token} pelo seu token real obtido nas configurações da sua conta ADVBOX.

Criar Novo Cliente

POST /customers

Descrição: Permite criar um novo cliente no sistema. Útil para automatizar o processo de cadastro de clientes a partir de sistemas externos ou formulários web.

Funcionalidade: Cria um novo registro de cliente com as informações fornecidas.

Parâmetros do Corpo da Requisição
Parâmetro Tipo Obrigatório Descrição
users_id integer Sim ID do usuário que está criando o cliente.
customers_origins_id integer Sim ID da origem do cliente.
name string Sim Nome completo do cliente.
email string Não Endereço de e-mail do cliente.
Exemplo de Requisição
curl -X 'POST' \
'https://app.advbox.com.br/api/v1/customers' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {bearer_token}' \
-H 'Content-Type: application/json' \
-d '{
"users_id": 12345,
"customers_origins_id": 67890,
"name": "John Doe",
"email": "john.doe@example.com"
}'
Resposta de Sucesso
[
{
"success": true,
"customer_id": 128712976
}
]

Obter Cliente por ID

GET /customers/{id}

Descrição: Recupera os dados detalhados de um cliente específico com base no seu ID único. Útil para obter informações completas de um cliente após identificá-lo em uma listagem ou para verificar dados atualizados.

Funcionalidade: Retorna todos os dados cadastrais do cliente especificado pelo ID.

Parâmetros de Path
Parâmetro Tipo Descrição
id integer (path) ID único do cliente a ser consultado.
Exemplo de Requisição
curl -X 'GET' \
'https://app.advbox.com.br/api/v1/customers/123' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {bearer_token}'

Aniversários de Clientes

GET /customers/birthdays

Descrição: Recupera uma lista de clientes que fazem aniversário no mês atual. Útil para campanhas de marketing, felicitações automáticas ou relatórios de CRM.

Funcionalidade: Retorna uma lista de clientes com aniversários no mês atual, com opções de paginação.

Parâmetros de Query
Parâmetro Tipo Obrigatório Descrição
limit integer Não Número máximo de registros a serem retornados (entre 1 e 1000).
offset integer Não Número de registros a serem ignorados antes de iniciar a resposta (para paginação).
Exemplo de Requisição
curl -X 'GET' \
'https://app.advbox.com.br/api/v1/customers/birthdays?limit=20&offset=0' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {bearer_token}'

Gerenciamento de Processos Judiciais

Listar Processos

GET /lawsuits

Descrição: Recupera uma lista de processos judiciais cadastrados no sistema. Permite filtrar por diversos critérios e paginar os resultados.

Funcionalidade: Retorna uma lista de processos judiciais com informações resumidas.

Parâmetros de Query
Parâmetro Tipo Obrigatório Descrição
name string Não Nome do processo ou parte dele.
process_number string Não Número do processo judicial.
protocol_number string Não Número de protocolo do processo.
customer_id integer Não ID do cliente associado ao processo.
limit integer Não Número máximo de registros a serem retornados (entre 1 e 100).
offset integer Não Número de registros a serem ignorados antes de iniciar a resposta (para paginação).
group string Não Filtrar processos por nome ou ID do grupo.
type string Não Filtrar processos por nome ou ID do tipo.
responsible string Não Filtrar processos por nome ou ID do responsável.
stage string Não Filtrar processos por nome ou ID da fase (Judicial, Recursal...).
step string Não Filtrar processos por nome ou ID da etapa (Aguardando retorno, Petição inicial...).
Exemplo de Requisição
curl -X 'GET' \
'https://app.advbox.com.br/api/v1/lawsuits?customer_id=123&limit=10' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {bearer_token}'

Criar Novo Processo

POST /lawsuits

Descrição: Permite criar um novo processo judicial no sistema. Útil para automatizar o cadastro de processos a partir de sistemas externos ou integrações com tribunais.

Funcionalidade: Cria um novo registro de processo judicial com as informações fornecidas.

Parâmetros de Body
Parâmetro Tipo Obrigatório Descrição
users_id string Sim ID do usuário que está criando o processo.
customers_id array[integer] Sim Lista de IDs de clientes associados ao processo.
stages_id string Sim ID da fase do processo.
type_lawsuits_id string Sim ID do tipo de processo.
process_number string Não Número do processo judicial.
protocol_number string Não Número de protocolo do processo.
folder string Não Nome da pasta para o processo.
date string Não Data do processo no formato DD/MM/YYYY.
notes string Não Informações detalhadas sobre o processo, incluindo histórico, notas importantes e contexto adicional para referência futura.
Exemplo de Requisição