Ошибки и ограничения. Pyrus Help
api:errors-and-limits

Ошибки и ограничения

Ограничение количества запросов

К методам Pyrus API можно обращаться не чаще 5000 раз в 10 минут для каждого пользователя.

В HTTP-заголовках ответа содержится дополнительная информация по ограничениям:

  • X-RateLimit-Limit — максимальное количество запросов, разрешенное в данном временном интервале;
  • X-RateLimit-Remaining — количество запросов до превышения ограничения в данном временном интервале;
  • X-RateLimit-Reset — количество секунд до начала следующего временного интервала.

После превышения лимита доступ к Pyrus API будет ограничен. В таком случае вы получите ответ с кодом состояния 429:

{
     "error_code": "too_many_requests",
     "error": "You have reached the limit of requests per 10 minutes."
}

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

Все методы API возвращают ошибки в формате JSON. Пример ошибки может выглядеть так:

{
     "error_code": "token_revoked",
     "error": "Authorization token has been revoked"
}

Кроме текста ошибки, ответ содержит ее код, который можно обрабатывать автоматически. Тексты ошибок могут меняться, но их коды останутся неизменными.

Ниже приведены коды ошибок, которые могут возникать при работе с API.

Код Описание
server_error Внутренняя ошибка сервера, обратитесь в техническую поддержку.
invalid_credentials Неправильный логин/секретный ключ.
token_not_specified Не указан токен авторизации. Необходимо указать токен в HTTP заголовке Authorization.
revoked_token Токен авторизации был отозван. Необходимо получить новый токен.
expired_token Время токена истекло. Необходимо получить новый токен.
invalid_token Неверный токен авторизации. Необходимо проверить корректность токена или получить новый.
account_blocked Учетная запись пользователя, выполняющего запрос, заблокирована. Свяжитесь с администратором вашей компании.
authorization_error Неизвестная ошибка авторизации. Проверьте правильность передаваемых параметров и повторите запрос.
invalid_field_id Поле с указанным идентификатором отсутствует. Проверьте корректность передаваемых параметров.
deleted_field Поле с указанным идентификатором было удалено. Проверьте корректность передаваемых параметров.
invalid_field_name Поле с указанным названием отсутствует. Проверьте корректность передаваемых параметров.
invalid_field_id_name Поле с указанным названием и идентификатором отсутствует. Проверьте корректность передаваемых параметров.
non_unique_name Название поля не уникально в пределах формы. Используйте идентификатор поля формы для записи значения.
field_identity_missing В запросе не заполнено ни одно из обязательных полей формы id/name.
duplicate_field Попытка изменить одно из полей формы несколько раз в одном запросе.
invalid_catalog_id Справочника указанным в шаблоне формы идентификатором не существует.
invalid_catalog_item_name Элемента с указанным наименованием в справочнике не существует.
non_unique_catalog_item_name Найдено несколько элементов с одинаковым наименованием в справочнике. Для записи значения используйте идентификатор соответствующего элемента.
invalid_catalog_item_id Элемента справочника с указанным идентификатором не существует.
catalog_item_id_name_mismatch В элементе справочника с указанным идентификатором не найдено указанного значения.
invalid_email Пользователя с указанным email не найдено.
non_unique_email Пользователь с указанным идентификатором не найден.
invalid_person_id Email пользователя с указанным идентификатором отличается от указанного.
invalid_person_id_email Email пользователя с указанным идентификатором отличается от указанного.
form_has_no_task Задачи с указанным идентификатором, созданным по указанному шаблону формы не существует. Проверьте корректность передаваемых параметров.
unrecognized_attachment_id Идентификатор прикладываемого файла неверен. У пользователя отсутствует файл с указаным идентификатором.
required_field_missing Не заполнено обязательное поле формы (в сообщении об ошибке будет указано, какое именно).
type_is_not_supported Данный тип поля не поддерживает запись значения.
catalog_identity_missing Не указан идентификатор значения в каталоге, необходимый для записи значения в поле с типом каталог.
incorrect_parameters_count Некорректное количество параметров для выбранного оператора фильтрации.
filter_type_is_not_supported Поле данного типа не поддерживается в качестве параметра фильтрации.
step_field_does_not_exists Данная форма не содержит поля с типом step. Фильтрация по номеру этапа недоступна.
catalog_item_id_missing Для записи значения в поле с типом каталог необходимо указать свойство item_id.
person_identity_missing Для записи значения с типом person необходимо указать id или email пользователя.
either_due_date_or_due_can_be_set Невозможно одновременно установить due_date и due для одной задачи.
negative_duration Продолжительность события не может быть отрицательной.
duration_is_too_long Превышена максимальная продолжительность события (1 год).
due_missing Невозможно установить продолжительность события (duration) без срока (due).
scheduled_date_in_past Запланированная дата не может быть в прошлом.
cannot_add_form_project Нельзя прикреплять задачу к проекту формы, а также к подпроектам формы.
form_template_cant_be_removed_from_task Список с шаблоном формы не может быть удален из задачи.
no_file_in_request Запрос не содержит файлов.
too_large_request_length Превышен лимит объема передаваемых данных. Возможно, вы прикрепляете файл слишком большого размера.
required_parameter_missing Не заполнен один из обязательных параметров запроса (в сообщении об ошибке будет указано, какой именно).
invalid_value_format Не удается преобразовать переданное значение к заданному типу (в сообщении об ошибке будет указано, к какому именно)
too_many_task_steps Превышено максимально допустимое количество этапов задаче.
form_id_missing Параметр form_id не может быть пустым.
text_missing Текст задачи не может быть пустым.
invalid_json Переданные в запросе данные не являются корректным json.
empty_body Тело запроса не может быть пустым.
access_denied_project Нет прав доступа к запрашиваемому проекту. Убедитесь, что у пользователя, от имени которого выполняется запрос, есть все необходимые права.
access_denied_task Нет прав доступа к запрашиваемой задаче. Убедитесь, что у пользователя, от имени которого выполняется запрос, есть все необходимые права.
access_denied_close_task Недостаточно прав для закрытия задачи.
access_denied_reopen_task Недостаточно прав для переоткрытия задачи.
access_denied_catalog Нет прав доступа к запрашиваемому справочнику. Убедитесь, что у пользователя, от имени которого выполняется запрос, есть все необходимые права.
access_denied_form Нет прав доступа к запрашиваемой форме. Убедитесь, что у пользователя, от имени которого выполняется запрос, есть все необходимые права.
access_denied_person Вы не можете взаимодействовать с указанным пользователем. Убедитесь, что пользователь есть в списке ваших контактов или отправьте ему запрос на знакомство.
too_many_requests Превышено максимальное количество запросов за период. Подождите несколько минут и повторите запрос.

Была ли эта статья полезной?

Да, спасибо! Нет, остался вопрос