Pular para o conteúdo principal
GET
/
instances
/
{instanceId}
/
token
/
{token}
/
call-token
Gerar token para chamadas
curl --request GET \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/call-token \
  --header 'Client-Token: <api-key>'
{
  "token": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://developer.z-api.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Conceituação

Este método gera um token efêmero para autenticação na SDK de chamadas.
O token é temporário e válido para uma única conexão. Se a aplicação reiniciar, um novo token deve ser gerado. Deve ser chamado a partir do backend, nunca do frontend, para evitar a exposição de credenciais.

​
Integração com SDK

Este endpoint deve ser utilizado em conjunto com a SDK oficial de chamadas: https://www.npmjs.com/package/@z-api/call Na documentação da SDK, consulte a seção “Exemplo de backend (Node.js)” para entender como utilizar este endpoint corretamente na geração do token.

​
Atributos

​
instanceId
string
obrigatório
ID da sua instância. Disponível no painel Z-API em Instâncias.
​
token
string
obrigatório
Token da sua instância Z-API.

​
Response

​
200

​
token
string
Token efêmero para autenticação na SDK de chamadas
{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

​
405

Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET conforme especificado no início deste tópico.

​
415

Caso você receba um erro 415, certifique de adicionar na headers da requisição o “Content-Type” do objeto que você está enviando, em sua grande maioria “application/json”.