API Букварикса
получение данных в автоматическом режиме
API доступен по следующему основному URL:
http://api.bukvarix.com
API Букварикса доступен в виде бесплатной версии, ограничения которой соответствуют бесплатному режиму без регистрации, см. Тарифы. Через бесплатный API можно запросить ключевые слова как в режиме простого поиска (поиск по одной фразе), так и в режиме расширенного поиска (поиск по спискам ключевых слов для поиска и исключений), а также ключевые слова для одного домена, отчеты сравнения двух и более доменов. Ключ для доступа к бесплатному API: free
Вы можете бесплатно скачать любую из баз, используемых в сервисе и в API, со страницы описания баз.
Примечания:
Значения параметров в запросе, в которых есть буквы русского языка и специальные символы, нужно передавать в виде экранированных последовательностей по правилам percent-encoding. Например, запрос слова "яблоко", перекодированый в соответствии с percent-encoding, будет выглядеть как "%D1%8F%D0%B1%D0%BB%D0%BE%D0%BA%D0%BE". Подробнее: https://ru.wikipedia.org/wiki/URL#Кодирование_URL
Для POST запросов Content-Type должен быть application/x-www-form-urlencoded.
Для разделителя строк используйте управляющие символы возврат каретки (Carriage Return) и перевод строки (Line Feed).
Отчеты в кодировке UTF-8 доступны в следующих форматах:
- в TXT формате (простой список слов)
- в JSON формате (массивы строк, разделенные запятыми)
- в CSV формате (разделитель полей точка с запятой, текстовые значения заключаются в кавычки)
- в TSV формате (разделитель полей табуляция, текстовые значения не заключаются в кавычки)
В случае успеха сервис возвращает данные и статус 200 (успешный код состояния HTTP).
В случае ошибки возвращается ошибочный статус HTTP и описание ошибки.
Возможные ошибки:
400 - неверный запрос (неправильно указаны параметры при запросе, пропущены обязательные параметры),
401 - ошибка авторизации (не указан ключ API, неверный ключ API, ключ API заблокирован, срок действия ключа API истек),
402 - превышены лимиты (превышено количество запросов, запрашивается больше строк в отчете, чем разрешено),
429 - превышена частота запросов, сделайте паузу и повторите запрос позже,
500 - внутренняя ошибка сервера (в случае ошибки обратитесь в службу поддержки),
503 - на сервере ведутся плановые работы, повторите запрос позже.
Примечание:
Если вы получили ошибку 402, то скорее всего превышено какое-либо ограничение бесплатной версии API. Ограничения бесплатного API соответствуют версии аккаунта без регистрации.
Если вы получаете ошибку 429, то вам нужно сделать паузу и только после этого продолжать запросы (или, как вариант, вместо использования API сразу интегрируйте наши базы к себе - все базы Букварикса доступны бесплатно, их можно скачать со страницы описания баз).
В начале файла может присутствовать сигнатура UTF-8 (BOM - 3 байта EF BB BF).
Сигнатура нужна в некоторых случаях для правильного определения кодировки. Например, если указана сигнатура UTF-8 то (в большинстве случаев), последние версии MS Excel откроют в верной кодировке отчет Букварикса в формате .csv.
Если необязательный параметр bom не указан, то наличие или отсутствие сигнатуры зависит от формата.
| Формат файла отчета | Наличие сигнатуры UTF-8 по умолчанию |
|---|---|
| txt | да |
| json | нет |
| csv | да |
| tsv | нет |