Общее описание функционала

Основные возможности

API позволяет работать со следующими разделами системы:

• Пользователи и группы -- получение информации о пользователях системы, их ролях и группах
• Финансы -- работа с начислениями, зарплатами, договорами, услугами, кассовыми операциями, счетами
• Проекты -- управление проектами, этапами, базовыми линиями, комментариями, планами и фактами по затратам и доходам
• Персонал -- информация о сотрудниках, организационной структуре, отсутствиях, трудоустройстве
• Задачи -- создание и управление задачами, комментариями, вложениями, шаблонами, зависимостями, чек-листами
• Сервис-деск -- работа с заявками, статусами, типами, приоритетами, категориями, комментариями, вложениями, SLA, маркерами, KPI
• CRM -- управление продуктами, сделками, активностями, контактами, телефонами, электронными адресами, комментариями
• Совещания -- работа с типами совещаний, самими совещаниями, вложениями, пунктами повестки, регулярными совещаниями
• Клиенты -- управление типами клиентов, приоритетами, лицензированием, регионами, клиентами, правилами, контактами, заявителями, локациями
• База знаний -- работа со страницами, категориями, ревизиями, черновиками, вложениями, комментариями, избранным, реакциями, FAQ, согласованиями, курсами, тестами, правилами доступа

Ключевые особенности

1. Безопасность доступа — все запросы к данным требуют аутентификации через специальные токены
2. Доступ к документации — просмотр документации API доступен только авторизованным пользователям с типом "employee" (сотрудники)
3. Гибкие права доступа — для каждого токена можно настроить доступ только к нужным разделам и операциям
4. Пагинация — большие списки данных автоматически разбиваются на страницы
5. Фильтрация и поиск — возможность фильтровать данные по различным критериям и искать по тексту
6. Сортировка — возможность сортировать результаты по различным полям
7. Мягкое удаление — удаленные записи можно восстановить или просмотреть
8. Автоматическое логирование — все операции записываются в журнал аудита
9. Интерактивная документация — доступна подробная документация с примерами использования для авторизованных сотрудников

Формат данных

Все данные передаются в формате JSON (JavaScript Object Notation) -- это стандартный текстовый формат для обмена данными. Ответы системы также приходят в формате JSON.

Версионирование

API использует версионирование через URL. Текущая версия API -- v1, доступна по адресу /api/v1/. Это позволяет в будущем добавлять новые версии API без нарушения работы существующих приложений.