REST API · JWT

`rest-projects` REST API: список проектов и создание нового

Проекты пользователя, вошедшего через user/auth, и создание нового проекта в три шага: подобрать поисковые системы и регионы для домена, подобрать запросы, создать проект. Это тот же «быстрый старт», что при добавлении проекта в интерфейсе. Все методы синхронные; данные одного проекта — в rest-project.

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

Список проектов

POST /api-rest/projects/list

Свои проекты и проекты с выданным доступом. По каждому — карточка, даты всех завершённых проверок позиций и счётчик ошибок технического аудита.

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

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

Access token из user/auth.

Ответ

data[].project object

Карточка проекта: id, user_id (владелец), domain, main_mirror, aliases, status (1 — активен), name, date, date_update и настройки съёма. Значения — строки.
data[].update array

Даты завершённых проверок позиций, ГГГГ-ММ-ДД, от старых к новым — вся история.
data[].errors object|false

Технический аудит: total_count — проверок, errors_count — ошибок. false, если аудит не запускался.

POST /api-rest/projects/list

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

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

$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/projects/list",
    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": [
        {
            "project": {
                "id": "7002",
                "user_id": "1001",
                "domain": "example.ru",
                "main_mirror": "https://example.ru/",
                "aliases": "",
                "check_interval": "2",
                "subdomain_check": "1",
                "priority_sytem": "1",
                "frequency_type": "3",
                "date": "2026-03-02 11:10:43",
                "date_update": "2026-10-05 04:12:09",
                "status": "1",
                "name": ""
            },
            "update": [
                "2026-09-28",
                "2026-10-05"
            ],
            "errors": {
                "total_count": "64",
                "errors_count": "7"
            }
        }
    ],
    "dt": "2026-10-06 12:00:00"
}

Поисковые системы и регионы для домена

POST /api-rest/projects/ss-list

Шаг 1 создания проекта. Предлагает поисковые системы и регион по умолчанию — регион из настроек пользователя (для доменов .ua, .by, .kz — регион страны) — и отдаёт справочник систем с регионами, чтобы пользователь мог выбрать свои. Пары search_sestem.id + ключ региона идут в projects/add как search_engine и search_region.

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

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

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

Домен сайта без протокола.

Ответ

data.prepared_search_systems[] array

Предложение по умолчанию: lbl — ID пары «система + регион», name — система, region — название региона.
data.search_systems_with_regions[] array

Четыре системы: Яндекс, Google, Яндекс мобильный, Google мобильный.
Вложенные поля
- search_sestem object
  
  Поисковая система: id (1, 2, 7, 8), name, domain, slug. Опечатка в имени ключа сохранена ради совместимости.
- region object
  
  Доступные регионы: ключ — ID региона (lr), значение — название.

POST /api-rest/projects/ss-list

curl -X POST 'https://tools.pixelplus.ru/api-rest/projects/ss-list' \
  -H 'token: ВАШ_JWT' \
  -H 'Content-Type: application/json' \
  -d '{
      "domain": "example.ru"
  }'

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

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 60,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => json_encode([
        'domain' => 'example.ru',
    ]),
    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/projects/ss-list",
    headers={
        "token": "ВАШ_JWT",
    },
    json={
        "domain": "example.ru",
    },
    timeout=60,
)
print(response.json())

token обязательный заголовок JWT из ответа user/auth token обязательный заголовок Access token из user/auth domain обязательный Домен сайта без протокола

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

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

{
    "status": "success",
    "message": "Request successful",
    "code": 200,
    "data": {
        "prepared_search_systems": [
            {
                "lbl": 1,
                "name": "Яндекс",
                "region": "Москва"
            },
            {
                "lbl": 3,
                "name": "Google",
                "region": "Москва"
            }
        ],
        "search_systems_with_regions": [
            {
                "search_sestem": {
                    "id": "1",
                    "name": "Яндекс",
                    "domain": "https://yandex.ru/",
                    "slug": "yandex",
                    "date": "2017-08-04 11:10:15"
                },
                "region": {
                    "213": "Москва",
                    "2": "Санкт-Петербург",
                    "54": "Екатеринбург"
                }
            }
        ]
    },
    "dt": "2026-10-06 12:00:00"
}

Подбор запросов для домена

POST /api-rest/projects/get-words

Шаг 2 создания проекта. Запросы, по которым домен уже виден в органике Яндекса, — до 500 штук, самые частотные первыми. Берётся первый регион, где у домена набралось хотя бы 200 запросов; если такого нет, придёт пустой список — тогда запросы придётся задать самим.

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

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

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

Домен сайта без протокола.

Ответ

В data — массив строк-запросов.

POST /api-rest/projects/get-words

curl -X POST 'https://tools.pixelplus.ru/api-rest/projects/get-words' \
  -H 'token: ВАШ_JWT' \
  -H 'Content-Type: application/json' \
  -d '{
      "domain": "example.ru"
  }'

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

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 60,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => json_encode([
        'domain' => 'example.ru',
    ]),
    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/projects/get-words",
    headers={
        "token": "ВАШ_JWT",
    },
    json={
        "domain": "example.ru",
    },
    timeout=60,
)
print(response.json())

token обязательный заголовок JWT из ответа user/auth token обязательный заголовок Access token из user/auth domain обязательный Домен сайта без протокола

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

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

{
    "status": "success",
    "message": "Request successful",
    "code": 200,
    "data": [
        "купить велосипед",
        "велосипед горный",
        "велосипеды москва"
    ],
    "dt": "2026-10-06 12:00:00"
}

Создание проекта

POST /api-rest/projects/add

Шаг 3. Создаёт проект с настройками быстрого старта: главное зеркало определяется по Яндексу (если не найдено — https://<домен>), домен проекта берётся из зеркала, запросы добавляются в группу «Общая». Проект принадлежит владельцу токена.

Массивы передавайте массивами — JSON-телом или как search-systems[0][search_engine]=1 в форме. Строку с JSON внутри поля формы метод не разбирает: запросы превратятся в одну строку, а поисковые системы не добавятся.

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

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

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

Домен сайта без протокола.
search-systems array

Поисковые системы проекта: массив объектов {"search_engine": ID системы, "search_region": ID региона} из projects/ss-list. Первая становится приоритетной. Без них — Яндекс и Google, Москва.
key-words array

Запросы: массив строк (например, отредактированный ответ projects/get-words) или одна строка, где запросы разделены переводом строки. Без них проект создаётся пустым.
debug int

Проверка без создания: с 1 метод вернёт, как он понял входные данные, и проект не создаст.

1
только показать разобранные данные

Ответ

data.project_id int

ID созданного проекта — для методов rest-project.

POST /api-rest/projects/add

curl -X POST 'https://tools.pixelplus.ru/api-rest/projects/add' \
  -H 'token: ВАШ_JWT' \
  -H 'Content-Type: application/json' \
  -d '{
      "domain": "example.ru",
      "search-systems": [
          {
              "search_engine": 1,
              "search_region": 213
          },
          {
              "search_engine": 2,
              "search_region": 213
          }
      ],
      "key-words": [
          "купить велосипед",
          "велосипед горный"
      ]
  }'

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

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 60,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => json_encode([
        'domain' => 'example.ru',
        'search-systems' => [
            [
                'search_engine' => 1,
                'search_region' => 213,
            ],
            [
                'search_engine' => 2,
                'search_region' => 213,
            ],
        ],
        'key-words' => [
            'купить велосипед',
            'велосипед горный',
        ],
    ]),
    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/projects/add",
    headers={
        "token": "ВАШ_JWT",
    },
    json={
        "domain": "example.ru",
        "search-systems": [
            {
                "search_engine": 1,
                "search_region": 213,
            },
            {
                "search_engine": 2,
                "search_region": 213,
            },
        ],
        "key-words": [
            "купить велосипед",
            "велосипед горный",
        ],
    },
    timeout=60,
)
print(response.json())

token обязательный заголовок JWT из ответа user/auth token обязательный заголовок Access token из user/auth domain обязательный Домен сайта без протокола search-systems

[
    {
        "search_engine": 1,
        "search_region": 213
    },
    {
        "search_engine": 2,
        "search_region": 213
    }
]

Поисковые системы проекта: массив объектов {"search_engine": ID системы, "search_region": ID региона} из projects/ss-list key-words Запросы: массив строк (например, отредактированный ответ projects/get-words) или одна строка, где запросы разделены переводом строки · по одному на строку

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

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

{
    "status": "success",
    "message": "Project successfully created",
    "code": 200,
    "data": {
        "project_id": 7105
    },
    "dt": "2026-10-06 12:00:00"
}

Ошибки

Код	Сообщение	Когда
`404`	`Domain not found`	`ss-list`, `get-words`, `add`: не передан `domain`.
`401`	`Token is not authorized`	Нет заголовка `token` или токен недействителен — см. rest-auth.

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

{
    "status": "error",
    "message": "Domain not found",
    "code": 404,
    "data": [],
    "dt": "2026-10-06 12:00:00"
}

Запросы при создании проходят ту же проверку, что и при добавлении в интерфейсе. Проверка позиций созданного проекта идёт по расписанию быстрого старта и тратит лимиты владельца; запустить её сразу — project/positions/schedule.

rest-projects REST API: список проектов и создание нового

Список проектов

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

Ответ

Поисковые системы и регионы для домена

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

Ответ

Подбор запросов для домена

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

Ответ

Создание проекта

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

Ответ

Ошибки

`rest-projects` REST API: список проектов и создание нового