Introdução
As APIs do iFood permitem que parceiros utilizem diversos recursos da plataforma como gerenciar suas lojas e seus pedidos. O iFood oferece soluções para a operação e gestão das suas vendas como Gestor de Pedidos e Portal do Parceiro, mas a API permite integrar seu PDV/POS ou qualquer outro aplicativo à plataforma iFood.
Módulos da API
Authentication
Como autenticar para ter acesso aos outros módulos da API
Merchant
Detalhes e configurações das lojas
Order
Receba, confirme e acompanhe seus pedidos
Shipping
Sob Demanda: solicite entregadores parceiros do iFood para pedidos captados fora da plataforma
Catalog
Configure o catálogo de produtos das suas lojas
Financial
Relatórios Financeiros e Conciliação
Review
Busque e responda a avaliações de pedidos
Picking
Separação e ruptura de pedidos
Promotion
Crie promoções para a sua loja
Item
Envie e atualize itens de seus canais de Groceries
Primeiros Passos
Utilizando as APIs
Tipo de Pedidos
Termos de Uso
Para utilizar a API e disponibilizar aplicativos, é necessário que o desenvolvedor leia e aceite os Termos de Uso do Usuário da API. E para utilizar os aplicativos, é necessário que o responsável pela loja aceite os Termos de Uso do Usuário de Aplicativos de Terceiros antes de conceder acesso aos seus dados através do aplicativo.
Bloqueio de Aplicações
Ao integrar seu aplicativo com as APIs do Ifood é sua responsabilidade garantir o uso correto de nossa plataforma, seguindo as recomendações de boas práticas que resultam em uma melhor experiência com as APIs, garantindo uma integração bem-sucedida com o iFood e evitando sanções em suas contas.
Na identificação de uso indevido das APIs do iFood através dos nossos mecanismos de monitoramento, a Integradora será formalmente notificada via e-mail pelo nosso time de Atendimento, onde será informado o tipo de infração cometida juntamente com as evidências, o prazo para correção e os níveis de bloqueio a serem aplicados caso a infração não seja corrigida dentro do prazo informado.
Orientações Importantes! Mantenha os dados cadastrais da sua conta devidamente atualizados (ex: email, telefone), garantindo que as comunicações sobre as infrações identificadas sejam recebidas e tratadas, evitando surpresas pela Integração na aplicação das sanções.
Tipos de bloqueios
| Nível de Bloqueio | Tipo |
|---|---|
| Bloqueio Nível I | Bloqueio do aplicativo para inclusão de novos merchants |
| Bloqueio Nível II | Bloqueio do aplicativo para consumo das APIS do iFood |
Bloqueio Nível I
Neste nível de bloqueio a integração ficará impedida de solicitar para o seu aplicativo novas autorizações de merchants. Merchants que já fazem uso do PDV, ficarão impossibilitados de autorizar seu aplicativo, caso a sessão expire.
Prazo de correção 30 dias corridos contados a partir da data de envio do comunicado
Bloqueio Nível II Neste nível de bloqueio o aplicativo será bloqueado para consumo das APIs do iFood, ou seja, nenhum merchant integrado ao seu PDV conseguirá utilizar a integração com o iFood.
Prazo de correção 20 dias corridos contados a partir da data de aplicação do Bloqueio Nível I
Nota: O iFood se reserva ao direito de definir/atualizar o prazo de resolução das infrações cometidas pelo integrador. Esse prazo será estipulado e comunicado formalmente ao integrador.
Comunicado ao Merchants: Para o bloqueio nível II, todos os merchants vinculados ao seu aplicativo serão notificados 10 dias antes da aplicação do bloqueio, onde informaremos o motivo do bloqueio e os possíveis impactos na operação.
Tipos de Infrações
- Não enviar ack para os eventos de polling
- Enviar requisições com formato inválido (Erro 400)
- Consultar detalhes de pedidos inexistentes (Erro 404)
- Consultar Merchants não autorizados (Erro 403)
- Fazer polling com intervalo menor que 30 segundos
- Consultar mais de 10 vezes o mesmo pedido
- Exceder o máximo de requisições que um único aplicativo pode fazer em um determinado período de tempo (Rate Limit)
- Expor indevidamente credenciais na url
Os endpoints listados abaixo terão um monitoramento mais rigoroso, levando a aplicação de sanções na identificação de uso abusivo, refletindo inclusive nos requisitos de elegibilidade do Programa de Super Integradoras.
| Endpoint | Limites |
|---|---|
| /orders/{id} | Taxa máxima de erro <= 2% |
| /orders/{id}/confirm | Taxa máxima de erro <= 2% |
| /orders/{id}/requestCancellation | Taxa máxima de erro <= 2% |
| /events:polling | Taxa máxima de erro <= 1% |
| /merchants/{merchantId}/status | Taxa máxima de erro <= 1% |
| /merchants/{merchantId} | Taxa máxima de erro <= 2% |
| /merchants | Taxa máxima de erro <= 2% |
| /merchants/{merchantId}/interruptions | Taxa máxima de erro <= 2% |
| /events/acknowledgment | Taxa mínima de ack >= 95% |
Atenção! Para o cálculo da taxa de erro utilizaremos os seguintes critérios:
- Período avaliado será referente as últimas 24 horas
- Cálculo da taxa de erro por endpoint: Quantidade de requests com erro/Quantidade de requests total do aplicativo
- Para o endpoint de /events/acknowledgment a regra aplicada será: Quantidade de ack enviado / Quantidade de Polling
As integrações que excederem esse limite estarão sujeitas a aplicação dos bloqueios
Tipos de Infrações As infrações aqui descritas estão sujeitas a alteração ou inclusão de novos tipos a qualquer momento e sem comunicação prévia.
Como solicitar o desbloqueio do meu aplicativo?
Para desbloqueio do seu aplicativo será necessário acionar nosso time de Atendimento através do próprio comunicado enviado, informando que as infrações foram solucionadas e a data da correção.
Ao receber a solicitação de desbloqueio, nossa equipe avaliará se as infrações foram efetivamente corrigidas. Caso haja a confirmação, uma comunicação formal será enviada e seu aplicativo será desbloqueado. Em caso negativo, as sanções de mantém, assim como o prazo inicial para correção.