Dinaup DocsWebhooks Entrantes
Los endpoints de la API REST de tu licencia y el playground que lanza peticiones reales desde el navegador con una de tus claves API.
Desarrollo → Conectar → Webhooks Entrantes lista los endpoints de la API REST de tu empresa y trae un playground que lanza peticiones reales desde el navegador. La referencia completa está en Referencia de endpoints.
Antes de empezar
Una clave API con Compatible WebHook marcada: Claves API.
Referencia de endpoints
Las peticiones van a https://<clave de conexión>.dinaup.io con el Token Bearer en la cabecera Authorization:
| Método | Ruta | Para qué |
|---|---|---|
| GET | /ping | Comprobar que la API responde ("pong"). Sin /api y sin token. |
| GET | /api/Whoami | Ver el usuario de la clave. |
| POST | /api/Reports | Consultar informes. |
| POST | /api/DynamicDocuments | Consultar documentos dinámicos. |
| POST | /api/WriteOperations | Escribir registros. |
Probar webhooks entrantes
Elige una clave en Clave API: la pantalla monta el token por ti. Si la clave no tiene Compatible WebHook, las pruebas fallan por autenticación. Cada pestaña muestra el comando curl, el botón Ejecutar y la Respuesta (N ms).
| Pestaña | Qué hace |
|---|---|
| Ping | GET a /ping. |
| Whoami | GET a /api/whoami: el usuario detrás de la clave. |
| Doc dinámicos | Elige el documento y rellena sus variables. POST a /api/DynamicDocuments?id=<id>. |
| Informes | Elige el informe, sus variables y los parámetros. POST a /api/Reports. |
| WriteOperations | Elige la sección, los campos y sus valores. POST a /api/WriteOperations?sectionId=<id>&fieldPrimary=id, con scripts. |
Parámetros de Informes:
| Parámetro | Qué hace |
|---|---|
| Página | De 1 a 200. |
| Resultados por página | Filas por página. |
| Modo seguro | safeColumnsName=true: columnas con su GUID en vez de su nombre, estables si renombras un campo. |
| Con archivos | withFiles=true: incluye las URL de los adjuntos. |
En WriteOperations, Con scripts (scripts=true) ejecuta los scripts de la sección al guardar. Con campos de lista, el cuerpo lleva Main y List.
Formato de los valores
| Tipo | Formato | Ejemplo |
|---|---|---|
| Fecha | ISO | 2023-03-15 |
| Fecha y hora | ISO en UTC | 2023-03-15 14:30:00 |
| Decimal | Punto decimal | 1234.56 |
| Booleano | 1 o 0 | 1 |
Si algo falla
- Autenticación: la clave no tiene Compatible WebHook, se eliminó o no tiene permiso sobre la sección. Un cambio en la clave tarda hasta dos minutos.
- Cualquier error queda en Errores API.
- Una sección recién creada puede tardar 24 horas en salir (Esa sección no está en el esquema).