Proceso de Autenticación

Referencia de API

Esta sección contiene toda la información que necesitas para obtener tus credenciales de API y te guía a través del proceso de autenticación para utilizar la API pública de Rappi.

Requisitos de Autenticación

Rappi utiliza OAuth 2.0 como método de autenticación para solicitudes de API seguras a la API pública de Rappi.

Durante el proceso de integración, Rappi te otorga tu propio conjunto de credenciales de API. Con estas credenciales, debes generar un token para autenticarte al realizar solicitudes de API.

Las credenciales de API que Rappi te proporciona constan de los siguientes objetos:

ArtículoDescripción
Client IDEste es el identificador del cliente donde se autentica.
Client SecretEste es el secret que necesita para autenticarse para su integración.

Important

Para compatibilidad hacia atrás, aún puedes enviar los campos audience y grant_type en el cuerpo de la solicitud al usar los nuevos endpoints. El sistema ignorará estos campos y no generará ningún error. Esto permite que los clientes migren a la última versión solo modificando la URL mientras mantienen el cuerpo de la solicitud sin cambios.

Generando un Token de Acceso

Referencia de API

Genera un token de acceso a través de una llamada a la API utilizando el POST login de integraciones endpoint o el POST login de utils endpoint, dependiendo de los servicios a los que necesites acceder.

Important

Tu token de acceso tiene una validez de 1 semana. Después de este tiempo, debes generar un nuevo token para continuar realizando solicitudes a los endpoints protegidos de API.

Para generar tu token:

Realiza una solicitud POST a una de las siguientes URLs y agrega un JSON al cuerpo de la solicitud con el siguiente objeto.

Para servicios de integraciones: https://{NEW_DOMAIN}/restaurants/auth/v1/token/login/integrations

Para servicios de utilidades: https://{NEW_DOMAIN}/restaurants/auth/v1/token/login/utils

El siguiente código muestra la estructura del objeto JSON en el cuerpo de la solicitud:

{ "client_id": "{{your_client_id}}", "client_secret": "{{your_client_secret}}" }

Note

Los valores de este JSON no son datos reales. Asegúrate de reemplazarlos con sus propios datos cuando realices solicitudes de API.

La siguiente tabla describe los valores de los atributos del cuerpo de la solicitud:

AtributosRequisitoDescripción
client_id
string
requeridoIdentificación de cliente de tus credenciales Rappi.
client_secret
string
requeridoCliente secreto de tus credenciales Rappi.

El sistema responde con tu access_token.

Ahora que tienes tu token, puedes comenzar a integrarte con la API pública de Rappi.

Usando tu Token de Acceso

Para autenticarte utilizando tu token de acceso al realizar solicitudes de API:

Incluye tu token de acceso en un encabezado personalizado de tu solicitud con los siguientes valores:

ClaveValor
x-authorizationBearer [{access_token}]

{access_token}: Este es el token de acceso que generaste.

Asegúrate de incluir estos valores en el encabezado de todas tus solicitudes de API para una autenticación exitosa.