O que é um app
Um app é um registro na CW App Store que representa uma integração com a plataforma. Ele concentra tudo o que a Cardápio Web precisa saber sobre a sua solução: identidade, permissões de acesso, URLs do fluxo de autorização e, opcionalmente, um endpoint de webhook para receber eventos em tempo real. Uma integradora pode ter vários apps cadastrados, cada um com funcionalidade, permissões e público distintos. Por exemplo: um app de gestão de cardápio, outro de relatórios de vendas e outro de automação de marketing, todos da mesma empresa, cada um com seu próprio ciclo de publicação e instalação. Do ponto de vista técnico, o app é o elo entre três peças:
As três peças são dependentes entre si. A CW App Store é o que dá ao app visibilidade e distribuição. O OAuth é o que transforma uma instalação em acesso autorizado. E a API aberta é onde a integração de fato acontece.
Se você nunca trabalhou com OAuth antes: pense no app como um sistema de login social. Assim como um site pode pedir que você “Entre com Google”, o app pede que o restaurante “Autorize com a Cardápio Web”. O Proprietário vê as permissões solicitadas e confirma no portal; a integração só fica ativa após a troca de token no servidor do parceiro.
Apps são o novo padrão para integrações
Toda nova integração com a Cardápio Web precisa de um app registrado na CW App Store. O modelo anterior, baseado em API Key, segue suportado apenas para integrações já existentes e não está disponível para novas aplicações. Isso vale para qualquer porte de integração. O app não precisa ser público: a visibilidade pode ser privada, e o acesso se dá via link direto, sem aparecer no catálogo público. Um app privado tem o mesmo suporte técnico e o mesmo fluxo que um app público; a diferença está apenas em quem pode encontrá-lo no catálogo.Integrações existentes que usam API Key continuam funcionando para as instalações atuais e não precisam mudar nada para continuar operando. Mas se você quer que a sua integração apareça na CW App Store e possa ser instalada pelos estabelecimentos pelo marketplace, é preciso cadastrar um app e migrar o fluxo de autenticação para OAuth. Sem um app registrado, a integração não pode participar do marketplace, independentemente de como ela foi construída.
Os dois fluxos da CW App Store
Toda integração passa por dois momentos distintos. Entender cada um deixa claro o que é responsabilidade da integradora e o que acontece do lado do estabelecimento.Cadastro e publicação
O primeiro fluxo é da integradora para a plataforma. Você envia os dados do app ao suporte (nome, ícone, descrição, URLs técnicas e permissões). A Cardápio Web revisa e, quando aprovado, o app fica disponível para instalação no marketplace.Cadastro e publicação
Campos obrigatórios, URLs, visibilidade, processo de aprovação e manutenção do app.
Instalação e autorização
O segundo fluxo é do estabelecimento para o app. Somente usuários com perfil Proprietário podem instalar apps e conceder permissões no portal. Quando o Proprietário clica em Instalar, ele passa pelo fluxo de onboarding da integradora, concede as permissões via OAuth e conclui a instalação. O app recebe um token vinculado àquela instalação e passa a consumir a API aberta.Instalação e autorização
Etapas da instalação, responsabilidades da integradora e gestão pós-instalação.
Próximos passos
Primeiros passos
Guia rápido para navegar a documentação e começar sua integração.
OAuth
Autorização, tokens, renovação e erros comuns.
Webhooks
Eventos em tempo real para apps do marketplace.
Sobre a API
Ambientes, formatos, códigos HTTP e rate limits.