Мы прекращаем поддержку локального API. Подробные сведения и информацию о том, как перейти на облачный API нового поколения, см. в документе Упразднение локального API.

Настройки бизнес-профиля

/v1/settings/business/profile

С помощью конечной точки /v1/settings/business/profile можно задать адрес компании, ее описание, электронный адрес для связи, отрасль и адрес сайта.

Прежде чем начать

  • Для доступа к настройкам бизнес-профиля следует использовать аккаунт admin.

Получение

Выполните вызов GET, чтобы получить настройки профиля компании.

Пример

GET /v1/settings/business/profile

В случае успеха в ответе будет объект profile, содержащий данные о бизнес-профиле. Подробное описание данных см. в списке параметров ниже.

{
   "settings": {
     "business": {
        "profile": {
          "address": "new-business-address",
          "description": "business-description",
          "email": "new-business-email",
          "vertical": "business-industry",
          "websites": [ "website-1", "website-2" ]
        }
      }
}

В случае ошибок обратитесь к этому разделу.

Обновление настроек бизнес-профиля

Выполните вызов POST, чтобы обновить настройки бизнес-профиля.

Пример

POST /v1/settings/business/profile
{
    "address": "your-business-address",
    "description": "your-business-description",
    "email": "your-business-email",
    "vertical": "your-business-industry",
    "websites": [ "your-website-1", "your-website-2" ]
}

Параметры

ИмяОписание

address

Тип: строка

Адрес компании. Максимальная длина: 256 знаков.

description

Тип: строка

Описание компании. Максимальная длина: 512 знаков.

email

Тип: строка

Электронный адрес компании в действительном формате. Максимальная длина: 128 знаков.

vertical

Тип: строка

Отрасль, в которой работает компания. Допустимые значения:

  • Automotive;
  • Beauty, Spa and Salon;
  • Clothing and Apparel;
  • Education;
  • Entertainment;
  • Event Planning and Service;
  • Finance and Banking;
  • Food and Grocery;
  • Public Service;
  • Hotel and Lodging;
  • Medical and Health;
  • Non-profit;
  • Professional Services;
  • Shopping and Retail;
  • Travel and Transportation;
  • Restaurant;
  • Other.

Если отрасль задана, установить для нее пустое значение невозможно.

websites

Тип: массив строк

URL (включая http:// и https://), связанные с компанией. Например: сайт, Страница Facebook, Instagram. Можно указать не более двух сайтов. Максимальная длина каждого адреса: 256 знаков.

Частичное обновление

Если вам нужно обновить только несколько полей, выполните запрос, указав только нужные изменения:

  POST /v1/settings/business/profile
{
    "address": "new-business-address",
    "email": "new-business-email"
}

В случае успеха возвращается код статуса HTTP 200 OK и значение null или {}. В случае ошибок обратитесь к этому разделу.