Inhoudstafel
Inleiding
Een API, de afkorting voor Application Programming Interface, wordt gebruikt om op een geformaliseerde manier gegevens uit te wisselen tussen softwareprogramma's en apps. Met behulp van een API token beschikt u dan ook over de mogelijkheid om een API koppeling te maken met een derde partij, indien deze nog geen connectie heeft met CrewPlanner.
Stel dat u als CrewPlanner klant een leverancier heeft zonder reeds bestaande koppeling met CrewPlanner, dan bieden we de mogelijkheid om alsnog bepaalde informatie uit CrewPlanner te halen, en naar believen te verwerken door middel van een Client of Agency API token.
U kunt deze API tokens zelf aanmaken en beheren via de API TOKENS pagina, welke u terugvindt in het INSTELLINGEN menu aan de rechterzijde. Op deze pagina heeft u eveneens documentatie beschikbaar waarmee de derde partij een Client API kan bouwen.
Een API-koppeling voorbereiden
Bovenaan de API token pagina heeft u de volgende mogelijkheden, API TOKEN AANMAKEN en NAAR DOCUMENTATIE.
Vooraleer u een API token aanmaakt, dient u eerst de nodige informatie aan uw derde partij te bezorgen zodat zij zich kunnen voorbereiden om met de API token te koppelen. Daarom selecteert u eerst NAAR DOCUMENTATIE, waar u de nodige informatie kunt terugvinden.
U krijgt vervolgens drie opties die leiden naar de relevante informatie voor het type koppeling dat u wenst te maken:
Client API: met deze koppeling kunnen prestatiegegevens doorgestuurd worden naar derden
Payroll API: met deze koppeling worden Payroll bedrijven verbonden met hun klanten in CrewPlanner
Agency API: met deze koppeling worden uitzendkantoren of projectenbureaus met hun klanten verbonden in CrewPlanner
Het is dus belangrijk dat u de juiste documentatie deelt met uw leverancier of derde partij.
Een API token aanmaken
Om een API token aan te maken in CrewPlanner gaat u voor de drie verschillende types op dezelfde wijze aan de slag. Indien u echter een koppeling wenst te maken met een payroll-, uitzendkantoor of projectenbureau dat nog niet bij CrewPlanner is aangesloten, dient u eerst contact op te nemen via [email protected]!
We bespreken dan ook enkel verder hoe uw een Client API aanmaakt:
Om gegevens van prestaties op te halen uit CrewPlanner heeft u een Client API nodig. Aan de hand van de relevante documentatie kan uw leverancier aan hun zijde de nodige voorbereidingen treffen om deze API token te realiseren.
Zodra dit in orde is maakt u eenvoudigweg een API-token aan voor deze leverancier, door API TOKEN AANMAKEN te selecteren. U wordt hierna naar de volgende pagina geleid:
U neemt vervolgens de volgende stappen:
Geef de token een voor u herkenbare naam, bijvoorbeeld die van de derde partij waarvoor u de API token aanmaakt.
Selecteer de toegang die u wenst toe te kennen door het relevante aan te vinken; momenteel ondersteunen wij een koppeling voor de rapportage van uw gepresteerde uren en werknemers gegevens.
Maak de token aan door OPSLAAN te selecteren.
Het API token overzicht
Zodra u de token heeft aangemaakt, verschijnt deze in het token overzicht op de API token pagina. Welke informatie vindt u hier terug:
Naam: de naam die u genoteerd heeft bij de aanmaak van deze token.
Toegang: hier wordt weergegeven aan welke informatie u toegang geeft.
Laatst gebruikt op: hier kunt u raadplegen wanneer deze koppeling laatst gebruikt werd door de derde partij.
Potlood icoon: selecteer dit om de token te bewerken of te raadplegen. We bespreken dit zo dadelijk in meer detail.
Prullenbak icoon: dit gebruikt u om de token te verwijderen.
Een API token raadplegen en kopiëren
Zoals reeds eerder aangegeven raadpleegt u een API token door in het overzicht het potlood icoon te selecteren naast de desbetreffende token.
Dit brengt u naar onderstaande pagina, waar u aan de rechterzijde de geheime token aantreft.
Zodra u het klipbord icoon selecteert, wordt deze token volledig zichtbaar en voor u gekopieerd.
Op deze manier kunt u de token delen met uw derde partij.
CrewTip! We raden u aan met grote voorzichtigheid om te gaan met deze code, aangezien u hierdoor uw gevoelige en personeelsdata kunt delen.
Met behulp van deze geheime sleutel kan uw partner op elk ogenblik naar believen alle gegevens van de rapportage uit uw omgeving halen. Het kan echter zijn dat deze opteert om bijvoorbeeld slechts wekelijks of maandelijks deze rapportage op te halen.
Het is dus aan de derde partij om aan de hand van de API documentatie en de geheime sleutel die u voor hen aanmaakt, een eigen koppeling te bouwen die met de CrewPlanner logica kan koppelen.
Een API token verwijderen
Zoals eveneens eerder aangegeven, verwijdert u een API token door het prullenbak icoon te selecteren in het overzicht.
Zodra u dit icoon selecteert, opent de volgende pop-up:
Drukt u vervolgens op Bevestigen, dan wordt deze API token verwijderd en zal de derde partij niet langer toegang hebben tot uw gegevens.
Hopelijk hebben wij u met dit artikel verder geholpen!
Indien u nog vragen heeft, neem eerst even een kijkje in onze Crew Academy. Hier vindt u misschien het antwoord in één van onze artikelen.