Plataforma
Rotas para quem oferece WhatsApp a clientes (SaaS, revendas, agências) — marco 11. Etiquete as instâncias para filtrá-las e operar em lote, crie chaves de API só de leitura ou só de envio para entregar a terceiros, gere um link de pareamento hospedado (o cliente escaneia o QR numa página do seu servidor, sem ver token nenhum) e consulte o uso de cada instância.
Renomear, etiquetar e restringir IPs fica em Editar instância; filtros e paginação em Listar instâncias. O passo a passo está no guia Multi-instância e parceiros.
Conceito: leia antes de integrar.
Operações
| Operação | Rota | Token |
|---|---|---|
| Operação em lote | POST /v1/instances/bulk | token admin |
| Listar chaves de API | GET /v1/instances/{id}/api-keys | token da instância ou admin |
| Criar chave de API | POST /v1/instances/{id}/api-keys | token da instância ou admin |
| Revogar chave de API | DELETE /v1/instances/{id}/api-keys/{key_id} | token da instância ou admin |
| Gerar link de pareamento | POST /v1/instances/{id}/pairing-links | token admin |
| Revogar links de pareamento | DELETE /v1/instances/{id}/pairing-links | token admin |
| Uso da instância | GET /v1/instances/{id}/usage | token da instância ou admin |
Eventos relacionados
Gerado de openapi.yaml. Convenções gerais na visão geral e todos os códigos em Erros.