INFRAESTRUCTURA ESTADÍSTICA

API DE ACCESO A LOS DATOS DE ISTAC.baseGUÍA DE USO PARA DESARROLLADORES

INFRAESTRUCTURA ESTADÍSTICAAPI de acceso a los datos de ISTAC.base Guía de uso para desarrolladores.

Elaboración y edición:Instituto Canario de Estadística

Luis Doreste Silva, 101 - Planta 7.35004 Las Palmas de Gran Canaria.Tlf.: 928 290 062 - Fax: 928 243 354

Rambla de Santa Cruz, 14938001 Santa Cruz de TenerifeTlf.: 922 922 801 - Fax: 922 475 004

Servidor Web:http://www.gobiernodecanarias.org/istac

E-mail:istac@gobiernodecanarias.org

Licencia:Este documento se distribuye bajo Licencia de Reconocimiento 3.0 de Creative Commons.

Texto legal: http://creativecommons.org/licenses/by/3.0/es/legalcode.es

INFRAESTRUCTURA ESTADÍSTICA

API DE ACCESO A LOS DATOS DE ISTAC.baseGUÍA DE USO PARA DESARROLLADORES

Sumario

¿Qué es ISTAC.base? /7Acceso a ISTAC.base /7

Información de acceso a los datos /7

Formatos de respuesta del acceso a los datos /9Formato PX /9Google Visualization /9JSON /11

URL de acceso a los datos /15Descarga /15Consulta /15

¿Qué es ISTAC.base?ISTAC.base es el sistema principal que utiliza el Instituto Canario de Estadística (ISTAC) para el almacenamiento y difusión de las estadísticas de la Comunidad Autónoma de Canarias. En ese sentido, en ISTAC.base se incluye la mayor parte de la información que el ISTAC produce, sistematiza o difunde.

ISTAC.base responde a los siguientes objetivos:

1. Disponer de una base de datos con estadísticas accesibles por Internet.

2. Establecer un sistema de publicación digital a medida, sin limitación en la cantidad de datos a ofrecer y sin renunciar a los componentes más típicos de las tablas estructura-das de una publicación estadística.

3. Incorporar ficheros en un formato tratable común que incluyan información numéri-ca y metadatos asociados con el objetivo de documentar claramente la información numérica.

4. Proporcionar un canal de difusión de datos de utilidad estadística complementario a otros formatos que permita el acceso a series históricas de información estadística.

5. Utilizar formatos homogéneos con otros productores de estadísticas.

6. Ofrecer más información, más rápida y con mayor calidad en datos y metadatos.

7. Facilitar una herramienta útil, rápida y económica para la disponibilidad de series estadísticas.

Acceso a ISTAC.base

Los datos de ISTAC.base se pueden consultar mediante los principales navegadores Web del mercado, para ello usamos el aplicativo JAXI. Si lo desea, puede consultar el video-tutorial so-bre cómo acceder y usar JAXI accediendo a la siguiente dirección:

https://www.youtube.com/watch?feature=player_embedded&v=2rlhozWM42Y

Información de acceso a los datosCuando en el JAXI accedemos a cualquier publicación nos aparece una relación de tablas, agru-padas en capítulos, que forman parte de la publicación que está siendo consultada.

Alineado a la parte izquierda de cada tabla aparece un icono que cuando cliqueamos nos mues-

INFRAESTRUCTURA ESTADÍSTICA. API de acceso a los datos de ISTAC.base. Guía de uso para desarrolladores.8

tra un panel que nos proporciona información relativa a los medios disponibles para llevar a cabo la descarga de los datos asociados a la tabla.

Este panel nos proporciona la siguiente información relativa a la descargar:

• Identificador del archivo

Se trata del identificador unívoco del archivo que además nos permite contextualizar al mismo.

El identificador se construye de la siguiente manera:

- Los siete primeros caracteres indican el código de la operación estadística.

- Los siguientes tres caracteres indican el tipo de recurso del que se trata. El tipo DSC es usado para Datasets.

Los siguientes cuatro caracteres son el indicador del recurso dentro de la operación estadística.

Los últimos seis caracteres siempre comienzan por “V” e indican la versión del recurso.

• Fecha de última actualización

Indica la fecha en la que se actualizó por última vez el recurso.

• Tamaño del archivo

Indica el tamaño del archivo a descargar.

• Número de datos

Indica el número de observaciones que contiene el recurso.

• Número de variables

Indica el número de variables que existen en el recurso.

• Formatos de descarga

Indica los formatos en los que podemos llevar a cabo la descarga de los datos. Los posibles formatos son: .px, .gviz o .json. A continuación se explican cada uno de estos formatos.

Ilustración 1. Panel de información de descarga

9INFRAESTRUCTURA ESTADÍSTICA. API de acceso a los datos de ISTAC.base Guía de uso para desarrolladores.

Formatos de respuesta del acceso a los datos

Formato PX

Ficheros que siguen el estándar de facto PC-Axis. Puede obtener más información sobre este estándar en: http://www.scb.se/pc-axis

Google Visualization

En este caso se nos provee una URL en la que podemos acceder a un fichero que devuelve los datos según el protocolo de datasources para herramientas de gráficos de Google (v0.6). Está URL podríamos usarla para insertarla en una página web que haga uso de la Google Visualiza-tion API para mostrar los datos que se están devolviendo. A continuación se muestra un ejemplo de cómo se podría construir una página web que hiciera uso de la Google VisualiZation API para mostrar datos relativos a una consulta del ISTAC.

Partimos que de que la URL del ISTAC que contiene los datos que vamos a reutilizar es la siguiente:

http://www.gobiernodecanarias.org/istac/jaxi-istac/tabla.do?accion=gviz&uuidConsulta=66bd5331-52bc-4de5-ab0b-d51cee9ed434

El código de la página sería como sigue:

<!DOCTYPE html>

<html>

<head>

<title>Getting Started Example</title>

<!--Load the AJAX API-->

<script type=”text/javascript” src=”http://www.google.com/jsapi”></

script>

<script type=”text/javascript”>

//Load the Visualization API and the ready-made Google table

visualization

google.load(‘visualization’, ‘1’, {‘packages’:[‘table’,’barchart’]});

// Set a callback to run when the API is loaded.

google.setOnLoadCallback(init);

// Send the query to the data source.

function init() {

// Specify the data source URL.

var query = new google.visualization.Query(‘http://

www.gobiernodecanarias.org/istac/jaxi-istac/tabla.

do?accion=gviz&uuidConsulta=66bd5331-52bc-4de5-ab0b-d51cee9ed434’);

// Send the query with a callback function.

query.send(handleQueryResponse);

}

// Handle the query response.

function handleQueryResponse(response) {

if (response.isError()) {

INFRAESTRUCTURA ESTADÍSTICA. API de acceso a los datos de ISTAC.base. Guía de uso para desarrolladores.10

alert(‘Error in query: ‘ + response.getMessage() + ‘ ‘ + response.

getDetailedMessage());

return;

}

// Draw the visualization.

var data = response.getDataTable();

var chart = new google.visualization.LineChart(document.

getElementById(‘chart_div’));

chart.draw(data, {width: 1000, height: 640, title: ‘Expectativas de los

hoteleros sobre la marcha del negocio respecto al trimestre anterior’});

var table = new google.visualization.Table(document.

getElementById(‘table_div’));

table.draw(data, {width: 1000, showRowNumber: true});

}

</script>

</head>

<body>

<h1>Prueba con Google Visualization!!!</h1>

<!--Div that will hold the visualization-->

<div id=”chart_div”></div>

<div id=”table_div”></div>

</body>

</html>

El resultado que obtendríamos sería el siguiente:

Ilustración 2. Ejemplo de visualización con Google

Visualization

11INFRAESTRUCTURA ESTADÍSTICA. API de acceso a los datos de ISTAC.base Guía de uso para desarrolladores.

JSON

En este caso se nos provee una URL en la que podemos acceder a un fichero en formato JSON con la que podríamos ser capaces de obtener toda la información relevante que se muestra en la página de visualización de datos del JAXI (visualización HTML).

El fichero JSON que se devuelve tiene la siguiente información:

• Grupo de metadatos

UUID

- Identificador único del recurso que se está obteniendo.

TITLE

- Título del recurso que se está obteniendo.

URI_PX

- URI del PX al que está vinculado el recurso que se está obteniendo.

STUB

- Variables que van en la fila del dataset.

HEADING

- Variables que van en las columnas del dataset.

CATEGORIES

- Categorías (códigos y etiquetas) de cada una de las variables anteriormente definidas en el STUB y el HEADING.

TEMPORALS

- Variables que se corresponden con el cubrimiento temporal.

SPATIALS

- Variables que se corresponden con el cubrimiento geográfico.

CONT_VARIABLE

- Variable que actúa como dimensión de medida.

INFRAESTRUCTURA ESTADÍSTICA. API de acceso a los datos de ISTAC.base. Guía de uso para desarrolladores.12

SOURCE

- Organismo que elabora y produce el recurso.

SURVEY_CODE

- Código de la operación estadística en la que se publica el recurso.

SURVEY_TITLE

- Título de la operación estadística en la que se publica el recurso.

NOTES

- Notas del PX asociado.

PUBLISHERS

- Organismo que publica el recurso

Debe tener en cuenta que si par alguno de los metadatos anteriores no existe dato, este campo se omitiría en la respuesta.

• Datos

Se especifica el valor de la observación y posteriormente se fijan los valores de las dimensiones.

Ejemplo:

{

“Valor”:”9.99”,

“dimCodes”:[

“0”,

“ES70”,

“2012Q4”,

“3”

]

},

Ejemplo de respuesta JSON:

{

“uuid”:”66bd5331-52bc-4de5-ab0b-d51cee9ed434”,

“title”:”Expectativas de la marcha del negocio respecto al trimestre

anterior según categorías de los establecimientos por islas y periodos.”,

“uriPx”:”urn:uuid:d40899d9-2bd6-4f58-b3c4-0797dec9eadf”,

“stub”:[

“Categorías de los establecimientos”,

“Islas”

],

“heading”:[

“Periodos”,

“Expectativas de la marcha del negocio”

],

“categories”:[

{

“variable”:”Categorías de los establecimientos”,

13INFRAESTRUCTURA ESTADÍSTICA. API de acceso a los datos de ISTAC.base Guía de uso para desarrolladores.

“codes”:[

“0”,

“6”,

“7”

],

“labels”:[

“TOTAL CATEGORÍAS”,

“1, 2, 3 Estrellas”,

“4, 5 Estrellas”

]

},

{

“variable”:”Islas”,

“codes”:[

“ES70”,

“ES708”,

“ES704”,

“ES705”,

“ES709”,

“ES706”,

“ES707”,

“ES703”

],

“labels”:[

“CANARIAS”,

“Lanzarote”,

“Fuerteventura”,

“Gran Canaria”,

“Tenerife”,

“La Gomera”,

“La Palma”,

“El Hierro”

]

},

{

“variable”:”Periodos”,

“codes”:[

“2012Q4”,

“2012Q3”

],

“labels”:[

“2012 Cuarto trimestre”,

“2012 Tercer trimestre”

]

},

{

“variable”:”Expectativas de la marcha del negocio”,

“codes”:[

“1”,

“2”,

“3”,

“0”

],

“labels”:[

“Favorable”,

“Normal”,

INFRAESTRUCTURA ESTADÍSTICA. API de acceso a los datos de ISTAC.base. Guía de uso para desarrolladores.14

“Desfavorable”,

“SALDO”

]

}

],

“temporals”:[

“Periodos”

],

“spatials”:[

“Islas”

],

“contVariable”:”Expectativas de la marcha del negocio”,

“source”:”Instituto Canario de Estadística (ISTAC).”,

“surveyCode”:”C00030A”,

“surveyTitle”:”Encuesta de Expectativas Hoteleras”,

“publishers”:[

“Instituto Canario de Estadística (ISTAC)”

],

“data”:[

{

“Valor”:”25.06”,

“dimCodes”:[

“0”,

“ES70”,

“2012Q4”,

“1”

]

},

{

“Valor”:”64.94”,

“dimCodes”:[

“0”,

“ES70”,

“2012Q4”,

“2”

]

},

{

“Valor”:”9.99”,

“dimCodes”:[

“0”,

“ES70”,

“2012Q4”,

“3”

]

},

…

]

}

15INFRAESTRUCTURA ESTADÍSTICA. API de acceso a los datos de ISTAC.base Guía de uso para desarrolladores.

URL de acceso a los datosPodemos interactuar con los datos de dos maneras distintas: descarga o consulta.

Descarga

El formato de descarga existente es el archivo PX. La dirección de descarga es la siguiente:

http://<url_servidor>/jaxi-istac/descarga.do?uripx=<URI_PX>

Donde el parámetro “uripx” espera la URI del PX que deseamos descargar.

Ejemplo:

http://www.gobiernodecanarias.org/istac/jaxi-istac/descarga.do?uripx=urn:uuid:d40899d9-2bd6-4f58-b3c4-0797dec9eadf

Consulta

La dirección de acceso/consulta es la misma en todos los casos:

http://<url_servidor>/jaxi-istac/tabla.do

Más dos parámetros en la URL:

• uuidConsulta

Identificador único para cada consulta.

• accion

Indica el formato en el que se desean consultar los datos.

Los posibles valores de este parámetro son:

- html: Indica que el formato de salida es la página de datos de JAXI. Ejemplo: http://www.gobiernodecanarias.org/istac/jaxi-istac/tabla.do?accion=html&uuidConsulta=75664a50-b3af-4c0a-9af1-36a6e10c02ce

- jsonMtd: Indica que el formato de salida es el JSON que incluye metadatos y datos. Ejemplo: http://www.gobiernodecanarias.org/istac/jaxi-istac/tabla.do?accion=jsonMtd&uuidConsulta=75664a50-b3af-4c0a-9af1-36a6e10c02ce

- gviz: Indica que el formato de salida es el fichero JSON que sólo devuelve da-tos y está preparado para que pueda ser usado por la Google Visualization API. Ejemplo: http://www.gobiernodecanarias.org/istac/jaxi-istac/tabla.do?accion=gviz&uuidConsulta=75664a50-b3af-4c0a-9af1-36a6e10c02ce