AYUDA - DATOS ABIERTOS - PRONABEC

Bienvenidos a la documentación de la API de la plataforma de datos abiertos del PRONABEC. Esta API está organizada en base a los conceptos REST. Es decir, la API está orientada a recursos y utiliza códigos de respuestas HTTP para devolver resultados o indicar errores. Además, se utilizan el verbo HTTP GET para las correspondientes acciones. Las respuestas son en JSON.

La plataforma de Datos Abiertos tiene una limitación respecto a consultas (requests) por segundo, establecidas en seis (06). Para consultas contactenos a datosabiertos@pronabec.gob.pe.

Autenticación

Los accesos se realizan a traves de una key válida. La key la puede obtener a partir de /developer/:
https://api.datosabiertos.pronabec.gob.pe/developer, dentro de la plataforma.
Las keys son anónimas y se generan dinámicamente para cada solicitud de key.
Una key tiene la siguiente forma: apiKey=58b3bc47e2203394dad16a54677017cfb1348e855621

Autorización

Si se exceden las seis (06) solicitudes por segundo, se deniega el acceso por tres (03) segundos.
Las keys permiten el acceso de sólo lectura.

Errores

La API - DATOS ABIERTOS - PRONABEC usa respuesta HTTP convencionales para indicar el éxito o el fracaso de una llamada a la API. Siguiendo los lineamientos HTTP los códigos de rango 2xx indican éxito y los códigos de rango 4xx indican error.

Si el código de la API es inválido, muestra el siguiente mensaje de error: Los parámetros inválidos son ignorados, por ejemplo, si ingresa el parámetro 'filas' y no 'rows', el mismo ('filas') será ignorando, sin generar un mensaje de error.

Paginación

Todos los métodos de listado de recursos de la API - DATOS ABIERTOS - PRONABEC tienen el funcionamiento de paginado. Cualquiera puede recibir los siguientes parámetros:

Cuando aparecen estos parámetros la respuesta se ordena de otra manera y agrega los siguientes campos

Un ejemplo de respuesta con page igual a 2 podría ser

https://api.datosabiertos.pronabec.gob.pe/developer/AsignacionPresupuestal?apiKey=18b3bc472203394dad16a54677017cfb1348e855621&page=2

Ordenamiento

Para poder ordenar los listados de todos los recursos se usa el parámetro order que puede tener uno de los siguientes valores.

Conjunto de Datos

Podemos consumir la metadata de los recursos de tipo conjunto de datos (dataset) publicados en API - DATOS ABIERTOS - PRONABEC a través de una llamada GET. Las llamadas GET nos pueden traer una lista completa de todos los conjuntos de datos o solo de un GUID específico. Las llamadas GET nos devuelven los siguientes parámetros en todas las consultas:

developer/{guid}

Por ejemplo

https://api.datosabiertos.pronabec.gob.pe/developer/{guid}?apiKey=MI_AUTH_KEY

retorna

[{
                "Apiguid": "Asignación Presupuestal",
                "ApiTitulo": "Asignación Presupuestal",
                "ApiDescripcion": "Lista la asignación presupuestal al año fiscal 2016.",
                "ApiCategoria": "DATOS ADMINISTRATIVOS",
                "ApiTags": "presupuesto|clasificador|devengado|pliego",
                "ApifechaCreacion": "\/Date(1478617647807)\/",
                "Apienlace": "https://api.datosabiertos.pronabec.gob.pe/developer/AsignacionPresupuestal",
                ... {query result}
            }]

Filtrar los resultados de una vista

La API de Datos Abiertos del PRONABEC le permite filtrar los resultados obtenidos durante la solicitud de una vista de datos. Puede ingresar los campos de filtro en cualquier orden. Puede ingresar los campos de filtro que considere necesario.
Los criterios para los filtros son los siguientes:
Si filter0 es texto el filtro se realiza por like (ignora si es mayúscula o minúscula).
Si filter0 es numerico el texto se realiza por =.
Si filter0 es fecha el formato del campo es: yyyy-MM-dd hh:mm:ss.mmm
La sintaxis es la siguiente:

https://api.datosabiertos.pronabec.gob.pe/developer/{guid}?apiKey=MI_AUTH_KEY&filter0=criterio0&filter1=criterio1

Por ejemplo

https://api.datosabiertos.pronabec.gob.pe/developer/AsignacionPresupuestal?apiKey=51b3bc47e220377017cfb0348e855621&page=1&rows=10&GLOSA=C

[{
                "Apiguid":"AsignacionPresupuestal",
                "ApiTitulo":"Asignación Presupuestal",
                "ApiDescripcion":"Lista la asignación presupuestal al año fiscal 2016.",
                "ApiCategoria":"DATOS ADMINISTRATIVOS",
                "ApiTags":"presupuesto|clasificador|devengado|pliego",
                "ApifechaCreacion":"\/Date(1478620556730)\/",
                "Apienlace":"https://api.datosabiertos.pronabec.gob.pe/developer/AsignacionPresupuestal",
                "TOTAL_RECORDS":15,
                "NRO_FILA":1,
                "SECTOR":"10 EDUCACION",
                "PLIEGO":"010 M. DE EDUCACION",
                "EJECUTORA":"117 PROGRAMA NACIONAL DE BECAS Y CREDITO EDUCATIVO [001438]",
                "CLASIFICADOR":"2.6","GLOSA":"GASTOS DE CAPITAL 2012",
                "PIM":9557469.0000,"
                ENERO":0.0000,
                "FEBRERO":0.0000,
                "MARZO":0.0000,
                "ABRIL":424250.0000,
                "MAYO":396630.0000,
                "JUNIO":41251.6000,
                "JULIO":61223.7000,
                "AGOSTO":334512.0100,
                "SETIEMBRE":277564.5600,
                "OCTUBRE":362673.8600,
                "NOVIEMBRE":227587.2000,
                "DICIEMBRE":2190492.1000,
                "TOTAL_DEVENGADO":4316185.0300,
                "SALDO":5241283.9700,
                "FECHA_HORA":"\/Date(1474347600000)\/"},
            ...
            ]