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.

curl -X GET "https://webhook.dinaup.com/api/whoami" -H "Authorization: Bearer conc**"

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.

curl -X GET "https://webhook.dinaup.com/api/reports?id=5b3b317c-0513-4ab8-9724-903100edea76&page=1&resultsPerPage=100&withFiles=false&safeColumnsName=false" \
-H "Authorization: Bearer conczzkkfpjt9s9z_f802863211b1e9cb2aefb423eee48a4054b5085038cba72a184bb93133042e6050f506b58ebd9969"

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.

curl -X GET "https://webhook.dinaup.com/api/DynamicDocuments?id=3db0df5f-af7f-4183-af9d-f561976fb61a" \
-H "Authorization: Bearer conczzkkfpjt9s9z_f802863211b1e9cb2aefb423eee48a4054b5085038cba72a184bb93133042e6050f506b58ebd9969" \
-H "dinaup-server: conczzkkfpjt9s9z"

Requiere header Authorization: Bearer ******

WriteOperations

Requiere header Authorization: Bearer ******

AnteriorWebHookSiguienteSalientes

Última actualización