Где Сейчас

Формат запросов и ответов

API имеет REST подобную архитектуру и поддерживает ответы как в JSON так и в XML формате.
Пример запроса:

GET http://gdeseychas.ru/api/v1/places

Параметры:

accessToken (required) Ключ доступа, выдается пользователю при авторизации. Может передаваться как заголовок HTTP-запроса.
output (optional) Формат ответа: xml или json. По умолчанию - json.

Пример ответа JSON и XML:

{ "data":[ { "latitude":59.9675, "longitude":30.3049, "radius":50, "id":212, "name":"Дом", "address":"Площадь Шевченко, СПб" }, { "latitude":59.9583, "longitude":30.2998, "radius":50, "id":533, "name":"Гараж", "address":"Большой пр., 38, СПб" } ] } <?xml version="1.0" encoding="UTF-8"?> <data> <place> <latitude>59.9683</latitude> <longitude>30.3043</longitude> <radius>69</radius> <id>21</id> <name>Дома</name> <address>Ординарная ул., 20, СПб, Россия</address> </place> <place> <latitude>59.9675</latitude> <longitude>30.3049</longitude> <radius>50</radius> <id>2</id> <name>Дома</name> <address>Площадь Шевченко, СПб</address> </place> </data>

Варианты ответа:

Ответ может содержать один из двух объектов: data(объект с данными) или error(ошибку).
В случае ошибки передвается ее код и расшифровка в видет текстового поля:

{ "error":{ "code":401, "message":"Unauthorized" } }

Возможные коды ошибок:

400 Неверный или недостающий параметр.
401 Требуется авторизация (пустой или неверный accessToken)
404 API не найден
405 Неверный метод HTTP (GET,POST,DELETE)
500 Внутренняя ошибка
1404 Запрашиваемый ресурс не существует (например указан неверный id пользователя)