Authorization. Não há fluxo OAuth para consumidores da API: você gera um token de longa duração diretamente no painel do PanÐá Zap e o inclui em cada requisição. A única exceção é o envio de mensagem por parâmetros na URL (GET /params/), que ignora o cabeçalho e recebe o token no parâmetro bearertoken (veja Enviar Mensagens).
Criando uma Chave de API
1
Faça login como Administrador
Abra o PanÐá Zap e entre com um usuário Administrador. Supervisores e perfis personalizados só acessam essa tela se a permissão tiver sido liberada para eles.
2
Abra Configuração → API
No menu lateral, abra o grupo Configuração e clique em API.
3
Clique em + Nova API
Selecione + Nova API para abrir o formulário de criação de integração.
4
Nomeie sua integração
Dê um nome descritivo que identifique sua finalidade, por exemplo,
Integração CRM ou Sincronização E-commerce. Isso ajuda você a gerenciar várias integrações no futuro.5
Selecione uma Sessão
Escolha a Sessão (canal) da qual esta integração de API enviará mensagens. Cada integração está vinculada a exatamente um canal, e a sessão não pode ser alterada depois de criada. Se precisar enviar de vários canais, crie uma integração de API por canal.
6
Salve e copie seu token
Clique em Salvar. Na janela seguinte, copie o token completo: ele aparece uma única vez. Só então clique em Já copiei, fechar. Depois disso, o cartão da integração mostra apenas o Prefixo do token. O ID da API é o código no fim da URL de integração, exibida no mesmo cartão (um identificador com letras, números e hífens, como
3f6c2a9e-8b1d-4e7a-9c55-0d2f7b1a4e63, e não um número); você vai usá-lo em toda URL de requisição.Usando o Token
Inclua o token Bearer no cabeçalhoAuthorization de toda requisição, e o {ApiID} no caminho da URL para rotear a requisição para o canal e o tenant corretos:
{BaseUrl} pelo domínio do seu servidor PanÐá Zap e {ApiID} pelo ID da sua listagem de integração.
Segurança do Token
Siga estas práticas para manter seu token seguro:- Nunca faça commit de tokens no controle de versão. Use variáveis de ambiente ou um gerenciador de segredos para armazená-los.
- Nunca compartilhe tokens em capturas de tela, mensagens do Slack ou coleções exportadas do Postman. Verifique se o campo Initial Value no Postman está sempre vazio (veja a seção Coleção do Postman, abaixo).
- Rotacione quando comprometido. Vá até Configuração → API e, no cartão da integração, clique no ícone Gerar novo token (seta circular) e confirme. O token antigo é invalidado imediatamente, então planeje a troca nas suas integrações para evitar interrupções.
- Armazene em variáveis de ambiente: referencie seu token como
$PANDAZAP_TOKENem scripts e pipelines de CI/CD em vez de fixá-lo no código-fonte.
Coleção do Postman
Abra a coleção oficial pelo botão Postman, no topo da tela Configuração → API: ele abre a documentação publicada da coleção do PanÐá Zap no Postman. Depois de importá-la, configure as variáveis na aba Variables (o domínio, emBaseUrl e BASE_URL, já vem preenchido; você completa o token e o ID da API):
- Sempre preencha a coluna Current Value, não a Initial Value: o Postman inclui os Initial Values quando você exporta ou compartilha uma coleção, o que arrisca expor credenciais.
Solucionando Erros 401
Se uma requisição retornar uma resposta401 Unauthorized, verifique o seguinte:
- O cabeçalho
Authorizationestá presente e formatado corretamente: deve conterBearer(com um espaço) seguido do seu token, sem espaços extras. - Se estiver usando o envio por parâmetros na URL (
/params/), o token precisa ir no parâmetrobearertoken: nessa rota o cabeçalho é ignorado. - O token não foi rotacionado ou invalidado. Se foi rotacionado recentemente, atualize sua integração para usar o novo token.
- Você está enviando as requisições para o
{BaseUrl}correto da sua conta PanÐá Zap.
Gerenciamento de Usuários
Administradores podem criar novos usuários da plataforma de forma programática via API. Isso é útil para provisionar contas de agentes a partir de um sistema externo de RH ou de integração, sem exigir acesso manual ao painel.
Uma resposta bem-sucedida retorna HTTP
201 com {"success": true, "data": {...}} e os detalhes do usuário criado. Veja as demais rotas em Usuários.
Métricas do Dashboard
Você pode obter contagens de tickets e análises de tempo de resposta para qualquer intervalo de datas usando o endpoint de métricas do dashboard. Isso é útil para construir relatórios personalizados ou sincronizar KPIs com uma ferramenta de BI externa.
Uma resposta bem-sucedida retorna
{"success": true, "data": [ ... ]}: a lista traz um único item com o volume de atendimentos e os tempos médios do período. Sem isGroup=true, a contagem considera só os atendimentos individuais. Veja todos os campos em Métricas do Dashboard.
