- Autenticação
- Rate limit
- Documentação
- Rotas disponíveis
- Gerenciamento de clientes
- Gerenciamento de processos
- Listar Processos (GET /lawsuits)
- Criar Processo (POST /lawsuits)
- Obter Processo por ID (GET /lawsuits/{id})
- Atualizar Processo (PUT /lawsuits/{id})
- Criar Tarefa (POST /posts)
- Listar Tarefas (GET /history/{lawsuit_id}/)
- Listar Andamentos (GET /movements/{lawsuit_id})
- Criar Andamento Manual (POST /lawsuits/movement)
- Últimos Andamentos (GET /last_movements)
- Gerenciamento de usuários
- Status da API
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
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.
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 #
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) #
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.
Recupera uma lista de clientes com base em filtros como nome ou CPF/CNPJ.
Exemplo de cURL
Criar Cliente (POST /customers) #
Use esta rota para cadastrar novos clientes no sistema. É essencial fornecer informações precisas, especialmente o nome e email, para facilitar a comunicação futura. A origem do cliente ajuda a rastrear de onde vieram os leads.
Cria um novo cliente no sistema.
Obter Cliente por ID (GET /customers/{id}) #
Quando você precisa acessar todas as informações de um cliente específico, como dados de contato completos, histórico de processos associados e outras informações relevantes.
Recupera informações detalhadas de um cliente específico.
Listar Aniversariantes (GET /customers/birthdays) #
Excelente para ações de relacionamento com clientes. Permite que escritórios enviem felicitações de aniversário, fortalecendo o relacionamento e demonstrando atenção personalizada.
Recupera uma lista de clientes com aniversário no mês atual.
Listar Aniversariantes (GET /customers/birthdays) #
Excelente para ações de relacionamento com clientes. Permite que escritórios enviem felicitações de aniversário, fortalecendo o relacionamento e demonstrando atenção personalizada.
Recupera uma lista de clientes com aniversário no mês atual.
Gerenciamento de processos #
Listar Processos (GET /lawsuits) #
Esta rota é fundamental para localizar processos específicos no sistema. Os múltiplos filtros permitem uma busca precisa, seja por número de processo, cliente envolvido ou fase atual. Ideal para relatórios gerenciais e acompanhamento de carteira.
Recupera uma lista de processos com base em diversos filtros.
Criar Processo (POST /lawsuits) #
Use esta rota para cadastrar novos processos no sistema. A associação com múltiplos clientes permite representar adequadamente casos com várias partes. As informações opcionais enriquecem o cadastro e facilitam o acompanhamento futuro.
Cria um novo processo no sistema.
Obter Processo por ID (GET /lawsuits/{id}) #
Quando você precisa acessar todas as informações de um processo específico, incluindo partes envolvidas, andamentos, tarefas associadas e documentos.
Recupera informações detalhadas de um processo específico.
Atualizar Processo (PUT /lawsuits/{id}) #
Ideal para atualizar informações de um processo, como mudança de fase, inclusão de número de processo após distribuição ou adição de novas observações relevantes ao caso.
Atualiza um processo existente no sistema.
Criar Tarefa (POST /posts) #
Esta rota permite criar compromissos, audiências, prazos e outras tarefas associadas a processos. O sistema de convidados facilita a colaboração entre membros da equipe, enquanto as marcações de urgência e importância ajudam na priorização.
Cria uma nova tarefa associada a um processo.
Listar Tarefas (GET /history/{lawsuit_id}/) #
Permite visualizar o histórico de tarefas associadas a um processo específico, facilitando o acompanhamento de compromissos, prazos e responsabilidades da equipe.
Lista as tarefas mais recentes de um processo.
Listar Andamentos (GET /movements/{lawsuit_id}) #
Permite acompanhar a evolução de um processo judicial, visualizando todos os andamentos registrados, sejam eles capturados automaticamente dos tribunais ou inseridos manualmente pela equipe.
Lista os andamentos de um processo.
Criar Andamento Manual (POST /lawsuits/movement) #
Permite registrar eventos importantes relacionados ao processo que não são capturados automaticamente dos tribunais, como reuniões com clientes, decisões estratégicas ou informações obtidas informalmente.
Cria um novo andamento manual para um processo.
Últimos Andamentos (GET /last_movements) #
Ideal para monitorar a atividade recente em todos os processos do escritório, permitindo uma visão geral das novidades sem precisar verificar cada processo individualmente.
Recupera os últimos andamentos de processos.
Gerenciamento de usuários #
Obter Configurações da Conta (GET /settings) #
Permite acessar informações sobre a configuração atual do escritório no sistema, incluindo preferências, permissões e outras configurações relevantes.
Recupera as configurações e configuração da conta.
Obter Recompensas do Usuário (GET /users/rewards) #
Permite visualizar as recompensas obtidas pelo usuário em uma data específica, útil para acompanhar o desempenho e as conquistas dentro do sistema.
Recupera as recompensas do usuário para uma data específica.
Status da API #
Confira abaixo a disponibilidade de cada rota da API. A verificação da disponibilidade de cada rota é realizada de forma continua a cada uma hora.