⏱️ Tempo estimado: 5 minutos
Nível: ⭐⭐⭐☆☆ (Intermediário)
Antes de começar, você precisa:
Ter um plano pago ativo na Loja Integrada
Acesso ao painel administrativo da sua loja
Saber qual aplicativo ou sistema receberá a credencial
O que são as credenciais de API
Sua loja pode gerar dois tipos de credencial na área de API: a Chave API e o personal token. As duas servem para autenticar sistemas externos que acessam os dados da sua loja, mas funcionam de formas diferentes.
A Chave API é uma credencial de 20 caracteres que identifica sua loja em integrações com aplicativos externos. Ela é usada em conjunto com a chave de aplicação do integrador, ou seja, sozinha ela não autentica uma requisição. Você pode criar várias, uma para cada serviço, e cada uma fica visível no painel sempre que precisar consultar.
O personal token é uma credencial única, exibida uma só vez no momento da geração. Ele autentica por conta própria, sem precisar de Chave API, e é enviado no cabeçalho Authorization no formato Basic seguido do token gerado. Ele não fica disponível para consulta depois da geração. Sua loja mantém um personal token ativo por vez e ele expira a cada 3 meses, exigindo uma confirmação sua para continuar valendo.
💡 Dica: se você já solicitou uma credencial para integrar sua loja antes, provavelmente a conheceu pelo nome de chave de aplicação. Naquele momento, um mesmo tipo de credencial atendia lojistas e integradores. Hoje os dois casos têm nomes e formatos próprios: a credencial da sua loja é o personal token, gerado direto no painel, e a chave de aplicação passou a identificar apenas integradores e aplicativos de parceiros.
⚠️ Atenção: se a sua loja já usa uma chave de aplicação no modelo antigo, ela será descontinuada em 31/10/2026. Gere o personal token em Configurações > Chave para API > Personal token e substitua a credencial antiga na sua integração antes dessa data, ajustando também o formato de autenticação. Depois de 31/10/2026, requisições feitas com a chave antiga passam a ser recusadas e a integração para de funcionar.
❗ Importante: cada credencial identifica exclusivamente sua loja e deve ser tratada como informação confidencial.
Qual delas usar?
Isso depende de como o aplicativo ou sistema que você está integrando se autentica. Se ele espera um personal token, você gera a credencial no painel e informa a ele. Se ele é uma solução de parceiro que usa chave de aplicação própria, o que você entrega é a sua Chave API. Consulte a documentação da integração ou o suporte do serviço em caso de dúvida.
Como gerar sua Chave API
01 - Acesse Configurações > Chave para API no painel da sua loja.
02 - Clique no botão Cadastrar nova chave para iniciar o processo de geração.
03 - No campo Identificação da Chave, insira um nome descritivo que identifique onde a chave será usada (exemplo: "Integração X", "ERP Y", "App Personalizado" etc).
💡 Dica: Use nomes claros para facilitar o gerenciamento quando você tiver múltiplas chaves ativas.
04 - Clique em Cadastrar para confirmar a criação.
05 - Copie a chave gerada e cole no sistema ou aplicativo que solicitou a integração.
⚠️ Atenção: tenha o hábito de excluir chaves que não estão mais sendo utilizadas!
Como gerar seu personal token
⚠️Atenção: apenas o usuário proprietário da loja consegue gerar o personal token. Usuários com perfil de Administrador, Membro ou qualquer outro tipo não têm acesso a essa opção.
01 - Acesse Configurações > Chave para API no painel da sua loja.
02 - Clique no botão Personal token.
03 - Clique no botão Gerar personal token.
04 - Preencha o campo Identificação do token com um nome que ajude a identificá-lo e clique em Gerar.
O token aparece na tela junto com o aviso de que é de visualização única e com a orientação de enviá-lo no cabeçalho Authorization das suas requisições.
❗ Importante: O personal token é exibido uma única vez. Copie e guarde em local seguro antes de fechar a tela. Se você perder o token, o suporte não consegue recuperá-lo — a única saída é trocar por um novo.
Renovando o personal token
O personal token tem validade de 3 meses. Um mês antes do vencimento, o botão Renovar fica disponível em Configurações > Chave para API > Personal token, ao lado do botão Remover. Nesse mesmo período, um alerta aparece nas notificações do painel avisando que a credencial está perto de expirar.
Ao clicar em Renovar, o token continua o mesmo e ganha mais 3 meses de validade. Nada precisa ser alterado nas suas integrações.
⚠️ Atenção: o prazo não é cumulativo. A contagem dos 3 meses recomeça a partir do clique em Renovar, e não a partir da data original de vencimento. Renovar logo que o botão aparece significa abrir mão do tempo que ainda restava.
❗ Importante: se a renovação não for feita até o fim dos 3 meses, o token é revogado automaticamente. As integrações que dependiam dele param de funcionar e será preciso gerar um novo token, já que o anterior não pode ser recuperado.
Trocando ou removendo o personal token
Acesse novamente Configurações > Chave para API > Personal token e escolha uma das opções:
Trocar token: substitui o token atual por um novo
Remover: apaga o token gerado
Nos dois casos, o token anterior para de funcionar assim que a ação é confirmada. Qualquer integração que estivesse usando ele deixa de se autenticar até receber a nova credencial.
Provedores de soluções
Se você é uma empresa desenvolvedora que quer integrar sua ferramenta à Loja Integrada, o caminho é outro. A chave de aplicação para provedores é solicitada por formulário, e não gerada pelo painel de uma loja. O processo está descrito em Como obter a chave de aplicação para integrar com a Loja Integrada.
Gerenciando suas Chaves API
Você pode criar múltiplas chaves para diferentes serviços, facilitando o controle e a segurança das suas integrações. Cada chave pode ser removida individualmente a qualquer momento através do mesmo menu Configurações > Chave para API.
Quando criar múltiplas chaves:
Integração com diferentes ERPs simultaneamente
Aplicativos personalizados que acessam sua loja
Testes de desenvolvimento separados da produção
Necessidade de revogar acesso de um serviço específico sem afetar outros
Dúvidas Frequentes
Qual a diferença prática entre a Chave API e o personal token?
A Chave API fica disponível para consulta no painel, pode ser criada em várias unidades e não expira. O personal token é exibido uma única vez, existe um por loja, expira a cada 3 meses e precisa ser enviado no cabeçalho Authorization das requisições.
Não encontro a opção de gerar o personal token. O que pode ser?
A geração é restrita ao usuário proprietário da loja. Se você acessa o painel como Administrador ou Membro, a opção não aparece — nesse caso, peça para o proprietário gerar o token.
As credenciais expiram com o tempo?
As Chaves API não expiram: ficam ativas até que você as exclua manualmente. Já o personal token expira a cada 3 meses e só continua válido se você confirmar o uso quando o alerta aparecer nas notificações do painel.
Meu personal token foi revogado por expiração. Consigo reativar?
Não. Depois de revogado, o token não volta a funcionar. É preciso gerar um novo em Configurações > Chave para API > Personal token e atualizar a credencial nas suas integrações.
Perdi meu personal token. O suporte consegue recuperar?
Não. O token é de visualização única e não fica armazenado de forma consultável. A única opção é acessar Personal token e clicar em Trocar token para gerar um novo.
O que acontece com minhas integrações quando eu troco ou removo o personal token?
O token anterior deixa de funcionar imediatamente. As integrações que dependiam dele param de autenticar até que você configure a nova credencial.
Sou uma empresa que quer integrar minha ferramenta à Loja Integrada. Gero a chave por aqui?
Não. Provedores de soluções solicitam a chave de aplicação pelo formulário indicado no artigo Como obter a chave de aplicação para integrar com a Loja Integrada.
Posso usar a mesma chave em vários aplicativos?
Sim, mas não é recomendado. Criar chaves específicas para cada serviço facilita o gerenciamento e aumenta a segurança, permitindo revogar acesso de forma seletiva.
O que acontece se eu excluir uma chave que está sendo usada?
A integração que utilizava essa chave parará de funcionar imediatamente. Você precisará gerar uma nova chave e reconfigurá-la no aplicativo afetado.
Existe limite de chaves que posso criar?
Não há limite definido para Chaves API. Já o personal token é um por loja: gerar outro significa trocar o atual.
Posso gerar uma chave no plano gratuito?
Não. O recurso está disponível apenas para planos pagos. Confira nossos planos e preços para fazer upgrade.
Resumo dos passos principais
Para gerar uma Chave API:
Acesse Configurações > Chave para API
Clique em Cadastrar nova chave
Defina um nome no campo Identificação da Chave
Clique em Salvar
Copie a chave gerada para usar em suas integrações
Para gerar o personal token (somente o proprietário da loja):
Acesse Configurações > Chave para API
Clique em Personal token
Clique em Gerar personal token
Preencha a Identificação do token e clique em Gerar
Copie o token na hora e guarde em local seguro — ele não será exibido de novo
Acompanhe as notificações do painel e confirme o uso antes de cada expiração de 3 meses
Lembre-se: crie chaves específicas para cada serviço e trate todas as credenciais como informação confidencial.
Pronto! Suas credenciais estão geradas e você pode conectar sua loja aos aplicativos e sistemas que precisa.
#chave-api #personal-token #chave-de-aplicacao #integracao #configuracoes #erp #api #plano-pago #provedores