Документация BILLmanager 6
Документация
/
Документация BILLmanager 6
/
Разработчику
/
Работа с API
/
BILLmanager API
/
Реферальные программы (referralprogram)
Ловим ваш фидбэк!
Пройдите опрос и станьте главным советником
по улучшениям экосистемы ISPsystem
Пройти опрос
Добавить в избранное
Документация
/
Документация BILLmanager 6
/
Разработчику
/
Работа с API
/
BILLmanager API
/
Реферальные программы (referralprogram)

Реферальные программы (referralprogram)

referralprogram

Уровень доступа: user

Функция предоставляет список доступных реферальных программ.

Просмотр данных:

  • Результат: список реферальных программ в формате bjson.

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

ПараметрОписание
outФормат ответа. По умолчанию bjson.
Пример ответа при успешном выполнении (код 200):
{
  "elem": [
    {
      "id": "1",
      "locale_name": "string",
      "assign_by_default": "on",
      "locale_url": "string",
      "project_name": "string"
    }
  ]
}

referralprogram.edit

Уровень доступа: user

Функция предназначена для создания или редактирования реферальной программы.

Изменение данных:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно ok;
  • Результат: успешное выполнение операции или сообщение об ошибке.

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

ПараметрОписание
funcИмя функции: referralprogram.edit.
sokПодтверждение отправки формы. Обычно принимает значение ok.
outФормат ответа. По умолчанию bjson.
projectПровайдер, у которого действует данная реферальная программа.
nameНаименование реферальной программы, которое отображается клиенту.
promocodeШаблон промокода. Используйте @ID@ в том месте, куда нужно вставить ID партнёра. Если реферал введёт промокод, соответствующий этому шаблону, то будет засчитано, что клиента привёл партнёр.
start_dateРеферальная программа начнёт приносить вознаграждения для расходов, созданных после этой даты.
end_dateРеферальная программа начнёт приносить вознаграждения для расходов, созданных до этой даты.
assign_by_defaultЕсли указано, реферальная программа будет выбираться для клиента автоматически при подключении его к провайдеру. По умолчанию может подключаться только одна реферальная программа.
urlURL сайта провайдера. У каждого партнёра будет уникальная ссылка. К данному URL будет добавлен ID клиента.
account_groupГруппа клиентов, для которых будет доступно участие в реферальной программе. Значение restrict: запретить участие состоящим в группе.
account_group_restrictГруппа, клиентам которой не будут начисляться вознаграждения по реферальной программе.
Пример ответа при успешном выполнении (код 200):
{
  "func": "referralprogram.edit",
  "ok": true,
  "id": "1"
}

referralprogram.edit

Уровень доступа: user

Функция предназначена для редактирования существующей реферальной программы.

Изменение данных:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно ok;
    • elid — уникальный идентификатор редактируемой реферальной программы;
  • Результат: успешное выполнение операции или сообщение об ошибке.

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

ПараметрОписание
funcИмя функции: referralprogram.edit.
sokПодтверждение отправки формы. Обычно принимает значение ok.
elidУникальный идентификатор реферальной программы.
outФормат ответа. По умолчанию bjson.
projectПровайдер, у которого действует данная реферальная программа.
nameНаименование реферальной программы, которое отображается клиенту.
promocodeШаблон промокода. Используйте @ID@ в том месте, куда нужно вставить ID партнёра. Если реферал введёт промокод, соответствующий этому шаблону, то будет засчитано, что клиента привёл партнёр.
start_dateРеферальная программа начнёт приносить вознаграждения для расходов, созданных после этой даты.
end_dateРеферальная программа начнёт приносить вознаграждения для расходов, созданных до этой даты.
assign_by_defaultЕсли указано, реферальная программа будет выбираться для клиента автоматически при подключении его к провайдеру. По умолчанию может подключаться только одна реферальная программа.
urlURL сайта провайдера. У каждого партнёра будет уникальная ссылка:  к данному URL будет добавлен ID клиента.
account_groupГруппа клиентов, для которых будет доступно участие в реферальной программе. Значение restrict: запретить участие состоящим в группе.
account_group_restrictГруппа, клиентам которой не будут начисляться вознаграждения по реферальной программе.
Пример ответа при успешном выполнении (код 200):
{
  "func": "referralprogram.edit",
  "ok": true
}

referralprogram.delete

Уровень доступа: user

Функция предназначена для удаления существующей реферальной программы.

Изменение данных:

  • Параметры:
    • elid — уникальный идентификатор удаляемой реферальной программы.
  • Результат: успешное выполнение операции или сообщение об ошибке.

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

ПараметрОписание
funcИмя функции: referralprogram.delete.
elidУникальный идентификатор элемента (реферальной программы).
outФормат ответа. По умолчанию bjson.
Пример ответа при успешном выполнении (код 200):
{
  "func": "referralprogram.delete",
  "ok": true
}

referralprogram.rule

Уровень доступа: user

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

Просмотр данных:

  • Результат: список правил реферальной программы в формате bjson.

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

ПараметрОписание
elidУникальный идентификатор реферальной программы.
outФормат ответа. По умолчанию bjson.
Пример ответа при успешном выполнении (код 200):
{
  "elem": [
    {
      "id": "1",
      "reward": "string",
      "reward_period": "string",
      "reward_payment_interval": "string",
      "orderpriority": "string"
    }
  ]
}

referralprogram.rule.edit

Уровень доступа: user

Функция предназначена для создания нового правила в рамках указанной реферальной программы.

Изменение данных:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно ok;
    • plid — уникальный идентификатор родительской реферальной программы.
  • Результат: успешное выполнение операции или сообщение об ошибке.

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

ПараметрОписание
funcИмя функции: referralprogram.rule.edit.
sokПодтверждение отправки формы. Обычно принимает значение ok.
plidУникальный идентификатор родительского элемента (реферальной программы).
outФормат ответа. По умолчанию bjson.
reward_method

Способ вознаграждения реферера за привлечение новых клиентов:

  • 0 — деньги на лицевой счёт;
  • 1 — бонусы.
reward_value_type

Способ определения суммы вознаграждения:

  • 0 — вычисляемый;
  • 1 — фиксированный.
reward_value_fixed_moneyРазмер выплаты рефереру в качестве вознаграждения в денежном эквиваленте.
reward_value_fixed_bonusРазмер выплаты рефереру в качестве вознаграждения в бонусах.
reward_value_percentРазмер выплаты рефереру в качестве вознаграждения в процентах.
reward_max_amountМаксимальная сумма вознаграждения. Если рассчитанная сумма превышает указанную, выплачивается только лимит.
reward_moment

Момент, с которого покупки реферала начинают учитываться:

  • 0 — после покупки рефералом;
  • 1 — после прошествия периода.
reward_months_afterКоличество месяцев, по прошествии которых будет выплачено вознаграждение. Если услуга будет удалена раньше, вознаграждение не начисляется.
reward_expense_period

Определяет, какие расходы учитываются при начислении вознаграждения:

  • 0 — только созданные при покупке;
  • 1 — все, созданные от момента покупки до момента начисления вознаграждения.
reward_periodПериод в месяцах, в течение которого начисляются выплаты от расходов реферала.
reward_payment_intervalИнтервал выплаты вознаграждения. Указывается в месяцах.
reward_double_sidedВ момент начисления вознаграждения рефереру рефералу будут начислены бонусы в указанном объёме.
orderpriorityПриоритет применения правил в рамках реферальной программы. Чем меньше значение, тем выше приоритет.
Пример ответа при успешном выполнении (код 200):
{
  "func": "referralprogram.rule.edit",
  "ok": true
}

referralprogram.rule.edit

Уровень доступа: user

Функция предназначена для редактирования существующего правила в рамках указанной реферальной программы.

Изменение данных:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно ok;
    • plid — уникальный идентификатор родительской реферальной программы;
    • elid — уникальный идентификатор редактируемого правила.
  • Результат: успешное выполнение операции или сообщение об ошибке.

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

ПараметрОписание
funcИмя функции: referralprogram.rule.edit.
sokПодтверждение отправки формы. Обычно принимает значение ok.
plidУникальный идентификатор родительского элемента (реферальной программы).
elidУникальный идентификатор элемента (редактируемого правила).
outФормат ответа. По умолчанию bjson.
reward_method

Способ вознаграждения реферера за привлечение новых клиентов:

  • 0 — деньги на лицевой счёт;
  • 1 — бонусы.
reward_value_type

Способ определения суммы вознаграждения:

  • 0 — вычисляемый;
  • 1 — фиксированный.
reward_value_fixed_moneyРазмер выплаты рефереру в качестве вознаграждения в денежном эквиваленте.
reward_value_fixed_bonusРазмер выплаты рефереру в качестве вознаграждения в бонусах.
reward_value_percentРазмер выплаты рефереру в качестве вознаграждения в процентах.
reward_max_amountМаксимальная сумма вознаграждения. Если рассчитанная сумма превышает указанную, выплачивается только лимит.
reward_moment

Момент, с которого покупки реферала начинают учитываться:

  • 0 — после покупки рефералом;
  • 1 — после прошествия периода.
reward_months_afterКоличество месяцев, по прошествии которых будет выплачено вознаграждение. Если услуга будет удалена раньше, вознаграждение не начисляется.
reward_expense_period

Расходы, которые учитываются при начислении вознаграждения:

  • 0 — только созданные при покупке;
  • 1 — все, созданные от момента покупки до момента начисления вознаграждения.
reward_periodПериод в месяцах, в течение которого начисляются выплаты от расходов реферала.
reward_payment_intervalИнтервал выплаты вознаграждения. Указывается в месяцах.
reward_double_sidedВ момент начисления вознаграждения рефереру рефералу будут начислены бонусы в указанном объёме.
orderpriorityПриоритет применения правил в рамках реферальной программы. Чем меньше значение, тем выше приоритет.
Пример ответа при успешном выполнении (код 200):
{
  "func": "referralprogram.rule.edit",
  "ok": true
}

referralprogram.rule.delete

Уровень доступа: user

Функция предназначена для удаления правила реферальной программы.

Изменение данных:

  • Параметры:
    • plid — уникальный идентификатор родительской реферальной программы;
    • elid — уникальный идентификатор удаляемого правила.
  • Результат: успешное выполнение операции или сообщение об ошибке.

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

ПараметрОписание
funcИмя функции: referralprogram.rule.delete.
plidУникальный идентификатор родительского элемента (реферальной программы).
elidУникальный идентификатор элемента (удаляемого правила).
outФормат ответа. По умолчанию bjson.
Пример ответа при успешном выполнении (код 200):
{
  "func": "referralprogram.rule.delete",
  "ok": true
}

referralprogram.rule.condition

Уровень доступа: user

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

Просмотр данных:

  • Результат: список условий в формате bjson.

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

ПараметрОписание
plidУникальный идентификатор родительского элемента (реферальной программы).
elidУникальный идентификатор элемента (правила).
outФормат ответа. По умолчанию bjson.
Пример ответа при успешном выполнении (код 200):
{
  "elem": [
    {
      "id": "1",
      "condition": "string",
      "group": "string"
    }
  ]
}

referralprogram.rule.condition.edit

Уровень доступа: user

Функция предназначена для создания нового условия в рамках правила реферальной программы.

Изменение данных:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно ok;
    • plid — уникальный идентификатор родительской реферальной программы.
  • Результат: успешное выполнение операции или сообщение об ошибке.

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

ПараметрОписание
funcИмя функции: referralprogram.rule.condition.edit.
sokПодтверждение отправки формы. Обычно принимает значение ok.
plidУникальный идентификатор родительского элемента (реферальной программы).
outФормат ответа. По умолчанию bjson.
ctype

Условие реферальной программы:

  • 0 — без условий;
  • 1 — объём продаж реферала;
  • 2 — по количеству услуг, купленных рефералом;
  • 3 — по количеству приведённых рефералов;
  • 4 — объём продаж всех рефералов.
orderperiodsПериод заказа услуг реферала.
comparisonОператор сравнения (например, "больше", "меньше или равно" и т.п.). Конкретные значения зависят от контекста условия.
amount_ctype_1Сумма всех расходов реферала за период, соответствующий расписанию правила реферальной программы.
amount_ctype_4Сумма расходов всех рефералов за период, соответствующий расписанию правила реферальной программы.
item_countКоличество услуг, купленных рефералом за всё время действия реферальной программы.
referral_countОбщее количество рефералов реферера на текущий момент.
group

Вы можете группировать условия. Условия в группе объединяются оператором ИЛИ. Группы между собой связаны оператором И. Пример: условия A, B и C объединены в одну группу, а D и E — в другую. Итоговое выражение: (A ИЛИ B ИЛИ C) И (D ИЛИ E).

Параметр принимает одно из значений:

  • none — без группы;
  • new — создать новую группу условий.
groupnameВведите имя группы условий.
Пример ответа при успешном выполнении (код 200):
{
  "func": "referralprogram.rule.condition.edit",
  "ok": true
}

referralprogram.rule.condition.edit

Уровень доступа: user

Функция предназначена для создания нового условия в рамках правила реферальной программы.

Изменение данных:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно ok;
    • plid — уникальный идентификатор родительской реферальной программы.
  • Результат: успешное выполнение операции или сообщение об ошибке.

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

ПараметрОписание
funcИмя функции: referralprogram.rule.condition.edit.
sokПодтверждение отправки формы. Обычно принимает значение ok.
plidУникальный идентификатор родительского элемента (реферальной программы).
outФормат ответа. По умолчанию bjson.
ctype

Условие реферальной программы:

  • 0 — без условий;
  • 1 — объём продаж реферала;
  • 2 — по количеству услуг, купленных рефералом;
  • 3 — по количеству приведённых рефералов;
  • 4 — объём продаж всех рефералов.
orderperiodsПериод заказа услуг реферала.
comparisonОператор сравнения (например, "больше", "меньше или равно" и т.п.). Конкретные значения зависят от контекста условия.
amount_ctype_1Сумма всех расходов реферала за период, соответствующий расписанию правила реферальной программы.
amount_ctype_4Сумма расходов всех рефералов за период, соответствующий расписанию правила реферальной программы.
item_countКоличество услуг, купленных рефералом за всё время действия реферальной программы.
referral_countОбщее количество рефералов реферера на текущий момент.
group

Вы можете группировать условия. Условия в группе объединяются оператором ИЛИ. Группы между собой связаны оператором И. Пример: условия A, B и C объединены в одну группу, а D и E — в другую. Итоговое выражение: (A ИЛИ B ИЛИ C) И (D ИЛИ E).

  • none — без группы;
  • new — создать новую группу условий.
groupnameВведите имя группы условий.
Пример ответа при успешном выполнении (код 200):
{
  "func": "referralprogram.rule.condition.edit",
  "ok": true,
"id": "1"
}

referralprogram.rule.condition.edit

Уровень доступа: user

Функция предназначена для редактирования существующего условия в рамках правила реферальной программы.

Изменение данных:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно ok;
    • plid — уникальный идентификатор родительской реферальной программы;
    • elid — уникальный идентификатор редактируемого условия.
  • Результат: успешное выполнение операции или сообщение об ошибке.

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

ПараметрОписание
funcИмя функции: referralprogram.rule.condition.edit.
sokПодтверждение отправки формы. Обычно принимает значение ok.
plidУникальный идентификатор родительского элемента (реферальной программы).
elidУникальный идентификатор элемента (редактируемого условия).
outФормат ответа. По умолчанию bjson.
ctype

Условие реферальной программы:

  • 0 — без условий;
  • 1 — объём продаж реферала;
  • 2 — по количеству услуг, купленных рефералом;
  • 3 — по количеству приведённых рефералов;
  • 4 — объём продаж всех рефералов.
orderperiodsПериод заказа услуг реферала.
comparisonОператор сравнения (например, "больше", "меньше или равно" и т.п.). Конкретные значения зависят от контекста условия.
amount_ctype_1Сумма всех расходов реферала за период, соответствующий расписанию правила реферальной программы.
amount_ctype_4Сумма расходов всех рефералов за период, соответствующий расписанию правила реферальной программы.
item_countКоличество услуг, купленных рефералом за всё время действия реферальной программы.
referral_countОбщее количество рефералов реферера на текущий момент.
group

Вы можете группировать условия. Условия в группе объединяются оператором ИЛИ. Группы между собой связаны оператором И. Пример: условия A, B и C объединены в одну группу, а D и E — в другую. Итоговое выражение: (A ИЛИ B ИЛИ C) И (D ИЛИ E).

  • none — без группы;
  • new — создать новую группу условий.
groupnameВведите имя группы условий.
Пример ответа при успешном выполнении (код 200):
{
  "func": "referralprogram.rule.condition.edit",
  "ok": true
}

referralprogram.rule.condition.delete

Уровень доступа: user

Функция предназначена для удаления условия реферальной программы.

Изменение данных:

  • Параметры:
    • plid — уникальный идентификатор родительской реферальной программы;
    • elid — уникальный идентификатор удаляемого условия.
  • Результат: успешное выполнение операции или сообщение об ошибке.

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

ПараметрОписание
funcИмя функции: referralprogram.rule.condition.delete.
plidУникальный идентификатор родительского элемента (реферальной программы).
elidУникальный идентификатор удаляемого условия.
outФормат ответа. По умолчанию bjson.
Пример ответа при успешном выполнении (код 200):
{
  "func": "referralprogram.rule.condition.delete",
  "ok": true
}

referralprogram.rule.up

Уровень доступа: user

Функция предназначена для повышения приоритета правила реферальной программы. Перемещает правило выше в списке.

Изменение данных:

  • Параметры:
    • plid — уникальный идентификатор родительской реферальной программы;
    • elid — уникальный идентификатор правила, приоритет которого повышается.
  • Результат: успешное выполнение операции или сообщение об ошибке.

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

ПараметрОписание
funcИмя функции: referralprogram.rule.up.
plidУникальный идентификатор родительского элемента (реферальной программы).
elidУникальный идентификатор правила.
outФормат ответа. По умолчанию bjson.
Пример ответа при успешном выполнении (код 200):
{
  "func": "referralprogram.rule.up",
  "ok": true
}

referralprogram.rule.down

Уровень доступа: user

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

Изменение данных:

  • Параметры:
    • plid — уникальный идентификатор родительской реферальной программы;
    • elid — уникальный идентификатор правила, приоритет которого понижается.
  • Результат: успешное выполнение операции или сообщение об ошибке.

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

ПараметрОписание
funcИмя функции: referralprogram.rule.down.
plidУникальный идентификатор родительского элемента (реферальной программы).
elidУникальный идентификатор правила.
outФормат ответа. По умолчанию bjson.
Пример ответа при успешном выполнении (код 200):
{
  "func": "referralprogram.rule.down",
  "ok": true
}

referralprogram.rule.history

Уровень доступа: user

Функция предоставляет историю изменений указанного правила реферальной программы.

Просмотр данных:

  • Результат: список записей об изменениях в формате bjson.

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

ПараметрОписание
plidУникальный идентификатор родительского элемента (реферальной программы).
elidУникальный идентификатор правила.
outФормат ответа. По умолчанию bjson.
Пример ответа при успешном выполнении (код 200):
{
  "elem": [
    {
      "changedate": "string",
      "desc": "string",
      "user": "string",
      "ip": "string",
      "action": "string"
    }
  ]
}

referralprogram.history

Уровень доступа: user

Функция предоставляет историю изменений указанной реферальной программы.

Просмотр данных:

  • Результат: список записей об изменениях в формате bjson.

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

ПараметрОписание
elidУникальный идентификатор реферальной программы.
outФормат ответа. По умолчанию bjson.
Пример ответа при успешном выполнении (код 200):
{
  "elem": [
    {
      "changedate": "string",
      "desc": "string",
      "user": "string",
      "ip": "string",
      "action": "string"
    }
  ]
}

referralprogram.referer

Уровень доступа: user

Функция предоставляет список рефереров, участвующих в указанной реферальной программе, с основной статистикой.

Просмотр данных:

  • Результат: список рефереров в формате bjson.

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

ПараметрОписание
elidУникальный идентификатор реферальной программы.
outФормат ответа. По умолчанию bjson.
Пример ответа при успешном выполнении (код 200):
{
  "elem": [
    {
      "id": "1",
      "name": "string",
      "stat_count_click_url": "string",
      "stat_count_click_promocode": "string",
      "stat_count_referral": "string",
      "stat_count_referral_with_success_payment": "string",
      "stat_sum_paid_reward_amount_money": "string",
      "stat_count_paid_reward": "string",
      "stat_count_reward_payment": "string",
      "stat_sum_planned_reward_amount_money": "string",
      "stat_near_reward_date": "string"
    }
  ]
}

referralprogram.referer.referral

Уровень доступа: user

Функция предоставляет список рефералов, приведённых указанным реферером в рамках заданной реферальной программы.

Просмотр данных:

  • Результат: список рефералов в формате bjson.

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

ПараметрОписание
plidУникальный идентификатор родительского элемента (реферальной программы).
elidУникальный идентификатор реферера.
outФормат ответа. По умолчанию bjson.
Пример ответа при успешном выполнении (код 200):
{
  "elem": [
    {
      "id": "1",
      "name": "string",
      "sum_expense_reward_amount": "string",
      "sum_expense_amount": "string"
    }
  ]
}

referralprogram.client

Уровень доступа: user

Функция предназначена для просмотра и изменения данных формы участия клиента в реферальной программе.

Просмотр данных:

  • Результат: список параметров.

Изменение данных:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно ok;
  • Результат: успешное выполнение операции или сообщение об ошибке.

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

ПараметрОписание
funcИмя функции: referralprogram.client.
outФормат ответа. По умолчанию bjson.
referralprogramРеферальная программа, в которой будет участвовать клиент.
urlURL реферальной ссылки.
promocodeКлиенты, которые введут этот промокод, будут считаться приведенными вами.
Пример ответа при успешном выполнении (код 200):
{
  "func": "referralprogram.client",
  "ok": true
}

referralprogram.client.click

Уровень доступа: user

Функция предоставляет статистику переходов по реферальной ссылке клиента.

Просмотр данных:

  • Результат: список записей о переходах в формате bjson.

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

ПараметрОписание
outФормат ответа. По умолчанию bjson.
Пример ответа при успешном выполнении (код 200):
{
  "elem": [
    {
      "cdate": "string",
      "site": "string",
      "referral": "string",
      "status": "string",
      "paid": "on"
    }
  ]
}
Дата последнего обновления статьи: 11.11.2025. Статья подготовлена техническими писателями ISPsystem