Общая структура xml запроса и ответа при использовании api

Войти или зарегистрироваться

Забыли пароль?

Главная Справка xml api проекта SEO-TOOLS Общая структура xml запроса и ответа при использовании api

Проект seo-tools поддерживает xml запросы для предоставления данных.

Вы покупатель seo-tools - Прочтите!

Полное копирование текстов справки с демонстрационного сайта проекта http://seo-tools.forwebm.net считается полноценным нарушением условий использования проекта seo-tools, в результате чего автоматически Вы лишаетесь обновлений и тех.поддержки. Вы можете использовать приведенные разработчиком на сайте http://seo-tools.forwebm.net тексты справок в качестве основы, но Вы не имеете права копировать их полностью на свои ресурсы.

Точка запроса:

Адрес для отправки запросов: http://seo-tools.forwebm.net/xml/
Метод запроса: POST
Кодировка запроса: UTF-8

Составление xml запроса [ пример запроса на php ]

Вид стандартного xml запроса (без указания параметров api для получения конкретных данных)

<?xml version="1.0" encoding="UTF-8"?>
<request>
 <charset>кодировка ответа</charset>
 <code>api код</code>
 <apitype>тип возвращаемых данных</apitype>

</request>

<charset></charset> - Указывается кодировка, в которой необходимо возвращать данные, например: windows-1251 или utf-8. Если оставить пустым или вовсе не указать данный тэг - по умолчанию данные будут возвращаться в кодировке UTF-8
Пример:

<?xml version="1.0" encoding="UTF-8"?>
<request>
 <charset>windows-1251</charset>

</request>

<code></code> - Указывается персональный api код, необходимый для предоставления доступа к api seo-tools. Данный код можно взять со страницы управления api Вашего кабинета.
Пример:

<?xml version="1.0" encoding="UTF-8"?>
<request>
 <code>9b3d80e69fe1a4e0a5df52a3c32b04f2</code>

</request>

<apitype></apitype> - Указывает на тип получаемых данных. Ограничено в диапазоне и функционально исключительно в рамках допустимых типов. Типы api приведены в соответствующих записях текущего раздела справки. Например, для получения апдейтов поисковиков используется тип `updates` и т.д. В соответствующих записях справки тип указывается.
Пример:

<?xml version="1.0" encoding="UTF-8"?>
<request>
 <apitype>updates</apitype>

</request>

Существует еще один тэг, который учитывается при составлении запроса:
<error></error> - Данный тэг не обязательный. Используется для возможности получения описания ошибки в случае её возникновения (текст ошибки возвращается на английском языке). По умолчанию в случае ошибки возвращается только код ошибки (см. ниже по тексту), для получения +описания ошибки необходимо добавить в тело запроса тэг <error> со значением 1.
Пример:

<?xml version="1.0" encoding="UTF-8"?>
<request>
 <error>1</error>

</request>

Описаны стандартные поля для составления запроса. В зависимости от типа запроса могут добавляться другие поля к уже описанным выше (все дополнительные поля описываются в соответствующей типу api справке).

Пример отправки xml запроса средствами php используя библиотеку cURL
Пример:


<?php
function PostXML($link, $xml) { 

   $chx = curl_init();

   curl_setopt($chx, CURLOPT_URL, $link);

   curl_setopt($chx, CURLOPT_TIMEOUT, 90);

   curl_setopt($chx, CURLOPT_RETURNTRANSFER, 1);

   curl_setopt($chx, CURLOPT_USERAGENT, $_SERVER["HTTP_USER_AGENT"]);

   curl_setopt($chx, CURLOPT_POST, 1);

   curl_setopt($chx, CURLOPT_POSTFIELDS, $xml);

   $result = curl_exec($chx);

   curl_close($chx);

   return $result;        

 }



 $xml = '<?xml version="1.0" encoding="UTF-8"?>     

 <request>     

    <charset>windows-1251</charset>

    <code>9b3d80e69fe1a4e0a5df52a3c32b04f2</code>

    <apitype>updates</apitype>

    <error>1</error>         

 </request>';

 

 $respons = PostXML('http://seo-tools.forwebm.net/xml/', $xml);



 /* переменная $respons будет содержать xml ответ описанный выше 

    по тексту в кодировке windows-1251 (указана при составлении запроса) */


?>

Структура xml ответа

Вид стандартного xml ответа (пустой):
Пример:

<?xml version="1.0" encoding="кодировка"?>
<seotools version="1.3.3">
 <request>
  <charset>кодировка</charset>
  и остальные тэги, отправленные в запросе
 </request>
 <response>
  <datetime></datetime>
  <host></host>
  <username></username>
  <results>
   результат взависимости от типа api
  </results>
 </response>
</seotools>

<datetime></datetime> - Содержит текущую дату и время запроса в формате: Y-m-d H:i:s
<host></host> - Содержит хост сайта проекта (т.е seo-tools.forwebm.net)
<username></username> - Содержит логин пользователя, чей api код был использован для подачи запроса. Может отсутствовать в случае возникновения ошибки составления запроса.
Пример:

<?xml version="1.0" encoding="WINDOWS-1251"?>
<seotools version="1.3.3">
 <request>

 </request>
 <response>
  <datetime>2011-09-06 21:20:27</datetime>
  <host>seo-tools.forwebm.net</host>
  <username>admin</username>

  <results>

  </results>
 </response>
</seotools>

<results></results> - Содержит вложенную xml структуру ответа в зависимости от типа api (в справке соответствующего типа api структура подробно описывается, см. необходимый тип api)

В случае, если возникает какая-либо ошибка - тэг results будет отсутствовать, но появится тэг errorcode, который будет содержать код ошибки.

Описание кодов ошибок:

1 - Пустой xml запрос
2 - Отправлен некорректный запрос
3 - Не указан hash код пользователя
4 - Не определен тип возвращаемых xml данных
5 - Неизвестный тип возвращаемых xml данных
6 - Api недоступен или отключен администратором
7 - Неверный hash код пользователя
8 - Аккаунт не поддерживает xml api
9 - Вы исчерпали дневной лимит запросов для используемого типа api
10 - На Вашем счете недостаточно средств для выполнения запросов
11 - Произошла ошибка при оплате выполнения запросов

В данном списке приведен `стандартный` список ошибок при составлении и идентификации запроса. Описание кодов ошибок определенных типов описывается в соответствующем типу api разделе справки.

Если в запрос был включен тэг <error>1</error>, в таком случае к ответу также будет добавлен тэг error, содержащий описание ошибки (на английском языке).
Пример:

<?xml version="1.0" encoding="WINDOWS-1251"?>
<seotools version="1.3.3">
 <request>
  <charset>WINDOWS-1251</charset>
  <code>9b3d80e69fe1a4e0a5df52a3c32b04f2</code>
  <apitype>updates</apitype>
  <error>1</error>
 </request>
 <response>
  <datetime>2011-09-06 21:20:27</datetime>
  <host>seo-tools.forwebm.net</host>
  <username>admin</username>
  <errorcode>8</errorcode>
  <error>Account does not support xml api</error>
 </response>
</seotools>

Дата добавления: 2011-09-11 16:06:47, просмотров: 9029

Комментарии: 2

	Re: Общая структура xml запроса и ответа при использовании api Приветствую! Примеры в статье указаны с несуществующими учетными записями. На сайте они не сработают.
admin \| 21.07.2014 18:32:12

	Re: Общая структура xml запроса и ответа при использовании api Приведенный пример запроса не работает
sdmitrii198 \| 20.07.2014 21:50:48

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

Витрина ссылок[Добавить]

Зарабатывайте на продаже ссылок с сайта Самые дешевые и надежные VPS/VDS

Апдейты поисковиков

Google pr	26.11.2014

Яндекс ТиЦ	25.06.2019
поиск	28.06.2019
каталог	16.01.2018

Информация для покупателей

Информация о проекте seo-tools для покупателей

(содержит справочную информацию по проекту seo-tools)

Бесплатно скачать обновление проекта

(здесь Вы можете бесплатно скачать нужное Вам обновление проекта)

Страница проекта, купить проект

Форум проекта seo-tools

(на форуме Вы сможете получить всю интересующую Вас информацию о проекте SEO-TOOLS)

Мы принимаем Наш аттестат