Документация на метод "affiliation"
API для инструмент «Проверка на аффилированность»:
url: https://tools.pixelplus.ru/api/affiliation
Описание:
Метод позволяет создать задачу для проверки доменов на аффилированность.
Для создания задачи необходимо сформировать запрос и отправить его на URL метода с обязательными GET-параметрами key параметрами необходимыми для запуска задачи. Система поставит задачу в очередь выполнения и вернет идентификатор отчета: report_id. Для получения результата проверки необходимо отправить GET запрос с параметрами key и report_id.
Принимает параметры:
GET:
- key — ключ доступа к API;
- report_id — номер отчета с группировкой;
- base — тип проверки по поиску;
- query — запрос для которого осуществляется проверка (параметр для типа base);
- url — домен, для которого ищутся аффилиаты (параметр для типа base);
- lr — регион проверки по Яндекс (параметр для типа base);
- two — проверка 2х доменов;
- domain1 — первый домен для проверки (параметр для типа two);
- domain2 — второй домен для проверки (параметр для типа two);
ДОПУСТИМЫЕ ЗНАЧАНИЯ ПАРАМЕТРОВ:
- query — поисковая фраза;
- lr — код региона в Яндексе из списка, скажем, Москва — 213 (можно опустить, по умолчанию стоит регион 213);
- url — доменное имя для проверки;
- domain1 — доменное имя для проверки;
- domain2 — доменное имя для проверки;
- base — любое число;
- two — любое число;
Метод возвращает JSON с массивом:
В случае запроса на обработку: [{"report_id":"номер запроса"}]
В случае запроса обработки (request - отправленный запрос, response - ответ инструмента):
- [{"error":"In progress", "code":50}]
- {"request":{"base":"1","query":"запрос","url":"домен","lr":"регион"},"response":{"status":от 1 до 7,"data":необязательное поле с дополнительными значениями}}
- {"request":{"two":"1","domain1":"домен 1","domain2":"домен 2"},"response":{"status":от 1 до 7,"data":необязательное поле с дополнительными значениями}}
Статусы:
- Сайт находится в выдаче на {data} месте, вероятно другие сайты не мешают;
- Указанный сайт не имеет релевантных запросу документов в индексе Яндекса. Дальнейшая проверка невозможна.
- Поздравляем, среди ТОП-25 результатов выдачи Яндекса по указанному запросу аффилиатов вашего проекта не найдено.
- Найдены аффилированные сайты. В {data} находится массив найденных сайтов.
- Поздравляем, указанные проекты не аффилированы.
- Главная страница указанного сайта {data} не проиндексирована. Дальнейшая проверка не возможна.
- Указанные проекты {data} признаны аффилированными в Яндексе.
В случае неудачи:
- {"error":"Type is not defined","code":-31} - если не задан тип для проверки;
- {"query":"Not set","code":-50} — если не задан запрос для проверки;
- {"url":"Not set","code":-50} — если не задан URL для проверки;
- {"lr":"Not set","code":-50} — если не задан регион для проверки;
- {"domain1":"Not set","code":-50} — если не задан первый домен для проверки;
- {"domain2":"Not set","code":-50} — если не задан второй домен для проверки;
- {"error":"error","code":-4} — если задан неверный report_id;
- {"error":"In progress","code":50} — если по запросу report_id все еще идет проверка;
- {"error":"In progress","code":-32,"report_id":номер} — при попытке запустить инструмент, пока не выполнена предыдущая проверка;
- {"error":"access denided","code":-1} — если не задан ключ доступа;
- {"error":"access denided","code":-2} — если неверно задан ключ доступа;
- {"error":"unknown method","code":-3} — если неверно задано название метода;
- {"error":"Not enough daily limits","code":-68} — недостаточно дневных лимитов;
- {"error":"Not enough hourly limits","code":-80} — недостаточно часовых лимитов;
- {"error":"Not enough weekly limits","code":-81} — недостаточно недельных лимитов;
- {"error":"Not enough monthly limits","code":-82} — недостаточно месячных лимитов;
- {"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';