API

Как читать JSON-RPC-пакет

`type` показывает тип сообщения. `call` означает запрос на вызов метода, `callback` означает ответ сервера, `event` означает серверное событие.

`id` в корне запроса вы задаёте сами. Это идентификатор запроса, чтобы потом понять, на какой именно вызов пришёл ответ.

Не путайте его с `result.id` в ответе метода. `id` в корне пакета — это идентификатор запроса. `result.id` — это идентификатор созданной задачи или аудита в системе.

`method` — это имя вызываемого метода, например `public/summaries/fromUrl`.

`args` — это данные, которые вы передаёте в метод. Например URL страницы, текст или `id` уже созданной задачи.

Создать заметку по ссылке

Техническое имя метода: `public/summaries/fromUrl`.

Создаёт заметку по ссылке. Этот метод нужен, когда материал уже лежит в сети и достаточно передать URL страницы.

В ответе вы получите `success`, `id` задачи и стартовый `status`. Сам итоговый текст заметки появится позже, когда задача завершится.

curl -X POST 'https://server.ranklyai.ru/api' \
  -H 'Authorization: Bearer rnk_your_api_key' \
  -H 'Content-Type: application/json' \
  -d '{
    "type": "call",
    "id": "request-1",
    "method": "public/summaries/fromUrl",
    "args": [{ "url": "https://example.com/article" }]
  }'

{
  "type": "callback",
  "id": "request-1",
  "result": {
    "success": true,
    "id": 9123,
    "status": "PROCESSING"
  }
}

Создать заметку из текста

Техническое имя метода: `public/summaries/fromText`.

Создаёт заметку из переданного текста. Полезно для черновиков, документов, писем и любого контента без публичного URL.

Логика ответа такая же: сначала приходит подтверждение создания задачи, потом результат читается через `get`.

curl -X POST 'https://server.ranklyai.ru/api' \
  -H 'Authorization: Bearer rnk_your_api_key' \
  -H 'Content-Type: application/json' \
  -d '{
    "type": "call",
    "id": "request-2",
    "method": "public/summaries/fromText",
    "args": [{ "text": "Большой текст статьи или документа" }]
  }'

Получить результат заметки

Техническое имя метода: `public/summaries/get`.

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

Именно этот метод обычно вызывается после `fromUrl` или `fromText`, чтобы понять, завершилась задача или ещё нет.

curl -X POST 'https://server.ranklyai.ru/api' \
  -H 'Authorization: Bearer rnk_your_api_key' \
  -H 'Content-Type: application/json' \
  -d '{
    "type": "call",
    "id": "request-3",
    "method": "public/summaries/get",
    "args": [{ "id": 9123 }]
  }'

Получить список заметок

Техническое имя метода: `public/summaries/list`.

Возвращает список уже созданных заметок с метаданными. Этот метод нужен для истории, таблиц в интерфейсе, поиска по библиотеке и повторного открытия прошлых материалов.

curl -X POST 'https://server.ranklyai.ru/api' \
  -H 'Authorization: Bearer rnk_your_api_key' \
  -H 'Content-Type: application/json' \
  -d '{
    "type": "call",
    "id": "request-4",
    "method": "public/summaries/list",
    "args": [{}]
  }'

Получить типы страниц

Техническое имя метода: `public/seo/pageTypes`.

Возвращает доступные типы страниц для аудита. Обычно именно с этого метода начинает интерфейс, чтобы показать пользователю понятные варианты вроде карточки товара, категории, блога или лендинга.

curl -X POST 'https://server.ranklyai.ru/api' \
  -H 'Authorization: Bearer rnk_your_api_key' \
  -H 'Content-Type: application/json' \
  -d '{
    "type": "call",
    "id": "request-5",
    "method": "public/seo/pageTypes",
    "args": [{}]
  }'

Запустить SEO-аудит

Техническое имя метода: `public/seo/audit`.

Запускает SEO-аудит страницы. На вход обычно передаются URL, целевые запросы и тип страницы. В ответе приходит подтверждение запуска и `id` аудита.

Сам итоговый отчёт появляется не сразу, а после обработки. Поэтому после этого метода обычно вызывают `public/seo/get` или ждут событие в `/ws`.

curl -X POST 'https://server.ranklyai.ru/api' \
  -H 'Authorization: Bearer rnk_your_api_key' \
  -H 'Content-Type: application/json' \
  -d '{
    "type": "call",
    "id": "request-6",
    "method": "public/seo/audit",
    "args": [{ "url": "https://example.com", "targetQueries": ["купить носки"], "pageType": "ecommerce" }]
  }'

Получить результат аудита

Техническое имя метода: `public/seo/get`.

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

curl -X POST 'https://server.ranklyai.ru/api' \
  -H 'Authorization: Bearer rnk_your_api_key' \
  -H 'Content-Type: application/json' \
  -d '{
    "type": "call",
    "id": "request-7",
    "method": "public/seo/get",
    "args": [{ "id": "2311" }]
  }'

Получить список аудитов

Техническое имя метода: `public/seo/list`.

Возвращает список прошлых SEO-аудитов. Этот метод полезен для таблиц, истории проверок, повторного открытия отчётов и административных интерфейсов.

curl -X POST 'https://server.ranklyai.ru/api' \
  -H 'Authorization: Bearer rnk_your_api_key' \
  -H 'Content-Type: application/json' \
  -d '{
    "type": "call",
    "id": "request-8",
    "method": "public/seo/list",
    "args": [{}]
  }'

Получить сигнал о готовности аудита

Техническое имя события: `seo/audit.ready`.

Это событие приходит в WebSocket, когда аудит завершён и результат уже можно забирать через `public/seo/get`.

{
  "type": "event",
  "name": "seo/audit.ready",
  "data": { "auditId": 2311 }
}