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

Категории:

Категории:

Подключение и работа с API Shifton

API Shifton предоставляет доступ ко всем ключевым функциям платформы — от управления расписанием до интеграции с внешними HR, системами начисления зарплаты и аналитическими системами.
С помощью API вы можете автоматизировать процессы и подключать Shifton к внутренним сервисам вашей компании.


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

Мы поддерживаем две версии нашей документации:


Начало работы

Получение API-ключа

В настройках вашей компании на платформе Shifton создайте API-ключ.
Авторизация выполняется через заголовок:

Authorization: Bearer {your_api_key}

Сделайте первый запрос

Например, чтобы получить список сотрудников:

GET /api/v1/employees
Host: api2.shifton.com
Authorization: Bearer {your_api_key}

Пример ответа:

{
"data": [
{
"id": 101,
"name": "Alice Johnson",
"position": "HR Manager"
},
{
"id": 102,
"name": "Bob Smith",
"position": "Cashier"
}
]
}

Интеграция API в ваши рабочие процессы

  • Автоматически создавать и изменять смены

  • Управлять запросами на отпуск и больничные

  • Экспортировать данные в системы начисления зарплаты

  • Создавать индивидуальные панели и отчеты


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

  • Сотрудники – добавление, редактирование и управление ролями

  • Расписания – создание, корректировка смен, планирование работы

  • Выходные и отсутствие – управление заявками на отпуск и больничный

  • Отчеты – экспорт данных о времени, заработной плате и посещаемости


Коды ошибок

API Shifton использует стандартные коды состояния HTTP:

  • 200 — Запрос успешен

  • 201 — Объект успешно создан

  • 400 — Неверные параметры

  • 401 — Ошибка авторизации (неверный ключ API)

  • 403 — Доступ запрещен

  • 404 — Ресурс не найден

  • 500 — Ошибка сервера


Советы по использованию

  • Всегда используйте новую версию API для новых интеграций

  • Используйте Postman или curl для тестирования

  • Соблюдайте ограничения по скорости чтобы избежать блокировки

  • Обновите интеграции, которые по-прежнему зависят от старой документации


Поделиться этой записью