nofollow
BLACKFRIDAY2018

-30% скидки на любую оплату
подробнее

Черная пятница в SE Ranking: 30% скидки на любую оплату. подробнее

API для получения ТОП 100 выдачи поисковых систем

Стоимость получения ТОП 100 по одному запросу:

0.03 р.

Ограничения на количество запросов к API

Для обеспечения бесперебойной работы SE Ranking API для всех клиентов, мы ограничиваем скорость отправки запросов. Обращение к любым методам API SE Ranking можно делать не чаще 5 раз в секунду.

Например, если клиентское приложение сделает больше чем 5 запросов в секунду, сервер вернет 429 ошибку, показывающую, что приложению нужно снизить скорость.

Клиентам, которые длительное время превышают лимит на количество запросов в секунду, будет ограничен доступ к API.

API для получение результатов поиска по запросу в Google и Yandex, ТОП 100 результатов (URL + Сниппет)

  • API доступен по адресу https://online.seranking.com/structure/clientapi/positions/?method=НАЗВАНИЕ_МЕТОДА
  • Взаимодействие идёт по протоколу HTTP
  • Все принимаемые и выдаваемые данные - в кодировке UTF-8, любой результат выполнения любого метода - JSON-строка
  • Все методы принимают параметры как GET, так и POST
  • Все параметры - обязательные, если не указано иное
  • При вызове любого метода, кроме login, необходимо передавать параметр token, полученый при авторизации
  • API рассчитан на однократный съём позиций, без привязки к вашим сайтам

Авторизация (метод login)

Параметры:

Имя Описание
login логин
pass md5 от пароля

Пример ответа:

{
"name":"name1 name2",
"token":"c3b7ce7ae4cce5a6312f4046b701da9d",
"avatar": "http://online.seranking.com/tmp/avatar/upload-icon.png"
}

Пример вызова:

https://online.seranking.com/structure/clientapi/positions/?method=login&login=ЛОГИН&pass=ХЭШ

Добавление запроса (addTask)

Параметры:

Имя Описание
query поисковый запрос
engine_id уникальный идентификатор поисковой системы (полный список - в методе getEngines)
region_name название региона (опционально, только для Google-поисковых систем)
region_id уникальный идентификатор региона (обязателен только для яндекс-поисковиков, полный список - в методе getYandexRegions)

Пример ответа:

{"task_id" : 12345 }

Пример вызова:

https://online.seranking.com/structure/clientapi/positions/?token=ТОКЕН&method=addTask&query=ЗАПРОС&engine_id=ID_ПОИСКОВОЙ_СИСТЕМЫ

Групповое добавление запросов (addTasks)

Параметры:

Имя Описание
query массив запросов
region_name название региона (опционально, только для Google-поисковых систем)
engine_id уникальный идентификатор поисковой системы (полный список - в методе getEngines)
region_id уникальный идентификатор региона (обязателен только для яндекс-поисковиков, полный список - в методе getYandexRegions)

Пример ответа:

{"task_ids":[4,5],"total_added":2}

Пример вызова:

https://online.seranking.com/structure/clientapi/positions/?token=ТОКЕН&method=addTasks&queries[]=ЗАПРОС1&queries[]=ЗАПРОС2&engine_id=ID_ПОИСКОВОЙ_СИСТЕМЫ

Проверка статуса обработки запроса (checkTaskStatus)

Параметры:

Имя Описание
task_id уникальный идентификатор запроса

Пример ответа:

{"status" : 0 }

Пример вызова:

https://online.seranking.com/structure/clientapi/positions/?token=ТОКЕН&method=checkTaskStatus&task_id=ID_ЗАПРОСА

Список возможных поисковых систем (getEngines)

Метод не требует параметров

Пример ответа:

{"engines":
    {
        "201":"Google Andorra",
        "202":"Google United Arab Emirates",
        ...
        "378":"Google Serbia",
        "339":"Google Russia"
    }
}

Пример вызова:

https://online.seranking.com/structure/clientapi/positions/?token=ТОКЕН&method=getEngines

Список возможных регионов яндекса (getYandexRegions)

Метод не требует параметров

Пример ответа:

{
    "regions":
        {
        "213":"Москва",
        "90":"Сан-Франциско",
        "2":"Санкт-Петербург",
        "10174":"Санкт-Петербург и Ленинградская область",
        ...
        }
}

Пример вызова:

https://online.seranking.com/structure/clientapi/positions/?token=ТОКЕН&method=getYandexRegions

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

Если снятие позиций по запросу ещё не завершено, метод вернёт ошибку

Параметры

Имя Описание
task_id уникальный идентификатор запроса

Пример ответа:

{
    "results": [
        {
            "position": "1",
            "url": "https:\/\/www.pizzahut.com\/",
            "title": null,
            "snippet": "<span>Order pizza online for fast pizza delivery or drop by for carryout. You may also
        \ncontact Pizza Hut and find out about our catering services for your next big event.<\/span>"
        },
        {
            "position": "2",
            "url": "https:\/\/www.dominos.com\/",
            "title": null,
            "snippet": "<span>Domino's Home Page - Domino's Pizza, Order Pizza Online for Delivery -
        \nDominos.com.<\/span>"
        },
            ...
    ]
}

Пример вызова:

https://online.seranking.com/structure/clientapi/positions/?token=ТОКЕН&method=getTaskResults&task_id=ID_ЗАПРОСА

Список всех запросов пользователя (getTasks)

Метод не требует параметров

Пример ответа:

{
    "tasks": [
        {
            "id": "1",
            "query": "Запрос1",
            "region_name": null,
            "engine_id": "200",
            "region_id": "0",
            "added": "2016-01-18 13:11:29",
            "is_completed": "1"
        },
        {
            "id": "2",
            "query": "Запрос2",
            "region_name": "New York",
            "engine_id": "200",
            "region_id": "0",
            "added": "2016-01-19 10:07:56",
            "is_completed": "1"
        },
    ...
}

Пример вызова:

https://online.seranking.com/structure/clientapi/positions/?token=ТОКЕН&method=getTasks

Прекращение сеанса (logout)

Параметры

Имя Описание
token token, полученый при авторизации

Пример вызова:

https://online.seranking.com/structure/clientapi/positions/?token=ТОКЕН&method=logout