Ключ доступа к API выпускается в настройках аккаунта. Один ключ подходит для API v1 и v2.

Ключ API API v2

Обращение к API

Все запросы необходимо направлять по адресу: https://bux.money/api/{method}

{method}
— Название одного из методов
token
— Ключ доступа (выпускается в настройках, вкладка «Безопасность»)
{params}
— Дополнительные параметры запроса в зависимости от метода

Запросы — методом POST. Параметры передаются в теле формы или в строке адреса; значение из строки адреса главнее. На запрос GET приходит пустой ответ.

Ответ — JSON: {"status":"ok","data":…} или {"status":"error","message":"…"}. Числа из базы приходят строками.

Общие ошибки: token is not valid — ключ пустой, неизвестный или выключен; method unknown — нет такого метода (регистр букв в имени важен).

Доступные методы

getBalance
— Используется для получения рекламного (adver) и основного (user) баланса.
createTask
— Используется для создания нового задания.
getInfoTask
— Используется для получения информацию о задании.
changeStatusTask
— Используется для изменения статуса задания.
upBalanceTask
— Используется для пополнения баланса задания.
setUp
— Используется для поднятия задания.
setVip
— Используется для выделения задания. Если задание уже VIP, то оплаты не произойдет
setSettingUp
— Используется для включения и выключения автоподнятия задания.
GetReportsTask
— Используется для получения заявок по данному заданию.
GetMessageReports
— Используется для получения переписки по заявке, новые сообщения сверху.
successTask
— Используется для подтверждения оплаты пользователю
cancelTask
— Используется для отказа в оплате
improveTask
— Используется для отправки задания на доработку
getTransaction
— Используется для Получения истории платежей
createAdv
— Используется для создания задания
getInfoAdv
— Используется для получения информации об объявлениях
changeStatusAdv
— Используется для включения и отключения объявления
upBalanceAdv
— Используется для пополнения баланса объявления

getBalance

Используется для получения рекламного (adver) и основного (user) баланса.

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

curl -X POST 'https://bux.money/api/getBalance' \
  -d 'token=ВАШ_КЛЮЧ'

Пример ответа:

{
  "status": "ok",
  "data": {
    "adver": "1000.00000",
    "user": "12.50000"
  }
}

createTask

Используется для создания нового задания.

Параметры метода:

title*
— Краткий заголовок задания
type*
— Тип задания.
links*
— (Массив) Ссылка для начала выполнения задания (может быть пустым у подзадач)
description*
— (Массив) Подробное описание задания
verify_info*
— (Массив) Подробное описание того, что нужно предоставить для проверки, чтобы засчитать задание выполненным.
price*
— (Массив) Позволяет установить цену которую вы готовы заплатить исполнителю
time_of_execution*
— (Массив) Время, которое отводится пользователю на выполнение задания.
timeWaitNextStep*
— (Массив) Время, через которое исполнитель сможет приступить к подзадаче (обязателен при создании подзадач)
uniqText*
— (Массив) Содержимое списка (обязателен при создании списков)
variable*
— (Массив) Переменная в виде {{LIST_N}}, где N - число, которая будет использоваться в описании или информации для отчета, для выдачи строки из списка (обязателен при создании списков)
executions_per_day
— Максимальное количество пользователей, которые могут начать выполнение задания в сутки.
executions_interval
— Время в секундах, которое должно пройти после начала выполнения задания одним пользователем и началом выполнения другим.
repeat_execution
— Позволяет управлять возможностью повторного выполнения задания для каждого конкретного пользователя.
select_country
— (Массив) Список стран, пользователям из которых будет видно задание.
not_show_countries
— Позволяет сделать инверсию списку стран select_country, и не показывать в этих странах задание.
age_audience
— Диапазон возрастов которому доступно ваше задание, через «;»: 18;100
show_hide_age
— Позволяет показывать задание тем, кто не указал свой возраст в анкете
gender
— Позволяет указать пол для пользователей которые будут выполнять задание: all — все, m — мужчины, другое значение — женщины
auto_balance_up
— Позволяет автоматически пополнять баланс задания, если он заканчивается
trigger_bal
— Сумма при которой сработает автопополнение
bal_repl
— На сколько пополнить баланс
device_type
— С каких устройств будет доступно для выполнения ваше задание
all_limits
— Общий лимит по заданию
timeCheck*
— Время на проверку задания в часах от 1 до 72
mustScreenshots
— (Массив) Сколько скриншотов обязательно приложить к отчёту на шаге, от 0 до 10
isHiddenArr
— (Массив) Скрытый шаг
exclude_orders
— (Массив) id заданий, исполнителям которых это задание не показывать, не больше 15

Задание создаётся остановленным. Запустите его методом changeStatusTask.

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

curl -X POST 'https://bux.money/api/createTask' \
  -d 'token=ВАШ_КЛЮЧ' \
  -d 'title=title' \
  -d 'type=1' \
  -d 'links[]=link' \
  -d 'time_of_execution[]=86400' \
  -d 'price[]=1' \
  -d 'timeWaitNextStep[]=300' \
  -d 'links[]=subtasklink.ru' \
  -d 'time_of_execution[]=86400' \
  -d 'price[]=2' \
  -d 'description[]=description task' \
  -d 'description[]=description subtask' \
  -d 'verify_info[]=verification info' \
  -d 'verify_info[]=verify info subtask 1' \
  -d 'timeCheck=24'

Пример ответа:

{
  "status": "ok",
  "data": {
    "id": 123
  }
}

Ошибки (текст message):

  • Время на проверку задания задано некорректно
  • Ссылка задана некорректно
  • Описание не может быть пустым
  • Такого типа задания не существует
  • Минимальная оплата задания: 1.00 RUB
  • Неверный формат данных
  • Домен запрещен
  • Аккаунт был заблокирован

getInfoTask

Используется для получения информацию о задании.

Параметры метода:

id*
— id задания

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

curl -X POST 'https://bux.money/api/getInfoTask' \
  -d 'token=ВАШ_КЛЮЧ' \
  -d 'id=1'

Пример ответа:

{
  "status": "ok",
  "data": {
    "title": "API задание",
    "description": "<p>Сделайте дело</p>",
    "verify_info": "Пришлите подтверждение",
    "link": "https://bux.money/task",
    "type_of_task": "2",
    "executions_per_day": "0",
    "cur_per_day": "0",
    "executions_interval": "0",
    "time_of_execution": "600",
    "repeat_execution": "0",
    "select_country": "all",
    "not_show_countries": "0",
    "age_audience": {
      "min": "18",
      "max": "100"
    },
    "statuses": [
      {
        "status": "1",
        "cnt": "1"
      }
    ],
    "show_hide_age": "1",
    "gender": "0",
    "level": "0",
    "price_user": "10.00000",
    "price_adver": "13.50000",
    "date_up": "0",
    "auto_balance_up": "0",
    "date_vip": "0",
    "vip_up": "0",
    "queue": null,
    "trigger_bal": "0",
    "bal_repl": "0",
    "balance": "0.00000",
    "play": "0"
  }
}

Ошибки (текст message):

  • К этому заданию доступ закрыт

changeStatusTask

Используется для изменения статуса задания.

Параметры метода:

id*
— id задания
play*
— Статус задания: 1 — запустить, 0 — остановить

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

curl -X POST 'https://bux.money/api/changeStatusTask' \
  -d 'token=ВАШ_КЛЮЧ' \
  -d 'id=3' \
  -d 'play=1'

Пример ответа:

{
  "status": "ok",
  "data": {
    "id": "3",
    "status": "1"
  }
}

Ошибки (текст message):

  • Передайте play
  • Изменение статуса отклонено
  • Баланс задания должен быть выше 13.50 RUB

upBalanceTask

Используется для пополнения баланса задания.

Параметры метода:

id*
— id задания, которое нужно пополнить;
sum*
— Сумма на которую нужно пополнить задание; Округляется до 2 знаков.

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

curl -X POST 'https://bux.money/api/upBalanceTask' \
  -d 'token=ВАШ_КЛЮЧ' \
  -d 'id=56' \
  -d 'sum=5'

Пример ответа:

{
  "status": "ok",
  "data": {
    "balance adver": "979.45000",
    "balance task": "20.55000"
  }
}

Ошибки (текст message):

  • Ошибочно задана сумма пополнения
  • Недостаточно средств
  • Пополнение отклонено
  • Аккаунт был заблокирован

setUp

Используется для поднятия задания.

Параметры метода:

id*
— id задания, которое нужно поднять;

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

curl -X POST 'https://bux.money/api/setUp' \
  -d 'token=ВАШ_КЛЮЧ' \
  -d 'id=5'

Пример ответа:

{
  "status": "ok",
  "data": []
}

Ошибки (текст message):

  • Задание должно быть запущено
  • Недостаточно средств
  • Изменение отклонено
  • Аккаунт был заблокирован

setVip

Используется для выделения задания. Если задание уже VIP, то оплаты не произойдет

Параметры метода:

id*
— id задания, которое нужно выделить;
auto_vip_up
— Нужно ли автоматически выделять задание.

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

curl -X POST 'https://bux.money/api/setVip' \
  -d 'token=ВАШ_КЛЮЧ' \
  -d 'id=1' \
  -d 'auto_vip_up=0'

Пример ответа:

{
  "status": "ok",
  "data": {
    "balanceA": "121.67000"
  }
}

Ошибки (текст message):

  • Задание должно быть запущено
  • Недостаточно средств
  • Изменение отклонено
  • Аккаунт был заблокирован

setSettingUp

Используется для включения и выключения автоподнятия задания.

Параметры метода:

id*
— id задания
enable*
— 1 — включить, 0 — выключить
date_up_interval
— Интервал автоподнятия в секундах, не меньше 60

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

curl -X POST 'https://bux.money/api/setSettingUp' \
  -d 'token=ВАШ_КЛЮЧ' \
  -d 'id=5' \
  -d 'enable=1' \
  -d 'date_up_interval=3600'

Пример ответа:

{
  "status": "ok",
  "data": "1"
}

Ошибки (текст message):

  • Интервал автоподнятия должен быть не меньше 60 секунд
  • Изменение отклонено

GetReportsTask

Используется для получения заявок по данному заданию.

Параметры метода:

id*
— id задания, заявки которого нужно вернуть;
status
— Статус заявок, можно несколько через запятую: 1,3 (по умолчанию 3 — на проверке)
search
— Поиск по id пользователя;
page
— Номер страницы (по умолчанию 1);
cnt
— Количество возвращаемых заявок (по умолчанию 10, не больше 50)

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

id
— id заявки;
uid
— id пользователя;
unixtime
— Когда пользователь взял задание (в unixtime с часовым поясом Москвы);
timeCheck
— Когда пользователь отправил задание на проверку;
price
— Стоимость для пользователя;
timeRev
— Время окончания данное на доработку, если значение примерно равно unixtime по модулю, значит задание никогда не возвращалось на доработку;
status
— Статус заявки;
tmmId
— id самого верхнего сообщения по заявке;
unixM
— Время создания сообщения;
country
— Страна пользователя;
ip
— Не передаётся, всегда пустая строка
attachments
— Ссылки на изображения в сообщении;
message
— Самое верхнее сообщение;
who
— Кто создатель сообщения, а также контекст сообщения;
timeStep
— Время по шагам задания (массив или null)
data
— Данные отчёта, а также имя (title) и фото (photo) исполнителя
curStep
— Текущий шаг
countSteps
— Всего шагов
tid
— id задания
ai_checked
— Проверен ли отчёт ИИ (1|0)
ai_comment
— Комментарий ИИ-проверки

Заявки без сообщений в выдачу не попадают.

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

curl -X POST 'https://bux.money/api/GetReportsTask' \
  -d 'token=ВАШ_КЛЮЧ' \
  -d 'id=55'

Пример ответа:

{
  "status": "ok",
  "data": {
    "data": [
      {
        "id": "67",
        "uid": "62",
        "unixtime": "1626271178",
        "timeCheck": "1626278387",
        "price": "0.20000",
        "timeRev": "0",
        "status": "3",
        "timeStep": [],
        "tmmId": "85",
        "unixM": "1626271187",
        "country": "US",
        "ip": "",
        "attachments": [],
        "message": "готово",
        "who": "1",
        "data": {
          "title": "Иван Петров",
          "photo": "/photo/ivan.jpg"
        },
        "curStep": "0",
        "countSteps": "1",
        "tid": "55",
        "ai_checked": "0",
        "ai_comment": ""
      }
    ],
    "cnt": "1"
  }
}

Ошибки (текст message):

  • Доступ запрещен

GetMessageReports

Используется для получения переписки по заявке, новые сообщения сверху.

Параметры метода:

id*
— id заявки

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

curl -X POST 'https://bux.money/api/GetMessageReports' \
  -d 'token=ВАШ_КЛЮЧ' \
  -d 'id=67'

Пример ответа:

{
  "status": "ok",
  "data": [
    {
      "id": "85",
      "uid": "62",
      "unixtime": "1626271187",
      "tmid": "67",
      "tid": "55",
      "country": "",
      "ip": "",
      "step": "0",
      "message": "готово",
      "attachments": [],
      "data": {
        "title": "Иван Петров",
        "photo": "/photo/ivan.jpg"
      },
      "who": "1"
    }
  ]
}

Ошибки (текст message):

  • Доступ запрещен

successTask

Используется для подтверждения оплаты пользователю

Параметры метода:

id*
— id заявки, которую нужно оплатить;

Оплатить можно только заявку на проверке.

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

curl -X POST 'https://bux.money/api/successTask' \
  -d 'token=ВАШ_КЛЮЧ' \
  -d 'id=67'

Пример ответа:

{
  "status": "ok",
  "data": []
}

Ошибки (текст message):

  • Доступ запрещен
  • Дейстие отклонено

cancelTask

Используется для отказа в оплате

Параметры метода:

id*
— id заявки, которой нужно отказать;
message*
— Текст причины отказа;

Отказ окончательный, без возврата на доработку.

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

curl -X POST 'https://bux.money/api/cancelTask' \
  -d 'token=ВАШ_КЛЮЧ' \
  -d 'id=67' \
  -d 'message=message'

Пример ответа:

{
  "status": "ok",
  "data": []
}

Ошибки (текст message):

  • Укажите причину отказа
  • Доступ запрещен
  • Дейстие отклонено

improveTask

Используется для отправки задания на доработку

Параметры метода:

id*
— id заявки, которую нужно доработать
message*
— Что нужно доработать

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

curl -X POST 'https://bux.money/api/improveTask' \
  -d 'token=ВАШ_КЛЮЧ' \
  -d 'id=67' \
  -d 'message=message'

Пример ответа:

{
  "status": "ok",
  "data": []
}

Ошибки (текст message):

  • Укажите, что нужно доработать
  • Доступ запрещен
  • Дейстие отклонено

getTransaction

Используется для Получения истории платежей

Параметры метода:

pagination[page]
— Номер страницы (по умолчанию 1);
pagination[perpage]
— Записей на странице (по умолчанию 100, не больше 100; если передан только pagination[page] — 1)
sort[sort]
— Порядок: desc (по умолчанию) или asc

Отдаются только зачисленные пополнения.

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

curl -X POST 'https://bux.money/api/getTransaction' \
  -d 'token=ВАШ_КЛЮЧ'

Пример ответа:

{
  "status": "ok",
  "data": {
    "meta": {
      "page": 1,
      "perpage": 100,
      "pages": 1,
      "total": "2",
      "sort": "desc",
      "field": "id"
    },
    "data": [
      {
        "id": "90",
        "uid": "1",
        "unixtime": "1655393806",
        "val": "101.00000",
        "valPlus": "111.10000",
        "bonus": "10",
        "service": "buxmoney",
        "status": "1"
      },
      {
        "id": "66",
        "uid": "1",
        "unixtime": "1623792666",
        "val": "100.00000",
        "valPlus": "120.00000",
        "bonus": "20",
        "service": "yoomoney",
        "status": "1"
      }
    ]
  }
}

createAdv

Используется для создания задания

Параметры метода:

type*
— Тип объявления (Разрешенные значения: ['teaser', 'banner', 'siteTraffic', 'viewsVideo'];)
header
(Обязательно для тизеров (2))
— Заголовок тизера;
text
(Обязательно для тизеров (2))
— Текст тизера;
link*
— Ключевая ссылка рекламы, для видео ссылка видео на ютубе, для посещений ссылка на сайт;
select_country[]
(передается в виде 2 заглавных букв. Если нужны все страны, не передавайте параметр)
— Массив стран (По умолчанию все страны);
not_show_countries
— Меняет список select_country как исключающий страны; Возможные значения: 1, 0 (По умолчанию 0)
age_audience*
— Возрастной диапазон для объявления через «;»: 18;100
show_hide_age
— Показывать ли объявление тем, кто не указал возраст (1 — показывать, 0 — нет; по умолчанию 0)
gender
— Гендер целевой аудитории (m|w) (По умолчанию all);
price_views
— Базовый CPM (по умолчанию 80)
daily_budget
— Суточный лимит, 0 - неограниченно;
auto_balance_up
— Пополнять ли автоматически баланс задания (1|0);
triggered_balance_sum
— Граница когда срабатывает автопополение;
top_up_on
— На какую сумму пополнять;
visits_interval
— Интервал повторного показа для одного пользователя в секундах; допустимые значения — из настроек тарифа
views_user_month
— Интервал повторного показа для одного юзера в месяц;
button_text
(для тизеров (1))
— Текст на кнопке, передается в виде цефры: 0 — Перейти на сайт, 1 — Подробнее, 2 — Скачать, 3 — Получить, 4 — Записаться. 5 — Играть (По умолчанию 0);
button_text
(для видео (2))
— Текст на кнопке, до 30 символов
ad_after_click
(Передается только для тизера и банера (2,3))
— Показывать ли объявление после клика пользователя по нему (1|0, по умолчанию 0)
duration_show
(Передается для посещения и видео (0,1))
— Длительность просмотра в секундах; допустимые значения — из настроек тарифа
visits_per_minute
(Передается для посещения и видео (0,1))
— лимит количества показов рекламы в минуту

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

curl -X POST 'https://bux.money/api/createAdv' \
  -d 'token=ВАШ_КЛЮЧ' \
  -d 'type=viewsVideo' \
  -d 'link=https://www.youtube.com/watch?v=VIDEO' \
  -d 'price_views=80' \
  -d 'age_audience=18;100' \
  -d 'duration_show=30'

Пример ответа:

{
  "status": "ok",
  "data": {
    "id": 237
  }
}

Ошибки (текст message):

  • Не поддерживаемый тип задания
  • Ссылка задана некорректно
  • CPM задан некорректно
  • Ошибочно задан суточный бюджет
  • Параметр возраста передан неправильно
  • Аккаунт был заблокирован

getInfoAdv

Используется для получения информации об объявлениях

Параметры метода:

page
— Номер страницы (По умолчанию 1);
cnt
— Объявлений на странице (по умолчанию 5, не больше 50)
search
— Имя или id объявления (По умолчанию не используется);
play
— Поиск по статусу: 0 — остановлено, 1 — работает, 2 — на модерации, 3 — приостановлено, 4 — удаляется, 5 — удалено (по умолчанию не используется)
select
— Поиск по типу: 0 — посещения, 1 — видео, 2 — тизеры, 3 — баннеры, 6 — Rutube (по умолчанию не используется)

У тизеров и баннеров поля duration в ответе нет. Суточный лимит «без предела» — "0".

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

curl -X POST 'https://bux.money/api/getInfoAdv' \
  -d 'token=ВАШ_КЛЮЧ' \
  -d 'cnt=1'

Пример ответа:

{
  "status": "ok",
  "data": {
    "data": [
      {
        "id": "237",
        "name": "", //Заданное имя задания
        "date": "2022-10-12 23:41:25", //Дата создания объявления
        "duration": null, //Длительность просмотра для видео и посещений
        "bal_up": "0", //автоподнятние 1|0
        "trigger_bal": "0", //Сумма при которой срабатывает автоподнятие
        "bal_repl": "0", // На сколько будет пополняться
        "daily": "0", //Лимит на суточный бюджет
        "dailyCalc": "0.00000", //Использовано лимита за сегодня
        "price": "80.00000", //Базовый CPM
        "pricePlus": "80.10000", //CPM с дополнительными настройками
        "balance": "0.00000", //Баланс задания
        "type": "2", //Тип задания
        "allViews": "0", //Всего просмотров
        "allclicks": "0", //Всего кликов
        "play": "0" //Статус задания
      }
    ],
    "cnt": "5"
  }
}

changeStatusAdv

Используется для включения и отключения объявления

Параметры метода:

id*
— id объявления;
play*
— Статус на который нужно изменить (1|0);
typeTask*
— Тип: 0 — посещения, 1 — видео, 2 — тизеры, 3 — баннеры, 6 — Rutube

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

curl -X POST 'https://bux.money/api/changeStatusAdv' \
  -d 'token=ВАШ_КЛЮЧ' \
  -d 'id=67' \
  -d 'typeTask=1' \
  -d 'play=0'

Пример ответа:

{
  "status": "ok",
  "data": []
}

Ошибки (текст message):

  • неизвестные параметры
  • Изменение статуса отклонено

upBalanceAdv

Используется для пополнения баланса объявления

Параметры метода:

id*
— id объявления;
typeTask*
— Тип: 0 — посещения, 1 — видео, 2 — тизеры, 3 — баннеры, 6 — Rutube
sum*
— Сумма пополнения;
play
— 1 — пополнить и сразу запустить

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

curl -X POST 'https://bux.money/api/upBalanceAdv' \
  -d 'token=ВАШ_КЛЮЧ' \
  -d 'id=67' \
  -d 'typeTask=1' \
  -d 'sum=100'

Пример ответа:

{
  "status": "ok",
  "data": {
    "balance": "899.98000",
    "task": "100.02000"
  }
}

Ошибки (текст message):

  • sum не может быть 0
  • Недостаточно средств
  • Пополнение отклонено
  • неизвестные параметры
  • Аккаунт был заблокирован