Огляд для розробників

Сторінка Розробник відкриває доступ до документації API Shifton та інструментів для створення користувацьких інтеграцій.

Покрокова інструкція

Доступ до сторінки Розробник

На лівій бічній панелі натисніть Інтеграції.

Перейдіть на сторінку Розробник.

У верхній частині — три вкладки: Огляд, Вебхукs та Додатокs.

Використання вкладки Огляд

Посилання	Опис
Нова документація	Актуальна документація API
Стара документація	Застаріла документація для існуючих інтеграцій

Натисніть потрібне посилання — документація відкриється в новій вкладці.

Інші вкладки Розробник

Вебхукs

mdash; налаштуйте кінцеві точки для сповіщень про події в реальному часі.

Додатокs

mdash; створюйте користувацькі додатки та керуйте ними.

Пов’язані статті

Часті запитання

П: Яку документацію використовувати — нову чи стару?
Використовуйте Нова документація для всіх нових інтеграцій. Стара — лише для зворотної сумісності.

П: Сторінка Розробник не відображається — чому?
Сторінка доступна лише Власник та Адміністратору.

П: Чи є обмеження на кількість запитів до API?
Так. Деталі — в документації API.

П: Де знайти API-ключ для роботи з Shifton API?
Інтеграції → Розробник → Додатокs → створіть додаток → у налаштуваннях отримайте API credentials.

П: Чи підтримує Shifton OAuth 2.0?
Так. Авторизація через OAuth використовується для підключення сторонніх додатків. Деталі в документації API.

П: Чи можна тестувати API без створення додатка?
Так — використовуйте інструменти типу Postman з вашими обліковими даними. Для продакшену рекомендується зареєструвати додаток.

П: У чому різниця між New і Стара документація?
Нова документація — актуальна (рекомендується для всіх нових інтеграцій). Стара документація — для зворотної сумісності з існуючими інтеграціями.

П: Чи можна отримати дані звітів через API?
Так. API Shifton надає доступ до даних розкладів, співробітників та інших ресурсів. Деталі в документації.

П: Вебхукs підтримують усі типи подій Shifton?
Ні, лише визначені. Список підтримуваних подій — у розділі Розробник → Вебхукs документації.

П: Чи потрібні технічні знання для роботи з API?
Так. Для роботи з REST API та створення інтеграцій через Додатокs необхідні базові навички розробки.

П: API платний чи входить у підписку?
API доступний у межах підписки без додаткової плати. Обмеження залежать від тарифного плану.

П: Як отримати підтримку при проблемах з інтеграцією через API?
Зверніться до підтримки Shifton з описом запиту, відповіді та коду помилки. Також вивчіть документацію на сторінці Розробник.

П: Який базовий URL для API Shifton?
Базовий URL — api2.shifton.com. Деталі та приклади запитів доступні в Нова документація.

П: Чи підтримує API пагінацію при запиті великих списків?
Так. Деталі реалізації пагінації описані в документації API.

П: Чи можна через API створювати та видаляти зміни?
Так. API надає повний CRUD-доступ до змін, співробітників, розкладів та інших ресурсів.

П: Чи є sandbox-середовище для тестування API?
Спеціального sandbox-середовища немає. Рекомендується створити тестову компанію в Shifton для безпечного тестування.

П: Які формати даних підтримує API?
API використовує формат JSON для запитів і відповідей.