Формат запроса
Для загрузки списка полигонов пользователь отпраляет GET-запрос по адресу:
https://soil-db.ru/api/v1/map/load-features
В заголовке запроса передаётся секретный токен:
Authorization: Bearer {token}
При наличии идентификатора текущей API-сессии session_id, полученного в предыдущем ответе сервера, его необходимо передать в GET-запросе.
Область поиска
В запросе необходимо передать географические координаты прямоугольной области запроса. Для этого используется параметр bounds с четырьмя вложенными координатами: sw_lat, sw_lng, ne_lat, ne_lng, которые задают прямоугольную область запроса:
- sw_lat — широта юго-западного угла,
- sw_lng — долгота юго-западного угла,
- ne_lat — широта северо-восточного угла,
- ne_lng — долгота северо-восточного угла.
Таким образом, полный адрес GET-запроса списка полигонов может выглядеть следующим образом:
https://soil-db.ru/api/v1/map/load-features?bounds[sw_lat]=55.7&bounds[sw_lng]=29.7&bounds[ne_lat]=55.8&bounds[ne_lng]=29.8
Фильтрация полигонов
Также в адресе запроса списка полигонов может передаваться необязательный параметр search для фильтрации возвращаемых полигонов. Параметр search содержит два вложенных значения: soils и as_admixture. Параметр soils содержит массив идентификаторов почв, по которым фильтруются полигоны, а булевый параметр as_admixture соответствует типу поиска:
- as_admixture=0 — основная почва (значение по умолчанию),
- as_admixture=1 — основная или сопутствующая почва.
Таким образом, полный адрес GET-запроса списка полигонов с фильтрацией по основным или сопутствующим почвам с идентификаторами 1, 2, 3, 4, 5 может выглядеть следующим образом:
https://soil-db.ru/api/v1/map/load-features?session_id=13&bounds[sw_lat]=55.7&bounds[sw_lng]=29.7&bounds[ne_lat]=55.8&bounds[ne_lng]=29.8&search[soils][0]=1&search[soils][1]=2&search[soils][2]=3&search[soils][3]=4&search[soils][4]=5&search[as_admixture]=1