Skip to main content
A chave de API do projeto autentica as chamadas à API da Zatten: enviar mensagem, ler e alterar leads, disparar automações e fluxos. Ela vai no header x-api-key e identifica o projeto: com a chave da Clínica A, só se enxerga e se altera a Clínica A. Use para integrar o sistema do cliente final, um n8n ou o assistente da agência no dia a dia.

​
Onde fica no painel

Menu API Keys (/api-keys). A lista mostra Nome, Chave secreta (só o começo e o fim), Criada e Último uso. Só admin e editor veem o menu e gerenciam chaves. Gestor e visualizador não veem. Ver Usuários, papéis e permissões.

​
Como configurar

1

Confira o projeto

A chave é criada para o projeto aberto no painel. Confira o nome antes.
2

Crie a chave

Em API Keys, crie uma chave nova e dê um Nome que diga onde ela vai ser usada (ex.: “n8n agenda”, “ERP clínica”, “assistente da agência”).
3

Copie na hora

A janela Salve sua chave mostra a chave inteira uma única vez. Copie e guarde num cofre de senhas ou no .env do sistema que vai usar. Depois disso, a lista só mostra o começo e o fim.
4

Use no header

Toda chamada leva x-api-key: <chave>. A única exceção é a API de template, que usa a mesma chave em Authorization: Bearer <chave>. Ver Autenticação.
Dá para renomear uma chave (o valor não muda) e excluir. Excluir corta o acesso de quem usa aquela chave.

​
Como funciona por trás

  • Escopo: um projeto. A chave não alcança outros projetos da conta, nem com attendant_id no corpo (dá 403).
  • Quantas: um projeto pode ter várias chaves. Use uma por sistema; assim dá para excluir uma sem derrubar as outras.
  • Último uso: atualizado quando a chave é usada nas rotas da API. As ações executadas pelos fluxos do Trigger Flow não contam: o fluxo roda sem usar a chave.
  • Limite de requisições: não há limite fixo publicado. Se a API responder 429, espere o Retry-After. Ver Limites.
  • Não há permissão parcial: toda chave lê e altera tudo o que a API do projeto permite.

​
Chave de API x token do MCP

Ver A API do dia a dia e Instalar a skill e o MCP.

​
Pelo MCP

A chave não viaja no template e o MCP não cria chaves. Quem cria é uma pessoa, no painel. O assistente guarda a chave no .env da pasta do cliente, nunca no repositório, e nunca a mostra em texto. Ver Organizar sua agência no computador.

​
Armadilhas

  • Chave no navegador. Nunca ponha a chave em código de site, app ou formulário público. Quem a vê lê as conversas e manda mensagens em nome do projeto. Chame a API sempre do seu servidor.
  • Chave do projeto errado. Como a chave define o projeto, uma chave trocada no .env faz o sistema mexer no cliente errado sem erro nenhum. Dê nomes claros.
  • Perdeu a chave? Não dá para ver de novo. Crie outra, troque no sistema e exclua a antiga.
  • Chave vazada: exclua na hora e crie outra.
  • Duplicar ou exportar o projeto não leva as chaves de API. O projeto novo precisa de chave própria.
  • Chaves que você não criou podem aparecer na lista. A plataforma cria chaves internas para o próprio projeto, que expiram e são revogadas sozinhas, e a tela de API Keys não as esconde. Não exclua essas chaves e não use para integração: crie uma chave sua, com nome claro. A chave temporária de uma campanha em andamento também aparece aqui.

​
Perguntas frequentes

A chave criada no painel não tem validade: vale até ser excluída. As chaves internas que a plataforma cria (e que podem aparecer na lista) expiram sozinhas.
Não. A API é sempre https://api.zatten.com/api/v1, com qualquer domínio do painel.
Não para as ações dos fluxos. Precisa só para chamar os fluxos de fora (/flows/trigger e /hooks/<path>). Ver Trigger Flow: disparar pela API.

​
Para saber mais