REST API Reference

Полное описание API для интеграции TIQQET с вашими системами. Общая настройка — в документации, описание модулей — в функционале

Авторизация

API использует JWT Bearer Token. Получите токен через эндпоинт авторизации и передавайте его в заголовке каждого запроса.

Authorization: Bearer eyJhbGciOiJIUzI1NiIs...
POST/api/auth/loginПолучение JWT-токена

Тело запроса:

{ "email": "sales@tiqqet.ru", "password": "your-password" }

Ответ:

{ "token": "eyJhbGciOiJIUzI1NiIs...", "user": { "id": 1, "name": "Иван Петров", "role": "OPERATOR" } }

Заявки

GET/api/ticketsСписок заявок

Параметры запроса:

ПараметрТипОписание
statusstringФильтр по статусу: NEW, IN_PROGRESS, WAITING, POSTPONED, DONE, CLOSED
prioritystringФильтр по приоритету: LOW, MEDIUM, HIGH, CRITICAL
assigneeIdnumberID исполнителя
serviceIdnumberID услуги
pagenumberНомер страницы (по умолчанию 1)
limitnumberКоличество на странице (по умолчанию 20)
POST/api/ticketsСоздание заявки
{ "subject": "Не работает принтер", "description": "Принтер HP в кабинете 305 не печатает", "priority": "MEDIUM", "serviceId": 3, "assigneeId": 5 }
GET/api/tickets/:idДетали заявки
PUT/api/tickets/:idОбновление заявки
POST/api/tickets/:id/commentsДобавить комментарий
{ "text": "Заменил картридж, проблема решена" }
PUT/api/tickets/:id/statusСмена статуса
{ "status": "DONE", "comment": "Проблема решена" }

Пользователи

GET/api/usersСписок пользователей
GET/api/users/:idДанные пользователя

Услуги

GET/api/servicesКаталог услуг

Оборудование

GET/api/equipmentСписок оборудования
GET/api/equipment/:idДетали оборудования
POST/api/equipment/qr/:codeПоиск по QR-коду

Аналитика

GET/api/dashboardДанные дашборда
GET/api/analytics/ticketsАналитика по заявкам
ПараметрТипОписание
fromdateНачало периода (ISO 8601)
todateКонец периода
groupBystringГруппировка: day, week, month
Rate limiting: API ограничен 100 запросами в минуту на токен. При превышении возвращается HTTP 429.

Коды ошибок

КодОписание
400Некорректный запрос — проверьте параметры
401Не авторизован — невалидный или просроченный токен
403Доступ запрещён — недостаточно прав
404Ресурс не найден
429Превышен лимит запросов
500Внутренняя ошибка сервера