API e webhooks: conectar ERPs e outros sistemas

Crie chaves de acesso com permissões para ERPs e automações, cadastre webhooks e acompanhe as chamadas. Documentação em docs.hoteldaslojas.com.br.

6 min de leitura Atualizado em 31/10/2026

Neste artigo

Criar uma chave de acesso
Cadastrar um webhook
Acompanhar e revogar
Perguntas frequentes
Veja também

A API permite que outros sistemas, como um ERP, um sistema de estoque, uma planilha automatizada ou uma ferramenta de automação, leiam e alterem dados da loja. Os webhooks fazem o caminho contrário: avisam o seu sistema na hora em que algo acontece, como um pedido novo. Normalmente quem usa esta tela é o programador ou a empresa do seu ERP. A documentação técnica fica em docs.hoteldaslojas.com.br.

Antes de começar

Só o dono da loja vê esta tela. Colaboradores da equipe não têm acesso.
Tenha em mãos o endereço (https) que vai receber os webhooks, se for usar.

Criar uma chave de acesso

Abra a tela. Vá em Configurações › API e webhooks. O botão Documentação da API abre a documentação para o programador.
Dê um nome. No quadro Nova chave, preencha o Nome (ex.: ERP, Bling, Planilha de estoque).
Marque as permissões. Marque só o que o sistema vai usar. Ex.: um ERP que lê pedidos e atualiza estoque precisa de pedidos.ler, pedidos.escrever e estoque.escrever.
Crie e copie. Clique em Criar chave. A chave aparece uma única vez: clique em Copiar e entregue ao responsável pelo sistema. Guarde num lugar seguro.

Cadastrar um webhook

Informe o endereço. No quadro Webhooks, preencha Endereço que recebe os avisos (https).
Marque os eventos. Escolha os avisos, como pedido.criado, pedido.pago, produto.esgotado ou carrinho.abandonado.
Adicione e copie o segredo. Clique em Adicionar webhook. O segredo de assinatura aparece uma única vez; ele serve para o seu sistema confirmar que o aviso veio da sua loja.

Acompanhar e revogar

A tabela Chaves de acesso mostra as permissões, quando foi criada, o último uso e a situação. Para cortar o acesso de um sistema, clique no ícone de revogar: a chave para de funcionar na hora e depois pode ser apagada da lista. O quadro Últimas chamadas lista as 30 chamadas mais recentes, com a resposta e o tempo.

Nunca envie a chave por mensagem aberta nem a publique. Quem tem a chave acessa os dados da loja com as permissões marcadas. Se ela vazar, revogue e crie outra.

Perguntas frequentes

Perdi a chave. Consigo ver de novo?

Não, por segurança ela só aparece ao ser criada. Revogue a antiga e crie uma nova.

Um webhook ficou "Pausado".

Ele parou depois de várias falhas seguidas do seu servidor. Corrija o endereço ou o servidor e clique em reativar.

Quantas chaves posso ter?

Até 20 chaves ativas e até 10 webhooks por loja.

Veja também

Este artigo ajudou?