1. Autenticarse
Para garantizar la seguridad en cada interacción con la API Plataforma, utilizamos el estándar OAuth 2.0 para la autenticación de las peticiones. A continuación, se describen los pasos clave para autenticar correctamente.
Paso 1: Obtener el Token de Acceso
Cada cliente debe solicitar un token de acceso utilizando sus credenciales client_id y client_secret mediante Basic Authentication.
La solicitud se realiza a través del siguiente endpoint:
Tipo de petición: POST
Endpoint: baseUrl/oauth2/token
El cuerpo de la solicitud debe ser de tipo application/x-www-form-urlencoded e incluir únicamente los siguientes parámetros:
Ejemplo de cuerpo de la solicitud:
grant_type: client_credentials
scope: test/full_access
Importante: client_id y client_secret no se envían en el cuerpo; se envían mediante Basic Authentication en el encabezado Authorization.
Uso de Basic Authentication
Para enviar la solicitud de autenticación, los valores de client_id y client_secret deben ser concatenados en el formato:
client_id:client_secret
Este valor debe ser codificado en Base64 y enviado en el encabezado Authorization:
Authorization: Basic {Base64(client_id:client_secret)}
Uso del parámetro scope
En ambientes de prueba, el valor de scope debe ser test/full_access.
Paso 2: Autenticar las Peticiones
Una vez obtenido el token, este debe ser incluido en el encabezado de cada petición autenticada. El encabezado debe tener el siguiente formato:
Authorization: Bearer {access_token}
Esto asegura que todas las peticiones estén validadas y autentificadas por el servidor.
Paso 3: Renovación del Token
Los tokens de acceso tienen un período de validez limitado. Cuando expire, deberás realizar una nueva solicitud para obtener un token actualizado.
Recuerda mantener tus credenciales seguras y renovar el token antes de que expire para evitar interrupciones en el servicio.
Ejemplo con cURL
curl --location 'baseUrl/oauth2/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Basic Base64(client_id:client_secret)' \
--data-urlencode 'scope=test/full_access' \
--data-urlencode 'grant_type=client_credentials'
Enlaces Útiles
El JWT devuelto tiene una duración de 1 hora, o sea 3600 segundos.
