logo
logo
Docs Primeiros Passos

Utilizando as APIs

Todos os endpoints disponibilizados na API exigem autenticação. Portanto, o primeiro passo antes de qualquer requisição é obter um token de acesso através do endpoint de autenticação.
Com o token de acesso em mãos, você pode configurar os dados da sua loja, como como horário de funcionamento e indisponibilidades, através dos endpoints do módulo de merchant. Além disso, consegue configurar os itens/pratos através do módulo de catálogo.Você também pode fazer essas configurações através do Portal do Parceiro.
Para abrir uma loja na plataforma, é necessário que:
  • Ela esteja dentro do horário de funcionamento,
  • Não tenha nenhuma indisponibilidade cadastrada,
  • Tenha um catálogo configurado, e
  • Uma área de entrega configurada.
Além disso, é necessário que sua loja esteja conectada à plataforma. Por isso, ela deve estar se comunicando regularmente para receber novos pedidos.Portanto, para manter uma loja aberta na plataforma é necessário que as requests de polling estejam sendo executadas regularmente a cada 30 segundos. Você encontra detalhes sobre como fazer polling aqui. Em caso de interrupções e oscilações nessa comunicação, a loja é fechada temporariamente.
Saiba se a sua loja está online Você pode consultar o status da loja em tempo real utilizando o endpoint de disponibilidade.
Agora que seu aplicativo está fazendo polling regularmente e sua loja está aberta, sempre que um novo pedido for feito você receberá um novo evento via polling ou webhook (PLACED).Ao receber um novo pedido no polling você deve consultar os detalhes do mesmo e, em seguida, confirmá-lo ou cancelá-lo.Depois de preparado, você deve avisar que ele está pronto (para os pedidos Pra Retirar) ou despachá-lo (para pedidos que devem ser entregues - delivery).Pronto! Seu aplicativo já está pronto para receber pedidos. Na seção de cada módulo você conhecerá todos os recursos de cada um deles.
Como gerar pedidos para fazer testes na API
Know more