Webhooks

Introducción

Webhooks es un sistema de notificación push impulsado por eventos; cuando ocurre un evento (por ejemplo, una refacturación), entregamos una publicación de datos a un script que usted diseñó en base a nuestra Documentación de webhook.

Webhooks es una alternativa a nuestra función Publicación en segundo plano en URL y una función complementaria para nuestro sistema ENS. El sistema Webhooks es mucho más robusto y proporciona notificaciones en tiempo real, además de cubrir una mayor variedad de tipos de eventos.

¿Qué es un Webhook?

En terminología general, Webhooks es un concepto de API para enviar notificaciones push en tiempo real a puntos finales de Webhook.

  1. tú Punto final de webhook es su URL previamente definida. Todas las notificaciones de eventos se enviarán a su URL.
  2. An Evento es un hecho relacionado con su cuenta, por ejemplo, un usuario que reactiva su suscripción o una venta exitosa. Siempre que se produzca un evento de pago, recibirá una notificación automática.
  3. An POST HTTP es el proceso de enviar datos a un recurso específico. Los datos enviados no se almacenan en el historial del navegador ni en los registros del servidor web; necesitará un script que lea los datos y los almacene en su base de datos. Cuando se trata de enviar datos, esta es una ambiente seguro y seguro método de transferencia de datos.

En pocas palabras, cuando sucede algo (un evento) con su cuenta, los Webhooks de CCBill enviarán una notificación a su URL (Punto final de webhook), lo que le proporciona información valiosa sobre su negocio en línea.

¿Por qué querría utilizar webhooks?

Para los comerciantes, Webhooks es una forma de recibir información valiosa tan pronto como ocurre, en lugar de verificar los datos de su cuenta continuamente y no obtener datos valiosos la mayor parte del tiempo. En muchos sentidos, Webhooks es como recibir notificaciones automáticas en su teléfono inteligente, es decir, Facebook le envía una notificación cada vez que recibe una solicitud de amistad. De manera similar, CCBill Webhooks le enviará una notificación si, por ejemplo, se realizó con éxito una nueva venta. Puede escribir estos datos en una base de datos para mantener registros o pasarlos a otro script.

Los webhooks son especialmente útiles para:

  • Calcula tus impuestos puede resultar molesto, pero con CCBill Webhooks puede realizar un seguimiento de sus pagos más fácilmente al iniciar sesión en una entrada de contabilidad cada vez que se le notifique sobre una venta exitosa.
  • Si no utiliza el sistema de gestión de CCBill, Webhooks le ayudará enormemente a actualizar las membresías de los clientes.
  • Manejo de contracargos y reembolsos. Se le notificará sobre devoluciones de cargo y reembolsos de inmediato, lo que le dará un tiempo precioso para actuar en consecuencia.

Cómo funcionan los webhooks

Un Webhook es una operación HTTP POST que se produce cuando sucede algo (por ejemplo, una venta). Es como un punto final de API invertido; en lugar de realizar una llamada a la API, puede hacer que se envíe información a su URL de devolución de llamada. Registra una URL que le notificaremos cada vez que ocurra un evento en la cuenta.

El siguiente diagrama ejemplifica cómo funcionan los Webhooks de CCBill:

Cómo funcionan los Webhooks.

¿Qué es exactamente un evento?

Como se señaló, un Evento es una acción relacionada con su cuenta. Cada notificación de inserción se envía como un paquete de datos XML y su URL debe ser un script, como CGI, PHP, ASP, etc., programado para recibir y analizar la información publicada por CCBill.

A continuación, encontrará un ejemplo de publicación de Webhooks.

POST /webhooks.php?clientAccnum=999999&clientSubacc=9999&eventType=Expiration&eventGroupType=Subscription HTTP/1.1
X-Allowed-Satellites: PHX,ASH,AMS
Content-Type: application/x-www-form-urlencoded
Content-Length: 102
Host: merchanturl.com
User-Agent: Java/1.6.0_03
Via: 1.1 wmq1.ccbill.com:3129 (squid/2.7.STABLE5), 1.0 internal
Cache-Control: max-age=0
Connection: keep-alive
clientAccnum=999999&clientSubacc=9999&subscriptionId=0913024401000012340&timestamp=2013-01-25 03:22:44

Habilitación y configuración de webhooks

Para configurar Webhooks:

  1. Desde el Administrador de subcuenta, haga clic en el Webhooks enlace en el lado izquierdo de la pantalla.
  2. Ingrese la URL a la que desea que se dirijan las publicaciones en el URL del webhook campo.
  3. Seleccione los tipos de publicaciones a las que desea suscribirse (haga clic en Todos para seleccionar todos los tipos, o seleccionar y elegir cualquier combinación de tipos de publicaciones seleccionando la casilla de verificación junto a ella).
  4. Seleccione el botón Ubicaciones satélite desde el que los Webhooks deberían enviarte mensajes. Intente elegir una ubicación que esté geográficamente cerca del servidor que la URL que seleccionó en el paso 2 para asegurarse de que las publicaciones lleguen a su URL lo más rápido posible. Las ubicaciones de los satélites son actualmente:
    • Phoenix, Arizona
    • Ashburn, Virginia
    • Amsterdam, Países Bajos
  5. Haga clic en Actualizar para guardar la configuración.

Para obtener una descripción detallada de los tipos de publicaciones de Webhooks, las variables y otra información importante, consulte la Guía del usuario.

Note: Recomendamos probar la configuración de Webhook antes de confiar en su precisión. Puede hacerlo creando una cuenta CCBill Test.

¿Puedo tener varias URL que actúen como puntos finales de webhook?

Después de que se haya guardado al menos un Webhook, se le presentará la opción de editar, eliminar o agregar más. Puede agregar hasta cuatro (4) Webhooks, y cada uno puede usar URL diferentes si lo desea.

Eventos de webhooks

Las notificaciones de webhooks se describen en la Documentación de webhooks.

Los eventos incluidos son:

Soporte

Si tiene algún problema al configurar Webhooks, comuníquese con Soporte al comerciante y un miembro de nuestro equipo lo ayudará de inmediato.