Chaves de API

Criar chave de API

POST /api/v1/api-keys

Cria uma nova chave de API para o usuário autenticado.

Corpo da requisição

{
  "name": "Minha integração"
}

Campo	Obrigatório	Descrição
name	Sim	Nome de exibição para a chave (1–100 caracteres)

Resposta

{
  "data": {
    "id": "key_uuid",
    "name": "Minha integração",
    "prefix": "rm_abc123",
    "key": "rm_abc123def456...",
    "created_at": "2025-09-19T15:00:00.000Z"
  }
}

Cuidado

O campo key é retornado apenas uma vez no momento da criação. Armazene-o com segurança - ele não pode ser recuperado novamente. Apenas o prefix (os primeiros 8 caracteres) é mostrado em requisições subsequentes.

---

Listar chaves de API

GET /api/v1/api-keys

Retorna todas as chaves de API para o usuário autenticado. O valor completo da chave nunca é retornado após a criação.

Resposta

{
  "data": [
    {
      "id": "key_uuid",
      "name": "Minha integração",
      "prefix": "rm_abc123",
      "created_at": "2025-09-19T15:00:00.000Z",
      "last_used_at": "2025-09-20T10:30:00.000Z",
      "is_revoked": false
    }
  ]
}

---

Revogar chave de API

DELETE /api/v1/api-keys/:id

Revoga permanentemente uma chave de API. As solicitações que usam esta chave falharão imediatamente com INVALID_API_KEY.

Resposta

{
  "data": { "success": true }
}

Códigos de erro

Código	Status HTTP	Significado
API_KEY_NOT_FOUND	404	A chave não existe ou pertence a outro usuário
ALREADY_REVOKED	400	A chave já foi revogada