Versões
Visão Geral das Nossas APIs
Bem-vindo ao Portal do Desenvolvedor do Aiqfome. Aqui, você encontrará a documentação completa para as nossas duas APIs principais: a API Aiqfome V0 (Alfredo) e a API Aiqfome V1. É fundamental entender qual API usar para garantir uma integração correta e eficiente.
Para Parceiros Atualmente Integrados com a API Aiqfome V0 (Alfredo)
Se a sua empresa já utiliza a API Aiqfome V0 (Alfredo) para gerenciar suas lojas, você deve continuar usando esta API para todas as suas operações, tanto para lojas do tipo catálogo (mercados, pets, farmácias) quanto para lojas do tipo cardápio (restaurantes).
Caso tenha dúvidas ou precise de suporte técnico sobre sua integração, entre em contato pelo e-mail integracao@aiqfome.zendesk.com
Para Novos Parceiros e Novas Integrações
Se você está iniciando uma nova integração com a nossa plataforma, a escolha da API dependerá do modelo de loja que você deseja criar:
- Lojas do tipo Cardápio (restaurantes): Se você deseja integrar lojas que utilizam o modelo de cardápio, realize a integração com a API Aiqfome V1. Esta é a nossa API mais atualizada e recomendada para novas integrações que operam neste modelo.
- Lojas do tipo Catálogo (mercados, pets, farmácias): Se a sua integração é voltada para lojas que utilizam o modelo de catálogo, realize a integração na API Aiqfome V0 (Alfredo). Atualmente, a API Aiqfome V1 não oferece suporte para esse formato de loja.
Diferente da V1, seu acesso não é gerenciado diretamente neste portal. É necessário preencher o formulário no site e a nossa equipe interna entrará em contato para dar prosseguimento ao credenciamento e implantação.
Documentação API Aiqfome V0 (Alfredo)
Diferenças das versões
| Recurso | V0 (Alfredo) | V1 |
|---|---|---|
| Pedidos | ✅ OK | ✅ OK |
| Pedidos no modelo Open Delivery | ❌ Não possui | 📦 Backlog |
| Catálogos | ✅ OK | 📦 Backlog |
| Cardápios | ✅ OK | ✅ OK |
| Aiqentrega | ✅ OK | 📦 Backlog |
| Dados de lojas | ✅ OK | ✅ OK |
| Webhooks | ✅ OK (legado) | 🛠️ Em desenvolvimento (prev. 29/nov) |
| Financeiro | ❌ Não possui | 📦 Backlog |
| Onboarding de parceiro | Manual | Self-onboarding do integrador |
| URL base | https://purple-box.aiqfome | https://plataforma.aiqfome |
- ❌ Não possui: Recurso não existe e não será desenvolvido
- 📦 Backlog: Recurso não existe, mas será desenvolvido.
- 🛠️ Em desenvolvimento: Estamos trabalhando no desenvolvimento do recurso
- ✅ OK: Recurso já está disponível