Los servicios de la API comparten una URL base común:

[URL_BASE]: http://opendata.gobiernodecanarias.org/apigobcan

A continuación se exponen algunos ejemplos del uso de la API.

Ejemplo 1: Obtener los metadatos del conjunto de datos.

Para estos ejemplos, vamos a tomar como referencia el conjunto de datos Centros educativos de Canarias. Para ello, ejecutamos "get_dataset".

[URL_BASE]/get_dataset?id=centros-educativos-de-canarias&prettyPrint=true

Con este servicio, obtendremos los metadatos del conjunto de datos y de los recursos que contiene. Los recursos vienen agrupados en el atributo "resources" y su identificador es "id". Este id se va a utilizar en el ejemplo siguiente.

Ejemplo 2: Obtener los metadatos de un recurso.

Para este ejemplo, hemos tomado el identificador del recurso "centros.csv". Si le pasamos su id al parámetro "resource_id" del servicio "get_resource", obtendremos sus metadatos:

[URL_BASE]/get_resource?resource_id=7f2eff7d-7f9f-41d3-8282-2b2660835bfe&prettyPrint=true

Ejemplo 3: Obtener los registros de un recurso.

Para obtener los registros de "centros.csv", invocaremos el servicio "get_resource_records":

[URL_BASE]/get_resource_records?resource_id=7f2eff7d-7f9f-41d3-8282-2b2660835bfe&prettyPrint=true

Esta invocación nos devolverá 100 (límite por defecto) registros del csv. Si observamos el resultado, el atributo "total" nos informa del número total de registros del recurso.

Para navegar por los resultados, existe la posibilidad de pedir distintos bloques de registros (tomando como referencia el actual): el siguiente, el anterior y el primero. De esta forma, se pueden paginar los resultados en bloques de 100 registros. Para ello, la API provee de los atributos "next", "prev" y "start", que son una url que se añade a la url base para obtener el bloque siguiente, anterior e inicial, respectivamente.

Por ejemplo, para el segundo bloque de 100 registros de "centros.csv":

[URL_BASE]/get_resource_records?offset=200&language=spanish&resource_id=7f2eff7d-7f9f-41d3-8282-2b2660835bfe&prettyPrint=true

• [URL_BASE]/get_resource_records?resource_id=7f2eff7d-7f9f-41d3-8282-2b2660835bfe&prettyPrint=true&limit=500

También tendremos la posibilidad de paginar los resultados, en este caso en bloques de 500 registros, en lugar de los bloques de 100 del ejemplo anterior. Por ejemplo, para obtener el segundo bloque de 500:

• [URL_BASE]/get_resource_records?offset=500&limit=500&language=spanish&resource_id=7f2eff7d-7f9f-41d3-8282-2b2660835bfe

Ejemplo 4: Obtener un registro concreto.

Cada registro que es devuelto se identifica con el atributo "_id". Para obtener únicamente los datos correspondientes a un solo registro, se filtran los resultados, pasando "_id" al parámetro "filters" del servicio "get_resource_records". Por ejemplo, para obtener el resultado del CEIP José Sánchez y Sánchez:

• [URL_BASE]/get_resource_records?resource_id=7f2eff7d-7f9f-41d3-8282-2b2660835bfe&prettyPrint=true&filters={"_id":"1"}

Ejemplo 5: Filtrando las búsquedas.

El parámetro "filters" del ejemplo anterior también sirve para filtrar los resultados por otros campos. Así por ejemplo, si quisiéramos obtener los centros educativos pertenecientes a la provincia de Las Palmas tendríamos que construir la siguiente URL:

• [URL_BASE]/get_resource_records?resource_id=7f2eff7d-7f9f-41d3-8282-2b2660835bfe&prettyPrint=true&filters={"Provincia":"Las Palmas"}

Podemos agregar más condiciones a los filtros. Por ejemplo, si quisiéramos conocer los centros educativos privados de Las Palmas, la URL sería:

• [URL_BASE]/get_resource_records?resource_id=7f2eff7d-7f9f-41d3-8282-2b2660835bfe&prettyPrint=true&filters={"Provincia":"Las Palmas","Naturaleza":"Privado"}

Ejemplo 6: Ordenando los resultados.

Por último, vamos a ordenar los resultados mediante el parámetro "sort". En este caso vamos a ordenar los resultados por denominación. La URL sería:

• [URL_BASE]/get_resource_records?resource_id=7f2eff7d-7f9f-41d3-8282-2b2660835bfe&prettyPrint=true&filters={"Provincia":"Las Palmas","Naturaleza":"Privado"}&sort=Denominación