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

API сервиса Usedesk, позволяет получить информацию о тикетах, клиентах, агентах, группах и дополнительных полях.

Формат возвращаемых данных: JSON.

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

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

Все запросы необходимо отправлять в HTTP POST.

Ограничения

  • 10 запросов в секунду с одного ip адреса
  • 10 запросов в минуту для поисковых запросов

Генерация ключа

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

  1. Включить интеграцию API в разделе Интеграции: https://secure.usedesk.ru/settings/integration.
  2. Затем перейдите в раздел Каналы https://secure.usedesk.ru/settings/channels и далее в блок «Настроить API».
  3. Укажите «Название канала». Так будет называться ваш канал API.
  4. Заполните поле «RedirectURL», на него будут приходить запросы, отмеченные чекбоксами ниже.
  5. Скопируйте секретный ключ и используйте его в запросах к 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