Knowledge Base

We hebben goed nieuws! De API staat sinds begin 2023 voor jullie klaar. Met behulp van de public API kan jouw organisatie alle data uit jullie omgeving uploaden voor eigen gebruik. 

Welke data is inzichtelijk?

De kwantitatieve data is te allen tijde inzichtelijk, zodat jullie de activiteiten omtrent de performance cyclus kunnen blijven volgen. Daarnaast is het mogelijk om de inhoudelijke ontwikkelingen van medewerkers inzichtelijk te maken. De inhoud van de persoonlijke ontwikkelingen moet daarvoor op ‘openbaar voor beheer’ gezet worden. Als beheerder kun je via het beheerpaneel kiezen voor “data delen”, zodat toekomstige doelen & reflecties zichtbaar worden met gebruik van de API. Doelen & reflecties worden dan standaard gedeeld met beheer en dit kan niet gewijzigd worden door medewerkers.

Hoe vraag je een API-Sleutel aan?

Er is een API-sleutel vereist om de API te gebruiken. Deze API-sleutel kan worden gegenereerd door naar de integratiepagina te gaan vanuit het beheerpaneel. 

Stap 1: Er moet een technisch contactpersoon worden ingesteld voordat de API-sleutel kan worden gegenereerd. Bij een storing of een belangrijke update met betrekking tot de API wordt contact opgenomen met de technische contactpersoon. Hiervoor gebruiken wij alleen de contactgegevens van de technische contactpersoon. 

Stap 2: Zodra de technische contactpersoon is ingesteld en het selectievakje Algemene voorwaarden is aangevinkt, kan de API-sleutel worden gegenereerd. Dit is de API-sleutel voor de hele organisatie en het is de verantwoordelijkheid van de technische contactpersoon om ervoor te zorgen dat alleen de juiste mensen binnen hun organisatie er toegang toe hebben. Mocht de API-Sleutel toch in verkeerde handen terechtkomen, dan kan de sleutel gereset worden op de integratiepagina en is de oude API-Sleutel niet meer geldig.

Hoe gebruik je de API?

Stap 2: Kijk naar de verschillende endpoints in Swagger UI. Om vertrouwd te raken met de verschillende endpoints hebben we ook een gebruikersinterface opgezet met Swagger UI, die toegankelijk is in de browser via de volgende URL: https://api.truqu.com/docs/static/index.html. Hier moet de API-sleutel worden ingevoerd door op de groene knop “autoriseren” te klikken. Zodra dit is gebeurd, kan de pagina worden gebruikt om de verschillende endpoints uit te proberen. Onderaan de pagina worden de schema’s van alle endpoints gedefinieerd.

Belangrijke mededeling!
Alle items die worden gemaakt, worden weergegeven in de API-resultaten, maar als het item niet met alle beheerders wordt gedeeld via de functie voor automatisch delen, worden alle velden met persoonlijke informatie weergegeven als null. Als het item wordt gedeeld met alle beheerders die de functie voor automatisch delen gebruiken, zullen deze velden de informatie tonen. De functie voor automatisch delen kan worden afgedwongen voor de hele organisatie door via het beheerdersdashboard naar de pagina “Gegevens delen” te gaan, de optie om automatisch een reflectierapport of een doel te delen met alle beheerders kan hier worden ingeschakeld.

Belangrijk om op te merken is dat verwijzingen naar gebruikers of andere objecten worden gedaan met ‘id’s’, dus om een item waarnaar wordt verwezen te bekijken, moet het worden verzameld met behulp van het bijbehorende eindpunt. Bij het verzamelen van een persoonlijke reflectie bevatten de gekoppelde items bijvoorbeeld de ‘id’ van alle items die aan het reflectieverslag zijn gekoppeld en niet het gehele item dat is gekoppeld.

Om rechtstreekse verzoeken aan de API te doen, moet een GET-verzoek worden gedaan aan:
https://api.truqu.com/v1/[ENDPOINT]
De juiste header moet eraan worden toegevoegd, zodat het de oproep kan autoriseren en het JSON-antwoord kan ontvangen. Hieronder ziet u een voorbeeld van zo’n oproep.

krul -X ‘KRIJGEN’ \
‘https://api.truqu.com/v1/user’ \
-H ‘accepteren: applicatie/json’ \
-H ‘autorisatie: [API_KEY]’

Hulp nodig bij het aanvragen van de API-key of het gebruik van de endpoints? We helpen jullie graag. Neem contact op via: Customerservice@truqu.com