Credencial por integração
Um token por sistema conectado, com escopo mínimo. Revogar um não derruba os outros.
Integração · Técnico
API REST e webhooks.
Toda integração da brisk4 se apoia nestes dois mecanismos. A plataforma consome APIs dos seus sistemas e também expõe a própria API, para que o seu time construa o que precisar sem depender de roadmap de fornecedor.
Recursos
O que a API permite.
| Recurso | Direção | Uso típico |
|---|---|---|
| Envio de mensagem | Seu sistema → brisk4 | Disparar notificação pelo WhatsApp oficial a partir de um evento no seu backend. |
| Contatos | Bidirecional | Criar, consultar e atualizar contatos e seus campos personalizados. |
| Conversas e histórico | brisk4 → seu sistema | Exportar transcrição, canal, duração e responsável para o seu data warehouse ou BI. |
| Webhook de mensagem recebida | brisk4 → seu sistema | Reagir em tempo real ao que o cliente escreve, para lógica que roda do seu lado. |
| Webhook de status | brisk4 → seu sistema | Entregue, lido ou falhou: acompanhar a entrega de cada mensagem enviada. |
Padrões técnicos
O que entra no ar primeiro.
- REST com JSON e OAuth 2.0Endpoints REST sobre HTTPS, payload JSON e autenticação por OAuth 2.0 ou token de aplicação, com escopo por recurso e revogação a qualquer momento.
- Webhooks com assinatura e retentativaCada entrega é assinada para o seu servidor validar a origem. Falha de recebimento gera retentativa com backoff, sem perder evento.
- Idempotência e paginaçãoChamadas aceitam chave de idempotência para não duplicar operação em retentativa, e as listagens são paginadas com cursor.
Boas práticas
Método e pré-requisitos.
Ambiente de homologação
Toda integração é validada em ambiente de teste antes de qualquer chamada em produção.
Observabilidade
Log de chamadas, latência e erro disponível para o seu time acompanhar a saúde da integração.
- Protocolo
- HTTPS com TLS
- Formato
- JSON
- Autenticação
- OAuth 2.0 ou token de aplicação
- Eventos
- Webhooks assinados com retentativa e backoff
- Limites
- Rate limit por credencial, dimensionado no contrato
- Documentação
- Referência técnica entregue no início da implantação
Perguntas frequentes
API da brisk4: dúvidas.
A brisk4 tem API própria?
Tem. A plataforma expõe uma API REST sobre HTTPS, com payload JSON e autenticação por OAuth 2.0 ou token de aplicação. Ela permite enviar mensagem, gerenciar contatos e exportar histórico de conversas para o seu sistema.
Como funcionam os webhooks?
A brisk4 notifica o seu servidor quando um evento acontece: mensagem recebida, status de entrega, mudança em um contato. Cada entrega é assinada para você validar a origem, e falhas geram retentativa com backoff.
Meu time consegue construir integração sozinho?
Consegue. A referência técnica é entregue no início da implantação, e a API foi desenhada para uso direto pelo seu time de desenvolvimento, sem depender do nosso roadmap para cada ajuste.
Existe limite de chamadas?
Existe rate limit por credencial, dimensionado conforme o volume contratado. Chamadas aceitam chave de idempotência, então uma retentativa nunca duplica a operação.
Fale com quem entende de API.
No diagnóstico gratuito o seu time técnico conversa direto com o nosso, sem intermediário comercial traduzindo requisito.