Содержание
API Букварикс
API: Общая информация
Поиск по словам
Поиск по доменам
API доступен по следующему основному URL:
http://api.bukvarix.com
У API Букварикса имеется как бесплатная, так и платная версия. Возможности бесплатной версии ограничены, они соответствуют ограничениям бесплатного режима без регистрации, см. Тарифные планы. Через бесплатный API можно запросить ключевые слова как в режиме простого поиска (поиск по одной фразе), так и в режиме расширенного поиска (по спискам до 10 поисковых слов и до 20 слов-исключений), а также ключевые слова для одного домена, отчеты сравнения двух и трех доменов. Ключ для доступа к бесплатному API: free
Примечания:
Значения параметров в запросе, в которых есть буквы русского языка и специальные символы, нужно передавать в виде экранированных последовательностей по правилам 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.
В платной версии API увеличены лимиты запросов, ключи индивидуальны. Для того, чтобы перейти на платный API, свяжитесь с нами и опишите ваши задачи, мы уточним стоимость API для ваших задач.
Отчеты в кодировке UTF-8 доступны в следующих форматах:
- в TXT формате (простой список слов)
- в JSON формате (массивы строк, разделенные запятыми)
- в CSV формате (разделитель полей точка с запятой, текстовые значения заключаются в кавычки)
- в TSV формате (разделитель полей табуляция, текстовые значения не заключаются в кавычки)
В случае успеха сервис возвращает данные и статус 200 (успешный код состояния HTTP).
В случае ошибки возвращается ошибочный статус HTTP и описание ошибки.
Возможные ошибки:
400 — неверный запрос (неправильно указаны параметры при запросе, пропущены обязательные параметры),
401 — ошибка авторизации (не указан ключ API, неверный ключ API, ключ API заблокирован, срок действия ключа API истек),
402 — превышены лимиты (превышено количество запросов, запрашивается больше строк в отчете, чем разрешено),
429 — превышена частота запросов, сделайте паузу и повторите запрос позже,
500 — внутренняя ошибка сервера (в случае ошибки обратитесь в службу поддержки),
503 — на сервере ведутся плановые работы, повторите запрос позже.
Примечание:
Если вы получили ошибку 402, то скорее всего превышено какое-либо ограничение бесплатной версии API. Ограничения бесплатного API соответствуют версии аккаунта без регистрации.
Если вы получаете ошибку 429, то вам нужно сделать паузу и только после этого продолжать запросы (бесплатный API, в отличии от платного, лимитирован по частоте запросов с одного IP).
В начале файла может присутствовать сигнатура UTF-8 (BOM — 3 байта EF BB BF).
Сигнатура нужна в некоторых случаях для правильного определения кодировки. Например, если указана сигнатура UTF-8 то (в большинстве случаев), последние версии MS Excel откроют в верной кодировке отчет Букварикса в формате .csv.
Если необязательный параметр bom не указан, то наличие или отсутствие сигнатуры зависит от формата.
Формат файла отчета | Наличие сигнатуры UTF-8 по умолчанию |
---|---|
txt | да |
json | нет |
csv | да |
tsv | нет |
API для поиска по словам
API для поиска по доменам
1000 | Недопустимый тип приведения | Указанный тип приведения не поддерживается | Тип приведения не поддерживается в приложении Office. Например, типы приведений OOXML и HTML не поддерживаются в Excel. | |||||||||||||||||||||||||||||
1001 | Ошибка чтения данных | Текущий выделенный фрагмент не поддерживается. | Текущий фрагмент, выделенный пользователем, не поддерживается (то есть он не является приведением поддерживаемого типа). | |||||||||||||||||||||||||||||
1002 | Недопустимый тип приведения | Указанный тип приведения несовместим с этим типом привязки. | Разработчик решения создал несовместимое сочетание типа приведения и типа привязки. | |||||||||||||||||||||||||||||
1003 | Ошибка чтения данных | Указано недопустимое значение параметра rowCount или columnCount. | Пользователь указал недопустимый индекс столбца или строки. | |||||||||||||||||||||||||||||
1004 | Ошибка чтения данных | Выделенный фрагмент несовместим с указанным типом приведения. | Выделенный фрагмент не поддерживается типом приведения, который указало приложение. | |||||||||||||||||||||||||||||
1005 | Ошибка чтения данных | Указано недопустимое значение параметра startRow или startColumn. | Пользователь указал недопустимое значение параметра startRow или startCol. | |||||||||||||||||||||||||||||
1006 | Ошибка чтения данных | Использование параметров координации с типом приведения «Таблица» не допускается, если таблица содержит объединенные ячейки. | Пользователь пытается считать часть данных из неоднородной таблицы (таблицы, содержащей объединенные ячейки). | |||||||||||||||||||||||||||||
1007 | Ошибка чтения данных | Размер документа превышает допустимый. | Пользователь пытается считать документ, размер которого превышает допустимый. | |||||||||||||||||||||||||||||
1008 | Ошибка чтения данных | Размер запрошенного набора данных превышает допустимый. | Пользователь запрашивает чтение данных за пределами ограничений данных, определенных приложением Office. | |||||||||||||||||||||||||||||
1009 | Ошибка чтения данных | Указанный тип файлов не поддерживается. | Пользователь отправляет файл недопустимого типа. | |||||||||||||||||||||||||||||
2000 | Ошибка записи данных | Заданный объект данных не поддерживается. | Задан неподдерживаемый объект данных. | |||||||||||||||||||||||||||||
2001 | Ошибка записи данных | Не удается записать данные в текущий выделенный фрагмент. | The user’s current selection is not supported for a write operation. (For example, when the user selects an image.) | |||||||||||||||||||||||||||||
2002 | Ошибка записи данных | Предоставленный объект данных несовместим с формой или измерениями текущего выделенного фрагмента. | Выделено несколько ячеек, а форма выделенного фрагмента не совпадает с формой данных. Выделено несколько ячеек, а измерения выделенного фрагмента не совпадают с измерениями данных. | |||||||||||||||||||||||||||||
2003 | Ошибка записи данных | Не удалось выполнить операцию задания, так заданный объект данных перезапишет данные. | Выделена одна ячейка, а заданный объект перезаписывает данные листа. | |||||||||||||||||||||||||||||
2004 | Ошибка записи данных | Заданный объект данных не соответствует размеру выделенного фрагмента. | Пользователь задает объект, размер которого превышает размер текущего выделенного фрагмента. | |||||||||||||||||||||||||||||
2005 | Ошибка записи данных | Указано недопустимое значение параметра startRow или startColumn. | Пользователь указал недопустимое значение параметра startRow или startCol. | |||||||||||||||||||||||||||||
2006 | Ошибка недопустимого формата | Формат указанного объекта данных недопустим. | Разработчик решения указывает недопустимую строку HTML и OOXML, деформированную строку HTML или недопустимую строку OOXML. | |||||||||||||||||||||||||||||
2007 | Недопустимый объект данных | Тип указанного объекта данных несовместим с выделенным фрагментом. | Разработчик решения задает объект данных, несовместимый с указанным типом приведения. | |||||||||||||||||||||||||||||
2008 | Ошибка записи данных | Подлежит определению. | Подлежит определению. | |||||||||||||||||||||||||||||
2009 | Ошибка записи данных | Размер указанного объекта данных превышает допустимый. | Пользователь пытается задать данные за пределами ограничений данных, определенных приложением Office. | |||||||||||||||||||||||||||||
2010 | Ошибка записи данных | Использование параметров координации с типом приведения «Таблица» не допускается, если таблица содержит объединенные ячейки. | Пользователь пытается записать часть данных в неоднородную таблицу (таблицу, содержащую объединенные ячейки). | |||||||||||||||||||||||||||||
3000 | Ошибка создания привязки | Не удается выполнить привязку к выделенному фрагменту. | The user’s selection is not supported for binding. (For example, the user is selecting an image or other non-supported object.) | |||||||||||||||||||||||||||||
3001 | Ошибка создания привязки | Подлежит определению. | Подлежит определению. | |||||||||||||||||||||||||||||
3002 | Ошибка недопустимой привязки | Указанная привязка не существует. | Разработчик пытается выполнить привязку к несуществующей или удаленной привязке. | |||||||||||||||||||||||||||||
3003 | Ошибка создания привязки | Выделение несмежных фрагментов не поддерживается. | Пользователь выделил несколько фрагментов. | |||||||||||||||||||||||||||||
3004 | Ошибка создания привязки | Невозможно создать привязку для текущего выделения и указанного типа привязки. | There are several conditions under which this might happen. Please see the «Binding creation error conditions» section later in this article. | |||||||||||||||||||||||||||||
3005 | Недопустимая операция привязки | Операция не поддерживается для этого типа привязки. | Разработчик отправляет операцию добавления строки или столбца для типа привязки, который не имеет тип приведения table . | |||||||||||||||||||||||||||||
3006 | Ошибка создания привязки | Именованный элемент не существует. | The named item cannot be found. No content control or table with that name exists. | |||||||||||||||||||||||||||||
3007 | Ошибка создания привязки | Найдено несколько объектов с одинаковыми именами. | Ошибка конфликта: существует несколько элементов управления содержимым с одинаковым именем, а для параметра fail on collision задано значение true . | |||||||||||||||||||||||||||||
3008 | Ошибка создания привязки | Указанный тип привязки несовместим с заданным именованным элементом. | Именованный элемент нельзя привязать к типу. Например, элемент управления содержимым содержит текст, но разработчик попытался выполнить привязку с помощью типа приведения table . | |||||||||||||||||||||||||||||
3009 | Недопустимая операция привязки | Тип привязки не поддерживается. | Используется для обратной совместимости. | |||||||||||||||||||||||||||||
3010 | Неподдерживаемая операция привязки | Выбранное содержимое должно быть представлено в формате таблицы. Отформатируйте данные как таблицу и повторите попытку. | Разработчик пытается использовать объект или addRowsAsync deleteAllDataValuesAsync TableBinding метод для данных типа приведения.matrix | |||||||||||||||||||||||||||||
4000 | Ошибка чтения параметров | Указанное имя параметра не существует. | Задано несуществующее имя параметра. | |||||||||||||||||||||||||||||
4001 | Ошибка сохранения параметров | Не удалось сохранить параметры. | Не удалось сохранить параметры. | |||||||||||||||||||||||||||||
4002 | Ошибка устаревших параметров | Не удалось сохранить параметры, так как они устарели. | Параметры устарели, а разработчик не переопределил их. | |||||||||||||||||||||||||||||
5000 | Ошибка устаревших параметров | Операция не поддерживается. | Операция не поддерживается в текущем приложении Office. Например, вызывается document.getSelectionAsync из Outlook. | |||||||||||||||||||||||||||||
5001 | Внутренняя ошибка | Внутренняя ошибка. | Указывает на состояние внутренней ошибки, которая может возникнуть по одной из указанных ниже причин.
| |||||||||||||||||||||||||||||
5002 | Отказ в разрешении | Запрошенная операция не допускается в текущем режиме документа. | Разработчик выполняет операцию записи, но документ находится в режиме, запрещающем изменения, например «Ограничить редактирование». | |||||||||||||||||||||||||||||
5003 | Ошибка регистрации события | Указанный тип события не поддерживается для текущего объекта. | Разработчик решения пытается зарегистрировать обработчик для несуществующего события или отменить его регистрацию. | |||||||||||||||||||||||||||||
5004 | Недопустимый вызов API | Недопустимый вызов API в текущем контексте. | Для контекста выполняется недопустимый вызов, например при попытке использовать CustomXMLPart объект в Excel. | |||||||||||||||||||||||||||||
5005 | Устаревшие данные | Сбой операции в связи с устаревшими данными на сервере. | Необходимо обновить данные на сервере. | |||||||||||||||||||||||||||||
5006 | Время ожидания сеанса | Время ожидания сеанса работы с документом истекло. Перезагрузите документ. | Истекло время ожидания сеанса. | |||||||||||||||||||||||||||||
5007 | Недопустимый вызов API | В текущем контексте перечисление не поддерживается. | В текущем контексте перечисление не поддерживается. | |||||||||||||||||||||||||||||
5009 | Отказ в разрешении | Отказано в доступе | У надстройки нет разрешения на вызов определенного API. | |||||||||||||||||||||||||||||
5012 | Недопустимый или истекший сеанс | Срок действия сеанса браузера Office истек или недопустим. Для продолжения обновите страницу. | Истек срок действия сеанса между клиентом Office и сервером либо дата, время или часовой пояс на вашем компьютере установлены неправильно. | |||||||||||||||||||||||||||||
6000 | Недопустимый узел | Указанный узел не найден. | Узел CustomXmlPart не найден. | |||||||||||||||||||||||||||||
6100 | Ошибка настраиваемого XML-документа | Ошибка настраиваемого XML-документа | Недопустимый вызов API. | |||||||||||||||||||||||||||||
7000 | Недопустимый идентификатор | Указанный идентификатор не существует. | Недопустимый идентификатор. | |||||||||||||||||||||||||||||
7001 | Недопустимый переход | Объект находится в таком месте, где не поддерживается навигация. | The user can find the object, but cannot navigate to it. (For example, in Word, the binding is to the header, footer, or a comment.) | |||||||||||||||||||||||||||||
7002 | Недопустимый переход | Объект заблокирован или защищен. | Пользователь пытается перейти к заблокированному или защищенному диапазону. | |||||||||||||||||||||||||||||
7004 | Недопустимый переход | Произошел сбой операции, так как индекс находится вне диапазона. | Пользователь пытается перейти к индексу, находящемуся вне диапазона. | |||||||||||||||||||||||||||||
8000 | Отсутствующий параметр | We couldn’t format the table cell because some parameter values are missing. Double-check the parameters and try again. | The cellFormat method is missing some parameters. For example, there are missing cells, format, or tableOptions parameters. | |||||||||||||||||||||||||||||
8010 | Недопустимое значение | One or more of the cells parameters have values that aren’t allowed. Double-check the values and try again. | The common cells reference enumeration is not defined. For example, All, Data, Headers. | |||||||||||||||||||||||||||||
8011 | Недопустимое значение | One or more of the tableOptions parameters have values that aren’t allowed. Double-check the values and try again. | Одно из значений параметра tableOptions является недопустимым. | |||||||||||||||||||||||||||||
8012 | Недопустимое значение | One or more of the format parameters have values that aren’t allowed. Double-check the values and try again. | Одно из значений формата является недопустимым. | |||||||||||||||||||||||||||||
8020 | Выход на пределы диапазона | The row index value is out of the allowed range. Use a positive value (0 or higher) that’s less than the number of rows. | Индекс строки превышает максимальный индекс строки в таблице или является отрицательным. | |||||||||||||||||||||||||||||
8021 | Выход на пределы диапазона | The column index value is out of the allowed range. Use a positive value (0 or higher) that’s less than the number of columns. | Индекс столбца превышает максимальный индекс столбца в таблице или является отрицательным. | |||||||||||||||||||||||||||||
8022 | Выход на пределы диапазона | Значение находится вне допустимого диапазона. | Некоторые значения формата находятся вне поддерживаемых диапазонов. | |||||||||||||||||||||||||||||
9016 | Отказ в разрешении | В разрешении отказано | Отказ в доступе. | |||||||||||||||||||||||||||||
9020 | Ошибка универсального ответа | Внутренняя ошибка. | Относится к внутреннему условию ошибки, которое может возникнуть по любому ряду причин. | |||||||||||||||||||||||||||||
9021 | Ошибка сохранения | При попытке сохранить элемент на сервере произошла ошибка подключения. | Не удалось сохранить элемент. Это может быть вызвано ошибкой подключения к серверу при использовании режима «В сети» в классическом приложении Outlook или попыткой повторно сохранить черновик элемента, который был удален с сервера Exchange Server. | |||||||||||||||||||||||||||||
9022 | Сообщение об ошибке в другом хранилище | Не удается получить идентификатор EWS, так как сообщение сохраняется в другом хранилище. | Не удалось получить идентификатор EWS для текущего сообщения, так как возможно, сообщение было перемещено или почтовый ящик отправки изменился. | |||||||||||||||||||||||||||||
9041 | Ошибка сети | Пользователь отключен от сети. Проверьте сетевое подключение и повторите попытку. | У пользователя больше нет доступа к сети или Интернету. | |||||||||||||||||||||||||||||
9043 | Тип вложения не поддерживается | Тип вложения не поддерживается. | API не поддерживает тип вложения. Например, item.getAttachmentContentAsync эта ошибка возникает, если вложение является внедренным изображением в формате RTF или типом элемента, отличного от элемента электронной почты или календаря (например, контакта или элемента задачи). | |||||||||||||||||||||||||||||
12002 | Неприменимо. | Неприменимо. | Одно из следующих: – По URL-адресу, переданному в displayDialogAsync , не существует страницы.– Страница, переданная в метод displayDialogAsync , загружена, но выполнена попытка открыть из диалогового окна страницу, которую не удается найти или загрузить, или для которой указан URL-адрес с недопустимым синтаксисом. Появляется в диалоговом окне и запускает событие DialogEventReceived на странице ведущего приложения. | |||||||||||||||||||||||||||||
12003 | Неприменимо. | Неприменимо. | Выполнена попытка открыть из диалогового окна страницу, для URL-адреса которой используется протокол HTTP. Необходим протокол HTTPS. Появляется в диалоговом окне и запускает событие DialogEventReceived на странице ведущего приложения. | |||||||||||||||||||||||||||||
12004 | Неприменимо. | Неприменимо. | Домен URL-адреса, передаваемого в метод displayDialogAsync , не является доверенным. Домен должен быть таким же, как и для страницы ведущего приложения (а также протокол и номер порта). Появляется при вызове displayDialogAsync . | |||||||||||||||||||||||||||||
12005 | Неприменимо. | Неприменимо. | URL-адрес, передаваемый в метод displayDialogAsync , использует протокол HTTP. Необходим протокол HTTPS. Появляется при вызове displayDialogAsync . (В некоторых версиях Office сообщение об ошибке 12005 совпадает с сообщением 12004.) | |||||||||||||||||||||||||||||
12006 | Неприменимо. | Неприменимо. | Диалоговое окно закрыто. Скорее всего, пользователь нажал кнопку X. Появляется в диалоговом окне и запускает событие DialogEventReceived на странице ведущего приложения. | |||||||||||||||||||||||||||||
12007 | Неприменимо. | Неприменимо. | Диалоговое окно уже открыто из этого главного окна. Для окна ведущего приложения (например, области задач) невозможно открыть сразу несколько диалоговых окон. Появляется при вызове displayDialogAsync . | |||||||||||||||||||||||||||||
12009 | Неприменимо. | Неприменимо. | Пользователь проигнорировал диалоговое окно. Эта ошибка может возникнуть в веб-версиях Office, где пользователи могут не разрешить надстройке открыть диалоговое окно. Появляется при вызове displayDialogAsync . | |||||||||||||||||||||||||||||
12011 | Неприменимо. | Неприменимо. | Браузер пользователя настраивается таким образом, чтобы блокировать всплывающие окна. Эта ошибка может возникнуть в Office в Интернете, если браузер safari настроен на блокировку всплывающих окон или браузер является устаревшим браузером Edge, а домен надстройки находится в другой зоне безопасности от домена, который диалоговое окно пытается открыть. Появляется при вызове displayDialogAsync . | |||||||||||||||||||||||||||||
13nnn | Неприменимо. | Неприменимо. | См . сведения о причинах и обработке ошибок в getAccessToken. |
API слияния — возможные коды ошибок
- Общая ошибка (R6000)
- Данные слияния отсутствуют (R6001)
- Файл не найден (R6002)
- Адрес электронной почты не найден (R6003)
- ( Адрес электронной почты подписывающей стороны не указан R6004)
- Недействительная информация о подписывающей стороне (R6006)
- Неверная информация об уникальном вложении (R6007)
- Превышен дневной лимит слияния (R6011)
- Превышен дневной лимит электронной почты (R6012)
- Превышен лимит кредитных баллов1 (R603) (R603)0004
- Превышен лимит данных для слияния (R6014)
- Достигнут лимит подписи (R6015)
- Превышен лимит содержимого документа (R6016)
- Невозможно сохранить файл в определенной папке (R6021)
- Невозможно отправить электронную почту с адрес «От» (R6022)
- Невозможно загрузить объединенный файл в папку (R6031)
- Невозможно получить доступ к знаку (R6033)
- Невозможно объединить документ (R6041)
- Неверные данные объединения для шаблонов CRM ( Р6044)
- Невозможно заменить существующий файл (R6053)
- Пользовательская функция, не настроенная (R6054)
Общая ошибка
Код ошибки
R6000
Описание ошибки
. ошибка. Пожалуйста, напишите нам по адресу: [email protected].
Ответ об ошибке
{
«ошибка»: {
«message»: «При обработке вашего мерж-реквеста произошла ошибка. Пожалуйста, проверьте и повторите попытку позже»,
«documentation_url»: «https://www.zoho.com/writer/help/api/v1/general-errors.html»,
«response_generated_time»: 1594131798612,
«request_url»: «https://
«код ошибки»: «R6000»
}
}
Данные слияния отсутствуют
Код ошибки
R6001
Описание ошибки
Вышеупомянутая ошибка возникает, когда данные слияния не предоставлены.
Ответ об ошибке
{
«ошибка»: {
«message»: «Данные для слияния не найдены. Повторите попытку с правильными данными для слияния»,
«documentation_url»: «https://www.zoho.com/writer/help/api/v1/general-errors. html»,
«response_generated_time»: 1594131798612,
«request_url»: «https://
«код ошибки»: «R6001»
}
}
Файл не найден
Код ошибки
R6002
Описание ошибки
Эта ошибка возникает, когда документ, который нужно объединить с данными, не предоставлен.
Ответ об ошибке
{
«ошибка»: {
«message»: «Файл не найден. Пожалуйста, попробуйте еще раз с нужным файлом.»,
«documentation_url»: «https://www.zoho.com/writer/help/api/v1/general-errors.html»,
«response_generated_time»: 1594131798612,
«request_url»: «https://
«код ошибки»: «R6002»
}
}
Адрес электронной почты не найден
Код ошибки
R6003
Описание ошибки
Эта ошибка возникает, если параметр ‘recipient_email’ не сохранен в настройках адреса электронной почты или не передан.
Ответ об ошибке
{
«ошибка»: {
«message»: «Адрес электронной почты не найден. Пожалуйста, повторите попытку с правильным адресом электронной почты.»,
«documentation_url»: «https://www.zoho.com/writer/help/api/v1/general-errors.html»,
«response_generated_time»: 1594131798612,
«request_url»: «https://
«код ошибки»: «R6003»
}
}
Адрес электронной почты подписывающей стороны не указан
Код ошибки
R6004
Описание ошибки
Эта ошибка возникает, если параметр «signer_data» не сохранен в настройках подписывающей стороны или если в настройках не указан параметр «signer_data».
Ответ об ошибке
{
«ошибка»: {
«message»: «Информация о подписывающей стороне не найдена. Повторите попытку, указав правильный адрес электронной почты подписывающей стороны».,
«documentation_url»: «https://www.zoho.com/writer/help/api/v1/general-errors.html»,
«response_generated_time»: 1594131798612,
«request_url»: «https://
«код ошибки»: «R6004»
}
}
Недопустимая информация о подписывающем лице
Код ошибки
R6006
Описание ошибки
Эта ошибка возникает, когда информация о подписывающем лице указана в недействительном ‘id’ (например, не задано ‘field_id).
Ответ на ошибку
{
«ошибка»: {
«message»: «Неверная информация о подписывающей стороне. Пожалуйста, повторите попытку, указав правильную информацию о подписывающем лице.»,
«documentation_url»: «https://www.zoho.com/writer/help/api/v1/general-errors.html»,
«response_generated_time»: 1594131798612,
«request_url»: «https://
«код ошибки»: «R6006»
}
}
Неверная информация об уникальном вложении
Код ошибки
R6007
Описание ошибки
Эта ошибка возникает, когда уникальное значение параметра вложения передается неправильно.
Ответ об ошибке
{
«ошибка»: {
«message»: «Недопустимая информация об уникальном вложении. Пожалуйста, повторите попытку, указав правильную информацию об уникальном прикрепленном файле.»,
«documentation_url»: «https://www.zoho.com/writer/help/api/v1/general-errors.html»,
«response_generated_time»: 1594131798612,
«request_url»: «https://
«код ошибки»: «R6007»
}
}
Превышен дневной лимит на слияние
Код ошибки
R6011
Описание ошибки
Достигнут максимальный лимит на слияние документов за день.
Ответ об ошибке
{
«ошибка»: {
«message»: «Достигнут дневной лимит слияния. Повторите попытку позже»,
«documentation_url»: «https://www. zoho.com/writer/help/api/v1/general-errors.html»,
«response_generated_time»: 1594131798612,
«request_url»: «https://
«код ошибки»: «R6011»
}
}
Превышен дневной лимит электронной почты
Код ошибки
R6012
Описание ошибки
Достигнут максимальный лимит на отправку объединенных документов по электронной почте за день.
Ответ об ошибке
{
«ошибка»: {
«message»: «Достигнут дневной лимит электронной почты. Повторите попытку позже»,
«documentation_url»: «https://www.zoho.com/writer/help/api/v1/general-errors.html»,
«response_generated_time»: 1594131798612,
«request_url»: «https://
«код ошибки»: «R6012»
}
}
Лимит кредитных баллов превышен
Код ошибки
R6013
Описание ошибки
0pt»> Достигнут максимальный лимит для выполнения операций слияния для вашей организации за месяц.Ответ об ошибке
{
«ошибка»: {
«message»: «Достигнут лимит кредитных баллов для вашей организации. Пожалуйста, купите больше кредитных баллов, чтобы продолжить.»,
«documentation_url»: «https://www.zoho.com/writer/help/api/v1/general-errors.html»,
«response_generated_time»: 1594131798612,
«request_url»: «https://
«код ошибки»: «R6013»
}
}
Счетчик данных слияния превысил
Код ошибки
R6014
Описание ошибки
Эта ошибка возникает, когда превышено количество данных слияния. Для нормального потока знаков значение данных слияния не должно превышать 5.
Ответ на ошибку
{
«ошибка»: {
«message»: «Превышено количество данных для слияния. Пожалуйста, проверьте документацию и передайте действительные данные.»,
«documentation_url»: «https://www.zoho.com/writer/help/api/v1/general-errors.html»,
«response_generated_time»: 1594131798612,
«request_url»: «https://
«код ошибки»: «R6014»
}
}
Достигнут предел подписи
Код ошибки
R6015
Описание ошибки
Эта ошибка возникает, когда достигнут месячный лимит подписи для вашей организации.
{
«ошибка»: {
«message»: «Для вашей организации достигнут месячный лимит подписанных документов. Пожалуйста, обновите свою учетную запись, чтобы продолжить»,
«documentation_url»: «https://www.zoho.com/writer/help/api/v1/general-errors.html»,
«response_generated_time»: 1594131798612,
«request_url»: «https://
«код ошибки»: «R6015»
}
}
Лимит содержимого документа превысил
Код ошибки
R6016
Описание ошибки
Эта ошибка выдается для всех API слияния, когда содержание документа превышает более 7 миллионов символов.
{
«ошибка»: {
«message»: «Документ слишком большой. Превышает ограничение в 0,7 миллиона (700 тыс.) символов.»,
«documentation_url»: «https://www.zoho.com/writer/help/api/v1/merge-api-possible-error-codes.html»,
«response_generated_time»: 1594131798612,
«request_url»: «https://
«код ошибки»: «R6016»
}
}
Невозможно сохранить файл в определенной папке
Код ошибки
R6021
Описание ошибки
Эта ошибка возникает, если у вас нет прав на сохранение файла в этой конкретной папке.
Ответ об ошибке
{
«ошибка»: {
«message»: «Отказано в доступе. У вас нет прав на сохранение файла в данной папке.»,
«documentation_url»: «https://www.zoho.com/writer/help/api/v1/general-errors. html»,
«response_generated_time»: 1594131798612,
«request_url»: «https://
«код ошибки»: «R6021»
}
}
Невозможно отправить электронную почту, используя адрес «От»
Код ошибки
R6022
Описание ошибки
Эта ошибка возникает, когда вы не авторизованы для использования адреса электронной почты «От».
Ответ об ошибке
{
«ошибка»: {
«message»: «В доступе отказано. Вы не авторизованы для использования данного адреса «От».»,
«documentation_url»: «https://www.zoho.com/writer/help/api/v1/general-errors.html»,
«response_generated_time»: 1594131798612,
«request_url»: «https://
«код ошибки»: «R6022»
}
}
Невозможно загрузить объединенный файл в папку
Код ошибки
R6031
Описание ошибки
0pt»> Эта ошибка возникает, если требуемая область не добавлена. Включите область Docs/Workdrive в зависимости от папки, в которую вы хотите загрузить файл.Ответ об ошибке
{
«ошибка»: {
«message»: «Произошла ошибка при загрузке объединенного файла в папку. Пожалуйста, проверьте и повторите попытку позже.»,
«documentation_url»: «https://www.zoho.com/writer/help/api/v1/general-errors.html»,
«response_generated_time»: 1594131798612,
«request_url»: «https://
«код ошибки»: «R6031»
}
}
Невозможно получить доступ к Sign
Код ошибки
R6033
Описание ошибки
Эта ошибка возникает, если ваша учетная запись не синхронизирована со службой Sign.
Ответ об ошибке
{
«ошибка»: {
«message»: «Похоже, ваша учетная запись не связана с сервисом Sign. Пожалуйста, проверьте и повторите попытку позже.»,
«documentation_url»: «https://www.zoho.com/writer/help/api/v1/general-errors.html»,
«response_generated_time»: 1594131798612,
«request_url»: «https://
«код ошибки»: «R6033»
}
}
Невозможно объединить документ
Код ошибки
R6041
Описание ошибки
Эта ошибка возникает при объединении файла с заданными данными слияния.
Ответ на ошибку
{
«ошибка»: {
«message»: «Произошла ошибка при слиянии файла с указанными данными слияния. Пожалуйста, проверьте и повторите попытку позже»,
«documentation_url»: «https://www.zoho.com/writer/help/api/v1/general-errors.html»,
«response_generated_time»: 1594131798612,
«request_url»: «https://
«код ошибки»: «R6041»
}
}
Недопустимая дата слияния для шаблонов CRM
Код ошибки
R6044
Описание ошибки
Эта ошибка возникает, когда запрос API электронной почты для шаблонов CRM отправляется без включения данных в поле слияния 50 ‘id’ 90.
Ответ об ошибке
{
«ошибка»: {
«message»: «Недопустимые данные слияния для шаблона crm. Пожалуйста, добавьте поле id в данные слияния и повторите попытку»,
«documentation_url»: «https://www.zoho.com/writer/help/api/v1/merge-api-possible-error-codes.html»,
«response_generated_time»: 1594131798612,
«request_url»: «https://
«код ошибки»: «R6044»
}
}
Предлагаемое действие
Передайте значение идентификатора записи для каждой записи внутри ключа ‘id’ для каждых данных и повторите попытку.
Например: merge_data = {data: [{«name»: «Amelia», «email»: «[email protected]», » id «: «1234567789»}]} // 1234567789 — CRM record id
Unable to replace an existing file
Error code
R6053
Error description
This error is thrown когда пользователь Zoho Docs пытается заменить существующий файл. Поскольку эта функция/опция поддерживается только для пользователей Zoho WorkDrive.
{
«ошибка»: {
«message»: «Замена существующего файла в настоящее время не поддерживается для вашей учетной записи. Пожалуйста, проверьте и обновите до Workdrive»,
«documentation_url»: «https://www.zoho.com/writer/help/api/v1/merge-api-possible-error-codes.html»,
«response_generated_time»: 1594131798612,
«request_url»: «https://
«код ошибки»: «R6053»
}
}
Пользовательская функция не настроена
Код ошибки
R6054
Описание ошибки
Эта ошибка возникает, когда пользователь пытается использовать пользовательскую функцию Merge and Invoke API без настройки.
{
«ошибка»: {
«message»: «Пользовательская функция не настроена в шаблоне. Пожалуйста, настройте и повторите попытку»,
«documentation_url»: «https://www. zoho.com/writer/help/api/v1/merge-api-possible-error-codes.html»,
«response_generated_time»: 1594131798612,
«request_url»: «https://
«код ошибки»: «R6054»
}
}
Справочник по сообщениям об ошибках Prisma (Справочник)
Типы ошибок клиента Prisma
Клиент Prisma выдает различные типы ошибок. Ниже перечислены типы исключений и поля их документированных данных:
PrismaClientKnownRequestError
Клиент Prisma выдает исключение PrismaClientKnownRequestError
, если обработчик запросов возвращает известную ошибку, связанную с запросом, например нарушение уникального ограничения.
Свойство | Описание | |
---|---|---|
код | Код ошибки Prisma. | |
meta | Дополнительная информация об ошибке — например, поле, вызвавшее ошибку: { цель: ['email'] } | |
сообщение об ошибке |
PrismaClientUnknownRequestError
Клиент Prisma выдает механизм PrismaClientUnknownRequestError, связанный с запросом, который не возвращает ошибку, связанную с запросом, и не возвращает ошибку, связанную с запросом, которая не возвращает ошибку, связанную с запросом, которая не возвращает исключение, связанное с запросом 906 код.
Свойство | Описание |
---|---|
сообщение, связанное с кодом ошибки. | |
clientVersion | Version of Prisma Client (for example, 2.19.0 ) |
PrismaClientRustPanicError
Prisma Client throws a PrismaClientRustPanicError
exception if the underlying engine crashes and exits with a non- нулевой код выхода. В этом случае клиент Prisma или весь процесс узла необходимо перезапустить.
Собственность | Описание |
---|---|
сообщение | Сообщение об ошибке, связанное с кодом ошибки. |
clientVersion | Version of Prisma Client (for example, 2.19.0 ) |
PrismaClientInitializationError
Prisma Client throws a PrismaClientInitializationError
exception if something goes wrong when the query engine is started and соединение с базой данных создано. Это происходит либо:
- При вызове
prisma.$connect()
ИЛИ - При выполнении первого запроса
Возможны следующие ошибки: работает под указанным именем хоста и портом
Генератор
Блок)Свойство | Описание |
---|---|
. | |
сообщение | Сообщение об ошибке, связанное с кодом ошибки. |
clientVersion | Версия Prisma Client (например, 2.19.0 ) |
PrismaClientValidationError
Prisma Client создает исключение PrismaClientValidationError
, если проверка не пройдена, например:
- Отсутствует поле — например, пустые данные
: {} свойство
при создании новой записи предоставлено неверный тип - например, установка поля
Boolean
на"Привет, я люблю сыр и золото!"Описание
}сообщение
Сообщение об ошибке. Коды ошибок
Общие
P1000
«Аутентификация не удалась на сервере базы данных по адресу
{database_host}
, предоставленные учетные данные базы данных для{database_user} недействительны, чтобы предоставить учетные данные. для сервера базы данных по адресу
{database_host}
».Р1001
"Не удается подключиться к серверу базы данных по адресу
{host_host}
:{port_base}
Убедитесь, что ваш сервер базы данных работает по адресу{host_base}
:{port_base}
."P1002
«Сервер базы данных по адресу
{database_host}
:{database_port}
был достигнут, но время ожидания истекло. Повторите попытку. Убедитесь, что ваш сервер базы данных работает по адресу{database_host}
:{database_port}
. "P1003
"База данных {database_file_name} не существует по адресу {database_file_path}"
"База данных
{database_name}. {database_schema_name}
не существует на сервере базы данных по адресу{database_host}: {database_port}
.""База данных
{database_name}
не существует на сервере базы данных по адресу{database_host}: {database_port}
. "P1008
"Операции истекли после
{время}
"P1009
"База данных
{database_name}
уже существует на сервере базы данных по адресу{database_host}: {database_port}
"P1010
"Пользователю
{database_user}
было отказано в доступе к базе данных {P1011
«Ошибка при открытии соединения TLS: {сообщение}»
P1012
Примечание: Если после обновления Prisma до версии 4.0.0 или выше вы получаете код ошибки P1012, см. руководство. Схема, действовавшая до версии 4.0.0, может оказаться недействительной в версии 4.0.0 и более поздних. В руководстве по обновлению объясняется, как обновить схему, чтобы сделать ее действительной.
"{full_error}"
Возможные сообщения об ошибках P1012:
- "Аргумент
{}
отсутствует." - "Функция
{}
принимает {} аргументов, но получила {}". - "Аргумент
{}
отсутствует в атрибуте@{}
. " - "Аргумент
{}
отсутствует в блоке источника данных{}
." - "Аргумент
{}
отсутствует в генераторном блоке{}
." - "Ошибка разбора атрибута
@{}
: {}" - "Атрибут
@{}
определен дважды." - "Не удалось определить модель с именем базы данных
{}
, поскольку существует другая модель с таким именем:{}
" - "
{}
является зарезервированным именем скалярного типа и не может использоваться." - "{}
{}
не может быть определен, поскольку {} с таким именем уже существует." - "Ключ
{}
уже определено в {}." - "Аргумент
{}
уже указан как безымянный аргумент." - "Аргумент
{}
уже указан." - "Такого аргумента нет."
- "Поле
{}
уже определено в модели{}
». - "Поле
{}
в модели{}
не может быть списком. Текущий коннектор не поддерживает списки примитивных типов." - "Имя индекса
{}
объявляется несколько раз. При использовании текущего коннектора имена индексов должны быть глобально уникальными." - "Значение
{}
уже определено в перечислении{}
." - "Атрибут неизвестен:
@{}
." - "Функция неизвестна:
{}
." - "Поставщик данных неизвестен:
{}
." - "shadowDatabaseUrl совпадает с URL-адресом источника данных
{}
. Укажите другую базу данных в качестве теневой базы данных." - "Функция предварительной версии
{}
неизвестна. Ожидается одна из: {}" - "
{}
не является допустимым значением для {}." - "Тип
{}
не является ни встроенным типом, ни ссылкой на другую модель, пользовательский тип или перечисление." - "Тип
{}
не является встроенный тип." - "Неожиданный токен. Ожидалось одно из: {}"
- "Переменная среды не найдена: {}."
- "Ожидалось значение {}, но получено значение {}
{}
." - "Ожидалось значение {}, но не удалось при анализе
{}
: {}." - "Ошибка проверки модели
{}
: {}" - "Ошибка проверки поля
{}
в модели{}
: {}" - "Ошибка проверки источника данных
{источник данных}
: {сообщение}"" - "Ошибка проверки enum
{}
: {}" - "Ошибка проверки: {}"
P1013
"Предоставленная строка базы данных недействительна. {details}"
P1014
"Основная модель 9062 для {kind} {модель} не существует."
P1015
«Ваша схема Prisma использует функции, которые не поддерживаются для версии базы данных.
Версия базы данных: {версия_базы_данных}
Ошибки:
{ошибки}»P1016
«В вашем необработанном запросе указано неправильное количество параметров. Ожидаемый:
{ожидаемый}
, фактический:{фактический}
».P1017
«Сервер закрыл соединение».
Prisma Client (Query Engine)
P2000
«Предоставленное значение для столбца слишком длинное для типа столбца. Столбец: {column_name}»
P2001
"Запись, искомая в условии where (
{model_name}.{argument_name} = {argument_value}
) не существует"P2002
"Ошибка ограничения уникальности {ограничения}"
- 1 P2003
"Ошибка ограничения внешнего ключа для поля:
{field_name}
"P2004
"Ошибка ограничения в базе данных:
{database_error}
"P2005
" 9 {0946 9} Значение поля0693 хранится в базе данных для поля
{имя_поля}
недопустимо для типа поля"P2006
"Предоставленное значение
{значение_поля}
для{имя_модели}
поле{имя_поля}
недействительно"P2007
"Data validation error
{database_error}
"P2008
"Failed to parse the query
{query_parsing_error}
at{query_position}
"P2009
"Не удалось подтвердить запрос:
{Query_validation_error}
на{Query_position}
"P2010
"RAW Query Fall. Код:
{код}
.«Нарушение нулевого ограничения для {ограничения}»
P2012
«Отсутствует требуемое значение в
{путь}
»P2013
«Отсутствует обязательный аргумент
{имя_поля} 9 {имя_поля} 9 30693 на
{object_name}
."P2014
"Изменение, которое вы пытаетесь внести, нарушит требуемое отношение '{relation_name}' между моделями
{model_a_name}
и{model_b_name}
."- 1 P2015
"Не удалось найти связанную запись. {details}"
P2016
"Ошибка интерпретации запроса. {details}"
P2017
"Записи для отношения
{relation_name}
междуМодели {parent_name}
и{child_name}
не подключены."P2018
"Не найдены требуемые подключенные записи. {details}"
P2019
"Ошибка ввода. {details}"
P2020
"Значение вне допустимого диапазона для данного типа. {details}"
P2021
"Таблица
{table}
не существует в текущей базе данных."P2022
"Столбец
{column}
не существует в текущей базе данных."P2023
«Несогласованные данные столбца: {message}»
P2024
«Время ожидания извлечения нового подключения из пула подключений истекло. (Дополнительная информация: http://pris.ly/d/connection-pool (Current тайм-аут пула соединений: {timeout}, ограничение на количество соединений: {connection_limit})"
P2025
"Операция не выполнена, поскольку она зависит от одной или нескольких записей, которые были необходимы, но не найдены. {cause}"
P2026
" Текущий поставщик базы данных не поддерживает функцию, использованную в запросе: {feature}"
P2027
«Во время выполнения запроса в базе данных произошло несколько ошибок: {ошибки}»
P2028
«Ошибка API транзакции: {ошибка}»
P2030
«Не удается найти полнотекстовый индекс для использования в поиске , попробуйте добавить @@fulltext([Fields. ..]) в вашу схему"
P2031
"Prisma должна выполнять транзакции, для чего ваш сервер MongoDB должен работать как набор реплик. См. подробности: https:/ /pris.ly/d/mongodb-replica-set"
P2033
«Число, используемое в запросе, не помещается в 64-битное целое число со знаком. Рассмотрите возможность использования
BigInt
в качестве типа поля, если вы пытаетесь сохранить большие целые числа»P2034
«Транзакция не удалась из-за конфликт записи или взаимоблокировка. Повторите транзакцию"
Prisma Migrate (движок миграции)
P3000
"Не удалось создать базу данных: {database_error}"
P3001
"Возможна миграция с деструктивными изменениями и возможной потерей данных: {migration_engine_destructive_details}"
P3002
«Попытка миграции была отменена: {database_error}»
P3003
«Формат миграций изменился, сохраненные миграции больше не действительны. Чтобы решить эту проблему, выполните действия по адресу: https: //pris. ly/d/migrate"
P3004
"База данных
{database_name}
является системной базой данных, ее нельзя изменять с помощью prisma migrate. Пожалуйста, подключитесь к другой базе данных."P3005
«Схема базы данных не пуста. Узнайте больше о том, как определить базовый уровень существующей рабочей базы данных: https://pris.ly/d/migrate-baseline»
P3006
«Миграция
{имя_миграции}
не удалось правильно применить к теневой базе данных.
{код_ошибки} Ошибка:
{внутренняя_ошибка}»P3007
«Некоторые из запрошенных функций миграции еще не разрешены в предварительной версии Engine. Пожалуйста, удалите их из своей модели данных перед использованием миграции. (blocked: {list_of_blocked_features})"
P3008
"Миграция
{migration_name}
уже зарегистрирована как примененная в базе данных."P3009
"миграция обнаружила неудачные миграции в целевой базе данных, новые миграции не будут применены. Узнайте больше о том, как решить проблемы с миграцией в производственной базе данных: https://pris.ly/d/migrate-resolve
{ сведения}"P3010
"Имя миграции слишком длинное. Оно не должно быть длиннее 200 символов (байтов)".
P3011
"Миграция
{имя_миграции}
не может быть отменена, поскольку она никогда не применялась к базе данных. Подсказка: вы передали полное имя миграции? (пример: \"20201207184859_initial_migration\")"P3012
"Миграция
{имя_миграции}
не может быть отменена, так как она не находится в состоянии сбоя."P3013
«Массивы поставщиков источников данных больше не поддерживаются при миграции. Измените источник данных, чтобы использовать одного поставщика. Подробнее читайте на странице https://pris.ly/multi-provider-deprecation»
P3014
«Prisma Migrate не удалось создать теневую базу данных. Убедитесь, что у пользователя базы данных есть разрешение на создание баз данных. Подробнее о теневой базе данных (и обходных решениях) читайте на странице https://pris.ly/d/migrate-shadow.
Исходная ошибка: {код_ошибки}
{внутренняя_ошибка}"P3015
"Не удалось найти файл миграции по адресу {путь_файла_миграции}. Удалите каталог или восстановите файл миграции."
P3016
"Не удалось выполнить резервный метод сброса базы данных, что означает, что Migrate не удалось полностью очистить базу данных. Исходная ошибка: {код_ошибки}
{внутренняя_ошибка}"P3017
"Миграция {имя_миграции} не найдена. Убедитесь, что миграция существует, и что вы указали полное имя каталога. (пример: \"20201207184859_initial_migration\")"
P3018
"Миграция не может быть применена. Новые миграции не могут быть применены до устранения ошибки. Узнайте больше о том, как решить проблемы миграции в производственной базе данных: https://pris.ly/ d/migrate-resolve
Имя миграции: {migration_name}
Код ошибки базы данных: {database_error_code}
Ошибка базы данных:
{database_error} "P3019
" Ваш поставщик данных указан в схеме
}
{провайдер не соответствует указанному в migration_lock. toml,
{ожидаемый_провайдер}
. Удалите текущий каталог миграции и начните новую историю миграции с помощью prisma migrate dev. Подробнее: https://pris.ly/d/migrate-provider-switch"P3020
"Автоматическое создание теневых баз данных отключено в Azure SQL. Настройте теневую базу данных, используя атрибут источника данных
shadowDatabaseUrl
.
Прочтите страницу документации для получения дополнительной информации: https://pris.ly/d/migrate-shadow"P3021
"Внешние ключи не могут быть созданы в этой базе данных. Узнайте больше, как с этим справиться: https://pris.ly/d/migrate-no-foreign-keys"
P3022
«Прямое выполнение операторов SQL DDL (язык определения данных) отключено в этой базе данных. Подробнее о том, как это сделать, читайте здесь: https://pris.ly/d/migrate-no-direct-ddl "
prisma db pull (Introspection Engine)
P4000
"Операции самоанализа не удалось создать файл схемы: {introspection_error}"
P4001
"База данных самоанализа пуста.
- "Аргумент