Wat de API allemaal kan (overzicht)

De Shyfter-API is georganiseerd per groot domein, dat de modules herneemt die je al kent uit de applicatie. Afhankelijk van de permissies van je token kun je deze gegevens raadplegen (lezen) en, als het token niet in alleen-lezen staat, er op inwerken (aanmaken, wijzigen). Hier is wat elk domein ter beschikking stelt, zonder in de techniek te duiken.

Waar te beginnen

Om te beginnen biedt de API een toegangspunt dat de permissies van je token en de actieve functies op het account oplijst. Dat is de juiste vertrekreflex: je weet meteen waarop je token recht heeft en of het in alleen-lezen staat.

Aangezien de meeste gegevens aan een afdeling gekoppeld zijn, haal je eerst de lijst op van de afdelingen waartoe je token toegang heeft, en geef je vervolgens bij elke oproep de betrokken afdeling op.

De beschikbare domeinen

• Afdelingen: de lijst van je toegankelijke vestigingen en afdelingen. Dat is de basis om daarna de juiste gegevens te viseren.
• Rooster: je shifts en je uurroosters. Raadpleeg het gepubliceerde rooster en maak, afhankelijk van de rechten, shifts aan of wijzig ze.
• Prikken: de opvolging van de werktijd. Je kunt de prikgegevens ophalen, de aankomst of het vertrek van een medewerker inklokken en een lopende prikbeurt annuleren.
• Medewerkers: de gegevens van je werknemers, met hun contracten, hun vaardigheden en hun afwezigheidsbeheer.
• Secties: de secties van je vestigingen (bar, keuken, zaal, afdeling...), handig om het rooster te organiseren.
• Attributen: de aangepaste attributen die je hebt gedefinieerd om je gegevens te verrijken.
• Omzet: het invoeren en raadplegen van je omzet, om te vergelijken met je gepresteerde uren en je kosten.
• Exports: het ophalen van je gegevens in de vorm van een export, handig om een rapportage of andere software te voeden.

De codes van het sociaal secretariaat zijn overigens op elkaar afgestemd tussen de shifts en de prikgegevens, voor een coherente doorstroming naar het loon.

Waar je het detail vindt

De volledige documentatie (elk domein, elk veld) en een implementatiegids zijn rechtstreeks beschikbaar op het Open API-platform, bestemd voor je technische teams of je integrator. Dit artikel geeft het overzicht; de online documentatie geeft de precieze handleiding.

Wat je token echt kan zien of wijzigen, hangt af van de permissies die je hebt toegekend en van het feit of het al dan niet in alleen-lezen staat. Bij twijfel controleer je eerst zijn permissies.