Skip to main content

​
1. Client-Token

Toda chamada pública exige o header Client-Token: 
Client-Token: SEU_CLIENT_TOKEN
Esse token identifica a conta dona das instâncias e também é o valor usado no campo de autenticação do playground (Try it).

​
2. instanceId e instanceToken

Depois de criar a instância, você recebe:
  • instanceId
  • instanceToken
Esses valores entram diretamente na URL, por exemplo: 
curl -X GET \
  'https://api.ezapi.com.br/instances/abc1234567890/token/tok_a1b2c3d4e5f6/status' \
  -H 'Client-Token: SEU_CLIENT_TOKEN'

​
3. Como testar no playground

  1. Abra qualquer endpoint da referência.
  2. Preencha o campo de autenticação com o valor do seu Client-Token.
  3. Substitua instanceId e instanceToken nos parâmetros da rota.
  4. Ajuste body, query params e execute.
O playground desta documentação foi configurado para usar autenticação por chave HTTP (Client-Token).

​
Exemplo autenticado

curl -X POST \
  'https://api.ezapi.com.br/instances/abc1234567890/token/tok_a1b2c3d4e5f6/send-text' \
  -H 'Client-Token: SEU_CLIENT_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "phone": "5511999999999",
    "message": "Mensagem autenticada com sucesso"
  }'

​
Erros de autenticação mais comuns

StatusQuando aconteceExemplo
401 UnauthorizedClient-Token ausente ou inválido, ou instanceToken incorreto{ "error": "Unauthorized", "message": "Invalid instanceToken" }
404 Not FoundA instância não existe mais ou não foi encontrada{ "error": "Instance not found" }
Nunca exponha Client-Token ou instanceToken em frontend público, aplicativos mobile distribuídos ao usuário final ou repositórios versionados.