REST API Reference
Полное описание API для интеграции TIQQET с вашими системами. Общая настройка — в документации, описание модулей — в функционале
Авторизация
API использует JWT Bearer Token. Получите токен через эндпоинт авторизации и передавайте его в заголовке каждого запроса.
Authorization: Bearer eyJhbGciOiJIUzI1NiIs...
POST/api/auth/loginПолучение JWT-токена
Тело запроса:
Ответ:
{
"token": "eyJhbGciOiJIUzI1NiIs...",
"user": {
"id": 1,
"name": "Иван Петров",
"role": "OPERATOR"
}
}
Заявки
GET/api/ticketsСписок заявок
Параметры запроса:
| Параметр | Тип | Описание |
|---|---|---|
| status | string | Фильтр по статусу: NEW, IN_PROGRESS, WAITING, POSTPONED, DONE, CLOSED |
| priority | string | Фильтр по приоритету: LOW, MEDIUM, HIGH, CRITICAL |
| assigneeId | number | ID исполнителя |
| serviceId | number | ID услуги |
| page | number | Номер страницы (по умолчанию 1) |
| limit | number | Количество на странице (по умолчанию 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Аналитика по заявкам
| Параметр | Тип | Описание |
|---|---|---|
| from | date | Начало периода (ISO 8601) |
| to | date | Конец периода |
| groupBy | string | Группировка: day, week, month |
Rate limiting: API ограничен 100 запросами в минуту на токен. При превышении возвращается HTTP 429.
Коды ошибок
| Код | Описание | |
|---|---|---|
| 400 | Некорректный запрос — проверьте параметры | |
| 401 | Не авторизован — невалидный или просроченный токен | |
| 403 | Доступ запрещён — недостаточно прав | |
| 404 | Ресурс не найден | |
| 429 | Превышен лимит запросов | |
| 500 | Внутренняя ошибка сервера | |