API Серпхант

  • Начало работы
  • Обработка ошибок
  • Проверки
    • Добавление задания
    • Получение результатов
  • Биллинг
    • Баланс
Начало работы

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

Все запросы к API должны отправляться на урл вида:

https://serphunt.ru/версия/действие/объект[/данные]

  • Версия API ( v1 )
  • Действие, которое необходимо выполнить при обращении к api:
    add - добавление объектов
    get - получение данных
    delete - удаление объектов
  • Объект, на который направлено выбранное действие
    check - проверка позиций, частотности, индексации
    billing - биллинг ( информация о балансе, платежах и расходах )
  • Данные которые необходимо получить, используются при действии get ( /api/v1/get/billing/balance )

Формат отсылаемых данных

Все данные нужно отправлять в кодировке UTF-8 с помощью метода POST, тип остылаемых данных - JSON.

Обязательные заголовки запроса:

Content-type: application/json; charset=UTF-8
Authorization: Bearer %apikey%

Заголовок Authorization требуется для авторизации пользователя в api. Ключ %apikey% можно взять в кабинете пользователя.

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

Ответ приходит в кодировке UTF-8 в формате JSON.

Возможные поля ответа:

error отдается в случае ошибки ( см. раздел обработка ошибок )
message cервисные сообщения
result результат выполнения задания / проверки
task_id идентификатор задания, возвращается в при добавлении проверки
balance
yandex_xml
информация о балансе пользователя и xml лимитах

Более подробную информацию смотрите в описании объектов: проверки, биллинг

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

  • В одном запросе на получение данных можно запросить не более 5 000 результатов ( ключевых слов для проверки позиций или частотности, страниц для проверки индексации ). При превышении лимита, количество заправшиваемых данных обрезается.

  • С одного IP не более 5 одновременных запросов, иначе будет возвращена ошибка TOO_MANY_REQUESTS и код ответа сервера 429

Обработка ошибок

В случае ошибки api возвращает ответ в формате:

{
  "error" : {
    "error_code" : "AUTHORISATION_ERROR",
    "error_code" : "Ошибочный APIKEY",
  }
}
Код ошибки Описание ошибки Возможные причины
INVALID_URL Ошибка запрашиваемого урл API Неверно указан URL запросов к API
AUTHORISATION_ERROR Ошибка авторизации В запросе отсутствует заголовок Authorization
Неверно задан ключ доступа к API
TOO_MANY_REQUESTS Слишком большое количество запросов Количество соединений в секунду для данного IP превышает величину заданную в лимитах
REQUEST_ERROR Ошибка отсылаемых к API данных Пропущен или неверно задан один из параметров запроса к API
DATA_NOT_FOUND Запрашиваемые данные не найдены Данные были удалены
BILLING_ERROR Ошибка биллинга Недостаточно средств на баллансе
Данный вид проверки не разрешен
Для данного тарифа работа с API не разрешена
Добавление задания для проверки

URL запроса

https://serphunt.ru/api/v1/add/check

POST параметры

service

Название сервиса: positions ( передается как строка )

"service": "positions"
page

Страница, которую надо проверить ( передается как строка )

"page": "https://serphunt.ru/positions/"
subdomains

Проверять или нет субдомены ( передается как число 0 или 1 )

"subdomains": 0
keywords

Ключевые слова.

Могут передаваться либо как массив ( один элемент и более )

"keywords": [ "ключевое слово 1", "ключевое слово 2", "ключевое слово 3" ]

либо как строка (ключевые слова соединяются символом переноса строки "\n")

"keywords": "ключевое слово 1
ключевое слово 2
ключевое слово 3"
search_engine

Поисковая система

yandexяндекс
googlegoogle

Данные передаются массивом ( один элемент и более )

"search_engine": [ "yandex", "google" ]
region

Регион. Список кодов регионов.

Передаются массивом ( один элемент и более )

"region": [ 216, 225 ]
device

Устройства

mobileмобильные устройства
desktopнастольные компьютеры

Передаются массивом ( один элемент и более )

"device": [ "mobile", "desktop" ]
language

Язык пользователей ( передается как строка ). Список кодов языков.

"language": "ru"

Пример запроса

{
  "service": "positions",
  "page": "https://serphunt.ru/positions/",
  "subdomains": 0,
  "keywords": [ "ключевое слово 1", "ключевое слово 2", "ключевое слово 3" ],
  "search_engine": [ "yandex", "google" ],
  "region": [ 216, 225 ],
  "device": [ "mobile", "desktop" ],
  "language": [ "ru" ]
}

Ответ

task_id идентификатор задания, который необходимо использовать при получении результатов проверки
{ "task_id" : "922f9e59ff84ea387c0748301a7cf3e5" }
Получение результатов проверки

Историю проверок можно посмотреть в кабинете пользователя.

Данные храняться в течении одного года.

URL запроса

https://serphunt.ru/api/v1/get/result

POST параметры

task_id идентификатор задания
{ "task_id" : "922f9e59ff84ea387c0748301a7cf3e5" }

Ответ

Если задание еще не выполнено, ответ будет следующим:

{
  "message" : {
    "code" : "TASK_IN_PROGRESS",
    "description" : "Задание в обработке"
  }
}

Примеры ответов, в случае успешного выполнения задания для проверки.

{
  "result" : {
    "225_mobile_ru" : {
      "анализ позиций сайта" : {
        "google" : {
          "position" : 3,
           "relevance_url" : "https://serphunt.ru/positions/"
        },
        "yandex" : {
          "position" : 4,
           "relevance_url" : "https://serphunt.ru/positions/",
           "modtime" : "2014-05-07 12:40:57"
        }
      }
    },
    "225_desktop_ru" : {
      "анализ позиций сайта" : {
        "google" : {
          "position" : 4,
           "relevance_url" : "https://serphunt.ru/positions/"
        },
        "yandex" : {
          "position" : 2,
           "relevance_url" : "https://serphunt.ru/positions/",
           "modtime" : "2017-03-01 12:45:52"
        }
      }
    }
  }
}
Проверка баланса

URL запроса

https://serphunt.ru/api/v1/billing/balance

Ответ

{
  "balance" : 568
  "yandex_xml" : 454
}
Остались вопросы? Обращайтесь!
Задать вопрос
Или позвоните нам
Что думают наши клиенты
Александр Трачум Основатель агентства по продвижению сайтов Seodev.by
Серпхант собрал в себе все инструменты, которые нужны SEO специалисту: анализ контента, проверка позиций, анализ конкурентов и многое другое. С помощью данного сервиса можно забыть о том, что такое ручной труд в работе специалиста по продвижению сайтов.
Марк Автор блога по SEO-оптимизации znet.ru
Пользуюсь проверкой индексации, снятием позиций и некоторыми другими функциями сервиса. Мало есть бесплатных инструментов, которые позволяют массово парсить данные Google, а вкупе с понятным и современным дизайном это делает Serphunt действительно востребованным в повседневной работе
Артур Чахалян SEO-оптимизатор
Очень удобно, что большой объем данных видно сразу в одном месте: страницы, ключи, позиции, тошнотность, биграммы, оценки по главреду, объем текста и даже трафик для каждой статьи за день и месяц! При чем все эти данные формируются автоматически. Достаточно указать url статей (или просто установить плагин WP) и можно получить все данные в пару кликов.
Юрий Гришаев Вебмастер
Очень удобный сервис, для информационных сайтов, т.к. в нём можно смотреть все параметры в постатейном срезе. Показываются все важные метрики, с помощью этого не надо никуда лезть, всё в 1-м месте. Сейчас активно им пользуюсь, что говорит о том, что мне всё нравится.
Александр Савин Вебмастер
Серпхант — один из лучших сервисов поисковой аналитики, который вмещает в себя необходимые инструменты для анализа продвигаемого ресурса. Главными его достоинствами являются точная проверка и семантический анализ текста.
Виктор SEO-специалист
Сервис Серпхант имеет понятный интерфейс. Он способен собрать полную информацию о вашем сайте, благодаря богатому SEO функционалу. В сервисе есть бесплатные проверки позиций, с использованием лимитов Яндекс.XML.
Наши инструменты для продвижения сайтов
  1. Проверка позиций сайта Бесплатный парсер занимаемых позиций в Яндексе и Гугл
  2. Проверка индексации страниц Контроль за наличием страниц в индексе поисковых систем Яндекс
  3. Анализ контента Комплексный семантический анализ контента
  4. Проверка частотности запросов Статистика ввода запросов в поисковых системах
  5. Анализ страниц конкурентов Глубокий, сравнительный анализ страниц конкурентов из ТОП 10 Яндекса
  6. Парсинг подсветок Анализ сниппетов в поисковой выдаче
Войти в аккаунт
 
Зарегистрироваться через:
Восстановление пароля
Зарегистрируйтесь и получите бесплатно
500 проверок позиций сайта
Регистрация
обновить
Зарегистрироваться через:
Нажимая "Зарегистрироваться", Вы принимаете Пользовательское соглашение и Политику конфиденциальности.
Загрузка ...