Docs Primeros Pasos

Aplicaciones y Credenciales

Crear cuenta de desarrollador

El primer paso para comenzar a utilizar las APIs de iFood es registrarse a través del botón "Registrar" en la parte superior de la página. Al registrarte recibirás un mensaje en tu bandeja de entrada para confirmar tu correo electrónico. Si no encuentras este mensaje, verifica tu carpeta de spam. Si ya tienes una cuenta, inicia sesión con el usuario y contraseña a través del botón "Entrar". Y si ya has iniciado sesión en el portal, pasa a la siguiente sección.

**Buenas Prácticas de Registro de Integradora** El registro implica el llenado de varios campos, cada uno con su propio propósito e importancia. Por eso, sigue nuestras recomendaciones y proporciona la información más relevante y útil en la presentación de tu integradora. - **Nombre de la Integradora**: Elige un nombre que sea único, fácil de recordar. Evita nombres genéricos o muy largos. - **Descripción**: Proporciona una descripción explicando un poco sobre la empresa y su historia, valores, misión y visión para que los usuarios puedan conocer mejor tu integradora. - **Logo**: La imagen debe ser clara, atractiva y de alta calidad. Evita usar texto en la imagen, ya que puede ser difícil de leer en tamaños menores.

Al registrarte, se creará automáticamente una tienda de prueba y una aplicación de prueba. Con los datos de tu aplicación y tienda de prueba ya podrás comenzar a utilizar las APIs.

**El correo electrónico utilizado para el registro no puede estar asociado a una cuenta existente en el portal del socio.**

Puedes comenzar a hacer las pruebas siguiendo las instrucciones de la sección Utilizando las APIs. Después mira cómo generar pedidos de prueba en iFood.

Homologar aplicativo

Antes de disponibilizar tu aplicación a tus clientes, es necesario validarla para asegurarnos de que la integración funciona correctamente. Encuenta aquí cómo homologar la aplicación..

Quedan suspendidas provisionalmente las aprobaciones de solicitudes destinadas a operaciones logísticas subcontratadas hasta la disponibilidad de un nuevo módulo exclusivo, prevista para marzo de 2024.

Registro de la aplicación

Creación automática de aplicaciones de prueba Cuando te registras en el portal, automáticamente se genera una aplicación de prueba para que puedas probar la API. Solo necesitarás registrar una nueva aplicación para usar la API en producción, después de homologar la aplicación de prueba. Para ver las credenciales de tu aplicación de prueba, inicia sesión y luego haga clic en "Mis aplicaciones".

Después de terminar el desarrollo y realizar todas las pruebas necesarias, puedes crear tu primera aplicación para usar la API en producción.Una vez que hayas iniciado sesión, haz clic en el menú Aplicaciones y luego en "Nueva aplicación".Elije el tipo de aplicación según tu modelo de distribución de software:

Centralizado (SaaS) - cuando tu software está disponible en la nube y tiene acceso a todas las tiendas en esa única instancia centralizada;
Distribuido (On-premises) - cuando tu software está disponible en la tienda y solo esa instancia tiene permiso para acceder a esa tienda;

Después de elegir el tipo de aplicación, completa los datos necesarios como nombre, descripción y url. Elije a qué módulos API debe tener acceso tu aplicación y si se puede enumerar para todos los colaboradores que usan iFood o si es exclusivo para algún cliente.Al registrar tu aplicación, las credenciales de acceso se generarán automáticamente, pero antes de disponibilizar de sus clientes, debe ser homologada.

Solicitar Accesos

Una vez homologado, puedes solicitar permiso para tener acceso a los datos de las tiendas que utilizarán tu aplicación en producción. La solicitud de acceso depende del tipo de aplicación creada.

Aplicación centralizada

Accede al menú Mis aplicaciones en el Portal do Desenvolvedor y seleccione la aplicación
En la pestaña Permisos, ubica la tienda por id o CNPJ
Confirma los detalles de la tienda y envía la solicitud.
El responsable de la tienda recibirá la solicitud y, en cuanto sea aprobada a través del Portal do Parceiro, tendrás acceso a los datos de esa tienda (según los módulos informados en el registro de la aplicación) pero es necesario generar un nuevo token de acceso.

Aplicación Distribuida

Debes proporcionar un botón/link en tu aplicación para que el usuario conceda acceso.
Cuando el usuario haga clic en este botón, se debe generar un código (userCode) a través del endpoint authentication/v1.0/oauth/userCode
Disponibiliza al usuario la URL (verificationUrlComplete) y el código (userCode) obtenidos en la solicitud anterior.
El usuario debe hacer clic en esta URL (verificationUrlComplete) que debes abrir el Portal do Parceiro que requiere autenticación.
El usuario (responsable de la tienda) recibirá un modal "Autorizar aplicación" y luego de hacer clic en "Autorizar" recibirá un código de autorización (authorizationCode).
El usuario deberá copiar el código de autorización (authorizationCode) y configurarlo en el PDV.
Con el código de autorización (authorizationCode) puede autenticarse a través del endpoint authentication/v1.0/oauth/token.

Ejemplo:

curl -X POST '[https://merchant-api.ifood.com.br/authentication/v1.0/oauth/token](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"
    }

Activar aplicación a través de códigoSi tu aplicación está instalada en un dispositivo sin acceso al navegador, muestra el userCode y guía al usuario para acceder al Portal do Parceiro y en el menú Aplicaciones haga clic en "Activar aplicación mediante código". Después de escribir el userCode, recibirá el authorizationCode.

Uso de las APIs

Autenticar

Todos los endpoint proporcionados en la API requieren autenticación. Por lo tanto, el primer paso antes de cualquier solicitud es obtener un token de acceso a través del endpoint de autenticação.

Configurar tienda

Con el token de acceso, puede configurar los datos de tu tienda, como el horario de apertura y restricciones, a través de los endpoints del módulo de merchant. Además, puede configurar los artículos/platos a través del módulo de catálogo.También puedes configurar estos ajustes a través del Portal do Parceiro.

Abrir Tienda

Para abrir una tienda en la plataforma, es necesario que:

Esta se encuentre dentro del horario de funcionamiento,
No tener ninguna restricción registrada,
Tener un catálogo configurado, y
Un área de entrega configurada.

Además, la tienda debe estar conectada a la plataforma. Por lo tanto, debe estar conectado a la red permanentemente para recibir nuevos pedidos.Por lo tanto, para mantener una tienda abierta en la plataforma, las solicitudes de polling deben ejecutarse regularmente cada 30 segundos. Puedes encontrar detalles sobre cómo hacer polling aqui. En caso de interrupciones y fluctuaciones en conectividad, la tienda será cerrada temporalmente.

Descubre si tu tienda está online Puedes verificar el estado de la tienda en tiempo real utilizando el endpoint de disponibilidad.

Recibir pedidos

Ahora que tu aplicación realiza polling regularmente y tu tienda está abierta, cada vez que se realice un nuevo pedido, recibirás un nuevo evento en el polling (PLACED).Cuando recibas un nuevo pedido en el polling, debes consultar os detalhes do mesmo y luego confirmarlo o cancelarlo.Una vez preparado,debes avisarnos que está listo (para pedidos de Para Recoger) o despacharlo(para pedidos que deben entregarse - delivery).¡Listo! Tu aplicación ahora está lista para recibir pedidos. En el apartado de cada módulo conocerás todas las características de cada uno de ellos.