API dokumentatsioon

Ühendamine ja töötamine Shiftoni API-ga

Shiftoni API annab teile juurdepääsu platvormi kõikidele põhifunktsioonidele — alates ajakava haldamisest kuni väliste HR, palga ja analüüsi süsteemidega.
API kasutamine võimaldab teil protsesse automatiseerida ja ühendada Shifton teie ettevõtte sisemiste teenustega.


API dokumentatsioon

Toetame oma dokumentatsiooni kahte versiooni:


Alustamine

API võtme hankimine

Shiftoni platvormi ettevõtte seadetes genereerige API võti.
Autoriseerimine toimub päise kaudu:

Authorization: Bearer {your_api_key}

Tehke oma esimene päring

Näiteks, et hankida töötajate nimekiri:

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

Näidisvastus:

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

API integreerimine oma töövoogudesse

  • Loomine ja muutmine automaatselt

  • Puhkuse ja haiguslehe taotluste haldamine

  • Andmete eksportimine palgasüsteemidele

  • Kohandatud juhtelementide ja aruannete loomine


Põhilised API võimekused

  • Töötajad – lisamine, muutmine ja rollide haldamine

  • Graafikud – vahetuste loomine ja kohandamine, töö planeerimine

  • Vabad Päevad ja Puudumised – puhkuste ja haiguslehe taotluste haldamine

  • Arvestus – aja, palgaarvestuse ja kohalolekuandmete eksportimine


Veakoodid

Shifton API kasutab standardseid HTTP olekukoodi:

  • 200 — Päring õnnestus

  • 201 — Objekt edukalt loodud

  • 400 — Vigased parameetrid

  • 401 — Autoriseerimisviga (vigane API võti)

  • 403 — Ligipääs keelatud

  • 404 — Ressurssi ei leitud

  • 500 — Serveri viga


Kasutamisjuhised

  • Alati kasutage uue API versiooni uute integreerimiste jaoks

  • Kasutage Postman või curl testimiseks

  • Järgige kiiruspiiranguid vältimaks blokeerimist

  • Uuendage integratsioone, mis endiselt tuginevad vanale dokumentatsioonile


Jaga seda postitust