NN Agent
Overview

Парсер: задачи сбора и воркеры

Работа делится на три части: задачи сбора, системные аккаунты, от имени которых сбор идёт, и воркеры, которые его выполняют.

Задачи сбора#

GET/v1/parser/tasks

Список задач сбора.

Authorization
Authorizationstring

Sent as the Authorization header. Your key is used only by your browser for this request — it is never sent to Docsbook or stored.

POST/v1/parser/tasks

Создать задачу сбора. Тело запроса — JSON.

Authorization
Authorizationstring

Sent as the Authorization header. Your key is used only by your browser for this request — it is never sent to Docsbook or stored.

GET/v1/parser/tasks/{task_id}

Состояние задачи сбора.

Authorization
Authorizationstring

Sent as the Authorization header. Your key is used only by your browser for this request — it is never sent to Docsbook or stored.

Path
task_idstringrequired

UUID задачи

POST/v1/parser/tasks/{task_id}/cancel

Отменить выполняющуюся задачу.

Authorization
Authorizationstring

Sent as the Authorization header. Your key is used only by your browser for this request — it is never sent to Docsbook or stored.

Path
task_idstringrequired

UUID задачи

GET/v1/parser/tasks/{task_id}/export

Выгрузить результат задачи.

Authorization
Authorizationstring

Sent as the Authorization header. Your key is used only by your browser for this request — it is never sent to Docsbook or stored.

Path
task_idstringrequired

UUID задачи

DELETE/v1/parser/tasks/{task_id}

Удалить задачу вместе с её результатом.

Authorization
Authorizationstring

Sent as the Authorization header. Your key is used only by your browser for this request — it is never sent to Docsbook or stored.

Path
task_idstringrequired

UUID задачи

POST/v1/parser/entity-checks

Создать проверку сущности. Тело запроса — JSON.

Authorization
Authorizationstring

Sent as the Authorization header. Your key is used only by your browser for this request — it is never sent to Docsbook or stored.

Системные аккаунты#

Системные аккаунты — отдельные аккаунты, от имени которых работает парсер. Они подключаются собственной сессией авторизации, устроенной так же, как подключение обычного аккаунта: код, при необходимости облачный пароль.

GET/v1/parser/system-accounts

Список системных аккаунтов парсера.

Authorization
Authorizationstring

Sent as the Authorization header. Your key is used only by your browser for this request — it is never sent to Docsbook or stored.

GET/v1/parser/system-accounts/{account_id}

Карточка системного аккаунта.

Authorization
Authorizationstring

Sent as the Authorization header. Your key is used only by your browser for this request — it is never sent to Docsbook or stored.

Path
account_idstringrequired

UUID системного аккаунта

DELETE/v1/parser/system-accounts/{account_id}

Отключить системный аккаунт.

Authorization
Authorizationstring

Sent as the Authorization header. Your key is used only by your browser for this request — it is never sent to Docsbook or stored.

Path
account_idstringrequired

UUID системного аккаунта

POST/v1/parser/system-accounts/auth-sessions

Открыть сессию авторизации системного аккаунта. Тело запроса — JSON.

Authorization
Authorizationstring

Sent as the Authorization header. Your key is used only by your browser for this request — it is never sent to Docsbook or stored.

GET/v1/parser/system-accounts/auth-sessions/{auth_id}

Состояние сессии авторизации.

Authorization
Authorizationstring

Sent as the Authorization header. Your key is used only by your browser for this request — it is never sent to Docsbook or stored.

Path
auth_idstringrequired

UUID сессии

POST/v1/parser/system-accounts/auth-sessions/{auth_id}/code

Передать код подтверждения. Тело запроса — JSON.

Authorization
Authorizationstring

Sent as the Authorization header. Your key is used only by your browser for this request — it is never sent to Docsbook or stored.

Path
auth_idstringrequired

UUID сессии

POST/v1/parser/system-accounts/auth-sessions/{auth_id}/password

Передать облачный пароль при двухфакторной защите. Тело запроса — JSON.

Authorization
Authorizationstring

Sent as the Authorization header. Your key is used only by your browser for this request — it is never sent to Docsbook or stored.

Path
auth_idstringrequired

UUID сессии

DELETE/v1/parser/system-accounts/auth-sessions/{auth_id}

Прервать незавершённую сессию.

Authorization
Authorizationstring

Sent as the Authorization header. Your key is used only by your browser for this request — it is never sent to Docsbook or stored.

Path
auth_idstringrequired

UUID сессии

Воркеры#

GET/v1/parser/workers

Список воркеров парсера и их состояние.

Authorization
Authorizationstring

Sent as the Authorization header. Your key is used only by your browser for this request — it is never sent to Docsbook or stored.

GET/v1/parser/workers/{node_name}

Состояние одного воркера.

Authorization
Authorizationstring

Sent as the Authorization header. Your key is used only by your browser for this request — it is never sent to Docsbook or stored.

Path
node_namestringrequired

Имя узла воркера

Дальше#

Updated

Работает на Docsbook
Парсер: задачи сбора и воркеры — NN Agent