View Categories

Autenticación

1 min read

Para consumir los servicios del Botón de Pagos, el Ecommerce debe autenticarse utilizando las credenciales proporcionadas por CrediSmart.

Como resultado de la autenticación se obtiene un accessToken, que deberá enviarse como Bearer Token en las siguientes peticiones.

Request #

Método: POST
Endpoint: /v1/auth/authenticate

Headers #

Content-Type: application/json
Accept: application/json

Body

CampoTipoObligatorioDescripción
clientIdstring
Identificador único del cliente para el protocolo OAuth (Passport). Se utiliza para identificar la aplicación que realiza la solicitud
clientSecretstringSecreto privado del cliente; se utiliza para autenticar la identidad de la aplicación. Longitud máxima de 255 caracteres.


Body ejemplo

{
  "clientId": "{{clientId}}",
  "clientSecret": "{{clientSecret}}"
}


Respuesta

CampoTipoDescripción
successbooleanIndica si la operación fue exitosa. Valor fijo: true.
accessTokenstringToken JWT utilizado para la cabecera Authorization: Bearer en las peticiones siguientes.
expiresInnumberTiempo de vida del token expresado en segundos (número entero mayor o igual a 0).
tokenTypestringTipo de token generado. Valor fijo: Bearer.
transactionIdstringIdentificador único de transacción para fines de auditoría y trazabilidad.

Respuesta ejemplo

{
  "success": true,
  "accessToken": "<token de acceso>",
  "expiresIn": 0,
  "tokenType": "Bearer",
  "transactionId": "fb3582881776953238"
}

Respuesta ejemplo

{
  "success": true,
  "accessToken": "<token de acceso>",
  "expiresIn": 0,
  "tokenType": "Bearer",
  "transactionId": "fb3582881776953238"
}

Nota: accessToken se utilizará para las peticiones futuras.

Ejemplo de petición

curl --location '<URL POR DEFINIR>/v1/auth/authenticate' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
  "clientId": "{{clientId}}",
  "clientSecret": "{{clientSecret}}"
}'