Что такое API Дескуса
API Дескуса — это доступ к хелпдеску из вашей системы: сайта, CRM, бота или коннектора вроде Albato. Через API заводят обращения клиентов, отвечают им, меняют статусы, ищут клиентов и статьи базы знаний, а события — новый тикет, сообщение, клиент — Дескус сам присылает вебхуками.
Что можно сделать
Задача | Как |
|---|---|
Принять заявку с формы сайта или из CRM | POST /tickets — обращение клиента, как из любого канала |
Ответить клиенту из своей системы | POST /tickets/{id}/messages — ответ уходит в канал тикета и письмом |
Закрыть тикет, сменить приоритет или ответственного | |
Найти клиента по почте или телефону | |
Показать статьи базы знаний у себя | |
Узнавать о событиях без опроса | Вебхуки: ticket.created, ticket.updated, message.created, client.created |
Как устроен доступ
Для своей системы администратор компании выпускает ключ API в кабинете. Для приложения, которое подключают разные компании, — OAuth 2.0: клиент нажимает «Разрешить», приложение получает токен. И ключ, и токен работают от имени сотрудника и не могут больше, чем этот сотрудник в кабинете.
Ключ API — выпуск и хранение, права.
OAuth 2.0 — как устроено, от регистрации приложения до токенов.
Что важно знать сразу
Адрес —
https://app.deskus.ru/api/v1, формат — JSON, время — UTC. Подробнее — адрес, версии и формат.API — для запросов сервер-сервер. Ключ нельзя показывать в браузере: на странице сайта он стал бы виден всем.
До 600 запросов в минуту на ключ — лимиты.
Повторный POST с тем же
Idempotency-Keyне создаст дубль — идемпотентность.
Спецификация OpenAPI 3.1
Полное описание методов — openapi.json. Его можно открыть в Postman, Insomnia или Swagger UI и получить готовую коллекцию запросов.