Proceso de Autenticación#
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ículo | Descripción |
---|---|
Client ID | Este es el identificador del cliente donde se autentica. |
Client Secret | Este es el secret que necesita para autenticarse para su integración. |
Audience | Este es el identificador de la API de Rappi. |
Grant Type | Este es el permiso a la solicitud. |
Important
Dependiendo de la API que utilices, la audiencia cambiará y deberás generar un token para utilizarla
Generando un Token de Acceso#
Genera un token de acceso a través de una llamada a la API utilizando el POST token
endpoint.
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 URL y agrega un JSON
al cuerpo de la solicitud con el siguiente objeto.
- URL de desarrollo:
https://rests-integrations-dev.auth0.com/oauth/token
- URL de producción:
https://rests-integrations.auth0.com/oauth/token
El siguiente código muestra la estructura del objeto JSON
en el cuerpo de la solicitud:
{
"client_id":"7iCfjZCO4bTns3OjqLK4de2GV3sp6Ymd",
"client_secret":"40iFFYJV9A1LrVmJsaIeARW40iFFYJV9A1LrVmJsaIeARW40iFFYJV9A1LrVmJsaIeARW",
"audience":"https://int-public-api-v2/api",
"grant_type":"client_credentials"
}
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:
Atributos | Requisito | Descripción |
---|---|---|
client_id string |
requerido |
Identificación de cliente de tus credenciales Rappi. |
client_secret string |
requerido |
Cliente secreto de tus credenciales Rappi. |
audience string |
requerido |
Identificador de la API de Rappi. |
grant_type string |
requerido |
Este es el permiso a la solicitud. |
El sistema responde con tu access_token
.
Ahora que tienes tu token, puedes comenzar a integrarte con la API pública de Rappi.
Audiencias#
Audiencia API | Valor |
---|---|
Public Api V2 | {Dominio del pais}/api/v2/restaurants-integrations-public-api |
Utils | https://rest-ops-utils/api |
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:
Clave | Valor |
---|---|
x-authorization |
bearer [{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.