REST API — документация для разработчиков

REST API для разработчиков и рекламодателей

RubProfit предоставляет публичный REST API для управления рекламными кампаниями (серфинг сайтов, задания с ручной проверкой, просмотры Rutube). API позволяет программно создавать, редактировать, пополнять и удалять кампании, проверять баланс и статусы выполнения.

Базовый URL: https://rubprofit.ru/api/v1/
Формат запроса: JSON (для POST/PATCH) или query-string (для GET).
Формат ответа: JSON в кодировке UTF-8.

Авторизация

Каждый запрос требует API-ключ. Получить и управлять ключами можно в разделе «API ключи» личного кабинета рекламодателя.

Передавайте ключ в HTTP-заголовке Authorization:

Authorization: Bearer YOUR_API_KEY

Альтернативно (например, для быстрого тестирования) допускается параметр ?api_key=YOUR_API_KEY в URL или в теле JSON.

Если для ключа настроен whitelist IP-адресов, запросы с других IP будут отклонены с ошибкой 403.

Формат ошибок

В случае ошибки сервер возвращает соответствующий HTTP-код (401/403/404/422/etc) и тело:

{
  "success": false,
  "error": {
    "code": 102,
    "message": "Неверный API ключ"
  }
}

Диапазон code	Значение
1xx	Ошибки авторизации (ключ, IP, блокировка аккаунта)
2xx (200–209)	Ошибки маршрутизации
210–299	Ошибки бизнес-логики (валидация, недостаток средств, статус кампании)

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

GET account GET campaigns/{type} POST campaigns/{type} GET campaigns/{type}/{id} PATCH campaigns/{type}/{id} DELETE campaigns/{type}/{id} POST .../balance POST .../status POST .../refund

Типы кампаний ({type})

type	Описание	Таблица данных
`serf`	Серфинг сайтов	tb_ads_dlink
`task`	Задание с ручной проверкой	tb_task_w
`rutube`	Просмотр видео Rutube	still_rutube_ads

GET /account

Информация о владельце ключа и балансах.

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

curl -H "Authorization: Bearer YOUR_API_KEY" \
     https://rubprofit.ru/api/v1/account

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

{
  "success": true,
  "id": 4284275,
  "username": "olegalazz",
  "balance": 0.81,
  "balance_adv": 0.01,
  "currency": "RUB"
}

Поле	Тип	Описание
id	int	ID пользователя
username	string	Логин
balance	float	Основной счёт (выплаты), руб.
balance_adv	float	Рекламный счёт, руб.

GET /campaigns/{type}

Список кампаний пользователя выбранного типа.

Query-параметры

Параметр	Тип	По умолчанию	Описание
limit	int	50	Размер страницы (1–100)
offset	int	0	Смещение

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

curl -H "Authorization: Bearer YOUR_API_KEY" \
     "https://rubprofit.ru/api/v1/campaigns/serf?limit=20"

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

{
  "success": true,
  "count": 1,
  "list": [
    {
      "id": 90,
      "type": "serf",
      "status": 1,
      "status_msg": "active",
      "balance": 20.4070,
      "price_r": 0.0210,
      "created_at": 1777804105,
      "title": "Топ Букс SooFastBux.RU",
      "url": "https://soofastbux.ru/?r=dimas25rw",
      "timer": 20,
      "price_u": 0.0210,
      "views": 933,
      "country": ""
    }
  ]
}

Значения status_msg

Значение	Описание
draft	Создана, не отправлена на модерацию
moderation	На модерации
active	Активна, в работе
paused	На паузе
banned	Заблокирована администратором

POST /campaigns/{type}

Создание новой кампании. Кампания создаётся в статусе draft и должна быть отправлена на модерацию (POST .../status с status: "moderation").

serf — параметры

Параметр	Тип	Обяз.	Описание
url	string	да	Ссылка на сайт (http:// или https://)
title	string	да	Название (до 60 символов)
description	string	нет	Описание (до 60 символов)
timer	int	нет	5, 10, 15, 20 (по умолч.), 25, 30, 35, 40, 45, 50, 55, 60

task — параметры

Параметр	Тип	Обяз.	Описание
title	string	да	Заголовок задания (до 55 символов)
url	string	да	Ссылка задания
description	string	да	Что нужно сделать (до 3000 символов)
report_info	string	да	Что должен прислать исполнитель в отчёте
price_u	float	да	Оплата исполнителю (мин. 0.5)
category	int	нет	ID категории

rutube — параметры

Параметр	Тип	Обяз.	Описание
title	string	да	Заголовок видео (до 60 символов)
video_id	string	да	Hash-идентификатор Rutube видео (32-символьный hex)
timer	int	нет	15, 20, 25, 30 (по умолч.), 40, 50, 60, 90, 120, 180, 240, 300 (секунд)

Пример запроса (serf)

curl -X POST \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com","title":"My site","timer":20}' \
  https://rubprofit.ru/api/v1/campaigns/serf

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

{
  "success": true,
  "id": 152,
  "type": "serf",
  "campaign": {
    "id": 152,
    "type": "serf",
    "status": 0,
    "status_msg": "draft",
    "balance": 0,
    "price_r": 0.021,
    "title": "My site",
    "url": "https://example.com",
    "timer": 20
  }
}

GET /campaigns/{type}/{id}

Подробная информация о кампании.

curl -H "Authorization: Bearer YOUR_API_KEY" \
     https://rubprofit.ru/api/v1/campaigns/serf/152

PATCH /campaigns/{type}/{id}

Редактирование кампании. Передавайте только те поля, которые хотите изменить.

Доступные для редактирования поля

type	Поля
serf	title, description
task	title, description, report_info
rutube	title

curl -X PATCH \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title":"New title"}' \
  https://rubprofit.ru/api/v1/campaigns/serf/152

DELETE /campaigns/{type}/{id}

Удаление кампании. Перед удалением кампания должна быть остановлена и иметь нулевой баланс (используйте refund для возврата остатка средств).

POST /campaigns/{type}/{id}/balance

Пополнение баланса кампании с рекламного счёта.

Параметр	Тип	Обяз.	Описание
amount	float	да	Сумма в рублях, списываемая с рекламного счёта

curl -X POST \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"amount":50}' \
  https://rubprofit.ru/api/v1/campaigns/serf/152/balance

{
  "success": true,
  "balance": 50.00,
  "added":   50.00
}

POST /campaigns/{type}/{id}/status

Управление статусом кампании.

Параметр	Тип	Обяз.	Описание
status	string	да	`active` — запустить, `paused` — приостановить, `moderation` — отправить на модерацию

curl -X POST \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"status":"paused"}' \
  https://rubprofit.ru/api/v1/campaigns/serf/152/status

POST /campaigns/{type}/{id}/refund

Возврат остатка баланса кампании на рекламный счёт. Кампания должна быть на паузе.

curl -X POST \
  -H "Authorization: Bearer YOUR_API_KEY" \
  https://rubprofit.ru/api/v1/campaigns/serf/152/refund

{
  "success": true,
  "refunded": 25.43
}

Ограничения и нагрузка

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

Лимит API-ключей на аккаунт — 10.

Поддержка

Вопросы по работе API — через техподдержку.