Поиск

Документация на метод "affiliation"

API для инструмент «Проверка на аффилированность»:
url: https://tools.pixelplus.ru/api/affiliation

Описание:
Метод позволяет создать задачу для проверки доменов на аффилированность.
Для создания задачи необходимо сформировать запрос и отправить его на URL метода с обязательными GET-параметрами key параметрами необходимыми для запуска задачи. Система поставит задачу в очередь выполнения и вернет идентификатор отчета: report_id. Для получения результата проверки необходимо отправить GET запрос с параметрами key и report_id.

Принимает параметры:
GET:

  1. key — ключ доступа к API;
  2. report_id — номер отчета с группировкой;
  3. base — тип проверки по поиску;
  4. query — запрос для которого осуществляется проверка (параметр для типа base);
  5. url — домен, для которого ищутся аффилиаты (параметр для типа base);
  6. lr — регион проверки по Яндекс (параметр для типа base);
  7. two — проверка 2х доменов;
  8. domain1 — первый домен для проверки (параметр для типа two);
  9. domain2 — второй домен для проверки (параметр для типа two);

ДОПУСТИМЫЕ ЗНАЧАНИЯ ПАРАМЕТРОВ:

  1. query — поисковая фраза;
  2. lr — код региона в Яндексе из списка, скажем, Москва — 213 (можно опустить, по умолчанию стоит регион 213);
  3. url — доменное имя для проверки;
  4. domain1 — доменное имя для проверки;
  5. domain2 — доменное имя для проверки;
  6. base — любое число;
  7. two — любое число;

Метод возвращает JSON с массивом:

В случае запроса на обработку:  [{"report_id":"номер запроса"}]
В случае запроса обработки (request - отправленный запрос, response - ответ инструмента): 

  1. [{"error":"In progress", "code":50}]
  2. {"request":{"base":"1","query":"запрос","url":"домен","lr":"регион"},"response":{"status":от 1 до 7,"data":необязательное поле с дополнительными значениями}}
  3. {"request":{"two":"1","domain1":"домен 1","domain2":"домен 2"},"response":{"status":от 1 до 7,"data":необязательное поле с дополнительными значениями}}

Статусы:

  1. Сайт находится в выдаче на {data} месте, вероятно другие сайты не мешают;
  2. Указанный сайт не имеет релевантных запросу документов в индексе Яндекса. Дальнейшая проверка невозможна.
  3. Поздравляем, среди ТОП-25 результатов выдачи Яндекса по указанному запросу аффилиатов вашего проекта не найдено.
  4. Найдены аффилированные сайты. В {data} находится массив найденных сайтов.
  5. Поздравляем, указанные проекты не аффилированы.
  6. Главная страница указанного сайта {data} не проиндексирована. Дальнейшая проверка не возможна.
  7. Указанные проекты {data} признаны аффилированными в Яндексе.

В случае неудачи:

  1. {"error":"Type is not defined","code":-31} - если не задан тип для проверки;
  2. {"query":"Not set","code":-50} — если не задан запрос для проверки;
  3. {"url":"Not set","code":-50} — если не задан URL для проверки;
  4. {"lr":"Not set","code":-50} — если не задан регион для проверки;
  5. {"domain1":"Not set","code":-50} — если не задан первый домен для проверки;
  6. {"domain2":"Not set","code":-50} — если не задан второй домен для проверки;
  7. {"error":"error","code":-4} — если задан неверный report_id;
  8. {"error":"In progress","code":50} — если по запросу report_id все еще идет проверка;
  9. {"error":"In progress","code":-32,"report_id":номер} — при попытке запустить инструмент, пока не выполнена предыдущая проверка;
  10. {"error":"access denided","code":-1} — если не задан ключ доступа;
  11. {"error":"access denided","code":-2} — если неверно задан ключ доступа;
  12. {"error":"unknown method","code":-3} — если неверно задано название метода;
  13. {"error":"Not enough daily limits","code":-68} — недостаточно дневных лимитов;
  14. {"error":"Not enough hourly limits","code":-80} — недостаточно часовых лимитов;
  15. {"error":"Not enough weekly limits","code":-81} — недостаточно недельных лимитов;
  16. {"error":"Not enough monthly limits","code":-82} — недостаточно месячных лимитов;
  17. {"error":"Not enough yearly limits","code":-83} — недостаточно годовых лимитов;

Пример формирования GET:
GET:
$url
= 'http://tools.pixelplus.ru/api/affiliation?key=API_KEY&base=1&query=запрос&lr=213&url=domain';