Skip to main content

17. Liga de Pago - Webhook

17 Introducción​

El servicio de notificaciones de liga de pago también está disponible a través de nuestra API REST, permitiendo la integración directa con sus sistemas. Para utilizarla, solo necesita las credenciales de autenticación proporcionadas por Zigu y poder realizar peticiones HTTP desde su aplicación.

17.2 Autenticación​

Obtener token de autenticación​

Vamos a necesitar el correo electrónico y contraseña de la cuenta de Zigu.

Para obtener el token de autenticación, se debe hacer una petición HTTP POST a la siguiente URL:

https://webserver.zigu.mx/api/v2/auth

Con los siguientes encabezados:

Content-Type: application/json

Con los siguientes parámetros:

  • correo: El correo electrónico de la cuenta de Zigu.
  • contrasena: La contraseña de la cuenta de Zigu.

Y el resultado será muy similar al siguiente:

{
    "payload": {
        "token": "eyJhbGciOiJ...5fJ-ab3e7ytpV8OIAFVNdTC"
    }
}

17.3 Suscribirse a notificaciones​

Para suscribirse a notificaciones a través de la API, necesitamos hacer una petición HTTP PUT a la siguiente URL:

https://webserver.zigu.mx/api/v2/business/webhook

El token de autenticación debe incluirse en el encabezado HTTP de la petición de la siguiente manera:

Authorization: BMToken <token>
Content-Type: application/json

Con los siguientes parámetros:

  • url: URL a la que se enviarán las notificaciones.

Y el resultado será muy similar al siguiente:

{
    "business": {
        "id": "xn8mq92krvhp4163lsyztdw5j",
        "webHookURL": "https://localhost:3000"
    }
}

17.4 Notificaciones​

Las notificaciones se enviarán a la URL que se haya configurado en el paso anterior.

Las notificaciones se enviarán en formato JSON y con el siguiente encabezado:

Content-Type: application/json

Las notificaciones se enviarán con el siguiente formato en el metodo POST:

{
    "paymentLinkId": "xn8mq92krvhp4163lsyztdw5j",
    "customerName": "juan",
    "customerLastName": "perez",
    "customerEmail": "juan.perez@gmail.com",
    "amount": 10,
    "status": "APPROVED"
}