En nuestra plataforma, los webhooks desempeñan un papel crucial al facilitar comunicaciones automatizadas y en tiempo real entre sistemas. Para asegurar que estas integraciones funcionen de manera eficiente y segura, es esencial seguir ciertas convenciones y estándares técnicos.

Especificaciones Técnicas para Webhooks

Tipo de API y Formato de Datos

Todos los webhooks implementados deben ser REST APIs que operen principalmente con el formato JSON tanto para las solicitudes entrantes como para las respuestas. Este enfoque asegura que la integración sea flexible y compatible con la amplia gama de tecnologías utilizadas en el desarrollo web moderno.

Las APIs deben recibir payloads en formato JSON, que es ligero y fácil de manejar, ofreciendo una estructura de datos clara y legible.

Similarmente, las respuestas a los webhooks también deben ser en JSON, permitiendo una interpretación sencilla y directa de los datos por parte del sistema receptor.

Nomenclatura de Atributos

Es importante que todos los atributos en los mensajes JSON sigan un formato consistente. Los nombres de las variables deben estar en formato snake_case, es decir, nombre_variable. Este formato mejora la legibilidad y mantiene la coherencia a lo largo de todas las interfaces API.

Uso de Verbos HTTP

Los webhooks deben apegarse estrictamente a los verbos HTTP especificados en nuestra documentación. Cada acción permitida por nuestros webhooks estará claramente asociada con un verbo HTTP apropiado (como GET, POST, PUT, DELETE), lo cual asegura que el comportamiento de la API sea predecible y esté en línea con los estándares REST.

Seguridad mediante Firma Digital

Para garantizar la seguridad y la integridad de los datos transmitidos:

• Cada mensaje de webhook debe incluir una firma digital en el header X-Signature.
• Esta firma verifica que el contenido del mensaje no ha sido alterado desde su origen y autentica la fuente del mensaje.
• El proceso para generar y verificar esta firma se describe detalladamente en nuestra documentación técnica, asegurando que ambos, el emisor y el receptor, puedan implementar este mecanismo de seguridad de manera eficiente.

Importancia de Seguir Estas Especificaciones

El cumplimiento de estas especificaciones no solo facilita la integración técnica entre diferentes sistemas sino que también asegura que las transacciones y los datos sean manejados de manera segura y confiable. Animamos a todos nuestros desarrolladores y socios a adherirse a estas prácticas para mejorar la interoperabilidad y la seguridad de nuestras soluciones integradas.

Al establecer estos estándares, nuestra plataforma se asegura de que todas las comunicaciones a través de webhooks sean robustas, coherentes y seguras. Esta sección de la documentación proporcionará todos los detalles necesarios para implementar y configurar webhooks correctamente, asegurando que sus integraciones sean exitosas y seguras desde el inicio.