logo
logo
Guias

Criar uma conta

Ao criar uma conta no iFood, você recebe automaticamente acesso a uma loja e aplicativo de teste. Use esses dados para acessar as APIs.Cadastre-se aqui.
O email usado para cadastro não pode estar associado a uma conta existente no Portal do Parceiro.

Boas práticas de cadastro

Preencha os campos seguindo estas recomendações:Nome da integradora
  • Escolha um nome único e memorável
  • Evite nomes genéricos ou longos
Descrição
  • Explique o propósito da sua empresa
  • Inclua valores e missão
  • Ajude usuários a conhecer sua integradora
Logo
  • Use imagem clara e de alta qualidade
  • Evite texto na imagem
  • Garanta boa legibilidade em tamanhos menores
Para testar as APIs e gerar pedidos de teste, consulte:

Criar um aplicativo

O portal cria automaticamente um aplicativo de teste quando você se cadastra. Use este aplicativo para testar a API. Para ver as credenciais do aplicativo de teste, faça login e clique em Meus apps.
Crie um aplicativo para produção somente após homologar o aplicativo de teste.
Após finalizar o desenvolvimento e os testes, crie um aplicativo para produção.
  1. Clique no menu Apps > Novo Aplicativo.
  2. Escolha o tipo de aplicativo conforme seu modelo de distribuição:
• Centralizado (SaaS) - Software disponível na nuvem com acesso a todas as lojas em uma instância centralizada• Distribuído (On-premises) - Software instalado no ambiente da loja com acesso restrito a essa loja
  1. Preencha os dados obrigatórios: nome, descrição e URL.
  2. Selecione os módulos da API que sua aplicação acessará.
  3. Defina se o aplicativo será listado para todos os parceiros ou exclusivo para clientes específicos.
O sistema gera automaticamente as credenciais de acesso após o registro. Homologue o aplicativo antes de disponibilizá-lo para seus clientes.

Boas práticas de cadastro de aplicativo

Forneça informações claras e precisas para ajudar usuários a escolher seu aplicativo.
  • Nome do aplicativo: Escolha um nome único, memorável e que reflita a funcionalidade. Evite nomes genéricos ou longos.
  • URL do aplicativo: Forneça a URL do site oficial. Mantenha o site atualizado com informações relevantes.
  • Descrição: Escreva um slogan que descreva seu aplicativo. Seja cativante e transmita rapidamente sua função.
  • Descrição completa: Explique como o aplicativo funciona, que problemas resolve e por que usuários devem escolhê-lo.
  • Categoria: Selecione a categoria que melhor descreve seu aplicativo para facilitar a descoberta no marketplace.
  • Visibilidade: Defina se o aplicativo será público (visível no marketplace) ou privado.
  • Logo: Faça upload de uma imagem clara, atraente e de alta qualidade. Evite texto na imagem.
  • Galeria de imagens: Inclua capturas de tela das principais funcionalidades. Use imagens claras, de alta qualidade e que representem precisamente a experiência do usuário. Evite imagens genéricas.

Comece a desenvolver

Defina o tipo de negócio do seu aplicativo após o cadastro.O tipo de negócio afeta:
  • Tipo de cadastro no Portal do Desenvolvedor
  • Geração de pedidos de teste
  • Processo de homologação
  • Disponibilidade dos módulos das APIs
Tipos disponíveis:
  • Food: Para integrações focadas em entregas de comida.
  • Grocery: Para integrações focadas em encomendas de mercado, farmácia e petshop.
Selecione o link abaixo de acordo com o tipo de negócio:

Food

Utilizando as APIS - Food
Saiba mais

Grocery

Utilizando as APIS - Groceries
Saiba mais

Homologar aplicativo

Homologue seu aplicativo antes de liberá-lo para clientes. Isso garante que a integração funciona corretamente.Complete o desenvolvimento antes de solicitar homologação. Testamos o aplicativo completo, não apenas as chamadas de API.Use conta Profissional (CNPJ) para homologação. Não aceitamos contas Pessoal/Estudante (CPF).

Categorias e módulos

O processo varia conforme os módulos do aplicativo. Alguns módulos são específicos para determinados tipos de aplicativo.
CategoriaMódulos
PDVMerchant, Events, Order, Catalog, Review, Shipping
GroceriesMerchant, Events, Order, Catalog, Item, Picking, Promotion, Shipping, Financial
CatálogoMerchant, Catalog
LogísticaMerchant, Events, Logistics
AvaliaçõesMerchant, Review
FinançasMerchant, Events, Financial
O uso do módulo de Order das nossas APIs é exclusivo para soluções desenvolvidas para a operação das lojas em tempo real (PDVs). Outras soluções como aplicativos de Business Intelligence (BI) não serão homologadas. Estamos avaliando o desenvolvimento de um módulo exclusivo para esses fins mas ainda não temos uma data prevista para o lançamento.

Solicitar acessos

Após a homologação, solicite acesso aos dados das lojas que usarão seu aplicativo em produção. O processo varia conforme o tipo de aplicativo.

Aplicativo centralizado

  1. Acesse Meus Apps no Portal do Desenvolvedor e selecione seu aplicativo
  2. Na aba Permissões, localize a loja pelo ID ou CNPJ
  3. Confirme os dados da loja e envie a solicitação
  4. O responsável pela loja recebe a solicitação. Após aprovação no Portal do Parceiro, você acessa os dados da loja conforme os módulos cadastrados. Gere um novo accessToken.

Aplicativo distribuído

  1. Crie um botão/link no seu aplicativo para o usuário conceder o acesso.
  2. Quando o usuário clicar nesse botão, você deve gerar um código (userCode) através do endpoint authentication/v1.0/oauth/userCode
  3. Forneça a verificationUrlComplete e o userCode para o usuário.
  4. O usuário clica na URL, que abre o Portal do Parceiro
  5. O usuário (responsável pela loja) visualizará um modal "Autorizar Aplicativo" e depois de clicar em "Autorizar" receberá um código de autorização authorizationCode.
  6. O usuário deve copiar o código de autorização authorizationCode e configurá-lo no PDV.
  7. Com o código de autorização (authorizationCode) você consegue autenticar através do endpoint de authentication/v1.0/oauth/token.
Exemplo:
curl -X POST 'https://merchant-api.ifood.com.br/authentication/v1.0/oauth/token' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d '{
      "grantType": "authorization_code",
      "clientId": "d28ed85f-9b43-4555-a7c1-9b0df25e9999",
      "clientSecret":"s18lm6m5uwatgihxdl6h9pr0j11ugh9sjjs9a127gohyyqsitzulx12p5b5kty1l59orgbaryy7r1545ty6se9ljnlvea609999",
      "authorizationCode": "LHQX-ZZZZ",
      "authorizationCodeVerifier": "f3u8geu9uq31k7l8co7kct2ow3ctxu1ujoaoewgotj7gc60ji1r3zmzhy13tmcp577gyck4lka3c5852k2jg1h1gkpr8nca9999"
    }

Ativar aplicativo via código

Caso o seu aplicativo esteja instalado em um dispositivo sem acesso ao navegador, exiba o userCode e oriente o usuário a acessar o Portal do Parceiro e no menu Aplicativos, clicar em Ativar aplicativo via código. Após digitar o userCode o usuário recebe o authorizationCode.