Passar para o conteúdo principal

Como gerar a Chave API da minha loja?

Gere credenciais seguras para integrar sua loja com aplicativos e sistemas externos [Disponível em planos pagos]

Atualizado há mais de 2 semanas

⏱️ Tempo estimado: 5 minutos
Nível: ⭐⭐☆☆☆ (Básico)

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 chave

O que é a Chave API?

A Chave API é uma credencial única de 20 caracteres que identifica sua loja em integrações com aplicativos externos. Ela funciona como uma senha especial que permite que sistemas parceiros acessem e sincronizem dados da sua loja de forma segura.

Por que você precisa dela?

Imagine que você usa um ERP para gerenciar seus produtos e pedidos. O ERP precisa saber exatamente quais dados pertencem à sua loja entre todas as outras lojas que também usam o serviço. A Chave API é essa "impressão digital" que garante que suas informações sejam acessadas corretamente.

🔑 Importante: Cada chave identifica exclusivamente sua loja e deve ser tratada como informação confidencial.


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 Salvar para confirmar a criação.

05 - Copie a chave gerada e cole no sistema ou aplicativo que solicitou a integração.

⚠️ Atenção: Guarde a chave em local seguro. Se perdê-la, será necessário gerar uma nova e reconfigurar as integrações.


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

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. Você pode criar quantas chaves precisar para suas integrações.

A chave expira com o tempo?
Não, as chaves permanecem ativas até que você as exclua manualmente. Recomendamos revisar periodicamente as chaves ativas e remover as que não estão mais em uso.

Posso gerar uma chave no plano gratuito?
Não. O recurso de Chave API está disponível apenas para planos pagos. Confira nossos planos e preços para fazer upgrade.


Resumo

Para gerar sua Chave API:

  1. Acesse Configurações > Chave para API

  2. Clique em Cadastrar nova chave

  3. Defina um nome identificador no campo Identificação da Chave

  4. Clique em Salvar

  5. Copie a chave gerada para usar em suas integrações

🔑 Lembre-se: crie chaves específicas para cada serviço e mantenha-as seguras.

Pronto! Sua Chave API está gerada e você pode começar a integrar sua loja com os aplicativos e sistemas que precisa. 🎉

#chave-api #integração #configurações #aplicativos #erp #api #plano-pago

Respondeu à sua pergunta?