El A.P.I.

¿Cómo consulto los datos desde mi aplicación?

Los datos de UniversiDATA pueden consumirse tanto desde las páginas de descarga, orientadas a los usuarios, como desde su API (Application Programming Interface).

UniversiDATA, al estar construido con DKAN, soporta los siguientes APIs:

Consultas sobre los datos (DataStore API)

Para poder consultar los datos de un determinado recurso, es necesario conocer dos cosas:

1) La URL del DataStore API, que es, dependiendo del formato en el que queramos que venga especificada la respuesta:

2) El identificador del recurso (Resource ID) que queremos consultar. Este identificador se obtiene consultando la sección "Data API" en la página del recurso correspondiente, como se ve en la siguiente captura:

Resource ID de un recurso (resaltado con un recuadro rojo)

Para todos los ejemplos aquí mostrados usaremos el recurso con Resource-ID84d7461c-34a9-4682-927f-3b20c1a02a3c, correspondiente a las titulaciones de la URJC en el curso 2018-19

EJEMPLO 1: Obtener los datos de un recurso

Se pueden especificar tres parámetros:

  1. Obligatoriamente, el parámetro resource_id
  2. Obligatoriamente, el parámetro limit, que especifica a cuántos registros queremos limitar la consulta. ATENCION: Si no se especifica este parámetro, el sistema interpreta que se trata de una consulta de prueba y devuelve por defecto sólo los primeros 10 registros.
  3. Opcionalmente, el parámetro offset, que especifica a partir de qué registro queremos que nos devuelva la consulta. Este parámetro es útil para consultar en varios pasos recursos muy grandes (con varios miles de registros) en los que puede resultar prohibitivo para el cliente o el servidor su procesamiento en una sola petición. En estos casos es una buena práctica fragmentar la petición en varias peticiones parciales sucesivas.

EJEMPLO 2: Especificar condiciones de filtrado en la petición

Hay que especificar un parámetro adicional:

  1. Parámetro filters, que especifica el campo y los valores por los que queremos filtrar en el formato filters[campo]=valor/es separados por comas
  2. En el caso de que queramos filtrar por más de un campo, se debe añadir el parámetro filters tantas veces como campos queramos filtrar

EJEMPLO 3: Limitar campos en la respuesta y especificar ordenación

Hay que especificar dos parámetros adicionales:

  1. Parámetro fields[], que especifica los campos que queremos que nos devuelva la consulta. Si queremos especificar varios campos, debemos especificar varias veces el parámetro.
  2. Parámetro sort , que especifica el campo por el cual ordenar los resultados, y el sentido de la ordenación

EJEMPLO 4: Filtrar por coincidencia de texto en todos los campos

Hay que especificar un parámetro adicional:

  1. Parámetro query, que especifica la cadena de texto que queremos buscar en todos los campos que devuelva la consulta. Es importante notar que para la comparación NO se tienen en cuenta mayúsculas/minúsculas.

 

EJEMPLO 5: Combinar datos de dos recursos distintos

Hay que especificar los dos recursos que se quieren unir, y usar parámetro adicional para definir los campos por los que se debe hacer la unión en cada recurso:

  1. Dos parámetros resource_id, especificando cada uno de los recursos a unir y dándoles un alias: resource_id[alias recurso 1]=id del recurso 1&resource_id[alias recurso 2]=id del recurso 2
  2. Parámetro join,  con el siguiente formato: join[alias recurso 1]=campo recurso 1&join[alias recurso 2]=campo recurso 2

 

Consultas sobre los metadatos (CKAN Dataset API)

Para poder consultar los metadatos de un determinado dataset o recurso mediante el CKAN API, es necesario conocer dos cosas:

1) La URL base del CKAN API, que es:

  • https://www.universidata.es/api/3/action/

2) El identificador del recurso (Resource ID) o del dataset que queremos consultar. Estos identificadores se obtienen consultando la sección "Data API" en la página del recurso correspondiente, o en la tabla de metadatos de la página de cada dataset.

EJEMPLO 6: Consultar los metadatos de tódo el catálogo

Hay que especificar la acción "current_package_list_with_resources":

 

EJEMPLO 7: Consultar los metadatos de un dataset

Hay que especificar la acción "package_show", especificando un parámetro "id" con el identificador del dataset:

 

EJEMPLO 8: Consultar los metadatos de un recurso

Hay que especificar la acción "resource_show", especificando un parámetro "id" con el identificador del recurso:

 

 

Consultas sobre el catálogo (DCAT API)

Para poder consultar los contenidos del catálogo de una determinada Universidad mediante el DCAT API, es necesario conocer dos cosas:

1) La URL base del DCAT API, que es:

  • https://universidatacatalog.azurewebsites.net/api/UniversiDATA_Catalog

2) El identificador de la Universidad (su acrónimo) cuyo catálogo queremos consultar (por ejemplo "URJC")

EJEMPLO 9: Consultar el catálogo de una Universidad

Hay que especificar el parámetro "universidad" con el acrónimo correspondiente:

 

 

Importante

Para acceder al portal UniversiDATA y sus contenidos es imprescindible que usted conozca y esté de acuerdo con los siguientes puntos:

  1. Que cada uno de los conjuntos de datos publicados a través de esta plataforma está asociado a una licencia que especifica los términos bajo los cuales se permite su acceso y utilización. En la página de cada conjunto de datos la licencia asociada por el publicador está claramente especificada y enlazada en la columna izquierda, bajo la descripción de la Universidad publicadora, tal y como se muestra en la siguiente captura:

  2. License block screenshot
  3. Que es su responsabilidad como reutilizador consultar y cumplir los términos de la licencia especificada en cada caso.