Documentación de la API REST

Para acceder a la API es necesario disponer de una clave de acceso proporcionada por el administrador (Use el formulario de contacto ). Una vez tenga su clave de acceso, deberá añadir esa clave como parámetro de cada consulta. A lo largo de la descripción de esta API se van a incluir diversos ejemplos que utilizan esta clave en las consultas, por lo que más adelante se podrá comprobar como funciona. La API REST se compone de diversas URLs de acceso o end-points que permiten consultar los elementos que en ellas se exponen. Entre esos elementos se encuentran variables, indicadores o mecanismos de cosulta para generar ficheros o respuestas jSON, el cuál es un formato típico en el que se reciben las respuestas de las consultas.

Servicios implementados en la API REST

  • Obtener indicadores - Parámetros: API_KEY. Respuesta JSON

    /api/v2/indicador?API_KEY=CLAVE_API

  • Obtener indicador - Parámetros: CODIGO_INDICADOR, API_KEY. Respuesta JSON

    /api/v2/indicador?codigo=NOMBRE_INDICADOR&API_KEY=CLAVE_API

  • Obtener variables - Parámetros: API_KEY. Respuesta JSON

    /api/v2/variable?API_KEY=CLAVE_API

  • Obtener variable - Parámetros: NOMBRE_VARIABLE, API_KEY

    /api/v2/variable?nombre=NOMBRE_VARIABLE&API_KEY=CLAVE_API

  • Obtener datos - Parámetros: [INDICADORES], [SEXOS], [CCAAs], [AÑOS], [EDUCATIVO], [CLASE], [INGRESOS] API_KEY. Respuesta JSON

    /api/v2/datos?indicador=[INDICADORES]&sexo=[SEXOS]&ccaa=[CCAAs]&anio=[AÑOS]&educativo=[EDUCATIVO]&ingresos=[INGRESOS]&clase=[CLASE]&API_KEY=CLAVE_API

En el siguiente ejemplo, tanto el indicador, como la CCAA, el sexo, el año, el nivel educativo, el niveld e ingresos y la clase social, son parámetros por los que se pueden consultar uno o más valores. Para hacerlo, solo hay que repetir el parámetro en la consulta pero con un valor diferente. En el caso de ccaa=andalucia y ccaa=cantabria repetimos ccaa pero con valores distintos. Si queremos buscar todos los valores para una variable sin tener que ponerlos todos explícitamente, el parámetro iría vacío. Por ejemplo: si queremos buscar todas las comunidades autónomas, el parámetro sería ccaa=. Si se introducen valores que no son válidos, la API responderá en formato JSON con el error que ha causado que no funcione la consulta. 

  • /api/v2/datos?indicador=1000&sexo=total&ccaa=andalucia&ccaa=cantabria&anio=2013&anio=2014&API_KEY=CLAVE_API

  • Obtener datos - Parámetros: [INDICADORES], [SEXOS], [CCAAs], [AÑOS], [EDUCATIVO], [INGRESOS], [SOCIAL], API_KEY. Respuesta CSV

    /api/v2/datos/csv?indicador=[INDICADORES]&sexo=[SEXOS]&ccaa=[CCAAs]&anio=[AÑOS]&educativo=[EDUCATIVO]&ingresos=[INGRESOS]&social=[SOCIAL]&API_KEY=CLAVE_API

  • Obtener gráfica - Parámetros: [indicador], [sexo], [ccaa], [anio], [economico], [ingresos], [social], [abscisas], API_KEY. Respuesta JSON

    /api/v2/datos/grafica?indicador=[INDICADOR]&anio=[AÑO]&sexo=[SEXO]&ccaa=&educativo=[EDUCATIVO]&ingresos=[INGRESOS]&social=[SOCIAL]&abscisas=ccaa&API_KEY=CLAVE_API

Caso de uso: utilizar la API en javascript

El siguiente ejemplo muestra como utilizar el servicio de gráficas usando jQuery y NVD3. El servicio de gráficas está preparado para que NVD3 procese su respuesta sin que se requiera modificar de forma alguna los datos. Para pintar la gráfica es necesario crear un DIV HTML con id=chart y en su interior un bloque SVG vacío. Para este ejemplo se han utilizado los siguientes parámetros:

  • Indicador: Indicador población total
  • Año: último disponible
  • CCAA: todas
  • Sexo: total
  • Nivel educativo: total
  • Nivel de ingresos: total
  • Clase social: total
  • Abscisas: ccaa
  • Ordenadas: Valor del indicador población total.

	<div id="chart">
		<svg></svg>
	</div>
Contacto
Términos de uso
Administrador