CEPALSTAT WEB SERVICES/API
 

En esta sección, el usuario desarrollador de aplicaciones encontrará la información técnica necesaria para acceder a toda la información estadística disponible en las bases de datos integradas de CEPALSTAT (datos y metadatos) a través del uso de la interfaz de programación de aplicaciones API (Application Programming Interface).

De esta manera, la CEPAL abre su base de datos BDI-CEPALSTAT, permitiendo el acceso automatizado a los datos en el marco del enfoque Open Data cada vez más utilizado e implementado entre los organismos de producción y difusión de información estadística pública.

Se espera que la implementación de esta nueva forma de acceso a la información estadística de CEPAL promueva el uso de las estadísticas regionales comparables con el fin de propender al desarrollo de políticas públicas informadas.

Acerca de los datos

El modelo de datos utilizado en BDI-CEPALSTAT identifica al indicador como el escalón básico y primario dentro de la estructura de datos. El modelo permite que cada indicador defina sus propias dimensiones así como la cantidad de las mismas.

Desde el punto de vista estructural de datos, un indicador simplemente es un arreglo multidimensional, entendiéndose así que los datos pertenecen al espacio multidimensional del indicador. Esto significa que todos y cada uno de los datos que pertenecen a un indicador serán siempre calificados por una n-upla donde n es el número de dimensiones del indicador.

Los indicadores se clasifican en un árbol temático multinivel donde los nodos "hojas" del árbol temático corresponden a los indicadores.

En BDI-CEPALSTAT los datos tienen metadatos, esto significa que los datos numéricos están acompañados de información esencial no-numérica, que los define, califica y complementa. La metadata se asocia a los datos en tres niveles: a nivel estructural, a nivel del indicador y a nivel del dato.

La metadata a nivel estructural define cuántas dimensiones tiene el indicador y cuáles son estas dimensiones, esto es, cuáles son sus desagregaciones.

La metadata a nivel de indicador (asociada a todos los datos de un indicador) se compone del texto de descripción (título) del indicador, texto de definición del indicador, unidad de medida, la metodología de cálculo y comentarios.

La metadata a nivel de dato se refiere a la fuente del dato, aunque en la mayoría de los casos todos los datos de un indicador tienen la misma fuente. Sin embargo y a pesar de dicha generalidad, en BDI-CEPALSTAT es posible definir una fuente distinta para cada dato, asociando cada dato a su propia fuente. También los metadatos en este nivel permiten asociar a cada dato un texto que lo califique, por ejemplo una nota que especifique cifras preliminares. El modelo es restringido en el primer caso (cada dato tiene solo una fuente) y amplio en el segundo (puede tener una o más notas).

Documentación API

webservices REST:

Acceso a la clasificación de los indicadores de CEPALSTAT
getThematicTree
http://interwp.cepal.org/sisgen/ws/cepalstat/getThematicTree.asp
retorna la clasificación temática completa de todos los indicadores disponibles en BDI-CEPALSTAT
Existe un parámetro incluyeLinks = { "si", "no" }, que retorna el árbol temático incluyendo enlaces a páginas de contenido estadístico externas a BDI-CEPALSTAT.
Opcionalmente acepta el parámetro language = { "spanish", "english" }, el default es inglés.
Por ejemplo: http://interwp.cepal.org/sisgen/ws/cepalstat/getThematicTree.asp?language=spanish
retorna la clasificación completa de todos los indicadores disponibles en BDI-CEPALSTAT en español.
En la imagen se destaca la estructura de árbol de la clasificación temática de BDI-CEPALSTAT, por ejemplo el indicador "Proporción de las áreas terrestres protegidas", cuyo idIndicator es igual a 2013, pertenece al subtema "Aréas protegidas" que pertenece al subtema "Biota" el cual a su vez pertenece al tema "Estadísticas e Indicadores Ambientales".
El atributo IdIndicator identifica al indicador, es este número el que debe ser usado en los webservices que siguen para recuperar por ejemplo las dimensiones del indicador con el webservice getDimensions y los datos y/o metadatos del indicador con el webservice getDataMeta o getDataWithoutMeta.
Descripción de los códigos de las dimensiones y desagregaciones de un indicador dado
getDimensions
http://interwp.cepal.org/sisgen/ws/cepalstat/getDimensions.asp?idIndicator=1
retorna todos los códigos y descripciones en inglés de las dimensiones y sus desagregaciones del indicador especificado en el parámetro idIndicator=1.
El parámetro idIndicator es requerido!
El código idIndicator se puede obtener con el webservice getThematicTree.
Opcionalmente acepta el parámetro language = { "spanish", "english" }, el default es inglés.
Por ejemplo: http://interwp.cepal.org/sisgen/ws/cepalstat/getDimensions.asp?idIndicator=1&language=spanish
retorna todos los códigos y descripciones en español de las dimensiones y sus desagregaciones del indicador especificado en el parámetro idIndicator=1.

sdmx_structure
http://interwp.cepal.org/sisgen/ws/cepalstat/sdmx_structure.asp?idIndicator=1
retorna metadatos estructurales del indicador en formato SDMX [versión 2.1 - 2013] (una iniciativa para fomentar las normas para el intercambio de información estadística. Patrocinado por BIS - BCE - EUROSTAT - FMI - OCDE - ONU - Banco Mundial).
Análogamente a getDimensions, acepta los mismos parámetros y retorna las dimensiones y desagregaciones del indicador, adicionalmente también se incluyen aquí las fuentes y las notas asociadas al indicador.
En BDI_CEPALSTAT los indicadores tienen un número indeterminado de dimensiones, en el caso del indicador 1 se definen 3 dimensiones: la dimensión "Sex" identificada por el número "144", la dimensión "Country" identificada por el número "208" y la dimensión "Years" identificada por el número "29117".
Cada dimension tiene sus desagregaciones identificadas también por un número, por ejemplo la dimension "Sex" tiene tres desagregaciones: la desagregación "Both sexes" identificada por el número "146", la desagregación "Men" identificada por el número "265" y la desagregación "Women" identificada por el número "266".
La imagen muestra los números identificadores de las desagregaciones de las otras dimensiones del indicador.
Estos números identificadores se usan en los webservices que siguen para recuperar los datos y/o metadatos del indicador con el webservices getDataMeta o getDataWithoutMeta.
El resultado XML tiene solo un item principal: dimensions.

El item dimensions tiene los siguientes subitems:
        dim contiene la descripción e identificador de la dimensión. Hay uno de estos subitems dim por cada dimensión del indicador.
        des contiene la descripción de la desagregación (atributo name), el identificador de la desagregación (atributo id) y un parámetro (atributo in)
        que indica si la desagregación está o no presente en los datos del indicador almacenado en la base de datos.
        Cada subitem dim puede contener uno o más subitems des que corresponden a las desagregaciones de la dimensión.


Acceso a los datos y metadatos
getDataMeta
http://interwp.cepal.org/sisgen/ws/cepalstat/getDataMeta.asp?
IdIndicator=1&language=spanish&dim_144=146&dim_208=222&dim_29117=29180,29185

retorna datos con metadatos, esto es, junto a los datos numéricos este webservice retorna información sobre estructura dimensional, metodología de cálculo, comentarios, fuentes y notas.
El parámetro idIndicator es requerido!
El código idIndicator se puede obtener con el webservice getThematicTree.
Opcionalmente acepta el parámetro language = { "spanish", "english" }, el default es inglés.
Este webservice, además de los parámetros idIndicator (que identifica al indicador) y language (que especifica el lenguaje del resultado) requiere de los parámetros que identifican las dimensiones y sus desagregaciones.
Por ejemplo, en el query que se muestra arriba se usan 3 parámetros del tipo dim_[id_dimension]=[id_desagregacion],[id_desagregacion],...
dim_144=146
dim_208=222
dim_29117=29180,29185
Los números que acompañan al prefijo dim_ son los identificadores de las dimensiones del indicador especificado en el parámetro idIndicator.
dim_144 se refiere a la dimensión "Sex"
dim_208 se refiere a la dimensión "Country"
dim_29117 se refiere a la dimensión "Years"
Los números que se especifican después de los signos igual corresponden a los identificadores de las desagregaciones que se está solicitando.
Note que cuando no se especifica una dimensión en un query string, esto es interpretado por el webservice como si se hubiese especificado todas las desagregaciones de la dimensión omitida. Es más, si Ud. no especifica ninguna dimensión en el query string se obtienen todos los datos de ese indicador.
En palabras, el query del ejemplo anterior está solicitando los datos del indicador cuyo idIndicator es igual a 1 que sean "Both sexes" (dim_144=146) de "Brazil" (dim_208=222) de los años "2010 y 2015" (dim_29117=29180,29185).

El resultado XML tiene los siguientes 5 items principales: metadatos, datos, dimensions, notas y fuentes.

El item metadatos tiene los siguientes atributos:
        idIndicator contiene el número identificador del indicador.
        indicador contiene la descripción del indicador.
        tema contiene la descripción del tema principal al que pertenece el indicador.
        area contiene la descripción del area al que pertenece el indicador.
        nota si la hay, contiene la descripción de alguna nota asociada al indicador.
        unidad contiene la unidad de medida de todos los datos del indicador.
        definicion contiene la definición del indicador.
        metodologia_calculo contiene la metodología que se usa para producir el indicador.
        comentarios contiene comentarios acerca del indicador.

El item datos tiene tantos subitems dato como datos haya recuperado el webservice.
El item dato tiene los siguientes atributos:
        dim_[id_dimension]=[id_desagregacion], hay uno de estos atributos por cada dimension del indicador,
        donde id_dimension es el identificador de una dimension del indicador y id_desagregacion es el identificador de la desagregación que califica el dato.
        id_fuente contiene el identificador de la fuente asociada al dato.
        ids_notas contiene los identificadores de las notas asociadas al dato, si el dato tiene más de una nota los identificadores se separan por coma.
        iso3 contiene el código iso3 del dato, si es que este dato tiene alguna desagregación que se refiera a algún país.
        valor contiene el valor.

El item dimensions tiene los siguientes subitems:
        dim contiene la descripción e identificador de la dimensión. Hay uno de estos subitems dim por cada dimensión del indicador.
        des contiene la descripción de la desagregación (atributo name), el identificador de la desagregación (atributo id) y un parámetro (atributo in)
        que indica si la desagregación está o no presente en los datos del resultado de la consulta actual.
        Cada subitem dim puede contener uno o más subitems des que corresponden a las desagregaciones de la dimensión.

El item notas tiene tantos subitems nota como notas asociadas a los datos haya recuperado el webservice.
El item nota tiene los siguientes atributos:
        id contiene el identificador de la nota.
        descripcion contiene la descripción de la nota.

El item fuentes tiene tantos subitems fuente como fuentes asociadas a los datos haya recuperado el webservice.
El item fuente tiene los siguientes atributos:
        id contiene el identificador de la fuente.
        descripcion contiene la descripción de la fuente.
        si la tiene, url_publicacion contiene la dirección internet de la fuente directa.
        nombre_organismo contiene el nombre de la organización a la que pertenece la fuente.
        sigla_organismo contiene la sigla de la organización a la que pertenece la fuente.
        si la tiene, url_organizacion contiene la dirección intenet del sitio de la organización a la que pertenece la fuente.


Acceso a los datos sin metadatos
getDataWithoutMeta
http://interwp.cepal.org/sisgen/ws/cepalstat/getDataWithoutMeta.asp?
IdIndicator=1&language=spanish&dim_144=146&dim_208=222&dim_29117=29180,29185

retorna datos numéricos sin metadatos, esto es, sin información sobre la estructura dimensional del indicador, sin metodología de cálculo, sin comentarios, sin fuentes ni notas. Sí retorna la descripción y la unidad de medida del indicador.
El parámetro idIndicator es requerido!
El código idIndicator se puede obtener con el webservice getThematicTree.
Opcionalmente acepta el parámetro language = { "spanish", "english" }, el default es inglés.
Este webservice, además de los parámetros idIndicator (que identifica al indicador) y language (que especifica el lenguaje del resultado) requiere de los parámetros que identifican las dimensiones y sus desagregaciones.
Por ejemplo, en el query que se muestra arriba se usan 3 parámetros del tipo dim_[id_dimension]=[id_desagregacion],[id_desagregacion],...
dim_144=146
dim_208=222
dim_29117=29180,29185
Los números que acompañan al prefijo dim_ son los identificadores de las dimensiones del indicador especificado en el parámetro idIndicator.
dim_144 se refiere a la dimensión "Sex"
dim_208 se refiere a la dimensión "Country"
dim_29117 se refiere a la dimensión "Years"
Los números que se especifican después de los signos igual corresponden a los identificadores de las desagregaciones que se está solicitando.
Note que cuando no se especifica una dimensión en un query string, esto es interpretado por el webservice como si se hubiese especificado todas las desagregaciones de la dimensión omitida. Es más, si Ud. no especifica ninguna dimensión en el query string se obtienen todos los datos de ese indicador.
En palabras, el query del ejemplo anterior está solicitando los datos del indicador cuyo idIndicator es igual a 1 que sean "Both sexes" (dim_144=146) de "Brazil" (dim_208=222) de los años "2010 y 2015" (dim_29117=29180,29185).
sdmx_dataset
http://interwp.cepal.org/sisgen/ws/cepalstat/sdmx_dataset.asp?IdIndicator=1&language=spanish&dim_144=146&dim_208=222&dim_29117=29180,29185
retorna datos del indicador en formato SDMX [versión 2.1 - 2013] (una iniciativa para fomentar las normas para el intercambio de información estadística. Patrocinado por BIS - BCE - EUROSTAT - FMI - OCDE - ONU - Banco Mundial).
Análogamente a getDataWithoutMeta, acepta los mismos parámetros y retorna los datos del indicador, incluyendo aquí los identificadores de fuentes y notas asociadas a cada dato. Las listas de códigos de las dimensiones, fuentes y notas se encuentran usando el webservice sdmx_structure, del cual ya se incluye una referencia explícita en el archivo de datos retornado.
El resultado XML tiene solo el item: datos.

El item datos tiene tantos subitems dato como datos haya recuperado el webservice.
El item datos tiene los siguientes atributos:
        idIndicator contiene el número identificador del indicador.
        indicador contiene la descripción del indicador.
        unidad contiene la unidad de medida de todos los datos del indicador.
El item dato tiene los siguientes atributos:
        dim_[id_dimension]=[id_desagregacion], hay uno de estos atributos por cada dimension del indicador,
        donde id_dimension es el identificador de una dimension del indicador y id_desagregacion es el identificador de la desagregación que califica el dato.
        iso3 contiene el código iso3 del dato, si es que este dato tiene alguna desagregación que se refiera a algún país.
        valor contiene el valor.

WEBSERVICES MISCELÁNEOS / MISCELLANEOUS
getDataAvailability.asp
http://interwp.cepal.org/sisgen/ws/cepalstat/getDataAvailability.asp?
idIndicator=1&dim_208=222&dim_29117=ret&language=spanish

retorna todas las desagregaciones con datos de una dimensión, para una desagregación dada de otra dimensión del indicador. Este web service se usa generalmente para saber los años disponibles (que tienen datos) para un país dado.
Ejemplo: el indicador 1 tiene 3 dimensiones (esto se puede saber usando el webservice getDimensions explicado más arriba) de las cuales la dim_208 corresponde a la dimensión de Países y el valor 222 corresponde al código del país Brasil, por otro lado, la dimensión dim_29117 corresponde a la dimensión de años, así lo que se está requiriendo al webservice getDataAvailability, en este ejemplo, es la disponibilidad de años con datos que tiene el país Brasil en el indicador 2137.
Note que, en el enlace del ejemplo, el parámetro dim_29117 tiene el valor "ret", esto indica al webservice que esta es la dimensión para la cual se retornaran las desagregaciones disponibles.

getIndicatorMeta.asp
http://interwp.cepal.org/sisgen/ws/cepalstat/getIndicatorMeta.asp?idIndicator=1&language=spanish
retorna metadatos, tales como metodología de cálculo, comentarios, definición, asociados al indicador.

getDataWithSourceAndFootnotes.asp
http://interwp.cepal.org/sisgen/ws/cepalstat/getDataWithSourceAndFootnotes.asp?idIndicator=1
&language=spanish&dim_144=146&dim_208=222&dim_29117=29180,29185

retorna datos con las descripciones de fuentes y notas asociadas a los datos retornados.

getIndicatorSources.asp
http://interwp.cepal.org/sisgen/ws/cepalstat/getIndicatorSources.asp?idIndicator=1&language=spanish
dado el identificador del indicador, retorna las descripciones de las fuentes.

getSources.asp
http://interwp.cepal.org/sisgen/ws/cepalstat/getSources.asp?ids=1,2,3,4,5,6,7,8,9&language=spanish
dados los identificadores de las fuentes, retorna las descripciones de las fuentes.
getFootnotes.asp
http://interwp.cepal.org/sisgen/ws/cepalstat/getFootnotes.asp?ids=1,2,3,4,5,6,7,8,9&language=spanish
dados los identificadores de las notas ("pie de página"), retorna las descripciones de las notas.

Términos y condiciones

El uso de las bases de datos de CEPALSTAT y los desarrollos API está bajo el amparo de los Términos y condiciones aquí descritos.

 
CEPALSTAT
© Naciones Unidas, 2000-2017 | Términos y condiciones