Webhooks 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 documenta y prueba la API REST: otros sistemas leen y escriben en Dinaup con peticiones HTTP, desde cualquier lenguaje y desde plataformas como Zapier, Make o n8n. La pantalla lista los endpoints y trae un playground que monta cada petición, la ejecuta desde el navegador y muestra la respuesta.

La referencia de cada endpoint, con parámetros, cuerpos y códigos de respuesta, está en Referencia de endpoints; el mapa de la API, en Referencia de la API REST.

Antes de empezar

La aplicación Desarrollo en la licencia y el interruptor Desarrollador en tu usuario. Ver Desarrollo.
Una clave API con la casilla Compatible WebHook marcada. Las emite un administrador en Administración → Claves API. Ver Claves API.

Referencia de endpoints

La tarjeta lleva la etiqueta Beta. Muestra el Endpoint Base, https://<clave de conexión>.dinaup.io/api, que es el servidor de tu licencia, y el Header: las peticiones llevan el Token Bearer en la cabecera Authorization. Las rutas cuelgan de https://<clave de conexión>.dinaup.io:

Método	Ruta	Para qué
GET	`/ping`	Comprobar estado del servidor. Fuera de `/api` y sin Token Bearer.
GET	`/api/Whoami`	Comprobar usuario asociado
POST	`/api/Reports`	Consultar informes
POST	`/api/DynamicDocuments`	Consultar documentos dinámicos
POST	`/api/WriteOperations`	Operaciones de escritura

Probar webhooks entrantes

El playground es la tarjeta Probar webhooks entrantes, con la etiqueta Beta. En Clave API eliges una de las claves de la empresa. La pantalla monta con la clave y su secreto el Token Bearer que va en cada petición, así que no lo copias ni lo escribes a mano.

Hasta que eliges una clave, la tarjeta dice Selecciona una clave API arriba para ejecutar tests.
Si la clave no tiene marcada Compatible WebHook, un aviso lo dice y anuncia que las pruebas fallan con error de autenticación. Márcala en su ficha de Administración → Claves API y vuelve a elegirla.

Con la clave elegida aparecen cinco pestañas. Todas terminan en el mismo bloque: la vista previa del comando curl con la URL, las cabeceras y el cuerpo, el botón Ejecutar y, tras ejecutar, Respuesta (N ms) con el JSON formateado o el texto devuelto.

Ping

Ping (HealthCheck) comprueba que el servidor de tu licencia responde: un GET a https://<clave de conexión>.dinaup.io/ping. Es la única ruta que no cuelga de /api y la única que no pide el Token Bearer. Si todo está en orden, contesta "pong" con 200 OK.

Whoami

WhoAmI devuelve el usuario asociado a la clave API: un GET a /api/whoami con la cabecera Authorization. Los webhooks usan claves API de usuario, y esta llamada dice qué usuario hay detrás de la clave elegida.

Doc dinámicos

Documentos dinámicos renderiza un documento dinámico. En Documento dinámico eliges uno; el desplegable filtra por título. Si el documento tiene variables, aparece Variables del Documento con un cuadro por variable y su etiqueta como texto de ayuda. La petición es un POST a /api/DynamicDocuments?id=<id del documento> con las variables en el cuerpo.

Informes

Informes ejecuta un informe con un POST a /api/Reports. En Informe eliges uno; el desplegable filtra por título. En Parámetros:

Parámetro	Qué hace
Página	La página de resultados, de 1 a 200.
Resultados por página	De 1 a 12. El valor que viaja en la URL es como mínimo 12.
Modo seguro	Envía `safeColumnsName=true`: las columnas vienen con su GUID en lugar de su nombre, y no cambian si renombras un campo.
Con archivos	Envía `withFiles=true`: incluye las URL de los archivos adjuntos.

Si el informe tiene variables, aparece Variables del Informe con un cuadro por variable. Con un informe elegido, la tarjeta Columnas (etiqueta Beta) genera el código de sus columnas en C#, C# DTO, JavaScript, JavaScript DTO, Python, Python DTO y PHP, igual que la ficha del informe en Esquema.

WriteOperations

WriteOperation escribe un registro en una sección.

En Sección, pulsa la caja y elige la sección en la ventana Elegir la sección sobre la que se escribe. Salen las secciones de datos; no las plantillas base ni las tablas de líneas.
En Parámetros, Con scripts envía scripts=true: el servidor ejecuta los scripts de la sección al guardar.
En Campos, marca los campos en Principales y, si la sección tiene lista, en Lista. Cada campo muestra su etiqueta, su nombre interno y el icono de su formato.
En Valores, rellena Valores Listador (los campos principales) y Valores Lista (los de la línea).

La petición es un POST a /api/WriteOperations?sectionId=<id>&fieldPrimary=id&scripts=<true|false>. El cuerpo lleva los valores principales; con campos de lista, lleva Main y List.

Si la sección que acabas de crear no aparece, la ventana avisa: Esa sección no está en el esquema. El esquema se guarda 24 horas.

Formato de los valores

En los cuadros de variables y de campos, los valores se escriben como texto:

Tipo	Formato	Ejemplo
Fecha	ISO	`2023-03-15`
Fecha y hora	ISO en UTC	`2023-03-15 14:30:00`
Decimal	EN-US, con el punto como separador decimal	`1234.56`
Booleano	`1` para "Sí", `0` para "No"	`1`

Si algo falla

Error de autenticación: la clave no tiene Compatible WebHook, se eliminó o no tiene permiso sobre la sección. Un cambio en una clave tarda hasta dos minutos en aplicarse.
La API devuelve un error: queda registrado con su detalle en Errores API.

En esta página