Этот Blueprint предназначен для вычисления расстояния между указанным адресом и МКАД в России. Он также проверяет, находится ли указанный адрес в пределах МКАД.
Перед использованием убедитесь, что у вас установлены следующие компоненты:
- Python 3.x
- Flask
- Requests
- Dotenv
Также вам потребуется действующий API-ключ от Yandex Geocoder API, который используется для получения координат указанного адреса. Он должен храниться в .env
файле:
API_KEY_YANDEX_GEOCODER=ваш_ключ_yandex_geocoder_api_здесь
Этот эндпоинт принимает POST-запросы для вычисления расстояния между адресом и МКАД, а также для проверки нахождения адреса внутри МКАД. Он ожидает JSON-заголовок с адресом, который требуется вычислить.
Пример POST-запроса:
POST /distance-calc
Content-Type: application/json
{
"address": "Большая Никитская улица, 2, Москва"
}
Пример ответа для адреса внутри МКАД:
{
"adress_inside_MKAD": 1
}
Пример ответа для адреса за пределами МКАД:
{
"adress_inside_MKAD": 0,
"distance": "5.72" # Расстояние в километрах
}
Пример ответа для ошибки или не найденного адреса:
{
"error": "The address field was not found in the request"
}
Blueprint можно встроить в web-приложение Flask, добавив его к основному приложению с помощью функции "register_blueprint".
Это API зависит от Yandex Geocoder API для геокодирования адресов и может подвергаться ограничениям по количеству запросов или ограничениям, установленным Yandex. Перед использованием этого API убедитесь, что вы ознакомились с условиями использования Yandex.