Autenticação e acessos
- Em Configurações → Integrações → API e webhooks, um administrador ou o dono do workspace cria uma chave, dá um nome e marca os acessos.
- A chave aparece uma vez só. Guarde no cofre de segredos do servidor que chama a API.
- Envie em todo pedido:
Authorization: Bearer pf_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxRegras da chave
Seção intitulada “Regras da chave”- Vale para um workspace. Toda chamada age nesse workspace; nada no corpo ou na URL troca isso.
- Faz só o que os acessos dela permitem (tabela abaixo).
- Revogada, para de funcionar na hora. Também cai sozinha quando quem a criou deixa de ser administrador do workspace.
- Disponível nos planos pagos (e para cliente financiado pela agência). No
Gratuito e no Try a chave responde
plan_upgrade_required; ao assinar, a mesma chave volta a funcionar. - É de servidor para servidor. Nunca coloque a chave no site, no app do celular ou em qualquer código que rode na máquina do seu cliente.
Confira a chave com GET /v1/me (Primeiros passos).
Acessos (escopos)
Seção intitulada “Acessos (escopos)”| Escopo | Permite |
|---|---|
whatsapp:read |
Ler linhas, templates, janela de 24h, mensagens e mídia |
whatsapp:send |
Enviar WhatsApp e subir arquivos |
leads:read |
Buscar leads e ler a linha do tempo |
leads:write |
Criar leads |
accounts:read |
Ler contas, etapas, donos e funis |
meetings:read |
Ler reuniões |
cadences:read |
Listar cadências |
cadences:write |
Inscrever lead em cadência e parar a cadência dele |
webhooks:manage |
Cadastrar e gerenciar webhooks |
Rota fora dos acessos da chave responde 403 insufficient_scope, com o escopo
que falta em details.required_scope, antes de qualquer efeito. Na
Referência da API, cada rota mostra o escopo que exige
(x-required-scope).
Convenções
Seção intitulada “Convenções”- JSON em UTF-8. Envie
Content-Type: application/jsonnos pedidos com corpo. - Ids são UUID. Datas em ISO-8601, em UTC. Telefones em E.164 (
+5511999998888). - Toda resposta traz
X-Request-Id. Informe esse valor ao suporte. - Corpo até 1 MB.