Формат ответа
Локатор API возвращает местоположение устройства в виде координаты центра (широта, долгота) в системе WGS-84 и точности позиционирования в метрах.
Сервис не может определять местоположение на территории, о которой у него нет данных. В таких случаях возвращается код 200 и пустой объект.
При некорректном запросе вернётся код 400 и сообщение об ошибке.
Параметры ответа
| Поле | Тип | Обязательность | Описание |
|---|---|---|---|
location |
object Location | - | Объект Location |
Location
| Поле | Тип | Обязательность | Описание |
|---|---|---|---|
point |
{lat: number, lon: number} | + | Географические координаты: широта (lat), долгота (lon) |
accuracy |
number | + | Точность предполагаемого местоположения в метрах |
Примеры
200 OK
Content-Type: application/json
{
"location": {
"point": {
"lat": 55.75586318969727,
"lon": 37.61769866943359
},
"accuracy": 40
}
}
200 OK
Content-Type: application/json
{ }
Сообщения об ошибках
Если при обработке запроса происходит ошибка, API возвращает сообщение с описанием ошибки в текстовом формате.
| Код ответа | Описание |
|---|---|
| 400 | Запрос содержит ошибку в теле запроса |
| 403 | Запрос не содержит параметр apikey или указан неверный ключ |
| 429 | Превышено количество запросов |
| 500 или 504 | Системная ошибка сервера. Повторите запрос с небольшой задержкой |
Примеры
400 Bad Request
Content-Type: text/plain
Unrecognized key(s) in object: 'location'
403 Forbidden
Content-Type: text/plain
Access denied