Skip to main content
Esta página reúne os fundamentos técnicos da API aberta. Use-a como referência ao implementar qualquer integração com a Cardápio Web. A API aberta é RESTful e composta por três módulos, além de webhooks para notificações em tempo real. Cada módulo expõe endpoints para recursos específicos do estabelecimento.

​
Módulos

Loja

Dados do estabelecimento, horários, pagamentos e configurações.

Catálogo

Categorias, produtos, complementos e gestão do cardápio.

Pedidos

Consulta, criação, atualização de status e histórico de pedidos.
Para entender como integrar cada módulo na prática, consulte Fluxos de integração.

​
Autenticação

A API suporta dois modelos de autenticação: Apps da CW App Store enviam o token no header Authorization: Bearer <access_token>. Integrações legadas usam X-API-KEY e, em alguns endpoints, também X-PARTNER-KEY.
Novas integrações devem usar OAuth. Integrações legadas podem continuar com API Key, mas recomendamos migrar. Para entender as diferenças, consulte Modelos de autenticação.

​
Ambientes

A Cardápio Web disponibiliza dois ambientes independentes e isolados. Para o desenvolvimento da sua integração, use o Sandbox. Cada ambiente possui cadastro, credenciais, instalações e tokens próprios. Apps cadastrados no Sandbox não são publicados automaticamente em Produção.

​
Estabelecimento de teste (Sandbox)

O estabelecimento usado para testes no Sandbox varia conforme o modelo de autenticação:
Para apps da CW App Store, cada integradora recebe um estabelecimento de teste próprio no Sandbox. Esse estabelecimento é criado pelo time de suporte de integrações da Cardápio Web.Solicite a criação junto com o cadastro do app, enviando os dados para integracao@cardapioweb.com. Você receberá as credenciais de acesso ao portal Sandbox para instalar o app, executar o fluxo OAuth e validar as chamadas à API.
Apps da CW App Store devem ser cadastrados separadamente em Sandbox e Produção.

​
Observações gerais

  • Por questões de segurança, todas as requisições devem usar o protocolo HTTPS.
  • Requisições e respostas usam JSON com o header Content-Type: application/json.
  • As datas seguem o padrão ISO 8601.

​
Códigos HTTP das respostas

A API utiliza respostas HTTP convencionais para indicar o sucesso ou a falha das requisições.
Se você encontrar um erro 5XX (500, 502, 503, 504, etc.), tente novamente em breve. Se o problema persistir, entre em contato com nossa equipe de suporte em integracao@cardapioweb.com.

​
Rate limits

Os limites se aplicam por estabelecimento. Quando o limite for excedido, a API retorna HTTP 429 Too Many Requests. Quando mais de um limite se aplica à mesma requisição, o mais restritivo prevalece.
Sempre que o recurso que você integra oferecer webhook, prefira receber notificações em vez de consultar a API em intervalos regulares. Você reduz requisições, evita rate limits e recebe alterações com menor latência. Consulte Webhooks para ver os eventos disponíveis no seu contexto.

​
Próximos passos

Primeiros passos

Cadastre no Sandbox, implemente OAuth e faça sua primeira chamada.

Fluxos de integração

Guia prático dos módulos Loja, Catálogo e Pedidos.

Modelos de autenticação

Entenda quando usar OAuth ou API Key (legado).

Referência da API

Endpoints, schemas e playground interativo.
Última modificação em 30 de junho de 2026