Skip to main content
As chaves de API são criadas e gerenciadas no painel, na seção Desenvolvedores. Cada chave pertence à sua conta e carrega um conjunto de escopos.

​
Criar uma chave

1

Abra Desenvolvedores no painel

Acesse a seção Desenvolvedores e clique em Nova chave de API.
2

Dê um nome e escolha o modo

Use um nome que identifique o uso (por exemplo, “Integração ERP”). Escolha o modo live ou test.
3

Selecione os escopos

Marque apenas os escopos que a integração precisa.
4

Copie o segredo

O segredo é exibido uma única vez. Copie e guarde com segurança. Se perder, gere uma nova chave.

​
Escopos

Cada escopo libera um conjunto de operações. Conceda o mínimo necessário.
Os webhooks têm três escopos, e não dois: uma chave pode registrar um destino sem poder apagar os que já existem. Silenciar uma assinatura fica com webhooks:create, junto com a edição.
O painel pode oferecer outros escopos, usados por outras superfícies da plataforma. A tabela acima é a dos escopos que esta API consulta. Uma chamada para um endpoint cujo escopo a chave não possui retorna 403:
O escopo é conferido antes de qualquer outra coisa, então um 403 nunca fica guardado como resposta idempotente: conceder a permissão que faltava muda a resposta na chamada seguinte. O GET /public/ping é a exceção: responde a qualquer chave válida, mesmo uma sem nenhum escopo.

​
Revogar uma chave

Na seção Desenvolvedores, revogue a chave a qualquer momento. A revogação é imediata: a partir dela, qualquer chamada com aquela chave passa a retornar 401.
Para girar uma chave sem interromper a integração, crie a nova chave, atualize a integração e só então revogue a antiga.