Como criar uma chave de API

A API permite que outro sistema, como um ERP, um hub de marketplaces ou uma planilha automatizada, leia e altere produtos, estoque e pedidos da sua loja. Cada sistema usa uma chave própria com só as permissões de que precisa. A tela é do administrador e a chave deve ser tratada como uma senha.

Passo a passo

1. 1

   Abra API e webhooks

   Clique em Configurações > API e webhooks. A aba Chaves de API abre primeiro e mostra quantas chaves estão ativas (até 20).

2. 2

   Clique em Nova chave

   Clique em Nova chave.

3. 3

   Dê um nome

   Em Nome da chave, escreva para que ela serve, como ERP ou Hub de marketplaces.

4. 4

   Marque as permissões

   Em Permissões, marque só o que a integração precisa. Vêm marcadas a leitura de produtos e de pedidos. As permissões com a etiqueta sensível alteram dados ou dão acesso a dados pessoais.

5. 5

   Crie

   Clique em Criar chave.

6. 6

   Copie a chave agora

   A chave aparece uma única vez numa caixa amarela. Clique em Copiar, guarde num lugar seguro e clique em Já guardei, fechar. Depois disso, o painel mostra só o começo e o fim dela.

7. 7

   Configure o outro sistema

   Cole a chave no sistema que vai se conectar. A aba Documentação mostra como enviar a chave em cada chamada e quais endereços usar.

As permissões

• Produtos: ler, ou criar e alterar (preço e status).
• Estoque: ler, ou ajustar (somar, subtrair ou definir).
• Pedidos: ler, ou alterar status e informar rastreio.
• Clientes: ler sem dados pessoais (números agregados).
• Dados pessoais de clientes (PII): nome, e-mail, telefone, CPF e endereço. Marque só se o sistema de destino realmente precisar.

Revogar uma chave

Na lista, clique em Revogar ao lado da chave e confirme. A integração que usa a chave para de funcionar na hora e não dá para desfazer. A lista mostra quando cada chave foi criada, o último uso e de qual IP, para você identificar chaves esquecidas.

A aba Documentação traz o guia rápido (autenticação, endpoints, paginação, erros e limites de requisições) e o link Especificação OpenAPI (JSON) para o time técnico.