Порядок подключения

Все инструменты XMLstock подключаются по единому принципу. Для выполнения запросов используются персональный идентификатор пользователя и уникальный ключ доступа, которые автоматически выдаются после регистрации.

Шаг 1. Откройте нужный инструмент

Выберите в личном кабинете сервис, с которым планируете работать:

• Яндекс XML Proxy;
• Яндекс Live;
• Google XML Search;
• Яндекс Wordstat.

У каждого инструмента есть отдельные настройки, персональные URL и документация по поддерживаемым параметрам.

Шаг 2. Получите данные для авторизации

Для доступа к API используются два параметра:

• &user= — идентификатор вашего аккаунта;
• &key= — уникальный ключ доступа к API.

Пример параметров авторизации:

https://xmlstock.com/google/xml/?user=USER_ID&key=API_KEY

Ваши фактические значения отображаются в личном кабинете и автоматически подставляются в персональные URL.

Не передавайте ключ доступа посторонним лицам и не публикуйте его в открытом доступе. При необходимости ключ можно изменить в настройках аккаунта.

Шаг 3. Проверьте настройки поиска

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

В зависимости от сервиса могут быть доступны:

• страна и регион поиска;
• язык поисковой выдачи;
• тип устройства;
• количество результатов;
• тип поиска;
• другие параметры выбранного инструмента.

Большинство настроек можно передавать непосредственно в URL запроса. В таком случае параметры из URL имеют приоритет над настройками, сохранёнными в личном кабинете.

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

Шаг 4. Используйте персональный URL

Для каждого инструмента предусмотрены собственные адреса API. Выберите URL в зависимости от сервиса и необходимого формата ответа.

Яндекс XML Proxy

Получение результатов Яндекс Search API в формате XML:

https://xmlstock.com/yandex/xml/?user=USER_ID&key=API_KEY

Яндекс XML Proxy возвращает результаты в формате XML. Форматы JSON и HTML для этого инструмента не поддерживаются.

Яндекс Live

Получение результатов в формате XML:

https://xmlstock.com/yandexlive/xml/?user=USER_ID&key=API_KEY

Получение результатов в формате JSON:

https://xmlstock.com/yandexlive/json/?user=USER_ID&key=API_KEY

Получение результатов в формате HTML. Работает только в режиме Turbo:

https://xmlstock.com/yandexlive/html/?user=USER_ID&key=API_KEY&tbm=turbo

Обратите внимание: запросы в режиме Turbo оплачиваются по повышенному тарифу.

Google XML Search

Получение результатов в формате XML:

https://xmlstock.com/google/xml/?user=USER_ID&key=API_KEY

Получение результатов в формате JSON:

https://xmlstock.com/google/json/?user=USER_ID&key=API_KEY

Получение результатов в формате HTML:

https://xmlstock.com/google/html/?user=USER_ID&key=API_KEY

Формат HTML подходит для самостоятельного разбора поисковой страницы и извлечения данных, которые могут отсутствовать в готовых ответах XML и JSON.

Яндекс Wordstat

Получение результатов в формате JSON:

https://xmlstock.com/wordstat/json/?user=USER_ID&key=API_KEY

Яндекс Wordstat поддерживает только формат JSON. Форматы XML и HTML для этого инструмента не поддерживаются.

Шаг 5. Добавьте параметры запроса

К персональному URL необходимо добавить параметры, обязательные для выбранного инструмента. Например, поисковый запрос:

https://xmlstock.com/google/xml/?user=USER_ID&key=API_KEY&query=купить+ноутбук

Значения параметров должны быть переданы в корректной URL-кодировке. Пробелы и специальные символы рекомендуется кодировать стандартными средствами используемого языка программирования.

Пример на PHP:

$url = 'https://xmlstock.com/google/xml/'
     . '?user=USER_ID'
     . '&key=API_KEY'
     . '&query=' . urlencode('купить ноутбук');

Полный список обязательных и дополнительных параметров находится в разделе «Параметры поиска» соответствующего инструмента.

Шаг 6. Проверьте запрос

Для первоначальной проверки можно открыть сформированный URL в браузере или отправить запрос через HTTP-клиент, например cURL или Postman.

Пример запроса через cURL:

curl "https://xmlstock.com/google/xml/?user=USER_ID&key=API_KEY&query=купить+ноутбук"

При корректной авторизации сервис вернёт результат в выбранном формате. Если запрос составлен неправильно, в ответе будет указан код и описание ошибки.

Шаг 7. Подключите программу

Персональный URL можно использовать в программах, которые поддерживают XMLstock или совместимый формат API.

Сервис интегрирован в популярные SEO-программы, включая:

• Key Collector;
• TopSite;
• Site-Control;
• другие программы и сервисы для анализа поисковой выдачи.

Обычно достаточно открыть настройки источника данных в программе, выбрать XMLstock и вставить персональный URL или отдельно указать идентификатор пользователя и ключ.

Подробные инструкции для конкретных программ находятся в разделеНастройки программ.

Шаг 8. Подключите собственный скрипт

API XMLstock работает через обычные HTTP-запросы и может использоваться практически из любого языка программирования.

Ваше приложение должно:

1. сформировать URL с параметрами авторизации и запроса;
2. отправить HTTP-запрос;
3. получить ответ сервиса;
4. проверить код ошибки;
5. обработать данные в формате XML, JSON или HTML.

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

Шаг 9. Просматривайте статистику

Информация о выполненных запросах и расходах доступна на странице «Статистика запросов» в личном кабинете.

В статистике можно контролировать:

• количество отправленных запросов;
• используемые инструменты;
• расход средств;
• периоды активности;
• ошибки и результаты обработки.

Если запросы не выполняются или выбранная программа не поддерживает XMLstock, обратитесь в службу поддержки или онлайн-чат.