API

Для подключения и начала использования XMLRiver, выполните следующие действия:

  1. Зарегистрируйтесь.
  2. В аккаунте в разделе Покупка запросов настройте параметры сбора. Без указания этих параметров Вам будет недоступна ссылка для сбора данных.
  3. Убедитесь, что запросы успешно отправляются:
    • Сформируйте и отправьте запрос методом GET с компьютера. Используйте URL для запросов, указанный в разделе Покупка запросов и добавьте к нему параметр query. Запрос будет выглядеть следующим образом:

    • http://xmlriver.com/search/xml?user=[user_id]&key=[key]&query=test
  4. Проверьте полученный XML-документ.

    Ответ должен соответствовать заданному формату и не должен содержать ошибок.

    Примечание. Если по поисковому запросу отсутствуют результаты, допустима ошибка с кодом «15».

 

Кроме установки необходимых настроек запросов в аккаунте, вы можете задавать их через GET запрос.

Возможные параметры:

groupby – числовое значение, ТОП позиций для сбора. Возможные значения: 10, 20, 30, 50, 100;
loc – числовое значение (id) местоположения из этого файла;
country – числовое значание (id) страны из этого файла;
lr – код языка из файла языков;
domain – числовое значение (id) google домена из этого файла;
device – устройство (desktop, tablet, mobile).

Пример: 
http://xmlriver.com/search/xml?user=[user_id]&key=[key]&groupby=20&loc=1000028&country=2008&lr=RU&domain=10&device=desktop

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

В стандартном аккаунте вам доступен сбор данных в 10 потоков api, что позволяет собрать около 70-80 тысяч запросов в сутки.
Если вам нужно больше, создайте тикет.

 

! Альтернативный вариант работы (если таймаут в 5 минут для вас критичен):

У нас существует возможность отложенного получения результата запроса.
Для этого к запросу необходимо добавить параметр delayed=1. В этом случае ожидать ответа не нужно. После этого запроса вы в ответе получите id вашего запроса в формате:
<req_id>101</req_id>
где 101 - id вашего запроса.
А позже, выполнив запрос http://xmlriver.com/search/xml?req_id=101 вы можете получить 3 варианта ответа:

  1. Получите обычный ответ, если он уже готов и такой id существует;
  2. Если ответ не готов, то получите ответ <status>WAIT</status>;
  3. При отсутствии запрошенного id в ответе будет ошибка: <status>ERROR</status><error>Bad request id</error>.