Guía para configuración de Webhook Response/URL Callback

Guía para configuración de Webhook Response/URL Callback

Para el consumo nuestros productos que funcionan de forma asíncrona Círculo de Crédito dispone de la API llamada Suscripciones, con la cual te notificamos el estado del proceso del producto (los estados varían entre productos: número de pasos, fuentes, etc.). Básicamente, para que podamos notificarte es necesario cubrir los siguientes pasos y características:

API de suscripción
Guia de suscripciones

1. Tener la API asociada a tu Aplicación

API asociada

Ambiente sandbox


Ir a la pestaña “Mis Aplicaciones” > seleccionar la aplicación de trabajo, caso contrario crear una aplicación con el botón “registrar aplicación” > seleccionar pestaña “Editar” y marcar la API “Suscriptions Sandbox”

Ambiente productivo


Solicitar el acceso de la API productiva. Envíanos un correo a api@circulodecredito.com.mx con el título “Solicitud de acceso a producción” y tu teléfono. Un representante de API Hub se pondrá en contacto contigo.

API asociada
Webhook

2. Contar con Webhook

Webhook

Contar con la URL del punto de retrollamada HTTP o mejor conocido como Webhook.

¿Para que sirve un webhook?

Esta herramienta te permite recibir notificaciones en tiempo real mediante solicitudes HTTP POST, dicha herramienta se expone en una URL especifica (también llamada extremo de webhook) la cual debes de configurar. Dicha notificación te servirá para desencadenar otras acciones. Para nuestro caso te permitirá saber si hubo una falla en el proceso del consumo o si bien, explotar los datos del producto final mediante una URL que nosotros te proporcionamos en la notificación.


  • Para sandbox existen sitios con webhooks que te permite recibir dichas notificaciones: webhook.site, pipedream.com, etc.
  • Para productivo el acceso al webhook deberá ser con credenciales (usuario y contraseña) bajo el mecanismo de Basic Authentication, el formato a seguir es el siguiente: {“username”: “usuario”, “password”: “contraseña”}.

3. Obtener el evento al cual te suscribes

Obtener evento

Es decir, el producto (API) que deseas consumir:

  • Employment Verification API: mx.com.circulodecredito.eva
  • API Bank Data Aggregation: mx.com.circulodecredito.ada
  • API SAT Personas Morales: mx.com.circulodecredito.sat
Obtener evento
Id suscripción

4. Obten tu id suscripción

Id suscripción

Con los datos anteriores deberás de complementar el request body de la petición de una nueva suscripción, donde:

  • webHookUrl será el dato del paso 2
  • eventType será el dato del paso 3
  • enrollmentId es un identificador de la suscripción con formato UUID v4

Por ejemplo:

{ webHookUrl": "https://miwebhook.com/v1/eva",
"eventType": "mx.com.circulodecredito.eva",
"enrollmentId": "470987ab-b4cb-4a1e-9eaf-8856a813da59"
}

Notas importantes para ambiente productivo:

Se agrega el header x-webhook-jwt-auth al grupo de headers tradicionales (x-signature, x-api-key, username y password), en el cual es un Json Web Token que contiene el nombre de usuario y la contraseña de acceso para invocar su API Webhook publicada con Basic Authentication. El formato de las credenciales es {“username”: “usuario”, “password”: “contraseña”}.