Saltar para o conteúdo principal
POST
Criar Chave de API do Consumidor
Cria uma nova chave de API pessoal para o consumidor autenticado. O segredo completo é retornado uma vez na resposta e não pode ser recuperado novamente — armazene-o com segurança. Cada consumidor pode ter até 5 chaves ativas. As chaves expiram automaticamente após 90 dias.

Respostas

Autorizações

Authorization
string
header
obrigatório

JWT para operações iniciadas pelo usuário

Corpo

application/json
name
string
obrigatório

Um rótulo legível para a chave

Resposta

Chave de API criada. O segredo é mostrado apenas nesta resposta.

key_id
string<uuid>
name
string

Rótulo legível por humanos para a chave

prefix
string

Primeiros 12 caracteres da chave, para fins de exibição

status
enum<string>
Opções disponíveis:
active,
revoked
scopes
string[]

Escopos de permissão concedidos a esta chave

created_at
string<date-time>
expires_at
string<date-time>

As chaves expiram 90 dias após a criação

last_used_at
string<date-time>

Carimbo de data/hora da última solicitação feita com esta chave

secret
string

Valor da chave de API completa (mostrado uma vez)