Toda chamada à API pública precisa de uma chave. Ela pertence a uma loja e define o que pode ser feito, por isso nenhuma rota pede o ID da loja.

Gerar uma chave#

Abra Integrações#
No painel, abra Integrações e clique em Criar key.
Dê um nome#
Use um nome que identifique a integração, como ERP ou Bot de suporte.

Marque só o que a integração precisa.

Permissão	Dá acesso a
`PROMISSE_ADMIN`	Tudo abaixo
`PROMISSE_CATALOG`	Catálogo, categorias, produtos e variantes
`PROMISSE_INVENTORY`	Estoque e entrega
`PROMISSE_SALES`	Vendas, somente leitura
`PROMISSE_TAGS`	Tags
`PROMISSE_BOT`	Bots de suporte

Defina a validade (opcional)#
Sem validade, a chave vale até ser revogada. Com validade, escolha uma data futura de até 5 anos.
Copie a chave#
A chave começa com psk_ e aparece uma única vez. A plataforma guarda apenas um hash, sem como recuperar o valor. Na lista fica apenas o começo, para você reconhecer.

Usar a chave#

Envie a chave no cabeçalho x-api-key:

Terminal

curl "https://api.promisse.store/api/v1/tags" \
  -H "x-api-key: psk_sua_chave"

Uma pessoa só gera chave com o que ela mesma pode fazer no painel.

Permissão	Quem concede
`PROMISSE_ADMIN`	Só o dono da loja
`PROMISSE_CATALOG`	Quem cria, edita e apaga produtos
`PROMISSE_INVENTORY`	Quem edita produtos e entrega pedidos
`PROMISSE_SALES`	Quem vê vendas
`PROMISSE_TAGS`	Quem edita as configurações
`PROMISSE_BOT`	Quem responde chats

Clique para revogar a chave na lista de Integrações. O efeito é imediato. Se uma chave vazar, revogue e crie outra.

Mensagem	Motivo
Você não pode gerar uma chave com...	Falta a permissão correspondente na sua conta.
Escolha uma validade futura de até 5 anos	A data está no passado ou longe demais.
A loja pode ter até 25 chaves ativas	Revogue uma chave antiga.