Acerca de la API de los indicadores
La interfaz de programación de aplicaciones (API) de los indicadores de ONU-Agua proporciona acceso a los datos acumulados a través de diversas fuentes. La mayoría de estos indicadores están disponibles en línea. La API proporciona un acceso programático a estos mismos datos. Muchas series de datos se remontan a hace más de 50 años y pueden utilizarse para crear aplicaciones interesantes.
La API de los indicadores proporciona acceso a bases de datos, entre ellas las siguientes:
- OMS
- PNUD
- UNICEF
- FAO
- Y muchas otras
Utilización de la API de los indicadores
Por ejemplo: https://sdg6data.org/api/indicator/6.1.1?_format=json
Además de hacer llamadas a la API utilizando una aplicación o un programa personalizado, usted también puede poner en un navegador web cualquiera de los puntos de conexión de la URL de la API de ejemplo que se dan en la documentación, o sus propias llamadas personalizadas, y ver los resultados. Si opta por recibir el resultado en formato JSON, puede utilizar el complemento de Firefox JSON View para ver fácilmente los resultados en JSON directamente en ese navegador.
También hay aplicaciones y bibliotecas de terceros que pueden facilitarle el uso de la API en función de sus objetivos.
Compruebe la siguiente estructura de llamada de Basic:
La documentación de la API que aparece a continuación muestra cómo se puede acceder a estos datos para utilizarlos dentro de su aplicación.
https://sdg6data.org/api/indicator/{indicator_code}?_format=xml
Parámetros de la solicitud:
{indicator_code} – Puede ser cualquier código de indicador del ODS 6. El código del indicador es una parte de la URL de la API y es obligatorio pasarlo en la llamada a la API.
https://sdg6data.org/api/indicator/6.1.1?_format=xml
La URL anterior devolverá datos para todos los años y todos los países del 6.1.1.
_format : El formato de salida. La API admite dos formatos: xml o json. Este parámetro es obligatorio según los estándares RESTful Web Services de Drupal 8.
https://sdg6data.org/api/indicator/6.1.1?_format=xml
https://sdg6data.org/api/indicator/6.1.1?_format=json
per_page : número de resultados por página, para la paginación del conjunto de resultados. El valor por defecto es 50.
https://sdg6data.org/api/indicator/6.1.1?_format=xml&per_page=20
page – parámetro de utilidad para la paginación en un conjunto de resultados grande. Indica el número de páginas solicitadas del conjunto de registros.
https://sdg6data.org/api/indicator/6.1.1?_format=xml&page=2
date – intervalo de fechas por año, mes o trimestre que abarca el conjunto de resultados. El intervalo se indica mediante el separador de dos puntos.
https://sdg6data.org/api/indicator/6.1.1?_format=xml&date=2000:2001
Mostrar todos los datos del indicador utilizando la consulta del indicador con parámetros de varios países
https://sdg6data.org/api/indicator/6.1.1?_format=json&country=CAN,ALB
Mostrar todos los datos del indicador utilizando la consulta del indicador
https://sdg6data.org/api/indicator/all?_format=json
Consultas de indicadores a la API
Los indicadores representan datos como las superficies nacionales, urbanas y rurales, la disponibilidad y el uso del agua, la gestión de los recursos hídricos, el número de muertes, el número de personas desaparecidas y muchos más. Las consultas de indicadores devuelven la siguiente información en la respuesta:
- Goal (Objetivo)
- Target (Meta)
- Indicator (Indicador)
- SeriesCode (Código de serie)
- SeriesDescription (Descripción de la serie)
- GeoAreaType (Tipo de área geográfica)
- GeoAreaName (Nombre del área geográfica)
- GeoAreaCode (Código del área geográfica)
- TimePeriod (Periodo de tiempo)
- Value (Valor)
- Time_Detail (Detalle de tiempo)
- Source (Fuente)
- FootNote (Nota al pie)
- Nature (Naturaleza)
- Units (Unidades)
- Age (Edad)
- Bounds (Límites)
- Frequency (Frecuencia)
- Level_Status (Estado de nivel)
- Location (Ubicación)
- Reporting_Type (Tipo de notificación)
- Sex (Sexo)
Ejemplo de formato de solicitud: Consulta de indicadores
Para solicitar todos los indicadores: https://sdg6data.org/api/indicator/all?_format=json
Para solicitar el indicador 6.1.1, utilice su código de indicador,
6.1.1
Ejemplo de formato de respuesta: Consulta de indicadores
<response> <item key="0"> <page>0</page> <pages>11593</pages> <per_page>50</per_page> <total>579635</total> </item> <item key="1"> <item key="0"> <Goal/> <Target/> <Indicator>6.1.1 </Indicator> <SeriesCode/> <SeriesDescription>Agua potable, por lo menos servicio básico</SeriesDescription> <GeoAreaType>País</GeoAreaType> <GeoAreaName>ABW</GeoAreaName> <GeoAreaCode>533</GeoAreaCode> <TimePeriod>2000</TimePeriod> <Value>94.488806355508</Value> <Time_Detail/> <Source>OMS, UNICEF</Source> <FootNote/> <Nature/> <Units/> <Age/> <Bounds/> <Frequency/> <Level_Status/> <Location>Nacional</Location> <Reporting_Type/> <Sex/> <SDG_6_Data_Portal_level><![CDATA]6.1.1 Proporción de la población que utiliza servicios de suministro de agua potable gestionados sin riesgos (%) > Por lo menos básico > Nacional
[{ "page":0, "pages":11593, "per_page":50, "total":579635 }, [{ "Goal":null, "Target":null, "Indicator":"6.1.1", "SeriesCode":null, "SeriesDescription":"Agua potable, por lo menos servicio básico", "GeoAreaType":"País", "GeoAreaName":"ABW", "GeoAreaCode":"533", "TimePeriod":"2000", "Value":"94.488806355508", "Time_Detail":null, "Source":"OMS, UNICEF", "FootNote":null, "Nature":null, "Units":null, "Age":null, "Bounds":null, "Frequency":null, "Level_Status":null, "Location":"Nacional", "Reporting_Type":null, "Sex":null, "SDG_6_Data_Portal_level":"6.1.1 Proporción de la población que utiliza servicios de suministro de agua potable gestionados sin riesgos (%) \u003E Por lo menos servicio básico \u003E Nacional" }] ]Ejemplo de formato de respuesta: Consulta de indicadores con filtro de país:
[{"page":0, "pages":2804, "per_page":50, "total":140199}, [{"Goal":null, "Target":null, "Indicator":"6.1.1", "SeriesCode":null, "SeriesDescription":"Agua potable, por lo menos servicio básico", "GeoAreaType":"País", "GeoAreaName":"ABW", "GeoAreaCode":"533", "TimePeriod":"2000", "Value":"94.488806355508", "Time_Detail":null, "Source":"OMS,UNICEF", "FootNote":null, "Nature":null, "Units":null, "Age":null, "Bounds":null, "Frequency":null, "Level_Status":null, "Location":"Nacional", "Reporting_Type":null, "Sex":null, "SDG_6_Data_Portal_level":"6.1.1 Proporción de la población que utiliza servicios de suministro de agua potable gestionados sin riesgos (%) \u003E Por lo menos servicio básico \u003E Nacional"}]Puede descargar la lista de países con los códigos ISO3 aquí
Acceso a la API / Autenticación
Ya no hacen falta las claves de la API ni otros métodos de autenticación para acceder a la API.