Описание работы API ARSENKIN TOOLS
Инструменты, для которых доступно API в настоящий момент:
- Проверка коммерциализации - (tools_name=commerce). Описание API.
- Проверка индексации документа - (tools_name=indexation). Описание API.
- Выгрузка ТОП - (tools_name=top10). Описание API.
- Сбор частотности Яндекс Вордстат - (tools_name=wordstat). Описание API.
Основные URL для работы с API:
- https://arsenkin.ru/tools/api/task/set - постановка задачи
- https://arsenkin.ru/tools/api/task/check - проверка статуса задачи
- https://arsenkin.ru/tools/api/task/result - получение результата
Ограничения:
Для одного пользователя - выполняется не более 3х задач одного типа одновременнно. В случае попытки постановки задач сверх лимита выдается ошибка, задача не ставится.
Формат ответа: JSON
Авторизация: по токену пользователя, передается в качестве GET либо POST параметра с именем token. Токен доступа можно получить в разделе «профиль» (только для тарифов Standard и Корпоративный)
Постановка задачи: осуществляется посредством GET/POST запроса на url https://arsenkin.ru/tools/api/task/set.
Описание для инструмента «Сбор частотности Яндекс Вордстат»
Для инструмента «Сбор частотности Яндекс Вордстат» обязательные параметры:
- tools_name=wordstat - название инструмента
- queries=JSON - фразы для проверки, массив в формате JSON, пример: queries=["\u043a\u0443\u043f\u0438\u0442\u044c \u0444\u043b\u0430\u0433"]
- lr=213 - регион поиска по Яндексу
- base=true/false - получение основной частоы (WS) по запросам
Для инструмента «Проверка частот Вордстат» возможны дополнительные параметры:
- lr1=213 - первый дополнительный регион поиска по Яндексу.
- lr2=2 - второй дополнительный регион поиска по Яндексу.
- lr3=47 - третий дополнительный регион поиска по Яндексу.
- quoted=true/false - получение частоы "WS" по запросам.
- overal=true/false - получение частоы "!WS" по запросам.
- exact=true/false - получение частоы "[!WS]" по запросам.
- device=desktop/mobile - уточнение устройства для сбора частоты.
Для инструмента «Проверка частот Вордстат» для получения сезонности по запросу:
- type=3 - тип проверки (3 - проверка сезонности, по умолчанию 1).
- query=ФРАЗА - фраза для проверки сезонности
Возвращает JSON с ID задачи, пример ответа: {"task_id":3944}
Проверка статуса задачи: осуществляется посредством GET запроса на url https://arsenkin.ru/tools/api/task/check
Обязательные параметры:
- task_id=12345 - ID задачи
Возвращает JSON со статусом задачи, пример ответа: {"status":"Done","progress":100}. Progress - ориентировочный прогресс выполнения задачи, в %.
Получение результата:
Осуществляется посредством GET запроса на url https://arsenkin.ru/tools/api/task/result
Обязательные параметры:
- task_id=12345 - ID задачи
Возвращает JSON с результатами проверки, пример ответа:
{ "\u043a\u0443\u043f\u0438\u0442\u044c \u0444\u043b\u0430\u0433\u0438": { "213":{ "base":8435 } } }
Массив 'result': Ключ - проверяемая фраза, значение - массив, в нем: ключ код региона Яндекс, значение массив полученных частот.
Описание для инструмента «Проверка коммерциализации, геозависимости и локализации»
Для инструмента «Проверка коммерциализации» обязательные параметры:
- tools_name=commerce - название инструмента
- queries=JSON - фразы для проверки, массив в формате JSON, пример: queries=["\u043a\u0443\u043f\u0438\u0442\u044c \u0444\u043b\u0430\u0433"]
- lr=213 - регион поиска для Яндекса или Google. Для Google указываем id региона из файла. Например, Москва в Google имеет id 1011969.
- ss - выбор поисковой системы: Яндекс - 1, Google - 2.
Возвращает JSON с ID задачи, пример ответа: {"task_id":3944}
Пример: https://arsenkin.ru/tools/api/task/set?token=ВАШ_ТОКЕН&tools_name=commerce&ss=1&lr=213&queries=[%22%5Cu0447%5Cu0435%5Cu043c%5Cu043e%5Cu0434%5Cu0430%5Cu043d%22,%22%5Cu043a%5Cu0443%5Cu043f%5Cu0438%5Cu0442%5Cu044c%20%5Cu0447%5Cu0435%5Cu043c%5Cu043e%5Cu0434%5Cu0430%5Cu043d%22]
Проверка статуса задачи: осуществляется посредством GET запроса на url https://arsenkin.ru/tools/api/task/check
Обязательные параметры:
- task_id=12345 - ID задачи
Возвращает JSON со статусом задачи, пример ответа: {"status":"Done","progress":100}. Progress - ориентировочный прогресс выполнения задачи, в %.
Пример: https://arsenkin.ru/tools/api/task/check?token=ВАШ_ТОКЕН&task_id=ID_ЗАДАЧИ
Получение результата:
Осуществляется посредством GET запроса на url https://arsenkin.ru/tools/api/task/result
Пример: https://arsenkin.ru/tools/api/task/result?token=ВАШ_ТОКЕН&task_id=ID_ЗАДАЧИ
Обязательные параметры:
- task_id=12345 - ID задачи
Возвращает JSON с результатами проверки, пример ответа:
{ "result": { "\u0447\u0435\u043c\u043e\u0434\u0430\u043d": { "yandex_comm":97,"loc":55,"geo":1}, "\u043a\u0443\u043f\u0438\u0442\u044c \u0447\u0435\u043c\u043e\u0434\u0430\u043d": { "yandex_comm":97,"loc":55,"geo":1} } }
Массив 'result': Ключевая фраза - проверяемая фраза, значение - массив, в нем:
- yandex_comm и google_comm - результат проверки коммерциализации, loc - локализации и geo - геозависимости (1 - геозависимый, 0 - геонезависимый) в Яндекс или Google, в %
Описание для инструмента «Проверка индексации документа»
Для инструмента «Проверка индексации документа» обязательные параметры:
- tools_name=indexation - название инструмента
- urls=JSON - Список url для проверки, массив в формате JSON, пример: urls=["https:\/\/nuzhna-mebel.ru\/shop\/shkafy-kupe\/2-metra"]
- yandex_check=0 либо 1 - флаг проверки индексации в Яндекс
- google_check=0 либо 1 - флаг проверки индексации в Google
- search_all=0 либо 1 - флаг, учитывать http/https/www единым URL или нет
Возвращает JSON с ID задачи, пример ответа: {"task_id":3944}
Проверка статуса задачи: осуществляется посредством GET запроса на url https://arsenkin.ru/tools/api/task/check
Обязательные параметры:
- task_id=12345 - ID задачи
Возвращает JSON со статусом задачи, пример ответа: {"status":"Done","progress":100}. Progress - ориентировочный прогресс выполнения задачи, в %.
Получение результата:
Осуществляется посредством GET запроса на url https://arsenkin.ru/tools/api/task/result
Обязательные параметры:
- task_id=12345 - ID задачи
Возвращает JSON с результатами проверки, пример ответа:
{ "https:\/\/nuzhna-mebel.ru\/shop\/shkafy-kupe\/2-metra": { "yandex":1, "yandex_doc_date":"02.06.2019 [16:03:16]", "indexdate":"2019-05-15", "yandex_doc":"https:\/\/hghltd.yandex.net\/yandbtm?lang=ru&fmode=inject&tm=1560576682&tld=ru&la=1559480576&text=%28url%3Anuzhna-mebel.ru%2Fshop%2Fshkafy-kupe%2F2-metra%20%7C%20url%3Awww.nuzhna-mebel.ru%2Fshop%2Fshkafy-kupe%2F2-metra%29&url=https%3A%2F%2Fnuzhna-mebel.ru%2Fshop%2Fshkafy-kupe%2F2-metra&l10n=ru&mime=html&sign=9b19d3a4292d2b41bde3da24762c9e55&keyno=0" } }
Описание для инструмента «Выгрузка ТОП-10»
Для инструмента «Выгрузка ТОП-10» обязательные параметры:
- tools_name=top10 - название инструмента
- queries=JSON - фразы для проверки, массив в формате JSON, пример: queries=["\u043a\u0443\u043f\u0438\u0442\u044c \u0444\u043b\u0430\u0433"]
- ss(i)=N - выбор поисковой системы: Яндекс XML = 1, Яндекс Desktop = 2, Яндекс Mobile = 3, Google Desktop = 11, Google Mobile = 12. i - порядковый номер ПС: 2, 3 и 4. Пример: ss2=12 - вторая поисковая система Google Mobile. Первая ПС всегда по умолчанию - ss.
- lr=id региона - регион поиска для Яндекса или Google. Для Google указываем id региона из файла. Например, Москва в Google имеет id 1011969, а в Яндексе - 213. lr=ID - регион для первой ПС (по умолчанию), lr2=ID - регион для второй ПС, lr3=ID - регион для третьей ПС, lr4=ID - регион для четвертой ПС.
- deep=10 - глубина сбора, необязательный параметр, по умолчанию = 10. Может иметь показатели: 5, 10, 20, 30, 50 и 100.
- is_snippet=1 или 0 - получение заголовка и описания страницы из сниппета поисковой выдачи. По умолчанию = 0.
Возвращает JSON с ID задачи, пример ответа: {"task_id":3944}
Пример: https://arsenkin.ru/tools/api/task/set?token=ВАШ_ТОКЕН&tools_name=top10&ss=1&lr=213&ss2=2&lr2=213&ss3=12&lr3=1011969&queries=[%22%5Cu0447%5Cu0435%5Cu043c%5Cu043e%5Cu0434%5Cu0430%5Cu043d%22,%22%5Cu043a%5Cu0443%5Cu043f%5Cu0438%5Cu0442%5Cu044c%20%5Cu0447%5Cu0435%5Cu043c%5Cu043e%5Cu0434%5Cu0430%5Cu043d%22]
Проверка статуса задачи: осуществляется посредством GET запроса на url https://arsenkin.ru/tools/api/task/check
Пример: https://arsenkin.ru/tools/api/task/check?token=ВАШ_ТОКЕН&task_id=ID_ЗАДАЧИ
Обязательные параметры:
- task_id=12345 - ID задачи
Получение результата:
Осуществляется посредством GET запроса на url https://arsenkin.ru/tools/api/task/result
Пример: https://arsenkin.ru/tools/api/task/result?token=ВАШ_ТОКЕН&task_id=ID_ЗАДАЧИ
Обязательные параметры:
- task_id=12345 - ID задачи
Возвращает JSON с результатами проверки, пример ответа:
{ "\u043a\u0443\u043f\u0438\u0442\u044c \u0444\u043b\u0430\u0433": [ "https:\/\/www.megaflag.ru\/shop", "https:\/\/flag.ru\/internet-magazin\/flagi\/", "https:\/\/atributia.ru\/catalog\/kupit-flag", "https:\/\/xn-----7kcbnzcflm0akguynv9byg.xn--p1ai\/", "https:\/\/podarki-moscow.ru\/category\/flags\/", "https:\/\/moskva.tiu.ru\/Flag-rossii.html", "https:\/\/Voentorg177.ru\/flagi", "https:\/\/voen-torg.ru\/flagi\/", "https:\/\/flagfs.ru\/products\/flags\/", "https:\/\/www.proflag.ru\/katalog\/flag\/flagi-rf-moskvyi-pobedyi" ] }
Массив: Ключ - проверяемая фраза, значение - массив Url из Top.