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/api/tools/set

Проверка статуса готовности задачи:

https://arsenkin.ru/api/tools/check

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

https://arsenkin.ru/api/tools/get

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

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

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

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

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

Авторизация: по токену пользователя, передается в заголовке Authorization:  Bearer %USER_API_TOKEN%.

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

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

Данные могут передаваться в теле запроса JSON.

Пример заголовка запроса, устанавливающего тип передаваемых данных:

Content-type: application/json

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

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

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

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

https://arsenkin.ru/api/tools/info

Тело запроса:

{
  "query": "limits"
}

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

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

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

https://arsenkin.ru/api/tools/info

{
  "query": "status"
}

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

https://arsenkin.ru/api/tools/tasks

{
  "action": "delete",
  "task_id": 28780004
}

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

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

https://arsenkin.ru/api/tools/tasks

{
  "action": "restart",
  "task_id": 28780004
}

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