REST API · JWT

`rest-auth` REST API: вход, токены и аккаунт

REST API работает от имени пользователя, который вошёл по email и паролю: метод user/auth выдаёт JWT, дальше он передаётся в HTTP-заголовке token. Так устроено мобильное приложение Пиксель Тулс — API подходит для клиентов, где каждый пользователь входит в свой аккаунт сам: регистрация, тариф, баланс, лимиты, сводка по проектам.

Для своих скриптов и интеграций удобнее API по ключу: инструменты (/api/<метод>?key=…) и SEO-проекты (/projects/api/v1/…?token=…) работают с постоянным ключом из настроек аккаунта, без пароля и обновления токенов. Ключ API и JWT не взаимозаменяемы: ключ в заголовке token REST не примет.

Адрес: /api-rest/<метод>
Авторизация: JWT в заголовке token
Тело запроса: JSON или форма
Лимиты: методы этой страницы не тратят

Выпуск токенов по email и паролю

POST /api-rest/user/auth

Проверяет email и пароль и выпускает пару токенов: access на час и refresh на год. Каждый вызов выпускает новую пару; прежние токены продолжают работать. Заголовок token этому методу не нужен.

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

email string обязательный

Email аккаунта Пиксель Тулс.
password string обязательный

Пароль аккаунта.

Ответ

Успех — code: 201.

data.jwt_token string

Access token — его передают в заголовке token всех остальных методов. Живёт 1 час.
data.refresh_token string

Refresh token для user/refresh-token. Живёт 1 год — сохраните его.
data.valid datetime

Когда истекает access token, ГГГГ-ММ-ДД чч:мм:сс.

POST /api-rest/user/auth

curl -X POST 'https://tools.pixelplus.ru/api-rest/user/auth' \
  -H 'Content-Type: application/json' \
  -d '{
      "email": "user@example.com",
      "password": "ваш_пароль"
  }'

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

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 60,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => json_encode([
        'email' => 'user@example.com',
        'password' => 'ваш_пароль',
    ]),
    CURLOPT_HTTPHEADER => ['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/auth",
    json={
        "email": "user@example.com",
        "password": "ваш_пароль",
    },
    timeout=60,
)
print(response.json())

email обязательный Email аккаунта Пиксель Тулс password обязательный Пароль аккаунта

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

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

{
    "status": "success",
    "message": "Token has been created successfully. Save your refresh-token. It will be valid for one year. If you lose your's refresh-token, you can easily recreate it via auth",
    "code": 201,
    "data": {
        "jwt_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjo…",
        "refresh_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjo…",
        "valid": "2026-10-06 13:00:00"
    },
    "dt": "2026-10-06 12:00:00"
}

Новый access token по refresh token

POST /api-rest/user/refresh-token

Выпускает новый access token на час, не спрашивая пароль. Refresh token передаётся в заголовке refresh-token и возвращается в ответе тот же — новый не выпускается. Когда он истечёт, получите новую пару через user/auth.

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

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

Refresh token из ответа user/auth.

Ответ

Успех — code: 201, message: Token has been updated successfully.

data.jwt_token string

Access token — его передают в заголовке token всех остальных методов. Живёт 1 час.
data.refresh_token string

Refresh token для user/refresh-token. Живёт 1 год — сохраните его.
data.valid datetime

Когда истекает access token, ГГГГ-ММ-ДД чч:мм:сс.

POST /api-rest/user/refresh-token

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

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

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 60,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => ['refresh-token: ВАШ_REFRESH_TOKEN'],
]);
$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/refresh-token",
    headers={
        "refresh-token": "ВАШ_REFRESH_TOKEN",
    },
    timeout=60,
)
print(response.json())

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

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

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

{
    "status": "success",
    "message": "Token has been updated successfully",
    "code": 201,
    "data": {
        "jwt_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjo…",
        "refresh_token": "ВАШ_REFRESH_TOKEN",
        "valid": "2026-10-06 13:00:00"
    },
    "dt": "2026-10-06 12:00:00"
}

Регистрация нового аккаунта

POST /api-rest/user/register

Создаёт аккаунт Пиксель Тулс и сразу выпускает для него токены — отдельно вызывать user/auth не нужно. Токены лежат на уровень глубже, чем в user/auth: в data.data.

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

email string обязательный

Email нового аккаунта. Нельзя: & = + < > , ' и две точки подряд.
password string обязательный

Пароль. Проверяется только, что он не пустой.
name string

Имя пользователя.
username string

Логин. Без него — не задаётся.
mobile_phone string

Телефон.

Ответ

Успех — code: 201. В data вложен целиком ответ выпуска токенов: data.data — токены, data.code, data.status, data.message — его статус.

data.data.jwt_token string

Access token, 1 час.
data.data.refresh_token string

Refresh token, 1 год.
data.data.valid datetime

Когда истекает access token.

POST /api-rest/user/register

curl -X POST 'https://tools.pixelplus.ru/api-rest/user/register' \
  -H 'Content-Type: application/json' \
  -d '{
      "email": "new-user@example.com",
      "password": "надёжный_пароль",
      "name": "Анна"
  }'

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

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 60,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => json_encode([
        'email' => 'new-user@example.com',
        'password' => 'надёжный_пароль',
        'name' => 'Анна',
    ]),
    CURLOPT_HTTPHEADER => ['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/register",
    json={
        "email": "new-user@example.com",
        "password": "надёжный_пароль",
        "name": "Анна",
    },
    timeout=60,
)
print(response.json())

email обязательный Email нового аккаунта password обязательный Пароль. Проверяется только, что он не пустой name Имя пользователя

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

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

{
    "status": "success",
    "message": "User has been created successfully",
    "code": 201,
    "data": {
        "data": {
            "jwt_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjo…",
            "refresh_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjo…",
            "valid": "2026-10-06 13:00:00"
        },
        "code": 201,
        "status": "success",
        "message": "Token has been created successfully. Save your refresh-token. It will be valid for one year. If you lose your's refresh-token, you can easily recreate it via auth"
    },
    "dt": "2026-10-06 12:00:00"
}

Отключение своего аккаунта

POST /api-rest/user/delete

Отключает аккаунт, которому принадлежит токен из заголовка token. Данные не стираются, но войти больше нельзя: user/auth вернёт 418 User has been deleted. Вернуть аккаунт — через поддержку.

Отключить можно только свой аккаунт: без действующего токена метод ответит 401 Token is not authorized.

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

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

Access token из user/auth.

Ответ

Успех — code: 202, data пустой.

POST /api-rest/user/delete

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

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

$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/delete",
    headers={
        "token": "ВАШ_JWT",
    },
    timeout=60,
)
print(response.json())

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

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

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

{
    "status": "success",
    "message": "User has been deleted successfully",
    "code": 202,
    "data": [],
    "dt": "2026-10-06 12:00:00"
}

Ошибки

Код	Сообщение	Когда
`401`	`Token is not authorized. Check api documentation on /api-rest/doc`	Любой метод, кроме этих трёх (`auth`, `refresh-token`, `register`): заголовок `token` не передан, подпись неверна или пользователь не найден.
`400`	`Incorrect user email!`	`auth`: email не передан или некорректен.
`404`	`User not found or incorrect credentials`	`auth`: нет такого пользователя или пароль неверный.
`418`	`User has been deleted`	`auth`: аккаунт отключён через `user/delete`.
`404`	`Refresh token field is empty`	`refresh-token`: нет заголовка `refresh-token`.
`404`	`Invalid refresh token!`	`refresh-token`: подпись токена неверна или его пользователь не найден.
`400`	`Email is not correct!`	`register`: email некорректен.
`400`	`Ampersand (&), equal sign (=), … are not allowed in email`	`register`: в email запрещённый символ или две точки подряд.
`400`	`User already exists`	`register`: аккаунт с таким email уже есть.
`400`	`Password cannot be empty.`	`register`: пароль пустой.
`404`	`Path: "…" does not found`	Метода по такому адресу нет.

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

{
    "status": "error",
    "message": "Token is not authorized. Check api documentation on /api-rest/doc",
    "code": 401,
    "data": [],
    "dt": "2026-10-06 12:00:00"
}

Формат ответа

Все методы REST отвечают одной обёрткой: status (success или error), message, code, data и dt — время ответа сервера. HTTP-код всегда 200: успех и ошибка различаются полями status и code в теле. status: success ставится при code от 200 до 299.

Как передавать параметры

Методы принимают GET и POST, но параметры читают из тела запроса — передавайте их POST-ом: JSON с заголовком Content-Type: application/json или обычной формой. Массивы в форме — как project[]=1&project[]=2, в JSON — обычными массивами. Строку JSON внутри поля формы методы не разбирают.

Жизненный цикл токенов

user/auth — получить jwt_token и refresh_token.
Передавать jwt_token в заголовке token всех методов.
Когда до valid остаётся мало времени — user/refresh-token.
Раз в год, когда истечёт refresh token, — снова user/auth.

rest-auth REST API: вход, токены и аккаунт

Выпуск токенов по email и паролю

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

Ответ

Новый access token по refresh token

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

Ответ

Регистрация нового аккаунта

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

Ответ

Отключение своего аккаунта

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

Ответ

Ошибки

Формат ответа

Как передавать параметры

Жизненный цикл токенов

`rest-auth` REST API: вход, токены и аккаунт