Доступ до API: графік, години й відсутності

Навіщо це

Опція «доступ до API» дає змогу вашим програмам бухгалтерії, зарплати чи CRM автоматично читати опублікований графік компанії, години кожного працівника й підтверджені відсутності. Доступ лише для читання: через API нічого змінити не можна.

Опцію можна підключити в застосунку: Управління → Керувати підпискою. Під час безкоштовного пробного періоду вона доступна.

1. Створіть ключ

У застосунку власник компанії відкриває Управління → Доступ до API → Новий ключ і дає йому назву (наприклад, «Програма зарплати»). Повний ключ показується лише один раз: скопіюйте його у свою програму. Ключ можна будь-коли відкликати; не більше 10 ключів на компанію.

2. Виклик API

Передайте ключ у заголовку «Authorization: Bearer …» (або «X-Api-Key»). Усі адреси починаються з https://app.staff-flow.cloud/api/v1/ext/.

curl -H "Authorization: Bearer sfk_xxxxxxxx_yyyyyyyy…" \
  "https://app.staff-flow.cloud/api/v1/ext/shifts?from=2026-10-01&to=2026-10-31"

3. Адреси

GET /api/v1/ext/company     company, sites, positions
GET /api/v1/ext/members     people (current and former), role, dates
GET /api/v1/ext/shifts      published shifts         ?from=&to=&format=csv
GET /api/v1/ext/totals      published hours/person   ?from=&to=&format=csv
GET /api/v1/ext/absences    approved leave and unavailability  ?from=&to=

Період: «from» і «to» у форматі РРРР-ММ-ДД. Без «from» — від створення компанії; без «to» — до сьогодні; не більше 5 років за один запит.

Формат: JSON за замовчуванням ({"data": […]}); додайте «format=csv», щоб отримати файл CSV (роздільник «;», відкривається в Excel).

Передається лише опублікований графік (те, що бачать працівники), ніколи не чернетки.

4. Приклад відповіді

{
  "data": [
    {
      "id": "6c1f…", "day": "2026-10-06", "start": "08:00", "end": "16:00",
      "minutes": 480, "userId": "a41e…", "userName": "Olena",
      "siteId": "…", "site": "Centre", "positionId": "…", "position": "Barista",
      "note": null
    }
  ]
}

5. Помилки

401: ключа немає, він неправильний або відкликаний. 402: опція «доступ до API» не активна (підписка без опції). 400: неправильні дати.

Персональні дані

Компанія відповідає за використання отриманих даних (імена, години, відсутності) і має захищати їх у своїх програмах. Зберігайте ключі в таємниці; відкликайте ключ, щойно він більше не потрібен.