Dinaup DocsReferencia de la API REST
Mapa de la API REST pública de Dinaup (webhook.dinaup.com). Qué hace cada endpoint, cómo te autenticas y dónde está el detalle técnico.
La API REST pública de Dinaup te deja leer y escribir tus datos desde cualquier lenguaje, mediante peticiones HTTP. Se sirve desde https://webhook.dinaup.com y está pensada para integradores: conectar una tienda online, alimentar un dashboard, importar datos en lote o sincronizar con otro sistema.
Esta página es el mapa de capacidades: qué endpoint usar para cada tarea. Para el detalle de parámetros, cuerpos y respuestas de cada llamada, ve a la referencia completa de endpoints.
¿Programas en .NET? Tienes un SDK oficial con tipado fuerte y nombres de campo legibles. La API REST es la vía universal para cualquier otro lenguaje.
Autenticación
Toda petición (salvo el ping) viaja con un Token Bearer en la cabecera HTTP. El token hereda los permisos del usuario al que pertenece: solo accede a lo que ese usuario puede ver y escribir.
Authorization: Bearer <token>El token no es tu clave API en crudo: Dinaup lo deriva de la clave y su secreto, firmados. Genera la clave en el panel de administración, márcala como compatible con webhooks y copia el token desde el Playground. El detalle está en la referencia de endpoints.
Usa la clave API solo en tu backend. Nunca la incrustes en código público ni en el frontend de una web.
Formato de las respuestas
Todas las respuestas son JSON. Cada endpoint devuelve su propia forma: whoami trae el usuario, reports trae las filas paginadas, writeoperations trae el resultado de la operación. El detalle de cada cuerpo está en la referencia de endpoints.
Si algo falla, la respuesta llega con un código HTTP de error (401 sin token, 403 sin permiso, 400 con datos inválidos) y un mensaje que describe el motivo. Ramificas tu integración leyendo el código de estado.
Endpoints de consulta
Lectura de datos: comprobar que todo está vivo, saber con qué usuario operas y ejecutar lo que ya tienes configurado en Flex.
| Endpoint | Para qué sirve |
|---|---|
| Ping | Comprueba que el servidor está operativo. No requiere autenticación; ideal para healthchecks. |
| Whoami | Devuelve el usuario asociado al token. Úsalo para verificar que la autenticación funciona. |
| Ejecutar informe | Lanza un informe de Flex ya configurado y te devuelve sus filas en JSON, paginadas. |
| Documento dinámico | Renderiza una plantilla de documento dinámico con los datos que le pases (HTML, JSON, texto). |
Primero configuras el informe o el documento dentro de Dinaup (columnas, filtros, plantilla) y luego lo ejecutas por API. La API dispara lo que tú ya dejaste preparado en Flex.
Endpoint de escritura
| Endpoint | Para qué sirve |
|---|---|
| WriteOperations | Crea o actualiza registros en cualquier sección. La misma operación sirve para alta y edición, admite lote e importación padre + hijos, y el borrado es lógico (editar marcando el registro como eliminado). |
Las escrituras respetan los permisos del usuario del token. Si ese usuario no puede escribir en una sección, la operación se rechaza con un error.
→ El detalle de parámetros, formatos de cuerpo (objeto simple, padre + hijos, lote) y ejemplos curl está en la referencia de endpoints.
Límites
La API protege el servicio con dos topes:
- Paginación: un informe devuelve resultados paginados; pide las páginas que necesites con
pageyresultsPerPageen lugar de un volcado único. - Límite de tasa por endpoint: cada endpoint acota las peticiones por periodo. Si lo superas, recibes
429 Too Many Requestscon la cabeceraRetry-Afterindicando cuándo reintentar.
Las cifras exactas de cada endpoint están en la referencia de endpoints.
Recibir eventos (webhooks salientes)
La API REST es la dirección tú → Dinaup (tú preguntas, Dinaup responde). Para la dirección contraria —que Dinaup te avise cuando se crea o modifica un registro— usa los webhooks salientes: configuras una URL y Dinaup le envía una petición en tiempo real.
→ Configurar webhooks salientes
Preguntas frecuentes
→ Referencia completa de endpoints → API y Webhooks → SDK .NET → Integraciones
Integraciones
Conecta Dinaup con tu ecosistema tecnológico mediante API REST, webhooks, SDK .NET, sincronización con PostgreSQL, Power BI y automatización sin código.
API y Webhooks
Dos direcciones de integración: la API REST para leer y escribir datos, y los webhooks salientes para recibir eventos cuando cambian tus datos.