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.
EscopoPermite
products:readConsultar e listar produtos
products:writeCriar, editar, arquivar e alterar preços de produtos
orders:readConsultar e listar pedidos
checkouts:readConsultar e listar checkouts
checkouts:writeEditar checkouts
upsells:readConsultar e listar upsells
upsells:writeCriar, editar e excluir upsells
sales:readConsultar o resumo de vendas
dashboards:readConsultar métricas
subscriptions:readConsultar e listar assinaturas
Uma chamada para um endpoint cujo escopo a chave não possui retorna 403: 
{
  "error": {
    "type": "insufficient_scope",
    "message": "This API key is missing the required scope."
  }
}

​
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.