API de datos abiertos

El API (abreviatura en inglés de Interfaz de Programación de Aplicaciones) te permite acceder a los datos publicados en el catálogo Datos Villa María mediante software de terceros o aplicaciones desarrolladas por vos mismo, sin tener que descargar los archivos. En esta página obtendrás información sobre cómo utilizar el API y cuáles son sus parámetros. Para poder utilizar el API necesitás una clave de API. Para obtener una clave de API hacé click en el botón Obtener clave de API. Si te olvidaste tu clave de API y querés recuperarla mediante tu dirección de email, hacé click en Recuperar clave de API.

Servicios del API

El API del Catálogo de Datos Abiertos tiene los siguientes servicios (endpoints). Siempre hay que agregar el parámetro api_key con la clave de API obtenida anteriormente:

https://datos.villamaria.gob.ar/api/organization_list.json?api_key=<tu-clave-api>

Listado de organizaciones

Devuelve un listado de las organizaciones que publican datos en el catálogo.

URL del endpoint: /api/organization_list.json
Método HTTP: GET
Formato de respuesta: JSON
Parámetros:

• api_key: Tu clave de API en formato UUID.
  Tipo: String
  

Listado de categorías

Devuelve un listado de las categorías con las que se clasifican los datasets.

URL del endpoint: /api/category_list.json
Método HTTP: GET
Formato de respuesta: JSON
Parámetros:

• api_key: Tu clave de API en formato UUID.
  Tipo: String
  

Listado de etiquetas

Devuelve un listado de las etiquetas con las que se clasifican los datasets.

URL del endpoint: /api/tag_list.json
Método HTTP: GET
Formato de respuesta: JSON
Parámetros:

• api_key: Tu clave de API en formato UUID.
  Tipo: String
  

Listado de conjuntos de datos

Devuelve un listado de los conjuntos de datos publicados en el catálogo.

URL del endpoint: /api/dataset_list.json
Método HTTP: GET
Formato de respuesta: JSON
Parámetros:

• limit: Indica cuántos registros mostrar.
  Tipo: Integer
  Ejemplo: https://datos.villamaria.gob.ar/api/dataset_list.json?limit=10
• start: Indica desde qué registro mostrar.
  Tipo: Integer
  Ejemplo: https://datos.villamaria.gob.ar/api/dataset_list.json?start=5
• organization_id: Filtra los conjuntos de datos por ID de organización. El ID de organización lo puedes obtener del listado de organizaciones.
  Tipo: Integer
  Ejemplo: https://datos.villamaria.gob.ar/api/dataset_list.json?organization_id=1
• category_id: Filtra los conjuntos de datos por ID de categoría. El ID de categoría lo puedes obtener del listado de categorías.
  Tipo: Integer
  Ejemplo: https://datos.villamaria.gob.ar/api/dataset_list.json?category_id=1
• tag_id: Filtra los conjuntos de datos por ID de etiqueta. El ID de etiqueta lo puedes obtener del listado de etiquetas.
  Tipo: Integer
  Ejemplo: https://datos.villamaria.gob.ar/api/dataset_list.json?tag_id=1
• query: Realiza una búsqueda en el título, la descripción y las etiquetas de los conjuntos de datos. Si hay varias palabras en la búsqueda se hace un AND entre ellas. Puedes incluir OR entre palabras para hacer disyunción inclusiva.
  Tipo: String
  Ejemplo: https://datos.villamaria.gob.ar/api/dataset_list.json?query=compras+or+personal
• api_key: Tu clave de API en formato UUID.
  Tipo: String
  

Consulta de un conjuntos de datos

Devuelve los metadatos y el listado de recursos de datos de un conjuntos de datos especificado.

URL del endpoint: /api/dataset/<dataset_id>.json
Método HTTP: GET
Formato de respuesta: JSON
Parámetros:

• dataset_id: ID de un conjuntos de datos en formato UUID. El ID del conjuntos de datos lo puedes obtener del listado de conjuntos de datos.
  Tipo: String
  Ejemplo: https://datos.villamaria.gob.ar/api/dataset/5133451f-9ac6-4763-8948-0f6b3eafa117.json
• api_key: Tu clave de API en formato UUID.
  Tipo: String
  

Consulta de un recurso de datos

Devuelve los metadatos, las columnas y los datos de un recurso especificado. Las columnas y los datos solo se muestran para recursos de tipo tabla (Excel, CSV, etc.).

URL del endpoint: /api/resource/<resource_id>.json
Método HTTP: GET
Formato de respuesta: JSON
Parámetros:

• resource_id: ID de un recurso en formato UUID. El ID de recurso lo puedes obtener de la consulta del conjuntos de datos relacionado.
  Tipo: String
  Ejemplo: https://datos.villamaria.gob.ar/api/resource/6134451f-ac46-3463-8948-0f6b3eaba128.json
• limit: Indica cuántos registros mostrar.
  Tipo: Integer
  Ejemplo: https://datos.villamaria.gob.ar/api/resource/6134451f-ac46-3463-8948-0f6b3eaba128.json?limit=10
• start: Indica desde qué registro mostrar.
  Tipo: Integer
  Ejemplo: https://datos.villamaria.gob.ar/api/resource/6134451f-ac46-3463-8948-0f6b3eaba128.json?start=5
• query: Realiza una búsqueda en todos los campos del recurso.
  Tipo: String
  Ejemplo: https://datos.villamaria.gob.ar/api/resource/6134451f-ac46-3463-8948-0f6b3eaba128.json?query=compra+directa
• api_key: Tu clave de API en formato UUID.
  Tipo: String