Chaves de API

Gerencie os tokens bearer usados para autenticar nesta API. O conceito é abordado em Conceitos → Chaves de API; esta página é o formato na rede (wire shape).

Listar chaves

GET/v1/api-keysBearer · API key

Retorna todas as chaves ativas do cliente autenticado. O material da chave em si não está na resposta — apenas o prefixo e os metadados.

Schema · ApiKey

Field	Type	Required
id	string · uuid	required
customer_id	string · uuid	required
channel_id	string · uuid	required · nullable
name	string	required
prefix	string	required
scopes	array<string>	optional
last_used_at	string · ISO 8601	required · nullable
expires_at	string · ISO 8601	required · nullable
created_at	string · ISO 8601	required
revoked_at	string · ISO 8601	required · nullable

curl -s "$WHATISUP_API/v1/api-keys" \
  -H "Authorization: Bearer $WHATISUP_API_KEY"

Emitir uma nova chave

POST/v1/api-keysBearer · API key

Schema · Request body

Field	Type	Required
name	string	required
channel_id	string · uuid	optional
scopes	array<string>	optional
expires_at	string · ISO 8601	optional

curl -sX POST "$WHATISUP_API/v1/api-keys" \
  -H "Authorization: Bearer $WHATISUP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"app-2026-q2"}'

Passe channel_id para vincular a chave a um único canal. Essa chave só conseguirá enviar mensagens de / ler entregas para aquele canal — útil para apps com privilégio mínimo.

Schema · Response · IssuedApiKey

Field	Type	Required
id	string · uuid	required
customer_id	string · uuid	required
channel_id	string · uuid	required · nullable
name	string	required
prefix	string	required
scopes	array<string>	optional
last_used_at	string · ISO 8601	required · nullable
expires_at	string · ISO 8601	required · nullable
created_at	string · ISO 8601	required
revoked_at	string · ISO 8601	required · nullable
secret	string	required

O campo secret é a única vez que mostraremos a chave completa. Salve antes de seguir em frente. Podemos revogá-la; não conseguimos recuperá-la.

O prefix (ex.: zpk_live_abcd1234) é o que aparece na lista de chaves e no dashboard. Guarde-o; você vai usá-lo para identificar a chave ao revogar.

Revogar uma chave

DELETE/v1/api-keys/:idBearer · API key

Exclusão lógica (soft-delete): a linha é marcada como excluída, a chave para de funcionar imediatamente, o log de auditoria registra o evento. Retorna 204 No Content.

curl -sX DELETE "$WHATISUP_API/v1/api-keys/key_01J..." \
  -H "Authorization: Bearer $WHATISUP_API_KEY"

O que você não pode fazer

Revelar o secret de uma chave existente. Perdeu = revogue + emita. É por design.
Revincular uma chave a outro canal. Crie uma nova; revogue a antiga. O vínculo é definido só no momento da emissão.