Поиск

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

API для парсинга подсказок в выдаче Яндекса:
URL: https://tools.pixelplus.ru/api/podskazkiyandex

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

Принимает параметры:
GET:
1. Обязательные параметры:

  1. key — ключ доступа к API;
  2. report_id — номер отчета с подсказками Яндекса;
  3. query — запрос для парсинга подсказок Яндекса;
  4. lr — регион по Яндексу;

2. Необязательные параметры (набор ключей/инструментов которые нужно применить):

  1. deep — глубина (от 1 до 3, по умолчанию 1);
  2. cb_with_space=on — c пробелом и без после фразы;
  3. cb_with_cyrillic=on — c перебором кириллического алфавита;
  4. cb_with_numbers=on — c перебором цифр;
  5. cb_with_english=on — c перебором английского алфавита;

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

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

  1. [{"error":"In progress", "code":50}]
  2.  ["count_words":{"фраза-подсказка 1":"кол-во слов в фразе-подсказке 1, "фраза-подсказка 2":"кол-во слов в фразе-подсказке 2, ..."}, "count_phrases":"кол-во полученных фраз-подсказок", "excess_requests_flag":"флаг достижения ограничений в выдаче(true/false)", "not_parsed_phrases":{"не распарсенная фраза 1", "не распарсенная фраза 2", ... }, "warning_text":"Собраны поисковые подсказки до глубины: 1(2)"]

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

  1. {"url":"Not set","code":-50} — если не задан url;
  2. {"error":"To many tasks from one user. Try again later.","code":"-60"} — если превышен лимит одновременно выполняемых задач для одного пользователя;
  3. {"error":"Not enough daily limits","code":-68} — недостаточно дневных лимитов;
  4. {"error":"Not enough hourly limits","code":-80} — недостаточно часовых лимитов;
  5. {"error":"Not enough weekly limits","code":-81} — недостаточно недельных лимитов;
  6. {"error":"Not enough monthly limits","code":-82} — недостаточно месячных лимитов;
  7. {"error":"Not enough yearly limits","code":-83} — недостаточно годовых лимитов;
  8. {"error":"In progress","report_id":"#####","code":-32} - уже есть запущенное задание, report_id содержит уникальный номер, по которому можно получить результат;
  9. {"error":"To many tasks from one user. Try again later.","code":-60} — превышен лимит одновременно поставленных задач для пользователя;
  10. {"error":"error","code":-4} — если задан неверный report_id;
  11. {"error":"In progress","code":50} — если по запросу report_id все еще идет проверка;
  12. {"error":"access denided","code":-1} — если не задан ключ доступа;
  13. {"error":"access denided","code":-2} — если неверно задан ключ доступа;
  14. {"error":"unknown method","code":-3} — если неверно задано название метода;
  15. {"error":"Processing error","code":-104} — инструмент завершился с фатальной ошибкой;
  16. {"error":"Limits run out","code":-105} — во время выполнения инструмента закончились лимиты;
  17. {"error":"The process was canceled by a user","code":-106} — задача отменена пользователем;
  18. {"error":"The process took more than 6 hours and was canceled","code":-107} — инструмент очень долго работал в фоне и мы автоматически завершили процесс;
  19. {"error":"Processing error":-125} — непредвиденная ошибка;

Пример формирования GET:
GET:
$url = 'http://tools.pixelplus.ru/api/podskazkiyandex?key=API_KEY&query=пример®ion=RU&deep=1&cb_with_space=on