Saltar al contenido principal

Tu primera llamada a la API

Guía para autenticarte y consultar datos desde la API REST de Dinaup usando curl.

Requisitos previos

  • Una Clave API generada (ver generar Clave API)
  • Un informe configurado en Dinaup Flex con su ID

Paso 1: Verificar autenticación

Comprueba que tu clave funciona:

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

Respuesta esperada (200 OK):

{
"user": "nombre@tuempresa.com"
}

Si recibes 401, la clave es inválida o está expirada.

Paso 2: Consultar un informe

Usa el ID de un informe configurado en Dinaup Flex:

curl -X POST "https://webhook.dinaup.com/api/reports?id=ID_DEL_INFORME&page=1&resultsPerPage=10" \
-H "Authorization: Bearer TU_CLAVE_API" \
-H "Content-Type: application/json" \
-d '{}'

Respuesta esperada (200 OK):

{
"data": [
{"columna1": "valor1", "columna2": "valor2"},
{"columna1": "valor3", "columna2": "valor4"}
],
"currentPage": 1,
"totalPages": 5,
"totalResults": 42,
"files": []
}

Paso 3: Entender la respuesta

CampoDescripción
dataArray con los registros del informe
currentPagePágina actual
totalPagesTotal de páginas disponibles
totalResultsTotal de registros
filesArchivos adjuntos (si withFiles=true)

Límites de tasa

Cada endpoint tiene un límite de peticiones por clave:

EndpointPeticionesReposición
Reports305 cada 10 seg
WriteOperations305 cada 10 seg
DynamicDocuments305 cada 10 seg
Whoami6010 cada 10 seg

Si excedes el límite: 429 Too Many Requests con header Retry-After: 10.

Siguiente paso