Инструменты, для которых доступно 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=commerce - название инструмента
  • queries=JSON - фразы для проверки, массив в формате JSON, пример: queries=["\u043a\u0443\u043f\u0438\u0442\u044c \u0444\u043b\u0430\u0433"]
  • lr=213 - регион поиска по Яндексу

Возвращает 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 с результатами проверки, пример ответа:

                    {
                        "result":
                            {
                                "\u043a\u0443\u043f\u0438\u0442\u044c \u0444\u043b\u0430\u0433":
                                        {
                                            "yandex_comm":100
                                        },
                                "\u0447\u0430\u0441\u044b":
                                        {
                                            "yandex_comm":100
                                        },
                                "\u0444\u043b\u0430\u0433":
                                        {
                                            "yandex_comm":10
                                        }
                            }
                    }
                    

Массив 'result': Ключ - проверяемая фраза, значение - массив, в нем: yandex_comm - результат проверки коммерции в Яндекс, в %.


Описание для инструмента «Проверка индексации документа»

Для инструмента «Проверка индексации документа» обязательные параметры:

  • 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
  • type=no_filter - необязательный параметр, тип проверки, по умолчанию = no_filter, может принимать значения no_filter, site, site_site_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"]
  • lr=213 - регион поиска по Яндексу
  • google_region=1011969 - регион в Google (полный список регионов - скачать)
  • searchsystem=yandex либо google - регион поиска по Яндексу
  • deep=10 - глубина сбора, необязательный параметр, по умолчанию = 10

Возвращает JSON с ID задачи, пример ответа: {"task_id":3944}

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

Обязательные параметры:

  • task_id=12345 - ID задачи

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

Осуществляется посредством GET запроса на url https://arsenkin.ru/tools/api/task/result

Обязательные параметры:

  • 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.