Ontwikkelaaroorsig - Shifton Help

Die Developer-bladsy gee toegang tot die Shifton API-dokumentasie en -instrumente vir die skep van pasgemaakte integrasies.

Stap-vir-stap instruksies

Toegang tot die Developer-bladsy

Klik op die linkerkantbalk op Integrasies.

Gaan na die Ontwikkelaar-bladsy.

Bo-aan is drie oortjies: Oorsig, Webhooks en Aansoeke.

Gebruik van die Overview-oortjie

Skakel	Beskrywing
Nuwe dokumentasie	Huidige API-dokumentasie
Ou dokumentasie	Verouderde dokumentasie vir bestaande integrasies

Klik op die verlangde skakel — die dokumentasie sal in ‘n nuwe oortjie oopmaak.

Ander Developer-oortjies

Webhooks

mdash; stel eindpunte op vir intydse gebeurteniskennisgewings.

Aansoeke

mdash; skep en bestuur pasgemaakte toepassings.

Verwante artikels

Gereelde vrae

V: Watter dokumentasie moet ek gebruik — nuwe of ou?
Gebruik Nuwe dokumentasie vir alle nuwe integrasies. Die ou een is slegs vir agterwaartse verenigbaarheid.

V: Die Ontwikkelaar-bladsy word nie vertoon nie — hoekom?
Die bladsy is slegs beskikbaar vir Owner.

V: Is daar beperkings op die aantal API-versoeke?
Ja. Besonderhede is in die API-dokumentasie.

V: Waar vind ek die API-sleutel vir die werk met die skofon API?
Integrations → Ontwikkelaar → Aansoeke → skep ‘n toepassing → in die instellings kry jy die API-legitimasie.

V: Ondersteun skofon OAuth 2.0?
Ja. Magtiging via OAuth word vir die koppeling van derdepartytoepassings gebruik. Besonderhede is in die API-dokumentasie.

V: Kan ek die API toets sonder om ‘n toepassing te skep?
Ja — gebruik instrumente soos Postman met jou aanmeldingsbesonderhede. Vir produksie word dit aanbeveel om ‘n toepassing te registreer.

V: Wat is die verskil tussen New en Ou dokumentasie?
Nuwe dokumentasie is die huidige weergawe (aanbeveel vir alle nuwe integrasies). Ou dokumentasie is vir agterwaartse verenigbaarheid met bestaande integrasies.

V: Kan ek verslagdata via die API kry?
Ja. Die Shifton API bied toegang tot rooster-, werknemer- en ander hulpbrondata. Besonderhede is in die dokumentasie.

V: Ondersteun Webhooks alle skofon-gebeurtenistipes?
Nee, slegs spesifieke tipes. Die lys van ondersteunde gebeurtenisse is in die Developer → Webhooks-dokumentasie.

V: Is tegniese kennis nodig om met die API te werk?
Ja. Vir die werk met die REST API en die skep van integrasies via Applications is basiese ontwikkelingsvaardighede nodig.

V: Is die API betaalbaar of by die intekening ingesluit?
Die API is binne die intekening beskikbaar sonder addisionele koste. Beperkings hang af van die tariefplan.

V: Hoe kry ek ondersteuning by probleme met API-integrasie?
Kontak Shifton-ondersteuning met ‘n beskrywing van die versoek, antwoord en foutkode. Bestudeer ook die dokumentasie op die Developer-bladsy.

V: Wat is die basis-URL vir die skofon API?
Die basis-URL is api2.shifton.com. Besonderhede en voorbeeldversoeke is in die Nuwe dokumentasie beskikbaar.

V: Ondersteun die API paginering vir groot lyste?
Ja. Besonderhede van die pagineringsimplementering word in die API-dokumentasie beskryf.

V: Kan ek via die API skofte skep en verwyder?
Ja. Die API bied volle CRUD-toegang tot skofte, werknemers, roosters en ander hulpbronne.

V: Is daar ‘n sandbox-omgewing vir API-toetsing?
Daar is geen spesiale sandbox-omgewing nie. Dit word aanbeveel om ‘n toetsmaatskappy in Shifton te skep vir veilige toetsing.

V: Watter daTaakepate ondersteun die API?
Die API gebruik die JSON-formaat vir versoeke en antwoorde.