Skip to main content
A API usa chaves de API. Envie a chave no header HTTP Authorization, como Bearer token, em toda requisição.

Formato da chave

A chave tem o formato sk_{modo}_{prefixo}.{segredo}.
string
live para produção ou test para o ambiente de testes. Veja Ambientes.
string
A parte pública da chave, antes do ponto. Aparece no painel para você identificar cada chave, e é por ela que o rate limit conta suas requisições.
string
A parte secreta, depois do ponto, exibida uma única vez na criação. Guarde com segurança.
Trate a chave como uma senha. Nunca a coloque no frontend, em repositórios públicos ou em logs. Use uma chave sk_test_ no desenvolvimento e mantenha a sk_live_ apenas no servidor.

Sem chave ou chave inválida

Uma requisição sem chave, ou com uma chave malformada, desconhecida, revogada ou com o segredo errado, retorna 401:
A resposta é a mesma em todos esses casos, de propósito: ela não diz qual metade da chave está errada. Cada chave tem escopos que limitam o que ela pode fazer. Uma chamada fora do escopo retorna 403. Veja Chaves de API e Erros.

Verificar uma chave

O GET /public/ping é a única rota que não exige escopo, justamente para responder a uma chave recém-criada que ainda não recebeu nenhum.