Saltar al contenido principal

Flujo

Los endpoints de alta y baja de usuarios siguen un flujo asíncrono explicado a continuación:

Onboarding Flow

  1. El partner realiza una petición http(request) según las instrucciones técnicas definidas en la documentación de la API.
  2. La API valida credenciales y payload de la solicitud y:
    1. En caso de no encontrar errores, se crea una transacción asíncrona para crear y/o actualizar la cuenta de usuario en cuestión. Mientras esta se procesa, se comunica al partner la correcta recepción de la solicitud y el UUID de la transacción.
    2. En caso de encontrar errores se detiene el flujo y dichos errores son comunicados al partner en la respuesta del request con código de error y mensaje(s) específico(s).
  3. Dependiendo de la configuración de Webhooks, despues de procesar la transacción ocurre uno de 2 escenarios:
    1. Partner cuenta con webhooks de confirmación: Hanu envía una petición (post) al endpoint configurado con el payload del request procesado. Ej.:
      {
      "event":"activate",
      "sub":"8048399623",
      "firstName":"John",
      "lastName":"Wick",
      "maternalLastname":"",
      "email":"jwick@gmail.com",
      "localIdentifier": {
      "idValue": "4567613",
      "countryCode": "CO"
      },
      "plan": {
      "id": "0",
      "startDate": "2023-07-24"
      },
      "locale":"en",
      "trx":"dd38a436-t34b-4h96-2072-2a826d40kc13"
      }
    2. Partner no cuenta con webhook(s) de confirmación: Para conocer el resultado de la transacción es necesario consultar el endpoint dispuesto para tal fin en la documentación de la API.
info

Si el partner opta por implementar webhooks de confirmación, estos deben ser previamente informados a Hanu para ser registrados en nuestra plataforma antes de comenzar con la integración. Esto incluye URL’s y métodos de autenticación (Api Key[s], HMAC, Flujo Oauth, etc.). La implementación de webhooks siempre deben ser con verbo http de tipo POST.