Primeiros passos em 5 minutos
Você precisa ser administrador ou dono do workspace e estar num plano pago (ou ser cliente financiado pela agência).
-
Crie a chave. No Preflow, abra Configurações → Integrações → API e webhooks, clique em criar chave, dê um nome (por exemplo
ERP) e marque os acessos de que a integração precisa. Para este teste nenhum acesso é necessário. -
Guarde a chave. Ela aparece uma vez só. Copie e guarde no cofre de segredos do servidor que vai chamar a API. No terminal, para o teste:
Janela do terminal export PREFLOW_API_KEY="pf_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -
Faça a primeira chamada.
GET /v1/mediz de qual workspace é a chave, quais acessos ela tem e o limite de pedidos:Janela do terminal curl https://api.preflow.sale/v1/me -H "Authorization: Bearer $PREFLOW_API_KEY"{"api_version": "v1","workspace": { "id": "6c1f…", "name": "Minha Empresa" },"api_key": { "id": "0b9e…", "name": "ERP", "environment": "live", "scopes": [] },"limits": { "requests_per_minute": 600 }} -
Escolha o próximo passo. Marque na chave os acessos do que você vai fazer e siga o guia: WhatsApp, Leads, contas e cadências ou Webhooks.
Deu erro?
Seção intitulada “Deu erro?”| Resposta | O que fazer |
|---|---|
401 authentication_required |
Faltou o cabeçalho Authorization: Bearer … |
401 invalid_api_key |
Confira se copiou a chave inteira e se o ambiente é o certo (Ambientes) |
403 plan_upgrade_required |
O plano do workspace não tem API; ao assinar, a mesma chave volta a funcionar |
Todos os códigos estão em Erros.