2GIS

Получение профиля

Выводит подробную информацию о профиле филиала по его уникальному идентификатору.

URL: http://catalog.api.2gis.ru/profile

Параметры запроса

Параметр Обязательное Тип Описание
key Да Строка Уникальный ключ пользователя API. Пример: 1234567890.
version Да Строка Указывает версию API, с которой идет работа. Возможные значения: 1.3
id Да Число Идентификатор филиала. Пример: 1234567890
hash Да Строка Уникальный хэш филиала из результатов поисковой выдачи. Пример: 07dd2164eb829f6d7532f9a9b56d3ffd30
show_see_also Нет Число

Показывать ли похожие предложения других организаций. Возможные значения:

1 — показывать,

любое другое значение — не показывать.

По умолчанию другие предложения не показываются.

output Нет Строка Формат ответа. Может принимать значения xml, json, jsonp. По умолчанию используется json.
callback Нет Строка

Название callback функции для jsonp-запроса. Ограничение: последовательность латинских букв, цифр и знака подчеркивания. Максимальная длина названия callback функции — 128 символов. В случае неправильного задания используется значение по умолчанию (dgCallback).

Пример: myCallback_1

Параметры ответа

Параметр Тип Описание
api_version Строка Версия API, с которой идет работа. Возможные значения: 1.3.
response_code Строка Код ответа API. Подробнее см. Коды ответов.
В случае успешного ответа
id Строка Уникальный идентификатор филиала. Пример: 141265769336625.
lon Строка Долгота координаты места расположения филиала. Система координат WGS84. Пример: 82.9117574728652.
lat Строка Широта координаты места расположения филиала. Система координат WGS84. Пример: 55.0346747796494.
name Строка Название филиала. Пример: Сибакадемстрой Недвижимость, агентство недвижимости.
firm Структура Информация о фирме, к которой относится филиал. Структура с параметрами:
  • id — уникальный идентификатор фирмы. Строка.
  • filials_count — количество филиалов фирмы. Число.
register_bc_url Строка URL для регистрации бизнес-коннекшна просмотра профиля.
project_id Строка Идентификатор проекта.
city_name Строка Город, к которому относится филиал.
address Строка Адрес, по которому располагается филиал. Пример: Димитрова проспект, 7 - 2 этаж.
additional_info Объект См. Дополнительные атрибуты филиала.
article Строка Рекламная статья. Параметр присутствует только для рекламных филиалов.
fas_warning Строка

Предупреждение ФАС.

Примеры:

  • Имеются противопоказания, необходимо проконсультироваться со специалистом.
  • Генеральная лицензия Банка России № 2306.
link Объект Рекламная ссылка. Параметр присутствует только для рекламных филиалов. См. Рекламная ссылка
contacts Массив См. Контактная информация филиала.
schedule Объект

Время работы филиала.

Возможные ключи: Mon, Tue, Wed, Thu, Fri, Sat, Sun, comment. Если в некоторый день организация не работает, соответственный ключ будет отсутствовать.

Ключ "comment" содержит текстовый комментарий к расписанию рабты, например "вторая, четвертая суббота месяца: 10:00-15:00".

Под каждым ключом, отвечающим за день недели, скрывается объект с ключами working_hours-0, working_hours-1, working_hours-2, ..., отвечающими за интервалы времени работы.

Каждый интервал представляет собой объект с ключами from и to и значениями в формате hh:mm.

Пример: Mon:{working_hours-0: {from:"09:30",to:"13:00"}, working_hours-1: {from:"14:00",to:"17:00"}}, Tue: {working_hours-0: {from:"09:30",to:"16:00"}}.

payoptions Массив

Список способов оплаты. Массив строк. Параметр отсутствует в выдаче, если данных по способам оплаты нет.

Возможные значения: Cash (наличный расчет), Visa, Mastercard, DinersClub, GoldCrown (Золотая Корона), AmericanExpress, Internet (оплата через интернет), Non-cash (безналичный расчет), Maestrocard (Maestro), Unioncard (Union Card), Cash-on-delivery (наложенный платеж), Bankcheques (оплата чеками).

Примеры:

  • ["Cash"]
  • ["Visa","Mastercard","DinersClub"]
rubrics Массив

Список рубрик, к которым относится филиал. Массив строк. Может отсутствовать в выдаче.

Пример: ["Пряжа","Товары для творчества и рукоделия","Швейная фурнитура"].

rating Число Рейтинг огранизации на flamp.ru. Параметр присутствует в ответе, если есть хоть одна оценка.
reviews_count Число Количество отзывов на flamp.ru. Параметр присутствует в ответе, только если есть хотя бы один отзыв.
see_also Массив Предложения других организаций. Содержит не более двух филиалов, может отсутствовать в выдаче. См. Предложения других организаций.
В случае ошибки
error_code Строка Код ошибки, см. Коды ошибок.
error_message Строка

Описание ошибки.

Пример: API version must be set. Supported versions are: 1.3

Дополнительные атрибуты филиала
Параметр Тип Описание
office Строка

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

Примеры:

  • 3, 4 этаж; ТРЦ Европейский
  • -2 этаж
wifi Булев Наличие Wi-Fi в заведении. Необязательный параметр.
business_lunch Булев Наличие бизнес-ланча в заведении. Необязательный параметр.
avg_price Строка

Информация о среднем чеке заведения. Необязательный параметр.

Примеры:

  • 600—800
  • 1500
currency Строка Код валюты согласно ISO 4217.
Контактная информация филиала
Параметр Тип Описание
name Строка Заголовок группы контактов. Строка, возможно, пустая.
contacts Массив

Массив объектов с ключами:

type — тип контакта, возможные значения: email, website, phone, fax, icq, jabber, skype, vkontakte, twitter, instagram, facebook;

value — значение;

email_register_bc_url — URL для регистрации бизнес-коннекшна перехода на email. Может отсутствовать;

phone_register_bc_url — URL для регистрации бизнес-коннекшна звонка. Может отсутствовать;

alias — заголовок контакта, в выдаче может отсутствовать, но в случае наличия обязательно должен использоваться;

comment — комментарий к контакту, может отсутствовать, но в случае наличия обязательно должен использоваться. Пример: Единая справочная.

Рекламная ссылка
Параметр Тип Описание
link Строка URL ссылки
text Строка Текст ссылки
Предложения других организаций
Параметр Тип Описание
id Строка Уникальный идентификатор филиала. Пример: 141265769336625.
lon Строка Долгота расположения рекламируемого филиала. Система координат WGS84. null, если у филиала нет адреса. Пример: 82.9117574728652
lat Строка Широта расположения рекламируемого филиала. Система координат WGS84. null, если у филиала нет адреса. Пример: 55.0346747796494
name Строка Название филиала. Пример: Сибакадемстрой Недвижимость, агентство недвижимости.
hash Строка Уникальный хэш, требуется для передачи в запрос на получение профиля филиала.
city_name Строка Город, к которому относится филиал.
address Строка Адрес, по которому располагается филиал. Пример: Димитрова проспект, 7 - 2 этаж.
ads Объект Объект, содержащий рекламные поля филиала. Присутствует в выдаче только для рекламных филиалов. См. Рекламные поля.
Рекламные поля
sponsored_article Объект Рекламное объявление. См. Рекламное объявление.
warning Строка

Предупреждение ФАС.

Примеры:

  • Имеются противопоказания, необходимо проконсультироваться со специалистом.
  • Генеральная лицензия Банка России № 2306.
Рекламное объявление
title Строка

Заголовок рекламного объявления.

Примеры:

  • Офтальмологическая клиника
  • Решение жилищных вопросов
text Строка

Текст рекламного объявления.

Примеры:

  • Диагностика, лазерная коррекция зрения, лечение глазных заболеваний.
  • Квартиры, дома, земля. Экономная ипотека. Аренда жилья.

Примеры

Получить профиль для филиала с идентификатором 4504127911171856.

Запрос: http://catalog.api.2gis.ru/profile?&version=1.3&key=1234567890&id=4504127911171856

Ответ: