menu
Общая информация Поиск по словам Поиск по доменам

API Букварикса

получение данных в автоматическом режиме

API доступен по следующему основному URL:

http://api.bukvarix.com

На текущий момент API полностью бесплатен. Предоставлятся возможность запросить через API ключевые слова в режиме простого поиска (поиск по одной фразе) и расширенного поиска (по спискам до 50 поисковых слов и до 50 слов-исключений), а также ключевые слова для одного домена. Запрос через API отчета сравнения двух доменов и нескольких доменов в процессе разработки. По мере доработки API мы предоставим платный API с расширенными возможностями.

Ключ для доступа к бесплатному API: free

Все отчеты в кодировке UTF-8.

Отчеты доступны в следующих форматах:
Букварикс API
  • в TXT формате (простой список слов)
  • в JSON формате (массивы строк, разделенные запятыми)
  • в CSV формате (разделитель полей точка с запятой, текстовые значения заключаются в кавычки)
  • в TSV формате (разделитель полей табуляция, текстовые значения не заключаются в кавычки)

В случае успеха сервис возвращает данные и статус 200 (успешный код состояния HTTP).

В случае ошибки возвращается ошибочный статус HTTP и описание ошибки.

Возможные ошибки:

400 - неверный запрос (неправильно указаны параметры при запросе, пропущены обязательные параметры),

401 - ошибка авторизации (неверный ключ API, ключ API заблокирован, срок действия ключа API истек),

402 - превышены лимиты (превышено количество запросов, запрашивается больше строк в отчете, чем разрешено),

429 - превышена частота запросов, сделайте паузу и повторите запрос позже,

500 - внутренняя ошибка сервера (в случае ошибки обратитесь в службу поддержки),

503 - на сервере ведутся плановые работы, повторите запрос позже.

В начале файла может присутствовать сигнатура UTF-8 (BOM - 3 байта EF BB BF).

Сигнатура нужна в некоторых случаях для правильного определения кодировки. Например, если указана сигнатура UTF-8 то (в большинстве случаев), последние версии MS Excel откроют в верной кодировке отчет Букварикса в формате .csv.

Если необязательный параметр bom не указан, то наличие или отсутствие сигнатуры зависит от формата.

Формат файла отчета Наличие сигнатуры UTF-8 по умолчанию
txt да
json нет
csv да
tsv нет

© 2018 Букварикс