Conectar seu próprio sistema ou site com a API do Delimenu
Crie uma chave de API para gerenciar seu cardápio a partir do seu software, ou mostre-o em um site feito sob medida.
Além do painel e dos agentes de IA, o Delimenu tem uma API para quem programa: ela serve para gerenciar seu cardápio a partir do seu próprio sistema (um caixa, um controle de estoque, um script) e para mostrar seu cardápio em um site ou app feito por você, com o seu design.
Este artigo explica como obter acesso. A documentação técnica completa, com todos os endpoints e exemplos, está em delimenu.co/developers.
Importante: tudo o que você fizer pela API altera seu cardápio de verdade, como se você o fizesse pelo painel. Não há rascunho nem botão de publicar.
Duas formas de usá-la
Mostrar seu cardápio no seu próprio site. O cardápio público de qualquer restaurante pode ser lido sem chave: a mesma informação que um cliente vê em delimenu.co/seu-identificador, em formato JSON, pronta para você exibir como quiser. Você continua cadastrando e editando o cardápio no Delimenu; seu site apenas o mostra.
Gerenciar o cardápio a partir do seu sistema. Com uma chave de API você pode criar, editar e excluir categorias e produtos, mudar preços e disponibilidade, enviar fotos e editar os dados do restaurante. É o mesmo que um agente de IA pode fazer, mas a partir do seu programa.
Criar uma chave de API
- Abra seu restaurante e vá para "Configurações".
- Procure a seção "API para desenvolvedores" e clique em "Criar chave".
- Dê a ela um nome que ajude você a reconhecê-la (por exemplo, "sistema de caixa") e escolha as permissões: ver o cardápio, ou ver e editar.
- Copie a chave quando ela aparecer. Ela só é exibida dessa vez: se você a perder, revogue-a e crie outra.
A chave é da sua conta, não de um restaurante: vale para todos os restaurantes que você tiver. Você pode ter até 10 chaves ativas por conta. A URL base da API é https://delimenu.co/api/v1.
Revogar uma chave
- Vá para "Configurações" › "API para desenvolvedores".
- Em "Chaves ativas", clique em "Revogar" ao lado da chave.
A partir desse momento ela deixa de funcionar, já na requisição seguinte. Revogue qualquer chave que tenha sido compartilhada por engano ou que você não use mais.
Receber avisos quando o cardápio muda (webhooks)
Se o seu sistema precisa ficar sabendo das alterações —por exemplo, para manter seu caixa ou sua loja online em dia—, ele não precisa consultar a API a todo momento: registre um webhook e o Delimenu avisará seu sistema sempre que um produto ou uma categoria for criado, editado ou excluído, ou quando os dados do restaurante mudarem.
- Abra seu restaurante e vá para "Configurações".
- Procure a seção "Webhooks" e clique em "Criar webhook".
- Digite a URL do seu sistema (ela tem que começar com
https://) e escolha os eventos que você quer receber. - Copie o segredo quando ele aparecer. Ele só é exibido dessa vez: com ele, seu sistema confere que cada aviso vem mesmo do Delimenu. Se você o perder, clique em "Novo segredo".
- Clique em "Enviar teste" para conferir se o seu sistema recebe os avisos.
Os webhooks são de cada restaurante, não da conta: você pode ter até 5 por restaurante. Se o seu sistema não responder, tentamos de novo até 8 vezes durante cerca de um dia. Se 20 avisos seguidos falharem, o webhook se desativa sozinho; verifique seu sistema e clique em "Ativar". Em "Histórico" você vê os últimos envios e como o seu sistema respondeu.
Perguntas frequentes
Preciso de um plano ativo? Para gerenciar um restaurante pela API, sim: só funciona com assinatura ou teste grátis ativo, assim como o painel. Para mostrar o cardápio no seu site, o restaurante também precisa ter um plano ativo; se não tiver, a API responde que o cardápio não está disponível, assim como a página pública.
Posso passar a chave para o meu desenvolvedor? Sim, é para isso que ela serve. Crie uma chave só para essa pessoa ou sistema, com as permissões estritamente necessárias, e revogue-a quando o trabalho terminar. Nunca compartilhe uma chave com permissão de edição se só for preciso ler o cardápio.
A chave dá acesso ao meu faturamento ou à minha conta? Não. Ela só pode ver e editar os cardápios. Não pode gerenciar a assinatura, excluir o restaurante nem entrar no painel.
Em que formato vão os preços?
Como no cardápio: 12500 são $ 12.500 pesos, 5.99 são US$ 5,99. Nunca em centavos.
As alterações aparecem na hora? Sim. Tanto no cardápio público quanto na leitura pela API, em segundos.