Документация API

Внимание

Если вы используете коробочную версию Юздеска на собственном сервере, то URL методов у вас будет отличаться. Уточните URL для работы с API у поддержки — support@usedesk.ru.

Общая информация

Данное API предназначено для взаимодействия интеграций, сайтов или мобильных приложения с системой.

При работе с API необходимо использовать актуальные методы. Предыдущие версии параметров запросов сохранены для совместимости и не рекомендуются к использованию.

Все запросы необходимо отправлять на URL: https://api.usedesk.ru/{method_name}

Например, для метода /update/ticket, URL для отправки запросов будет https://api.usedesk.ru/update/ticket

Все запросы принимаются только по https в кодировке UTF-8. Ответ формируется в JSON формате.

Данные типа «Дата» указываются в формате Y-m-d (например 2022-01-01), данные типа «Дата/время» — в формате Y-m-d H:i (например, 2022-01-01 00:00).

Авторизация

Авторизация производится с помощью API-ключа, который передается в теле запроса.

Для получения API ключа необходимо:

  1. Открыть раздел Каналы → Добавить канал → API;
  2. Заполнить поле «Redirect URL». На него будут приходить запросы, отмеченные ниже;
  3. Для запросов к API используйте указанный секретный ключ.

В случае использования неверного секретного ключа, API сообщает об ошибке.

Список ошибок

Мы отдаем ошибки со статусом ответа 200, а в самом ответе содержится код ошибки и ее расшифровка.

КодЗначение
111server error, ошибка на сервере
112invalid token, в запросе передан не правильный токен
113invalid ticket_id, передан не верный Id тикета, либо отсутствует доступ для данной компании/токена
114invalid message, не передан текст сообщения, либо текст не содержит символов
115access error, ошибка доступа
116tags must be a string, теги переданы в неверном формате
117invalid user_id, не корректное значение id пользователя
118invalid group_id не корректное значение id группы
119invalid client_id, не корректное значение id клиента
120file size is too large, размер файла превышает 15 мб
121request limits, превышен лимит запросов

Вопросы?

Если у вас возникли вопросы по использованию API — пишите. Разберемся, поможем.

Recently Updated Pages