Об API показателей
API показателей Механизма «ООН-Водные ресурсы» обеспечивает доступ к данным, накопленным из различных источников. Большинство из этих показателей доступны в формате онлайн. API предоставляет программный доступ к этим данным. Многие ряды данных охватывают более 50 лет и могут быть использованы для создания полезных приложений.
API показателей обеспечивает доступ к базам данных, в том числе базам данных:
- ВОЗ
- ПРООН
- ЮНИСЕФ
- ФАО
- и многих других организаций
Как использовать API показателей
Например: https://sdg6data.org/api/indicator/6.1.1?_format=json
Помимо выполнения вызовов API с помощью приложения или пользовательской программы, вы также можете перенести любой из примеров конечных точек URL-адреса API, приведенных в документации, или свои собственные пользовательские запросы в веб-браузер и просмотреть результаты. Если вам необходим результат в формате JSON, вы можете использовать плагин JSON View Firefox для удобного просмотра результатов JSON непосредственно в браузере Firefox.
Существуют также сторонние приложения и библиотеки, которые могут упростить использование API в зависимости от ваших целей.
Ознакомьтесь с приведенной ниже базовой структурой запросов:
В приведенной ниже документации по API показано, как можно получить доступ к этим данным для использования в вашем приложении.
https://sdg6data.org/api/indicator/{indicator_code}?_format=xml
Параметры запроса:
{indicator_code} — любой код показателя ЦУР 6. Код показателя является частью URL-адреса API и является обязательным для передачи в вызове API.
https://sdg6data.org/api/indicator/6.1.1?_format=xml
Приведенный выше URL-адрес отобразит данные показателя 6.1.1 за весь год и для всей страны
_format : Формат вывода. API поддерживает 2 формата: xml или json. Этот параметр является обязательным в соответствии со стандартами веб-сервиса Drupal 8 RESTful.
https://sdg6data.org/api/indicator/6.1.1?_format=xml
https://sdg6data.org/api/indicator/6.1.1?_format=json
per_page : количество результатов на странице для разбивки набора результатов на страницы. Значение по умолчанию равно 50
https://sdg6data.org/api/indicator/6.1.1?_format=xml&per_page=20
page — служебный параметр для просмотра большого результирующего набора. Указывает номер страницы, запрошенный из набора записей.
https://sdg6data.org/api/indicator/6.1.1?_format=xml&page=2
date — диапазон дат по годам, месяцам или кварталам, который охватывает набор результатов. Диапазон указывается с помощью разделителя-двоеточия
https://sdg6data.org/api/indicator/6.1.1?_format=xml&date=2000:2001
Отображение всех данных показателя с помощью запроса показателя с параметрами нескольких стран
https://sdg6data.org/api/indicator/6.1.1?_format=json&country=CAN,ALB
Отображение всех данных показателя с помощью запроса показателя
https://sdg6data.org/api/indicator/all?_format=json
Запросы API показателей
Показатели представляют собой такие данные, как национальные, городские, сельские районы, доступность и использование водных ресурсов, управление водными ресурсами, число погибших, число пропавших без вести и многое другое. При использовании запросов показателей результат содержит следующую информацию:
- Goal
- Target
- Indicator
- SeriesCode
- SeriesDescription
- GeoAreaType
- GeoAreaName
- GeoAreaCode
- TimePeriod
- Value
- Time_Detail
- Source
- FootNote
- Nature
- Units
- Age
- Bounds
- Frequency
- Level_Status
- Location
- Reporting_Type
- Sex
Примерный формат запроса: Запрос показателя
Для запроса всех показателей: https://sdg6data.org/api/indicator/all?_format=json
Чтобы запросить показатель 6.1.1, используйте его код показателя,
6.1.1
Примерный формат ответа: Запрос показателя
<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>Drinking water, At least basic service</SeriesDescription> <GeoAreaType>Country</GeoAreaType> <GeoAreaName>ABW</GeoAreaName> <GeoAreaCode>533</GeoAreaCode> <TimePeriod>2000</TimePeriod> <Value>94.488806355508</Value> <Time_Detail/> <Source>WHO, UNICEF</Source> <FootNote/> <Nature/> <Units/> <Age/> <Bounds/> <Frequency/> <Level_Status/> <Location>National</Location> <Reporting_Type/> <Sex/> <SDG_6_Data_Portal_level><![CDATA]6.1.1 Proportion of population using safely managed drinking water service (%) > At least basic service > National
[{ "page":0, "pages":11593, "per_page":50, "total":579635 }, [{ "Goal":null, "Target":null, "Indicator":"6.1.1", "SeriesCode":null, "SeriesDescription":"Drinking water, At least basic service", "GeoAreaType":"Country", "GeoAreaName":"ABW", "GeoAreaCode":"533", "TimePeriod":"2000", "Value":"94.488806355508", "Time_Detail":null, "Source":"WHO, UNICEF", "FootNote":null, "Nature":null, "Units":null, "Age":null, "Bounds":null, "Frequency":null, "Level_Status":null, "Location":"National", "Reporting_Type":null, "Sex":null, "SDG_6_Data_Portal_level":"6.1.1 Proportion of population using safely managed drinking water service (%) \u003E At least basic service \u003E National" }] ]Примерный формат ответа: Запрос показателя с использованием фильтра по странам:
[{"page":0, "pages":2804, "per_page":50, "total":140199}, [{"Goal":null, "Target":null, "Indicator":"6.1.1", "SeriesCode":null, "SeriesDescription":"Drinking water, At least basic service", "GeoAreaType":"Country", "GeoAreaName":"ABW", "GeoAreaCode":"533", "TimePeriod":"2000", "Value":"94.488806355508", "Time_Detail":null, "Source":"WHO,UNICEF", "FootNote":null, "Nature":null, "Units":null, "Age":null, "Bounds":null, "Frequency":null, "Level_Status":null, "Location":"National", "Reporting_Type":null, "Sex":null, "SDG_6_Data_Portal_level":"6.1.1 Proportion of population using safely managed drinking water service (%) \u003E At least basic service \u003E National"}]Скачать список стран с кодами ISO3 можно здесь
Доступ к API / Аутентификация
Ключи API и другие методы аутентификации больше не нужны для доступа к API.