Документация по API ARSENKIN TOOLS

Документация по API сервиса «ARSENKIN TOOLS» поможет разработчикам и пользователям получать данные от инструментов для собственных разработок в удобном JSON формате.

API поддерживается только для пользователей на платных тарифах STANDARD и КОРПОРАТИВНЫЙ.

Как получить токен API?

Чтобы получить токен API выполните следующие действия:

• Зарегистрируйтесь в сервисе ARSENKIN TOOLS.
• Перейдите в раздел Данные профиля.
• Сгенерировать API токен.

Обратите внимание. Создание токена API возможно только после покупки тарифа STANDARD или КОРПОРАТИВНЫЙ.

Введение в API

URL запроса для обращения к серверу API

Все запросы к API должны направляться на https://arsenkin.ru/tools/api/ с помощью метода POST.

• https://arsenkin.ru/tools/api/task/set - постановка задачи;
• https://arsenkin.ru/tools/api/task/check - проверка статуса задачи;
• https://arsenkin.ru/tools/api/task/result - получение результата (если вы получаете 500 код ответа, значит задача ещё не выполнена. Мы настоятельно рекомендуем проверять статус выполнения задачи);

Ограничение на использование API

1) Для одного пользователя - выполняется не более 5-и задач одновременно, не более. В случае попытки постановки задач сверх лимита выдается ошибка либо уходит в очередь. Размер очереди - 50 задач, после уже задачи не будут ставиться.

2) За одну минуту можно делать не более 30 запросов ко всем статусам (включая постановку задач, проверку статуса и передачу результатов). При превышении этого лимита, вы получите код ошибки 429. Пожалуйста, повторите попытку.

{"status":"Error","code":"429","error":"Too Many Requests"}

Формат передачи данных

Авторизация: по токену пользователя, передается в качестве GET параметра с именем token.

Название инструмента: передается в качестве GET параметра с именем tools_name.

Постановка задачи: осуществляется посредством POST запроса на url https://arsenkin.ru/tools/api/task/set.

ВАЖНО. Все параметры передаваемые в инструментах должны идти через POST запрос, кроме token и tools_name. Пример PHP кода по ссылке.

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

Поддерживается только один формат ответа: JSON.

Получение системной информации

Получение информации о имеющихся и затраченных лимитах аккаунта.

https://arsenkin.ru/tools/api/stat?token=ВАШ_ТОКЕН

limits_total - общее количество лимитов на аккаунте

Возвращает JSON с результатами, пример ответа:

{
  "limits_total": 30000
}

---

Получение списка задач, которые ВЫПОЛНЯЮТСЯ на текущий момент (выполненные задачи списком нельзя получить).

https://arsenkin.ru/tools/api/tasks?token=ВАШ_ТОКЕН

Возвращает JSON с результатами, пример ответа:

[
  {
    "user_id": 84216,
    "task_id": 23319462,
    "tools": "Выгрузка ТОП",
    "datetime": "2024-01-29 11:15:31",
    "progress": "49",
    "status": "process"
  },
  {
    "user_id": 84216,
    "task_id": 23319469,
    "tools": "Проверка коммерциализации",
    "datetime": "2024-01-29 11:16:13",
    "progress": "28",
    "status": "process"
  }
]

---

Удалить задачу в статусе "В работе"

https://arsenkin.ru/tools/api/action/delete?token=ВАШ_ТОКЕН&task_id=ID_ЗАДАЧИ

Данный метод позволяет удалить задачу, которая сейчас находится в статусе "В работе". Метод дублирует функционал со страницы https://arsenkin.ru/tools/queue/.

---

Перезапустить задачу (использовать осторожно)

https://arsenkin.ru/tools/api/action/restart?token=ВАШ_ТОКЕН&task_id=ID_ЗАДАЧИ

Данный метод позволяет перезапустить задачу, которая сейчас находится в статусе "В работе". Метод дублирует функционал со страницы https://arsenkin.ru/tools/queue/. Функционал активируется через 12 часов после постановки задачи.

Статусы ошибок

'error' => 'Access denied! Invalid token', 'error_code' => 1
'error' => 'Не указан task_id', 'error_code' => 3
'error' => 'Undefinded action', 'error_code' => 2

'error_code' => 3, 'message' => 'Активные задачи можно перезапустить только через 1 час'
'error_code' => 0, 'message' => 'Задача успешно перезапущена...'
'status' => 1, 'message' => 'Ошибка перезапуска'
'status' => 0, 'message' => 'Задача успешно удалена...'
'status' => 1, 'message' => 'Ошибка удаления'
'status' => 2, 'message' => 'Задача не найдена в списке активных или это не ваша задача'

---

Методы для инструментов

• api-commerce - проверка коммерциализации, геозависимости и локализации
• api-parser-ads - парсинг рекламы Яндекс
• api-top - Парсинг и выгрузка ТОП
• api-indexation - Проверка индексации URL
• api-paa - Парсинг быстрых ответов/похожих запросов
• api-wordstat - Яндекс Wordstat
• api-whois - Сбор Whois
• api-clustering - Кластеризация
• api-suggest - Сбор поисковых подсказок
• api-iks - Проверка ИКС
• api-relevant-url - Определение релевантных страниц по ключевым фразам

Коды ошибок

all
'error' => 'Access denied! Invalid token', 'error_code' => 1

check-h
'error' => 'Internal parsing error!', 'error_code' => 500 - ошибка разбора парсинга
'error' => 'Parsing keywords error!', 'error_code' => 501
'error' => 'Fields ' . implode(', ', array_keys($validator->failed())) . ' required!', 'error_code' => 400
'error' => 'Search System Region is not found', 'error_code' => 406
'error' => "Not enough limits! ($limits_used/$limits_total)",'error_code' => 51

relevant-url
'error' => 'Internal parsing error!', 'error_code' => 500 - ошибка разбора парсинга
'error' => 'Empty URL!', 'error_code' => 402
'error' => 'Empty keywords json array!', 'error_code' => 401
'error' => 'Parsing keywords error!', 'error_code' => 501
'error' => 'Wrong ss!', 'error_code' => 403
'error' => 'Wrong region!', 'error_code' => 405
'error' => 'Search System Region is not found', 'error_code' => 406
'error' => "Not enough limits! ($limits_used/$limits_total)",'error_code' => 51

iks
'error' => 'Internal parsing error!', 'error_code' => 500 - ошибка разбора парсинга
'error' => 'Empty keywords json array!', 'error_code' => 401
'error' => 'Parsing keywords error!', 'error_code' => 501
'error' => 'Empty urls json array!', 'error_code' => 402
'error' => 'Wrong ss!', 'error_code' => 403
'error' => 'Wrong depth!', 'error_code' => 404
'error' => 'Wrong region!', 'error_code' => 405
'error' => 'Search System Region is not found', 'error_code' => 406
'error' => "Not enough limits! ($limits_used/$limits_total)",'error_code' => 51

paa
'error' => 'Internal parsing error!', 'error_code' => 500 - ошибка разбора парсинга
'error' => 'Queries :  minimum 1 query ', 'error_code' => 42
'error' => 'Queries : max ' . $limits, 'error_code' => 43
'error' => 'Wrong Search System ', 'error_code' => 50
'error' => 'Wrong Search System Region ', 'error_code' => 51
'error' => 'Search System Region is not found', 'error_code' => 59
'error' => 'Need Google domain (google_domain)','error_code' => 65
'error' => 'Need Google from country (google_from)', 'error_code' => 66
'error' => 'Need Google lang (google_lang)','error_code' => 67
'error' => 'This Count is not avalible', 'error_code' => 52
'error' => 'This Depth is not avalible', 'error_code' => 53
'error' => "Not enough limits! ($limits_used/$limits_total)",'error_code' => 51

parser-ads
'error' => 'Internal parsing error!', 'error_code' => 500 - ошибка разбора парсинга
'error' => 'Tariff : not possible in your tariff ', 'error_code' => 40
'error' => 'Internal parsing error!', 'error_code' => 500
'error' => 'Queries :  minimum 1 query ', 'error_code' => 42
'error' => 'Queries : max ' . $limits, 'error_code' => 43
'error' => 'Sites : max 400 symbols. URL to long ' . $url, 'error_code' => 45
'error' => 'Max count of regions is 10', 'error_code' => 47
'error' => 'Yandex region is wrong', 'error_code' => 46
'error' => 'Device is wrong, only:desktop,mobile', 'error_code' => 46
'error' => "Not enough limits! ($limits_used/$limits_total)",'error_code' => 51

clustering
'error' => 'Internal parsing error!', 'error_code' => 500 - ошибка разбора парсинга
'error' => 'Unknown SearchSystem ','error_code' => 71
'error' => 'Queries : wrong JSON! ', 'error_code' => 41
'error' => 'Queries : minimum 2 query! ', 'error_code' => 42
'error' => 'Need site url ', 'error_code' => 43
'error' => 'Queries : max query length is ' . $max, 'error_code' => 44
'val' => $validator->failed(), 'error_code' => 45
'error' => "Not enough limits! ($limits_used/$limits_total)",'error_code' => 51

suggest
'error' => 'Internal parsing error!', 'error_code' => 500 - ошибка разбора парсинга
'error' => 'Queries : wrong JSON! ', 'error_code' => 41
'error' => 'No keywords ', 'error_code' => 42
'error' => 'No parsing types ', 'error_code' => 43
'val' => implode(" ", array_flatten($validator->errors()->messages())),'error_code' => 45
'error' => "Not enough limits! ($limits_used/$limits_total)",'error_code' => 51

whois
'error' => 'Queries : wrong JSON! ', 'error_code' => 41
'val' => implode(" ", array_flatten($validator->errors()->messages())),'error_code' => 45
'error' => "Not enough limits! ($limits_used/$limits_total)",'error_code' => 51

commerce
'error' => 'Queries : wrong JSON! ', 'error_code' => 41
'error' => "Not enough limits! ($limits_used/$limits_total)",'error_code' => 51
'error' => 'Unknown SearchSystem ','error_code' => 71

wordstat
'error' => 'Queries : wrong JSON! ', 'error_code' => 41
'error' => 'Queries : Too mutch queries! ', 'error_code' => 41
'error' => "Nothing to check!", 'error_code' => 505
'error' => "Not enough limits! ($limits_used/$limits_total)",'error_code' => 51

top10
'error' => 'Internal parsing error!', 'error_code' => 500 - ошибка разбора парсинга
'error' => 'Queries : wrong JSON! ', 'error_code' => 41
'error' => 'Queries : empty! ', 'error_code' => 42
'error' => 'Queries : max ' . $limits, 'error_code' => 43
'error' => 'Unknown SearchSystem ss' . $s, 'error_code' => 71
'error' => 'SearchSystem : unknown Region ss' . $s, 'error_code' => 72
'error' => "Not enough limits! ($limits_used/$limits_total)",'error_code' => 51

indexation
'error' => 'Internal parsing error!', 'error_code' => 500 - ошибка разбора парсинга
'error' => 'Select a SearchSystem !', 'error_code' => 71
'error' => 'Urls : wrong JSON! ', 'error_code' => 41
'error' => 'Urls : wrong or empty JSON! ', 'error_code' => 41
'error' => "Not enough limits! ($limits_used/$limits_total)",'error_code' => 51

---

---

---