Entrantes

Los WebHooks permiten interactuar con el API de Dinaup en tiempo real. Para utilizarlos, necesitas una Clave API de usuario válida. Puedes probarlos fácilmente desde el Playground: Play Dinaup WebHook PlayGround

  • GET / para comprobar el estado del servidor.

  • GET /API/Whoami para comprobar el usuario.

  • GET /API/Reports para consultar informes

  • GET /API/DynamicDocuments para consultar documentos dinámicos.

  • POST /API/WriteOperations para realizar operaciones de escritura.

/ (Ping)

Este endpoint permite verificar si los servicios de webhook de Dinaup están funcionando correctamente. Si todo está en orden, responderá con una cadena de texto "Hola :)" y un código de estado 200 OK.

curl -X GET "https://webhook.dinaup.com"

Whoami

Los WebHooks utilizan Claves API de Usuarios, puedes recibir la información del usuario asociado a la clave API utilizando /api/whoami. Esto también sirve para testear los headers de autenticación.

Requiere header Authorization: Bearer ******

Reports

Este endpoint permite obtener un informe de Dinaup mediante el método POST en la ruta /api/Reports. Se tienen en cuenta la paginación, la inclusión de archivos asociados mediante withFiles y el uso de nombres de columna seguros con safeColumnsName.

Reqquiere header Authorization: Bearer ******

Tips

  • Configura una pregunta para filtrar dinámicamente, ejemplo para "Recibir las Ventas asociadas a un cliente determinado"

  • Para mayor estabilidad se recomienda activar safeColumnsName.

DynamicDocuments

Los documentos dinámicos son documentos en texto plano que pueden combinar diferentes datos de distintas secciones, permitiendo una estructura totalmente personalizada.

Requiere header Authorization: Bearer ******

WriteOperations

Requiere header Authorization: Bearer ******

AnteriorWebHookSiguienteSalientes

Última actualización