Saltar al contenido principal

Gestión de API Key

Generar API Key​

El API Key es la forma de autenticarte a nuestra API.
Para obtenerla, sigue los siguientes pasos:

  1. Accede a tu perfil: ubica la sección de perfil en la parte superior derecha (versión web) o superior izquierda (versión móvil)de la pantalla.
  2. API Key dinámico o fijo: selecciona el tipo de API Key de tu preferencia, detalles dirígete a el apartado de API Key. API Key.
  3. Genera tu API Key: busca la opción "Generar API Key" y haz clic en ella.
  4. Guarda tu API Key: el API Key generado es único para tu cuenta. Guárdalo en un lugar seguro y confidencial, ya que te será necesario para realizar todas las solicitudes a nuestra API. Si pierdes tu API Key, podrás generar uno nuevo, pero recuerda actualizarlo en todas las integraciones donde lo estés utilizando.

Nuestra API utiliza JWT (Json Web Token) como método de autenticación para las peticiones.
Aquí te mostraremos como obtener tu token de autenticación:

Recuerda tener a la mano tu nombre de usuario SyPago y tu API Key.

Si el tipo de API Key no es fijo entonces se debe hacer un request http con método POST a el siguiente endpoint /api/v1/auth/token para obtener el token de acceso.
El cuerpo del request debe ser el siguiente:

Endpoint Autenticación
POST api/v1/auth/token
Request Json
    {
        "client_id": "nombre_de_usuario",
        "secret": "API_Key"
    }
Body de exitoso
{
  "access_token": "string",
  "expires_in": 0,
  "refresh_expires_in": 0,
  "refresh_token": "string",
  "token_type": "string",
  "not_before_policy": 0,
  "session_state": "string",
  "scope": "string"
}

API Key

Nuestro API Key es una herramienta esencial para automatizar, de manera eficiente y segura, la integración con los distintos modos de cobros, pagos y reportes en línea de SyPago. La generación del API Key de SyPago ofrece 2 modalidades de uso:

  1. JWT dinámico: el usuario utiliza su client_id y secret (API Key generado en su perfil) para obtener un token (JWT) con duración de 1 hora, por defecto,a través de un EndPoint del API. Este token le permite acceder a los servicios de cobro, pago y reporte disponibles en el API de SyPago. Para autenticarte y generar un token de acceso, debes utilizar el endpoint "api/v1/sypago/token" y colocar allí tu API key.

  2. JWT fijo: bajo esta modalidad, SyPago le genera al cliente un JWT sin expiración que servirá como un API key fijo, en lugar de un API Key para obtener un token. Este “API Key” (token sin expiración) debe ser enviado en el Bearer del request.

Pasos del proceso de autenticación​

Todo request o petición a los APIs (Endpoints) debe llevar una autorización en el encabezado (Header). La autorización es tipo Bearer con un token JWT.

Cuando un cliente se registra puede generar un token JWT fijo con una duración por un año, lo puede definir por el tiempo que desee, cuando el cliente desea revocar debe generar uno nuevo.

El cliente también puede generar una API KEY que consiste en un client_id y un secret. Con estas credenciales el cliente debe solicitar el token JWT de autorización al endpoint correspondiente para solicitar un token /api/v1/auth/token.

Idealmente el cliente debe validar el vencimiento del token para solicitarlo sólo cuando sea necesario y así evitar realizar requests innecesarios de solicitud de token.

API Keys permisadas:​

La plataforma de SyPago ofrece la capacidad de generar API Keys con permisos específicos. Para ello, se deben seguir los siguientes pasos:

1. El usuario maestro debe generar su propio API Key.

2. El usuario maestro o con privilegios debe crear un subusuario y asignarle un rol con los permisos deseados.

3. El subusuario podrá entonces acceder al portal y generar su propio API Key, a través de su perfil.

4. Finalmente este API Key le permitirá utilizar los EndPoints del API para los que tenga permiso.

Si el tipo de API Key es fijo entonces ya usted posee el token de acceso, simplemente lo añade en el encabezado del request que realice a nuestra API.

info

Posibles errores y lista de mensajes.

Prueba tu API Key dinámico aquí y obtén tu token​

Coloca tu nombre de usuario y API Key de SyPago y recibe tu AccessToken. Recuerda que esta prueba apunta a nuestro ambiente de certificación por lo tanto no habrá ningún movimiento de fondos real

Mensaje de Autenticación
{  
    "client_id": "nombre_de_usuario_sypago",
    "secret": "api_key" 
}