Escolha sua trilha
- Novo app (CW App Store)
- Integração legada (API Key)
Para integrações que serão publicadas no marketplace e instaladas pelos estabelecimentos:
1
Entenda o ecossistema
Leia a visão geral da CW App Store para conhecer os papéis de integradora, app, estabelecimento e instalação.
2
Cadastre o app
Prepare os dados e envie o cadastro conforme Cadastro e publicação. Comece pelo Sandbox para validar tudo antes de Produção.
3
Entenda a instalação
Leia Instalação e autorização para entender o fluxo do estabelecimento (Instalar, onboarding, consentimento) e o que a integradora precisa implementar em cada etapa.
4
Implemente OAuth
Implemente PKCE, redirect ao portal e troca de token conforme OAuth.
5
Consuma a API
Com um token válido, siga os Fluxos de integração e consulte a Referência da API.
A integração em resumo
A integradora cadastra o app, a Cardápio Web aprova, o estabelecimento instala e autoriza os escopos, e o app passa a consumir a API com tokens OAuth. Cada token representa uma instalação específica: um app autorizado por um estabelecimento.Como navegar a documentação
A documentação está organizada em duas abas:
Dentro da aba Documentação, as seções mais usadas no início são:
CW App Store
Marketplace, cadastro, publicação e instalação de apps.
Sobre a API
Ambientes, formatos, códigos HTTP e rate limits.
OAuth
Autorização, tokens, escopos, renovação e erros comuns.
Fluxos de integração
Módulos Loja, Catálogo e Pedidos: polling, webhooks e status.
Desenvolva com IA
Menu de ações, servidor MCP e exemplos de prompts para integração.
Módulos da API
Depois da autenticação, use os módulos conforme a necessidade da integração:
Para entender quando usar cada módulo e como combiná-los, consulte Fluxos de integração. Para receber eventos em tempo real (como novos pedidos), configure Webhooks.
Ambientes
Sandbox e Produção são independentes: apps, credenciais, instalações e tokens não são compartilhados. Use o Sandbox para validar o fluxo completo antes de solicitar publicação em Produção.
Detalhes em Sobre a API.
Precisa de ajuda?
Para cadastro de apps, aprovação, autenticação ou dúvidas técnicas, entre em contato pelo e-mailintegracao@cardapioweb.com.