Documentación del API – Wiki del Prototipo

Prototipoda es una API disponible en http://23.96.92.32/api/v1/ que permite a los ciudadanos consultar datos abiertos de la Administración Pública Nacional.

La intencion es poner a disposición de la ciudadanía, datos priorizados y hacer frente a los retos para el de desarrollo global en seis sectores: gobernabilidad, educación, salud, transporte, medio ambiente, saneamiento y residuos.

La v1 del API aborda el sector de desarrollo de Gobernabilidad que promueve la transparencia, justicia y economía del área,para lograrlos se han de disponer de información de presupuesto, gasto y contratación, mapas planimétricos, información sobre ubicación de crímenes, información electoral, información de lugares de votación, registro de empresas, legislación, mapa catastral, información de precios de mercado, información de impuestos y tasas.

En la versión 1 se disponen registros para el Minpet (Ministerio de Petroleo de Venezuela) especificamente para sus proyectos.

Grupo Proyecto

A continuación se presentan los distintos recursos de datos abiertos pertenecientes a los proyectos de los diferentes organismos que conforman la Administracion Pública Nacional y que promueven la gobernabilidad como parte de la información de presupuesto, gasto y contratación.

Publicaciones [/minpet/proyectos/publicaciones/{id}]

Dentro del grupo "Proyecto" tenemos un recurso llamado "publicaciones" [/minpet/proyectos/publicaciones/{id}] los cuales comprenden a los proyectos realizados en un año en particular y por cada uno de los Ministerios que conformar la APN.

Por ejemplo este recurso permitiría trabajar con los proyectos del "Minpet" publicados en el 2015 donde el parametro {id} correspondería con el año de publicación del memoria y cuenta que se desee consultar .

+ Parameters

+ id : 2015 (number)

`Listar los proyectos publicados en una fecha [GET]`

+ Response 200 (application/json)

Ejemplo de Request http://23.96.92.32/api/v1/minpet/proyectos/publicaciones/2015

curl
 --location --request GET 'http://23.96.92.32/api/v1/minpet/proyectos/publicaciones/2015'

curl --location --request GET 'http://23.96.92.32/api/v1/minpet/proyectos/publicaciones/2015'

Un ejemplo de como se veria en la interfaz de Postman es la siguiente:

Organizaciones [/minpet/proyectos/organizaciones/{id}]

Dentro del grupo "Proyecto" tenemos un recurso llamado "organizaciones" [/minpet/proyectos/organizaciones/{id}] los cuales comprenden a los proyectos realizados por una organizacion adscritas a un ministerio de los que conforman la APN.

Por ejemplo este recurso permitiría trabajar con los proyectos de la empresa PDVSA que es un ente adscrito del "Minpet"

donde el parametro {id} correspondería con el identificador de la organizacion (PDVSA) adscritas al ministerio (Minpet) segun la estructura organizacional que se desee consultar.

Los parametros válidos para las organizaciones adscritas del Minpet son las siguientes:

Parámetro {id}	Referencia
mpetromin	MINISTERIO DEL PODER POPULAR DE PETRÓLEO Y MINERÍA
bielovenezolana	PETROLERA BIELOVENEZOLANA.SA
gasGuarico	GAS GUÁRICO S.A
yepergas	YEPERGAS S.A
quiriquiriGas	QUIRIQUIRE GAS.SA
enagas	ENTE NACIONAL DEL GAS
samh	SERVICIO AUTÓNOMO DE METROLOGÍA DE HIDROCARBURO
oroNegro	FUNDACIÓN ORO NEGRO
alquitrana	FUNDACIÓN GUARDERÍA INFANTIL LA ALQUITRANA
misionRibas	FUNDACIÓN MISIÓN RIBAS
misionPiar	FUNDACIÓN MISIÓN PIAR
inc	INSTITUTO NACIONAL DE CANALIZACIONES
ingeomin	INSTITUTO NACIONAL DE GEOLOGÍA Y MINERÍA
pdvsa	PETRÓLEOS DE VENEZUELA S.A
pequiven	PETROQUÍMICA DE VENEZUELA
cjaa	COMPLEJO PETROQUÍMICO G/D
ducolsa	DESARROLLOS URBANOS DE LA COSTA ORIENTAL DEL LAGO
minerven	COMPAÑÍA GENERAL DE MINERÍA DE VENEZUELA (MINERVEN)
cvgTecmin	CVG TECNICA MINERA C.A. (CVG TECMIN)

+ Parameters

+ id : pdvsa (string)

`Listar los proyectos de una organización adscrita a un ministerio [GET]`

+ Response 200 (application/json)

Un ejemplo de como se veria en la interfaz de Postman es la siguiente:

Naturalezas [/minpet/proyectos/organizaciones/naturalezas/{id}]

Dentro del grupo "Proyecto" tenemos un recurso llamado "naturalezas" [/minpet/proyectos/organizaciones/naturalezas/{id}] los cuales comprenden a los proyectos realizados en función a la naturaleza organizacional de las organizaciones que los ejecutan bajo la adscripción de un ministerio.

Por ejemplo este recurso permitiría trabajar con los proyectos de las fundaciones del estado adscritas al minpet.

donde el parametro {id} correspondería con la naturaleza organizacional de las organizaciones adscritas a un ministerio que se desee consultar.

Los parametros válidos para las naturalezas organizacionales que conforman la APN son las siguientes:

+ Parameters

+ id : fundacionEstado (string)

Listar los proyectos indicando la naturaleza organizacional de los organismos realizadores [GET]

+ Response 200 (application/json)

Parámetro {id}	Referencia
administracioncentral	ORGANO DE LA ADMINISTRACIÓN CENTRAL
empresaestado	EMPRESA DEL ESTADO
empresaprivada	EMPRESA NACIONAL PRIVADA
organodesconcentrado	ÓRGANO DESCONCENTRADO
serviciodesconcentrado	SERVICIO DESCONCENTRADO
fundacionestado	FUNDACIÓN DEL ESTADO
institutopublico	INSTITUTO PÚBLICO

Un ejemplo de como se veria en la interfaz de Postman es la siguiente:

Publicaciones por organización [/minpet/proyectos/results?organizacion={organizacion}&publicacion={publicacion}]

Dentro del grupo "Proyecto" tambien es posible realizar consultas multiples asociadas a la combinación de parámetros.

Tenemos un recurso [/minpet/proyectos/results?organizacion={organizacion}&publicacion={publicacion}] el cual

comprende a los proyectos publicados en una fecha por una organizacion adscrita a un ministerio.

Por ejemplo este recurso permitiría trabajar con los proyectos de la empresa PDVSA adscritas al Minpet que fueron

publicados en la memoria y cuenta del 2015, donde el parametro {organizacion} correspondería con el identificador de la organizacion (PDVSA) adscritas al ministerio (Minpet) segun la estructura organizacional que se desee consultar y el parámetro {publicacion} correspondería con el año de publicación del memoria y cuenta que se desee consultar

+ Parameters

+ organizacion : pdvsa (string)

+ publicacion : 2015 (number)

Listar los proyectos por publicaciones y organización [GET]

+ Response 200 (application/json)

Un ejemplo de como se veria en la interfaz de Postman es la siguiente:

Treemap naturaleza y organización [/minpet/proyectos/treemap/results?publicacion={publicacion}]

Dentro del grupo "Proyecto" tambien es posible realizar consultas treemap y mostrar gran cantidad de datos de estructura jerárquica (estructura de árbol).

Tenemos un recurso [/minpet/proyectos/treemap/results?publicacion={publicacion}] donde el parámetro {publicacion} correspondería con el año de publicación del memoria y cuenta que se desee consultar y cuyos datos permitiría hacer una representación gráfica de los proyectos de un ministerio en 2 niveles: naturaleza y organización.

El espacio de la visualización treemap está dividido en rectángulos a los que se les asigna un tamaño y un orden en función de una variable cuantitativa que para este recurso es la cantidad de proyectos en cada conjunto que conforman los 2 niveles.

Por ejemplo este recurso permitiría cuantificar y jerarquizar los datos de los proyectos y visualizar en un primer nivel

las naturalezas organizacionales que conforman la APN donde cada bloques de rectangulo es una Naturaleza cuya dimensión esta asociada a la cantidad de proyectos presentados por ese conjunto de organizaciones y en un segundo nivel las organizaciones propiamente donde cada bloques de rectangulo es una organización cuya dimención esta asociada a la cantidad de proyectos presentados por esa organización.

Una implementación de este recurso se puede visualizar en la seccion "Descubre" del Portal del prototipo http://proto.zz.com.ve/portalprototipo

+ Parameters

+ publicacion : 2015 (number)

Listar Treemap naturaleza y organización [GET]

+ Response 200 (application/json)

Un ejemplo de como se veria en la interfaz de Postman es la siguiente: