Skip to content

Instantly share code, notes, and snippets.

@mib32
Last active August 29, 2015 14:25
Show Gist options
  • Select an option

  • Save mib32/52fb25bb7def2f9ac081 to your computer and use it in GitHub Desktop.

Select an option

Save mib32/52fb25bb7def2f9ac081 to your computer and use it in GitHub Desktop.
API2

Метки на карте

Путь запроса

/markers.json

Входные параметры

параметр имя
q[business_category_id_eq] id категории
q[business_sub_category_id_eq] id подкатегории

Выходные параметры

имя аттрибута параметр
ID компании id
широта latitude
долгота longitude
индекс подраздела бизнеса subcategory.id
размер скидки sale.amount

Пример

http://secret.okcity.pro/markers.json?q[business_category_id_eq]=1&q[business_sub_category_id_eq]=1

ИНФОРМАЦИЯ НА БАЛУНЕ

Путь запроса

businesses/13.json?data_type=balloon

Входные параметры

параметр имя
coordinates координаты откуда определять расстояние
data_type balloon

Выходные параметры

имя аттрибута параметр
название name
профиль компании
флаг действия акции on_sale? или has_special_offer?
особенности (рекл. фраза) description
удалённость от локации устройства distance

Пример

http://secret.okcity.pro/businesses/13.json?data_type=balloon&coordinates=55.75,37.63

ДЕТАЛИЗИРОВАННАЯ ИНФОРМАЦИЯ О КОМПАНИИ

Путь запроса

businesses/13.json

Входные параметры

параметр имя
user_token Токен авторизации зарегистрированного клиента. Выдается при авторизации
user_email Электронная почта зарегистрированного клиента. Необходимо для определения персональной скидки и т.п.

Выходные параметры

имя аттрибута параметр
фото титульное (лого) – если есть logo
адрес address
телефон phone
е-майл email
флаг подписки на организацию (да / нет) subscribed_to?
срок окончания акции sale.stop
описание акции special_offer.description
рейтинг rating
количество посещений visits_count
персональная скидка personal_discount
фото (до 5) pictures
ссылка на видео video_url
ссылка на онлайн online_video_url

КРАТКАЯ ИНФОРМАЦИЯ О КОМПАНИЯХ ДЛЯ ОТОБРАЖЕНИЯ В РЕЖИМЕ «ПЛИТКИ»

Путь запроса

businesses/local.json или markers/local.json

Входные параметры

параметр имя
coordinates координаты откуда определять расстояние
limit количество выдаваемых компаний

Выходные параметры

имя атрибута параметр
ID компании (32 бит) id
широта (32 бит) latitude
долгота (32 бит) longitude
индекс подраздела бизнеса (8 бит) sub_category.id
размер скидки (8 бит). sale.amount
название name
профиль компании (новое текстовое поле)
флаг действия акции (действует / не действует) on_sale? или has_special_offer?
особенности (рекл. фраза) description
рейтинг компании rating
удалённость от локации устройства distance

ИНФОРМАЦИЯ ДЛЯ ФУНКЦИОНИРОВАНИЯ ПУЛЬТА

Путь запроса

/control-panel/business.json

Входные параметры

параметр имя
user_token Токен авторизации зарегистрированного клиента. Выдается при авторизации
user_email Электронная почта зарегистрированного клиента. Необходимо для авторизации доступа.

Выходные параметры

имя атрибута параметр
ID компании id
Размер временной скидки sale.amount
Флаг временной скидки "ежедневно / произвольно» sale.regular?
Дни недели действия временной скидки sale.working_days
Флаг указания интервала дат для временной скидки sale.start sale.stop
Флаг вкл / выкл действия акции has_special_offer?
Условия акции (текстовое поле) special_offer.description
Количество подписчиков (статистика) subscriptions_count
Количество визитов (статистика) visits_count
Количество визитов сегодня (статистика) today_visits_count

Обновление параметров бизнеса

Путь запроса

/control-panel/business.json

Тип запроса

PATCH или PUT

Выходные параметры

имя атрибута параметр
Размер временной скидки sale_attributes.amount
Дни недели действия временной скидки sale_attributes.working_days[]
Флаг указания интервала дат для временной скидки sale_attributes.start sale_attributes.stop
Флаг вкл / выкл действия акции sale_attributes.has_special_offer?
Условия акции (текстовое поле) sale_attributes.special_offer.description

Пример запроса

"/control-panel/business.json?business%5Bsale_attributes%5D%5Bamount%5D=78&business%5Bsale_attributes%5D%5Bstart%5D=2015-08-10+00%3A00%3A00&business%5Bsale_attributes%5D%5Bstop%5D=2015-08-21+20%3A12%3A20+%2B0300&user_email=text2%40example.com&user_token=G7DPC9rLgX_d_Uv98QSs"

Или в более понятном виде: "/control-panel/business.json?business[sale_attributes][amount]=78&business[sale_attributes][start]=2015-08-10+00%3A00%3A00&business[sale_attributes][stop]=2015-08-21+20%3A12%3A20+%2B0300&user_email=text2%40example.com&user_token=G7DPC9rLgX_d_Uv98QSs"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment