Chaves de API
Como criar, editar e revogar chaves de API, e como funciona a validade e a regra de uma chave ativa por empresa.
Atualizado em 27/10/2026
A chave de API (a tela chama de API Key) é a senha que o sistema da sua empresa, o ERP, usa para enviar fornecedores e produtos para a plataforma. Quem cria e controla as chaves é o administrador da conta.
Para que serve
Permitir que o ERP converse com a plataforma sem usar o login de uma pessoa. Veja Integração com o ERP.
Quem tem acesso
A aba API Keys aparece para o Proprietário e o Gerente.
Uma chave pertence a uma empresa
Cada chave é criada para uma empresa, e o que o ERP enviar com ela entra nessa empresa. Cada empresa pode ter uma chave ativa por vez: se todas as empresas já têm uma, a tela avisa e pede para revogar uma chave existente antes de criar outra.
Criar uma chave
- Em Configurações, abra API Keys e clique em Gerar Nova API Key.
- Em Empresa, escolha a empresa da chave.
- Em Nome da API Key, dê um nome que ajude a reconhecê-la (por exemplo, "API Integração ERP"). Use letras, números e caracteres simples: parênteses, por exemplo, não são aceitos.
- Se quiser, escreva uma Descrição (opcional) com o propósito da chave.
- Em Período de Validade, escolha Nunca expira, 30 dias, 90 dias, 1 ano ou Personalizado (com a Data de Expiração).
- Clique em Gerar API Key.
Guarde a chave: ela aparece uma única vez
Depois de gerar, a tela API Key Gerada mostra a chave inteira e avisa: "Esta chave só será exibida uma vez. Guarde-a em um local seguro." Use Copiar ou Download na hora. Se você perder, não dá para ver de novo: gere outra (e revogue a antiga).
A mesma tela lembra que a chave vai no cabeçalho X-API-Key de cada requisição.
A lista de chaves
Em API Keys, a lista mostra Nome, API Key, Empresa, Expira em e Ações. Busque por nome ou empresa, filtre por Status (Ativas, Revogadas, Expiradas) e ordene por Data, Nome ou Empresa.
Editar
Em Editar, mude o Nome da API Key, a Descrição e o Período de Validade. A chave em si (o valor) não muda.
Revogar
Revogar desliga a chave para sempre. Em Revogar API Key (na lista, ou dentro da edição), a plataforma avisa: a ação é permanente e as requisições que usarem a chave serão rejeitadas na hora. Para confirmar, a plataforma pede que você digite o nome da chave no campo de confirmação, e só então libera o botão Revogar API Key.
Perguntas frequentes
A chave expirou. E agora?
Uma chave Expirada deixa de funcionar. Gere outra em Gerar Nova API Key (se a empresa já tiver uma chave ativa, revogue-a antes) e atualize o ERP.
Posso ter duas chaves para a mesma empresa?
Não ao mesmo tempo: é uma chave ativa por empresa.
Perdi a chave.
A chave só é exibida uma vez. Revogue a que se perdeu e gere uma nova.