serpstat sdk

серпстат/СДК

Это официальная библиотека SDK для Serpstat API v3.

Начиная

Шаг 1. Создайте токен аутентификации.

API Serpstat использует токен пользователя для аутентификации запросов. Вы можете создать токен на странице своего профиля.

Шаг 2. Установите пакет

Откройте командную консоль, войдите в каталог вашего проекта и выполните следующую команду, чтобы загрузить последнюю стабильную версию этого пакета:

$ composer require serpstat/sdk

Для этой команды требуется, чтобы Composer был установлен глобально, как описано в главе об установке документации Composer.

Шаг 3: Использование в приложении

 <?php
require_once __DIR__ . ' /../vendor/autoload.php ' ;

// configure your application
$ config = [
    ' token ' => ' 19666fc1ae1724da1d5ea2f3a99d5f5a ' ,
];

$ domain = ' example.com ' ;
$ keywords = ' keywords ' ;
$ url = ' http://example.com/page1/ ' ;

// init client with your serpstat api token
$ apiClient = new  Serpstat  Sdk  Core  ApiGuzzleHttpClient ( $ config [ ' token ' ]);

// create instance of any api method class
// e.g. DomainKeywordsMethod
// list of methods classes in folder srcMethods
$ apiMethod = new  Serpstat  Sdk  Methods  DomainKeywordsMethod (
    $ keywords , 
     Serpstat  Sdk  Interfaces  IApiClient :: SE_GOOGLE_RU
);

try {
    // try call api method
    $ response = $ apiClient -> call ( $ apiMethod );
} catch (  Exception $ e ) {
    // catch api error 
    $ response = $ e -> getMessage ();
}

Список методов API SDK

Сорт	API-метод	Описание
Метод ЧекЛимитсМетод	/статистика	Вы можете проверить количество запросов, которые вы можете выполнить в рамках дневного лимита, с помощью команды stats.
ДоменИнфоМетод	/domain_info	Этот отчет предоставляет вам количество ключевых слов, используемых доменом в SEO и PPC, показывает его видимость в Интернете и другие показатели.
Метод DomainHistoryMethod	/domain_history	Этот отчет предоставляет вам исторические данные о количестве ключевых слов и видимости домена.
ДоменКлючевые словаМетод	/domain_keywords	В этом отчете показаны ключевые слова, по которым домен занимает место в топ-100 результатов поиска Google.
ДоменURLSМетод	/domain_urls	Возвращает список URL-адресов в анализируемом домене. Также показывает количество ключевых слов из топ-100 для каждого URL.
ДоменыПересечениеМетод	/domains_intersection	Показывает общие ключевые слова до 3 доменов.
ДоменыUniqKeywordsМетод	/domains_uniq_keywords	Показывает уникальные ключевые слова домена. Ключевые слова, общие для запрашиваемого домена с одним или двумя другими доменами, удаляются из списка.
Метод GetTopUrls	/get_top_urls	Показывает популярные URL-адреса по доменам.
КонкурентыМетод	/конкуренты	В отчете перечислены все домены, которые занимают место по данному ключевому слову в топ-20 результатов Google.
Ключевые словаМетод	/ключевые слова	Этот метод использует полнотекстовый поиск для поиска всех ключевых слов, соответствующих запрошенному термину. Для каждого найденного ключевого слова вы увидите его объем, цену за клик и уровень конкуренции.
Ключевое словоИнформацияМетод	/keyword_info	В этом отчете представлен обзор ключевых слов, показывающий их объем, цену за клик и уровень конкуренции.
ПредложенияМетод	/предложения	В этом отчете перечислены варианты автозаполнения для запрошенного вами ключевого слова (они находятся с помощью полнотекстового поиска).
Связанные ключевые словаМетод	/родственные_ключевые слова	В этом отчете представлен полный список связанных ключевых слов, поисковая выдача которых аналогична той, которую имеет запрошенное ключевое слово (только для типов учетных записей «Стандарт» и «Профессионал»).
Ключевое словоTopMethod	/keyword_top	В этом отчете показаны 100 лучших результатов обычного поиска Google по запрошенному вами ключевому слову.
Метод ключевых слов объявления	/ad_keywords	В этом отчете показаны копии объявлений, которые появляются по запрошенному ключевому слову в результатах платного поиска Google.
UrlKeywordsМетод	/url_keywords	В отчете перечислены ключевые слова, по которым URL ранжируется в результатах поиска Google.
UrlCompetitorsМетод	/url_competitors	Показывает список URL-адресов, которые конкурируют с запрошенным URL-адресом в обычном поиске.
UrlMissingKeywordsМетод	/url_missing_keywords	Показывает список ключевых слов, по которым URL-адреса конкурентов входят в топ-10, но которые отсутствуют на запрашиваемой странице.

Исключения SDK

Класс исключения	Код	Сообщение
APIException	-	-
Апиинвалидрекуестисключение	400	Неверный запрос
ApiLimitExceededException	402	Превышены тарифные лимиты
ApiAccessErrorException	403	Проблемы с авторизацией (неправильный токен, запрещенное действие или пользователь заблокирован)
Апинорезультсисключение	404	Нет результатов
ApiFrequencyExceededException	429	Превышена частота запросов (увеличьте таймаут между запросами)
Аписерверисключение	500	Ошибка сервера
ИнвалидПарамИсключение	500	Неверный параметр
Исключение ParseResponseException	500	Не удалось проанализировать ответ