API Dokumentasie

Koppel en Werk met die Shifton API

Die Shifton API gee jou toegang tot al die sleutelfunksies van die platform — van skedulebestuur tot integrasies met eksterne HR, betaalstaat, en analistiese stelsels.
Deur die API te gebruik, kan jy prosesse outomatiseer en Shifton met jou maatskappy se interne dienste koppel.


API Dokumentasie

Ons ondersteun twee weergawes van ons dokumentasie:


Aan die Slag

Verkry ‘n API Sleutel

In jou maatskappy-instellings op die Shifton-platform, genereer ‘n API-sleutel.
Magtiging word via die opskrif gedoen:

Authorization: Bearer {your_api_key}

Maak Jou Eerste Versoek

Byvoorbeeld, om ‘n lys van werknemers te kry:

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

Voorbeeld reaksie:

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

Integreer die API in Jou Werkvloei

  • Skep en verander skofte outomaties

  • Bestuur vakansie- en siekteverlof aansoeke

  • Voer data uit na betaalstelsel stelsels

  • Bou pasgemaakte dashboards en verslae


Kern-API-vermoëns

  • Werknemers – voeg by, wysig en bestuur rolle

  • Skedules – skep, pas skofte aan, beplan werk

  • Verlof & Afwesighede – bestuur vakansie- en siekteverlof versoeke

  • Verslae – voer tyd-, betaalstaat- en bywoningsdata uit


Foutkodes

Shifton API gebruik standaard HTTP statuskodes:

  • 200 — Suksesvolle versoek

  • 201 — Oorleg suksesvol geskep

  • 400 — Ongeldige parameters

  • 401 — Magtigingsfout (ongeldige API-sleutel)

  • 403 — Toegang geweier

  • 404 — Hulpbron nie gevind nie

  • 500 — Bedienerfout


Gebruikswenke

  • Gebruik altyd die nuwe API weergawe vir nuwe integrasies

  • Gebruik Postman of curl vir toetsing

  • Respekteer tydslimiete om te voorkom dat jy geblokkeer word

  • Werk integrasies op wat steeds op die ou dokumentasie staatmaak


Deel hierdie pos