Onde encontrar o número da conta
O número aparece na tela de escolha de conta, ao entrar na plataforma, no formato Conta #12345. Se você acessa mais de uma conta, cada uma tem seu próprio número e sua própria chave. As duas coisas andam sempre juntas.Como gerar a chave de API
1
Abra as configurações da conta
Na plataforma, vá em Minha conta.
2
Vá para a aba Integrações
A seção Integrações mostra o campo Chave de Acesso à API.
3
Gere ou copie a chave
Se a conta ainda não tem chave, clique em Gerar chave. Se já tem, use o
ícone de olho para revelar e o botão Copiar.
Rotação da chave
Cada conta tem uma chave por vez. Ao clicar em Gerar nova chave, a chave anterior morre na hora, e toda integração que a usava passa a receber401 até
ser atualizada.
A troca precisa de um pouco de planejamento:
1
Liste onde a chave está em uso
Servidores, funções serverless, automações, ferramentas internas.
2
Gere a nova chave
Em Minha conta › Integrações.
3
Atualize todos os pontos de uma vez
Não existe período de convivência entre a chave antiga e a nova.
Identificando a conta pelo canal
Quando o sistema que integra conhece o ID do canal mas não o número da conta, useX-Canal no lugar de X-Ambiente:
X-Ambiente tem precedência: se
os dois vierem, o número da conta é usado e o canal é ignorado.
O que a chave autoriza
A chave autentica a conta, não um usuário. Isso muda duas coisas na prática. A primeira é que não há papéis nem permissões por chave. Ela alcança todos os endpoints e todos os dados da conta. Se a sua integração precisa de escopo reduzido, o controle tem de ficar do seu lado. A segunda é que as ações não têm autor. O que a API cria não fica atribuído a um usuário da plataforma. Quando o endpoint precisa de um responsável, como ao atribuir um atendimento, o usuário vai no corpo da requisição. Os dados ficam sempre isolados por conta. Uma chave nunca alcança dados de outra conta, mesmo que você informe um ID válido de lá. A resposta é404.
Quando a autenticação falha
Falha de autenticação devolve401 Unauthorized com corpo vazio e o cabeçalho
WWW-Authenticate: X-Chave-Api realm="CPlus". Diferente dos outros erros da API,
o 401 não traz JSON explicando o motivo. Isso é deliberado, para não revelar se
uma conta existe.
Se você recebeu 401, verifique nesta ordem:
Os demais códigos de erro estão em Erros.
Autenticação do servidor MCP
O endereço/mcp, usado por agentes de IA, aceita a mesma chave de API nos mesmos
cabeçalhos. Ele também aceita OAuth 2.1 com PKCE, que é o caminho de clientes como
o Claude para conectar sem ninguém colar uma chave em arquivo de configuração. Os
detalhes estão em Servidor MCP.