Документация за 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

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

  • Графици – създаване, коригиране на смени, планиране на работа

  • Отпуски и отсъствия – управление на заявки за отпуски и болнични

  • Отчитане – експортиране на данни за време, заплати и присъствие


Кодове за грешки

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

  • 200 — Успешна заявка

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

  • 400 — Невалидни параметри

  • 401 — Грешка при авторизация (невалиден API ключ)

  • 403 — Достъпът е отказан

  • 404 — Ресурсът не е намерен

  • 500 — Грешка на сървъра


Съвети за използване

  • Винаги използвайте новата версия на API за нови интеграции

  • Използвайте Postman или curl за тестване

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

  • Актуализирайте интеграциите, които все още разчитат на старата документация


Сподели този пост