API для партнёров

ВНИМАНИЕ: К API разрешено делать не более 120 запросов в минуту. При превышении лимита, излишние запросы не будут обработаны.

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

createTask

— Создание нового задания

getInfoTask

— Получить информацию о задании

changeStatusTask

— Изменить статус задания

improveTask

— Отправка задания на доработку

cancelTask

— Отказ в оплате пользователю

successTask

— Подтверждение оплаты пользователю

getBalance

— Получить текущий баланс

getTransaction

— Получить историю платежей

GetReportsTask

— Получение заявок по данному заданию

GetMessageReports

— Получение переписки по данной заявке

upBalanceTask

— Пополнение баланса задания

setUp

— Поднять задание

setVip

— Сделать задание VIP

createAdv

— Создание нового объявления

getInfoAdv

— Получить информацию об объявлении

changeStatusAdv

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

upBalanceAdv

— Пополнение баланса объявления

Метод «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

— Диапазон возрастов которому доступно ваше задание

show_hide_age

— Позволяет показывать задание тем, кто не указал свой возраст в анкете

gender

— Позволяет указать пол для пользователей которые будут выполнять задание

level

— Позволяет установить уровень пользователя, с которого ему будет видно это задание

auto_balance_up

— Позволяет автоматически пополнять баланс задания, если он заканчивается

trigger_bal

— Сумма при которой сработает автопополнение

bal_repl

— На сколько пополнить баланс

device_type

— С каких устройств будет доступно для выполнения ваше задание

all_limits

— Общий лимит по заданию

timeCheck

— Время на проверку задания в часах от 1 до 72

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

https://bux.money/api/createTask?token=token&title=title&type=1&links[]=link&time_of_execution[]=86400&price[]=1&timeWaitNextStep[]=300&links[]=subtasklink.ru&time_of_execution[]=86400&price[]=2&description[]=description+task&description[]=description+subtask&verify_info[]=verification+info&verify_info[]=verify+info+subtask+1

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

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

Метод "getInfoTask"

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

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

id*

— id задания

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

https://bux.money/api/getInfoTask?token=token&id=1

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

{ "status": "ok", "data": { "title": "Регистрация в Bux, быстрая оплата!", "description": "

Регистрация в Bux

", "verify_info": "

Прислать скриншот

", "links": "[\"https://bux.com/p/17\"]", "type_of_task": "2", "executions_per_day": "0", "cur_per_day": "0", "executions_interval": "0", "time_of_execution": "172800", "repeat_execution": "0", "select_country": "all", "not_show_countries": "0", "age_audience": { "min": "18", "max": "100" }, "statuses": [], "show_hide_age": "1", "gender": "0", "level": "0", "price user": "3.00000", "price adver": "3.90000", "date_up": "0", "auto_balance_up": "1", "queue": 1, "trigger_bal": "10", "bal_repl": "100", "balance": "84.66000" "play": 1, } }

Метод "changeStatusTask"

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

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

id*

— id задания

play*

— Статус задания;

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

https://bux.money/api/changeStatusTask?token=token&play=1

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

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

Метод "upBalanceTask"

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

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

id*

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

sum*

— Сумма на которую нужно пополнить задание;

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

https://bux.money/api/upBalanceTask?token=token&task-id=56&sum=5

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

{
    "status":"ok",
    "data":{
        "balance":"95.00000",
        "task":"5.00000"
    }
}

Метод "setUp"

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

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

id*

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

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

https://bux.money/api/setUp?token=token&task-id=5

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

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

Метод "setVip"

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

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

id*

— id задания, которое нужно выделить;

auto_vip_up

— Нужно ли автоматически выделять задание.

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

https://bux.money/api/setVip?token=token&id=1&auto_vip_up=0

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

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

Метод "GetReportsTask"

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

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

id*

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

status*

— Статус заявок, которые нужно вернуть;

search

— Поиск по id пользователя;

page

— Номер страницы (по умолчанию 1);

page

cnt — Количество возвращаемых заявок (по умолчанию 10);

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

https://bux.money/api/GetReportsTask?token=token&id=55

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

{
    "status":"ok",
    "data":{
        "data":[
            {
                "id":"67",
                "uid":"62",
                "unixtime":"1626271178",
                "timeCheck":1626271187,
                "price":"0.20000",
                "timeRev":-1626341951,
                "status":"3",
                "tmmId":"85",
                "unixM":"1626271187",
                "country":"US",
                "ip":"143.244.45.136",
                "attachments":[],
                "message":"!!!",
                "who":"1"
            }
        ],
        "cnt":"1"
    }
}

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

id

— id заявки;

uid

— id пользователя;

unixtime

— Когда пользователь взял задание (в unixtime с часовым поясом Москвы);

timeCheck

— Когда пользователь отправил задание на проверку;

price

— Стоимость для пользователя;

timeRev

— Время окончания данное на доработку, если значение примерно равно unixtime по модулю, значит задание никогда не возвращалось на доработку;

status

— Статус заявки;

tmmId

— id самого верхнего сообщения по заявке;

unixM

— Время создания сообщения;

country

— Страна пользователя;

ip

— ID пользователя;

attachments

— Ссылки на изображения в сообщении;

message

— Самое верхнее сообщение;

who

— Кто создатель сообщения, а также контекст сообщения;

Метод "successTask"

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

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

id*

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

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

https://bux.money/api/successTask?token=token&id=67

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

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

Метод "successTask"

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

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

id*

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

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

https://bux.money/api/successTask?token=token&id=67

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

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

Метод "cancelTask"

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

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

id*

— id заявки, которой нужно отказать;

message*

— Текст причины отказа;

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

https://bux.money/api/cancelTask?token=token&id=67&message=message

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

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

Метод "getTransaction"

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

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

pagination[page]

— Номер страницы (по умолчанию 1);

pagination[perpage]

— Записей на странице (по умолчанию 100);

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

https://bux.money/api/getTransaction?token=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"
      }
    ]
  }
}

Метод "improveTask"

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

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

pagination[page]

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

message*

— Текст причины доработки;

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

https://bux.money/api/improveTask?token=token&id=67&message=message

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

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

Метод "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 нет) (По умолчанию 1);

gender

— Гендер целевой аудитории (m|w) (По умолчанию all);

level

— Минимальный уровень аккаунта с которого будут показываться объявления;

price*

— Базовый CPM;

daily

— Суточный лимит, 0 - неограниченно;

auto_balance_up

— Пополнять ли автоматически баланс задания (1|0);

triggered_balance_sum

— Граница когда срабатывает автопополение;

bal_repl

— На какую сумму пополнять;

visits_interval

— Интервал повторного показа для одного юзера в секундах Допустимые значения: [0, 60, 120, 300, 600, 900, 1800, 3600, 10800, 21600, 43200, 86400];

views_user_month

— Интервал повторного показа для одного юзера в месяц;

button_text (для тизеров (1))

— Текст на кнопке, передается в виде цефры: 0 — Перейти на сайт, 1 — Подробнее, 2 — Скачать, 3 — Получить, 4 — Записаться. 5 — Играть (По умолчанию 0);

button_text (для видео (2))

— Текст на кнопке, до 30 символов

ad_after_click (Передается только для тизера и банера* (2,3))

— Показывать ли объявление после клика пользователя по нему (1|0) (По умолчанию 1)

link_after_show (Передается для видео* (1))

— Ссылка для перехода после показа видео (1|0) (По умолчанию 1)

duration_show (Передается для посещения и видео* (0,1))

— Длительность просмотра в секундах для посещений: [5, 15, 30, 45, 60, 90, 120, 180, 240, 300], для видео: [30, 45, 60, 90, 120, 240, 480, 600]

visits_per_minute (Передается для посещения и видео* (0,1))

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

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

https://bux.money/api/improveTask?token=token&id=67&message=message

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

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

Метод "getInfoAdv"

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

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

page

— Номер страницы (По умолчанию 1);

cnt

— Объявлений на странице (По умолчанию 5);

search

— Имя или id объявления (По умолчанию не используется);

play

— Поиск по статусу 0 - остановленные, 1 - запущенные, 2 - На модерации, 3 - Отклонено, 5 - Удалено, (По умолчанию не используется);

select

— Поиск по типу задания 0 - Посещения, 1 - Видео, 2 - Тизеры, 3 - Баннеры, (По умолчанию не используется);

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

https://bux.money/api/getInfoAdv?token=token&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 - Баннеры;

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

https://bux.money/api/changeStatusAdv?token=token&id=67&play=0

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

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

Метод "upBalanceAdv"

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

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

id*

— id объявления;

typeTask*

— Тип задания 0 - Посещения, 1 - Видео, 2 - Тизеры, 3 - Баннеры;

sum*

— Сумма пополнения;

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

https://bux.money/api/improveTask?token=token&id=67&message=message

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

{
    "status":"ok",
    "data":{
        "balance":"12180.67000",
        "task":"1.00000"
    }
}

Обращение к API

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

Метод «createTask»

Метод "getInfoTask"

Метод "changeStatusTask"

Метод "upBalanceTask"

Метод "setUp"

Метод "setVip"

Метод "GetReportsTask"

Метод "successTask"

Метод "successTask"

Метод "cancelTask"

Метод "getTransaction"

Метод "improveTask"

Метод "createAdv"

Метод "getInfoAdv"

Метод "changeStatusAdv"

Метод "upBalanceAdv"