Skip to main content
POST
Criar chave de API

Autorizações

Authorization
string
header
obrigatório

Chave secreta da conta: Authorization: Bearer sk_test_… ou sk_live_…. Use só no servidor.

Cabeçalhos

Idempotency-Key
string

Chave única por operação (um UUID serve). Repetir com a mesma chave devolve a resposta original.

Corpo

application/json
tier
enum<string>

Plano de limite de requisições da chave.

Opções disponíveis:
free,
pro,
enterprise
scopes
string[]

Permissões da chave. Vazio dá acesso completo à conta.

kind
enum<string>
padrão:secret

secret (padrão) para o servidor; publishable para o navegador.

Opções disponíveis:
secret,
publishable

Resposta

Criado.

A chave recém-criada, com o segredo completo em value.

id
string<uuid>
prefix
string

sk_test, sk_live, pk_test ou pk_live.

Exemplo:

"sk_live"

kind
enum<string>
padrão:secret
Opções disponíveis:
secret,
publishable
lastFour
string

Os quatro últimos caracteres

tier
enum<string>

Plano de limite de requisições.

Opções disponíveis:
free,
pro,
enterprise
scopes
string[]
revokedAt
string<date-time> | null

Quando foi revogada. null se está ativa.

createdAt
string<date-time>
value
string

O segredo completo. Só aparece na resposta de criação.

secret
string