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

Conceituação

Este método gera um token de sessão para o SDK de conexão. O seu backend chama este endpoint com o seu Client-Token e devolve o token retornado para o frontend, que o usa em ZAPIConnector.open({ token }).
A chamada deve ser feita pelo seu backend. Nunca exponha o seu Client-Token nem as credenciais da instância (instanceId e token) no frontend. O token gerado tem validade limitada — gere-o sob demanda, no momento em que o cliente for conectar.
Guia de implementação completo: SDK de conexão.

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 de sessão a ser usado em ZAPIConnector.open({ token }) no frontend
{
  "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”.