Skip to main content

API de API Keys

Gerencie API keys do Grwthy. As API keys são usadas para autenticar requisições à API e pertencem ao usuário, não a uma conta específica.
No Dashboard do Grwthy, você pode criar e gerenciar API keys na página API Keys. Os endpoints abaixo são a API programática equivalente.

Criar API Key

X-Api-Key
string
required
API key do Grwthy existente
POST https://grwthy.com/whatsapp/api-keys
Cria uma nova API key para o usuário autenticado.

Corpo da Requisição

name
string
required
Nome descritivo para a key (ex: “Produção”, “Staging”)
expiresAt
string
Data de expiração em formato ISO 8601. Se omitido, a key nunca expira

Resposta

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Produção",
  "keyPrefix": "wk_a1b2c3d4e5f6...",
  "key": "wk_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2",
  "expiresAt": "2026-03-01T00:00:00.000Z",
  "lastUsedAt": null,
  "isActive": true,
  "createdAt": "2026-02-01T00:00:00.000Z"
}
O campo key contém a API key completa e é retornado apenas uma vez durante a criação. Armazene-o com segurança.

Listar API Keys

GET https://grwthy.com/whatsapp/api-keys
Retorna todas as API keys do usuário autenticado. O campo key completo nunca é incluído na resposta — apenas o prefixo (keyPrefix).

Resposta

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Produção",
    "keyPrefix": "wk_a1b2c3d4e5f6...",
    "expiresAt": "2026-03-01T00:00:00.000Z",
    "lastUsedAt": "2026-02-15T12:30:00.000Z",
    "isActive": true,
    "createdAt": "2026-02-01T00:00:00.000Z"
  }
]

Revogar API Key

DELETE https://grwthy.com/whatsapp/api-keys/:id
id
string
required
UUID da API key
Revoga uma API key. A key é imediatamente invalidada e não pode ser reativada.

Resposta

{
  "message": "API key revoked"
}

Erros

StatusDescrição
404API key não encontrada