API dokumentáció

Kapcsolódás és munkavégzés a Shifton API-val

A Shifton API hozzáférést biztosít a platform összes kulcsfontosságú funkciójához — az ütemezés kezelésétől kezdve a külső integrációkig, mint például HR, bérszámfejtés, és analitikai rendszerek.
Az API használatával automatizálhatók a folyamatok, és összekapcsolhatja a Shifton-t vállalatának belső szolgáltatásaival.


API Dokumentáció

Két verziót támogatunk dokumentációból:


Kezdeti Lépések

API Kulcs Beszerzése

A Shifton platform vállalati beállításaiban generáljon egy API kulcsot.
Az autorizáció a fejlécen keresztül történik:

Authorization: Bearer {your_api_key}

Első Kérdésének Elkészítése

Például egy alkalmazotti lista lekérdezéséhez:

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

Példa válasz:

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

Integrálja az API-t a Munkafolyamataiba

  • Automatikusan hozza létre és módosítsa a műszakokat

  • Kezelje a szabadság- és betegszabadság-kérelmeket

  • Exportálja az adatokat bérszámfejtő rendszerekbe

  • Egyéni műszerfalakat és jelentéseket készíthet


Alapvető API funkciók

  • Munkatársak – hozzáadás, szerkesztés, és szerepkörök kezelése

  • Beosztások – műszakok létrehozása, módosítása, munkatervezés

  • Szabadságok és hiányzások – szabadság és betegszabadság kérelmek kezelése

  • Jelentések – idő, bérszámfejtés és jelenlét adatok exportálása


Hibakódok

A Shifton API szabványos HTTP státuszkódokat:

  • 200 — Kérelem sikeres

  • 201 — Objektum sikeresen létrehozva

  • 400 — Érvénytelen paraméterek

  • 401 — Jogosultsági hiba (érvénytelen API kulcs)

  • 403 — Hozzáférés megtagadva

  • 404 — Erőforrás nem található

  • 500 — Szerverhiba


Használati tippek

  • Mindig az új API verziót használd az új integrációkhoz

  • Használja a Postman-t vagy a curl-t a teszteléshez

  • Tartsa tiszteletben a sebességkorlátozásokat hogy elkerülje a blokkolást

  • Frissítse azokat az integrációkat, amelyek még mindig a régi dokumentációra támaszkodnak


Ossza meg ezt a bejegyzést