Парсер: задачи сбора и воркеры
Парсер собирает данные, из которых потом получается база контактов кампании. Он опубликован только в версии v1 — в v2 этих операций нет.
Работа делится на три части: задачи сбора, системные аккаунты, от имени которых сбор идёт, и воркеры, которые его выполняют.
Задачи сбора#
/v1/parser/tasksСписок задач сбора.
Отправляется в заголовке Authorization. Ваш ключ используется только вашим браузером для этого запроса — он никогда не отправляется в Docsbook и не сохраняется.
/v1/parser/tasksСоздать задачу сбора. Тело запроса — JSON.
Отправляется в заголовке Authorization. Ваш ключ используется только вашим браузером для этого запроса — он никогда не отправляется в Docsbook и не сохраняется.
/v1/parser/tasks/{task_id}Состояние задачи сбора.
Отправляется в заголовке Authorization. Ваш ключ используется только вашим браузером для этого запроса — он никогда не отправляется в Docsbook и не сохраняется.
UUID задачи
/v1/parser/tasks/{task_id}/cancelОтменить выполняющуюся задачу.
Отправляется в заголовке Authorization. Ваш ключ используется только вашим браузером для этого запроса — он никогда не отправляется в Docsbook и не сохраняется.
UUID задачи
/v1/parser/tasks/{task_id}/exportВыгрузить результат задачи.
Отправляется в заголовке Authorization. Ваш ключ используется только вашим браузером для этого запроса — он никогда не отправляется в Docsbook и не сохраняется.
UUID задачи
/v1/parser/tasks/{task_id}Удалить задачу вместе с её результатом.
Отправляется в заголовке Authorization. Ваш ключ используется только вашим браузером для этого запроса — он никогда не отправляется в Docsbook и не сохраняется.
UUID задачи
/v1/parser/entity-checksСоздать проверку сущности. Тело запроса — JSON.
Отправляется в заголовке Authorization. Ваш ключ используется только вашим браузером для этого запроса — он никогда не отправляется в Docsbook и не сохраняется.
Системные аккаунты#
Системные аккаунты — отдельные аккаунты, от имени которых работает парсер. Они подключаются собственной сессией авторизации, устроенной так же, как подключение обычного аккаунта: код, при необходимости облачный пароль.
/v1/parser/system-accountsСписок системных аккаунтов парсера.
Отправляется в заголовке Authorization. Ваш ключ используется только вашим браузером для этого запроса — он никогда не отправляется в Docsbook и не сохраняется.
/v1/parser/system-accounts/{account_id}Карточка системного аккаунта.
Отправляется в заголовке Authorization. Ваш ключ используется только вашим браузером для этого запроса — он никогда не отправляется в Docsbook и не сохраняется.
UUID системного аккаунта
/v1/parser/system-accounts/{account_id}Отключить системный аккаунт.
Отправляется в заголовке Authorization. Ваш ключ используется только вашим браузером для этого запроса — он никогда не отправляется в Docsbook и не сохраняется.
UUID системного аккаунта
/v1/parser/system-accounts/auth-sessionsОткрыть сессию авторизации системного аккаунта. Тело запроса — JSON.
Отправляется в заголовке Authorization. Ваш ключ используется только вашим браузером для этого запроса — он никогда не отправляется в Docsbook и не сохраняется.
/v1/parser/system-accounts/auth-sessions/{auth_id}Состояние сессии авторизации.
Отправляется в заголовке Authorization. Ваш ключ используется только вашим браузером для этого запроса — он никогда не отправляется в Docsbook и не сохраняется.
UUID сессии
/v1/parser/system-accounts/auth-sessions/{auth_id}/codeПередать код подтверждения. Тело запроса — JSON.
Отправляется в заголовке Authorization. Ваш ключ используется только вашим браузером для этого запроса — он никогда не отправляется в Docsbook и не сохраняется.
UUID сессии
/v1/parser/system-accounts/auth-sessions/{auth_id}/passwordПередать облачный пароль при двухфакторной защите. Тело запроса — JSON.
Отправляется в заголовке Authorization. Ваш ключ используется только вашим браузером для этого запроса — он никогда не отправляется в Docsbook и не сохраняется.
UUID сессии
/v1/parser/system-accounts/auth-sessions/{auth_id}Прервать незавершённую сессию.
Отправляется в заголовке Authorization. Ваш ключ используется только вашим браузером для этого запроса — он никогда не отправляется в Docsbook и не сохраняется.
UUID сессии
Воркеры#
/v1/parser/workersСписок воркеров парсера и их состояние.
Отправляется в заголовке Authorization. Ваш ключ используется только вашим браузером для этого запроса — он никогда не отправляется в Docsbook и не сохраняется.
/v1/parser/workers/{node_name}Состояние одного воркера.
Отправляется в заголовке Authorization. Ваш ключ используется только вашим браузером для этого запроса — он никогда не отправляется в Docsbook и не сохраняется.
Имя узла воркера
Дальше#
- Кампании и контакты — куда попадает собранная база.
- Справочник v1 — остальные операции первой версии.