Создание геосоциальных событий на карте

Материал из Map.BY
Перейти к: навигация, поиск

Описание: Интерфейс служит создания социальных событий, привязаных к координатам на карте.

Параметры использования: Функция вызывается при помощи сформированного GETзапроса по указанному URL. Данные возвращаются в формате JSON.

http://map.by/api/addGeoEvent?api_key={:api_key}&secret_key={:secret_key}&duration={:duration}&message={:message}&latitude={:latitude}&longitude={:longitude}

Параметр Описание
{:api_key} Ваш уникальный ключ к API. Для получения информации о его получении обратитесь к разделу документации: Получения ключа API
{:secret_key} Ваш секретный ключ. Не передавайте его 3м лицам. С его помощью система вас идентифицирует.
{:duration} Продолжительность отображения на карте, в минутах. Время, в течение которого ваш маркер будет отображен на карте. По истичении указанного времени маркер будет перенесен в раздел Событий и будет доступен по ссылке
{:message} Текст сообщения. Параметр должен быть передан в виде urlencode(строка, в которой все не цифробуквенные символы, кроме -_. заменены знаком процента (%), за которым следует два шестнадцатеричных числа, а пробелы кодируются как знак сложения (+) Формат кодировки – UTF8
{:latitude} Градус, сферическая координата - широта точки. Задается в формате {XX.XXXXX}
{:longitude} Градус, сферическая координата - долгота точки. Задается в формате {YY.YYYYY}

В случае успеха сервис вернет JSON код в виде:

{"status":"success","token":8983078815,"shortest_url":"http:\/\/map.by\/d"}
Параметр Описание
status Статус ответа. Может принимать 2 варианта значений:
  • success – в случае успешного выполнения запроса
  • error – в случае возникновения ошибки
token Уникальный номер токена сообщения (идентификатор). Вы всегда сможите просмотреть свое сообщение по адресу: http://map.by/?event={token}
shortest_url Уникальный адрес вашей новости на нашем сайте

Если поиск завершится неудачей (записей не найдено), сервис вернет JSON нотификацию об ошибке в виде:

{"status":"error","error":"auth_error","error_description":"\u041e\u0448\u0438\u0431\u043a\u0430 \u0430\u0432\u0442\u043e\u0440\u0438\u0437\u0430\u0446\u0438\u0438, \u0443\u043a\u0430\u0436\u0438\u0442\u0435 \u0434\u043e\u0441\u0442\u043e\u0432\u0435\u0440\u043d\u044b\u0435 \u0434\u0430\u043d\u043d\u044b\u0435"}
Параметр Описание
status Статус ответа. Может принимать 2 варианта значений:
  • success – в случае успешного выполнения запроса
  • error – в случае возникновения ошибки
error Короткий указатель причины ошибки:
  • general – общая ошибка системы добавления событий
  • limit_exceed – ваш лимит сообщений на сутки исчерпан
  • auth_error – ошибка авторизации API_KEY или SECRET KEY
  • message_too_long – вводимое вами сообщение больше 140 символов
  • duration_too_long – интервал отображение превосходит 30 минут
  • error_description Русское описание причины ошибки

Пример использования:

REQUEST: http://map.by/api/addGeoEvent?api_key=9957691451&secret_key=419fea7dac76228ac8c387b6df48d0da3282ab2b&duration=5&message=%27%27%3B!--%22%3CXSS%3E%3D%26{%28%29}+-+http%3A%2F%2Fbit.ly%2Fhelp&latitude=53.9004949&longitude=27.5595474

RESPONSE:

{"status":"success","token":5509367791,"shortest_url":"http:\/\/map.by\/e"}
Личные инструменты
Пространства имён

Варианты
Действия
Навигация
Инструменты