Chaves da API

As chaves da API autenticam as chamadas dos sistemas da sua empresa à plataforma. Cada chave tem um ID e um token secreto, usados como usuário e senha no esquema HTTP Basic descrito em Integração técnica.

Criar uma chave

Em Configurações > Chaves da API > Nova chave:

  1. Informe uma descrição opcional para identificar o uso da chave (até 32 caracteres).
  2. Clique em Criar.
  3. Copie o ID e o token secreto e guarde os dois em local seguro. A tela exibe a chave uma única vez: depois de sair da tela, o token não pode ser recuperado.

Cada conta suporta até 10 chaves simultâneas. Para criar uma chave além desse limite, remova uma existente antes.

Painel

A tela Chaves da API lista todas as chaves da conta com:

  • ID da chave.
  • Token visível: primeiros caracteres do token, suficientes para identificá-lo sem expor o segredo.
  • Descrição definida na criação.
  • Último uso: horário aproximado da última chamada autenticada com a chave.

Edite a descrição a qualquer momento. Por segurança, o token não volta a ser exibido depois da criação.

Remoção

Uma chave removida deixa de autenticar novas chamadas. Em situações críticas, considere rotacionar também as credenciais dos sistemas que usavam a chave.

Boas práticas

  • Uma chave por integração: facilita rastrear o uso (Último uso) e revogar acesso sem afetar outras integrações.
  • Descrições explícitas: indique o sistema ou ambiente que usa a chave (ex.: checkout-prod, etl-staging).
  • Rotação periódica: gere uma chave nova, atualize o sistema e remova a anterior depois de confirmar que não há mais chamadas com ela.
  • Nunca versione tokens: armazene em variáveis de ambiente, gerenciadores de segredo ou cofres dedicados.