REST API · JWT

`rest-user` REST API: лимиты, состояние аккаунта и тарифы

Методы аккаунта, вошедшего через user/auth: остаток лимитов, какие задачи и проверки сейчас идут, список тарифов с ценами и покупка тарифа с баланса. Все методы синхронные.

Адрес: /api-rest/…
Авторизация: JWT в заголовке token
Списания: user/tariff/buy списывает деньги с баланса

Остаток лимитов

POST /api-rest/user/get-limits

Месячный лимит пользователя: сколько всего, сколько потрачено и сколько осталось. Если тариф не даёт лимитов (базовые ограничения), все три числа — 0.

Параметры query и тело формы

token string обязательный заголовок

Access token из user/auth.

Ответ

data.total int

Лимитов на месяц.
data.used int

Потрачено в этом месяце.
data.available string

Осталось: total − used. Приходит строкой.
data.month_total, data.month_limits int

То же «всего» и «потрачено» за месяц; есть, только если месячный лимит больше нуля.

POST /api-rest/user/get-limits

curl -X POST 'https://tools.pixelplus.ru/api-rest/user/get-limits' \
  -H 'token: ВАШ_JWT'

<?php
$url = 'https://tools.pixelplus.ru/api-rest/user/get-limits';

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 60,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => ['token: ВАШ_JWT'],
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

print_r($response);

import requests

response = requests.post(
    "https://tools.pixelplus.ru/api-rest/user/get-limits",
    headers={
        "token": "ВАШ_JWT",
    },
    timeout=60,
)
print(response.json())

token обязательный заголовок JWT из ответа user/auth token обязательный заголовок Access token из user/auth

Запрос настоящий — выполнится с вашим ключом

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

{
    "status": "success",
    "message": "User limits successfully received",
    "code": 200,
    "data": {
        "total": 65000,
        "used": 12480,
        "available": "52520",
        "month_total": 65000,
        "month_limits": 12480
    },
    "dt": "2026-10-06 12:00:00"
}

Состояние аккаунта и идущие задачи

POST /api-rest/user/state/get

Снимок для экрана приложения: задачи инструментов, которые ждут очереди или выполняются, прогресс фоновых процессов по каждому проекту, баланс и тариф. Удобно опрашивать, чтобы показать ход проверки позиций, запущенной через positions/schedule.

Параметры query и тело формы

token string обязательный заголовок

Access token из user/auth.

Ответ

data.tools[] array

Задачи инструментов в очереди или в работе.
Вложенные поля
- hid int
  
  ID задачи в истории инструментов.
- progress int
  
  Прогресс, %.
- tools_id int
  
  ID инструмента.
data.projects object

Ключ — ID проекта (свои и с выданным доступом). Значение — прогресс процессов: число в процентах или false, если процесс не идёт.
Вложенные поля
- positions_yandex int|false
  
  Проверка позиций.
- qdata int|false
  
  Сбор данных по запросам (частоты).
- pf int|false
  
  Поведенческие факторы.
- intopt, extopt int|false
  
  Внутренняя оптимизация и ссылочная масса.
- distribution_import, queries_import, queries_import_spreadsheet int|false
  
  Импорт распределения и запросов.
- url_group_generation int|false
  
  Генерация групп URL.
- todo[] array
  
  Пересчёт задач TODO: {task_id, progress}. Ключа нет, если пересчёта нет.
data.notices array

Зарезервировано, сейчас всегда пустой.
data.user object

id, email, name, balance (рубли) и tariff: id, name, date_end, price.

POST /api-rest/user/state/get

curl -X POST 'https://tools.pixelplus.ru/api-rest/user/state/get' \
  -H 'token: ВАШ_JWT'

<?php
$url = 'https://tools.pixelplus.ru/api-rest/user/state/get';

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 60,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => ['token: ВАШ_JWT'],
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

print_r($response);

import requests

response = requests.post(
    "https://tools.pixelplus.ru/api-rest/user/state/get",
    headers={
        "token": "ВАШ_JWT",
    },
    timeout=60,
)
print(response.json())

token обязательный заголовок JWT из ответа user/auth token обязательный заголовок Access token из user/auth

Запрос настоящий — выполнится с вашим ключом

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

{
    "status": "success",
    "message": "Request successful",
    "code": 200,
    "data": {
        "tools": [
            {
                "hid": 48211903,
                "progress": 40,
                "tools_id": 12
            }
        ],
        "projects": {
            "7002": {
                "positions_yandex": 35,
                "qdata": false,
                "pf": false,
                "intopt": false,
                "extopt": false,
                "distribution_import": false,
                "queries_import": false,
                "queries_import_spreadsheet": false,
                "url_group_generation": false
            }
        },
        "notices": [],
        "user": {
            "id": "1001",
            "email": "user@example.com",
            "name": "Анна",
            "balance": "5000",
            "tariff": {
                "id": "10",
                "name": "Гуру",
                "date_end": "2026-11-21",
                "price": "2490"
            }
        }
    },
    "dt": "2026-10-06 12:00:00"
}

Тарифы и цены по периодам

POST /api-rest/tariff/list/get

Публичные тарифы и цены на 10, 30, 90 и 365 дней с учётом скидки за период и личных промо-скидок пользователя — из двух скидок берётся бо́льшая. Отсюда берут tariff_id и period для user/tariff/buy.

Параметры query и тело формы

token string обязательный заголовок

Access token из user/auth.

Ответ

data.tariffs[] array

Строки справочника тарифов, все значения — строки.
Вложенные поля
- id, name string
  
  ID и название тарифа.
- price string
  
  Цена за 30 дней, рубли.
- limits_price string
  
  Базовая цена докупки лимитов по тарифу, рубли — из неё калькулятор считает стоимость пакета.
- api_access, api_limit string
  
  Доступ к API и его лимит.
- hourly_limits, monthly_limits string
  
  Лимиты тарифа в час и в месяц.
- role, support, base, date string
  
  Служебные поля справочника.
data.prices object

Ключ — период в днях (10, 30, 90, 365).
Вложенные поля
- percent int
  
  Скидка за период, %.
- period, label int|string
  
  Период в днях и подпись: «30 дней».
- tariffs_data object
  
  Ключ — ID тарифа: full_price без скидки, end_price к оплате, end_price_word — склонение «рубль», benefit — выгода: value, word, percent.

POST /api-rest/tariff/list/get

curl -X POST 'https://tools.pixelplus.ru/api-rest/tariff/list/get' \
  -H 'token: ВАШ_JWT'

<?php
$url = 'https://tools.pixelplus.ru/api-rest/tariff/list/get';

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 60,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => ['token: ВАШ_JWT'],
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

print_r($response);

import requests

response = requests.post(
    "https://tools.pixelplus.ru/api-rest/tariff/list/get",
    headers={
        "token": "ВАШ_JWT",
    },
    timeout=60,
)
print(response.json())

token обязательный заголовок JWT из ответа user/auth token обязательный заголовок Access token из user/auth

Запрос настоящий — выполнится с вашим ключом

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

{
    "status": "success",
    "message": "Request successful",
    "code": 200,
    "data": {
        "tariffs": [
            {
                "id": "10",
                "name": "Гуру",
                "api_access": "1",
                "api_limit": "3300",
                "support": "6",
                "role": "ROLE_USER_EXPERT",
                "limits_price": "299",
                "price": "2490",
                "date": "2020-07-13 15:20:54",
                "base": null,
                "hourly_limits": "1500",
                "monthly_limits": "65000"
            }
        ],
        "prices": {
            "30": {
                "percent": 0,
                "period": 30,
                "label": "30 дней",
                "tariffs_data": {
                    "10": {
                        "id": "10",
                        "full_price": 2490,
                        "end_price": 2490,
                        "end_price_word": "рублей",
                        "benefit": {
                            "value": 0,
                            "word": "рублей",
                            "percent": 0
                        }
                    }
                }
            }
        }
    },
    "dt": "2026-10-06 12:00:00"
}

Покупка или продление тарифа

POST /api-rest/user/tariff/buy

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

Метод списывает реальные деньги с баланса. Если денег не хватает, ничего не списывается — придёт ошибка 450; пополнить баланс можно через balance/add.

Параметры query и JSON-тело

token string обязательный заголовок

Access token из user/auth.
tariff_id int обязательный

ID тарифа из tariff/list/get. Должен быть публичным и не ниже текущего.
period int

Период в днях. Любое другое значение молча заменяется на 30.

10
10 дней

30
30 дней

90
90 дней, скидка

365
365 дней, скидка

По умолчанию 30
limits int

Сколько лимитов докупить вместе с тарифом. Без него — только тариф.

По умолчанию 0

Ответ

В data — сообщения для пользователя о том, что произошло: смена или продление тарифа, списание с баланса.

POST /api-rest/user/tariff/buy

curl -X POST 'https://tools.pixelplus.ru/api-rest/user/tariff/buy' \
  -H 'token: ВАШ_JWT' \
  -H 'Content-Type: application/json' \
  -d '{
      "tariff_id": 10,
      "period": 30
  }'

<?php
$url = 'https://tools.pixelplus.ru/api-rest/user/tariff/buy';

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 60,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => json_encode([
        'tariff_id' => 10,
        'period' => 30,
    ]),
    CURLOPT_HTTPHEADER => ['token: ВАШ_JWT', 'Content-Type: application/json'],
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

print_r($response);

import requests

response = requests.post(
    "https://tools.pixelplus.ru/api-rest/user/tariff/buy",
    headers={
        "token": "ВАШ_JWT",
    },
    json={
        "tariff_id": 10,
        "period": 30,
    },
    timeout=60,
)
print(response.json())

token обязательный заголовок JWT из ответа user/auth token обязательный заголовок Access token из user/auth tariff_id обязательный ID тарифа из tariff/list/get period Период в днях

Запрос настоящий — выполнится с вашим ключом

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

{
    "status": "success",
    "message": "Request successful",
    "code": 200,
    "data": {
        "tarif": "Тариф успешно продлен до 05.11.2026",
        "balance": "С вашего счета были списаны средства в размере: 2 490 рублей."
    },
    "dt": "2026-10-06 12:00:00"
}

Ошибки

Код	Сообщение	Когда
`450`	`not enough balance`	`tariff/buy`: на балансе меньше стоимости покупки.
`440`	`unable to lower tariff`	`tariff/buy`: тариф ниже текущего, не публичный, или `tariff_id` не передан.
`404`	`User not found!`	`get-limits`: пользователь токена не найден.
`401`	`Token is not authorized`	Нет заголовка `token` или токен недействителен — см. rest-auth.

Ответ с ошибкой

{
    "status": "error",
    "message": "not enough balance",
    "code": 450,
    "data": [],
    "dt": "2026-10-06 12:00:00"
}

Для user/tariff/buy «ниже» определяется сравнением ID тарифов: тариф с меньшим ID, чем текущий, купить нельзя, даже если он дороже. Администраторам доступны и непубличные тарифы.

Остаток лимитов по ключу API без входа по паролю отдаёт getlimits.

rest-user REST API: лимиты, состояние аккаунта и тарифы

Остаток лимитов

Параметры query и тело формы

Ответ

Состояние аккаунта и идущие задачи

Параметры query и тело формы

Ответ

Тарифы и цены по периодам

Параметры query и тело формы

Ответ

Покупка или продление тарифа

Параметры query и JSON-тело

Ответ

Ошибки

`rest-user` REST API: лимиты, состояние аккаунта и тарифы