Autenticação

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

Abra qualquer endpoint da referência.
Preencha o campo de autenticação com o valor do seu Client-Token.
Substitua instanceId e instanceToken nos parâmetros da rota.
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

Status	Quando acontece	Exemplo
`401 Unauthorized`	`Client-Token` ausente ou inválido, ou `instanceToken` incorreto	`{ "error": "Unauthorized", "message": "Invalid instanceToken" }`
`404 Not Found`	A 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.

Introdução

Instância

Mensagens

Conversas

Contatos

Privacidade

Grupos

Status

Fila de mensagens

WhatsApp Business

Webhooks

Autenticação

1. Client-Token

2. instanceId e instanceToken

3. Como testar no playground

Exemplo autenticado

Erros de autenticação mais comuns

​1. Client-Token

​2. instanceId e instanceToken

​3. Como testar no playground

​Exemplo autenticado

​Erros de autenticação mais comuns

1. Client-Token

2. instanceId e instanceToken

3. Como testar no playground

Exemplo autenticado

Erros de autenticação mais comuns