Promo_Code — работа абонентов сервиса с промокодами

Группа методов Promo_Code внешнего программного интерфейса Менеджера сервиса предназначена для работы абонентов сервиса с промокодами.

Для выполнения всех методов этой группы пользователь, от имени которого вызывается программный интерфейс, должен обладать следующей ролью:

  • Владелец абонента

Сводка по методам

МетодНазначение
promo_code/activateАктивировать промо-код
promo_code/listСписок результатов активации промо-кодов

promo_code/activate

Активировать промо-код

ПараметрТипОписаниеПример
Запрос
accountЧисло (+12.0)Код абонента1010
subid *Строка переменная (50)Дополнительная информация по промокодуemail
codeСтрока переменная (50)Промо-кодBase
Ответ
Нет параметров
Пример запроса  Развернуть
POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/promo_code/activate
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "account": 1010,
  "subid": "email",
  "code": "Base",
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть
{
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 28,
    "sm_version": "1.1.37.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

promo_code/list

Список результатов активации промо-кодов

ПараметрТипОписаниеПример
Запрос
accountЧисло (+12.0)Код абонента1010
Ответ: code (0..*)
activatedДата и время в строке формата ISOМомент активации28.02.2019 0:00:00
successБулевоУспешная активацияtrue
idСтрока переменная (50)Промо-кодCRMday
Пример запроса  Развернуть
POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/promo_code/list
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "account": 1010,
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть
{
  "code": [
    {
      "activated": "2019-02-28T00:00:00",
      "success": true,
      "id": "CRMday"
    }
  ],
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 28,
    "sm_version": "1.1.37.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх