In het ANS Help center staan handleidingen over functionaliteiten van Ans.
Let op: Niet alle artikelen zijn relevant voor de situatie bij de Universiteit Leiden.
ANS handleidingen zijn Niet relevante als de procedure binnen de Universiteit:
- Afwijkt. In dat geval wordt er een verwijzing naar die procedure gemaakt.
- Niet is toegestaan. In dat geval wordt dat hier aangegeven.
- Niet van toepassing is. In dat geval wordt er hier niet naar de handleiding verwezen.
De volgende linkjes verwijzen naar relevante handleidingen over API documentatie.
Inhoudsopgave
Wat is een API?
Een API (Application Programming Interface) is een verzameling definities die voor communicatie tussen applicaties gebruikt worden om processen te automatiseren of om informatie uit een applicatie op te halen.
In Ansbgebruik je een API bijvoorbeeld om data te kunnen;
- Ophalen (Get);
- Toevoegen (Post);
- Aanpassen (Patch);
- Verwijderen (Delete).
Klik hier voor meer informatie.
Een API token genereren.
Je een API token nodig om toegang te krijgen tot de 'Ans API V2' om met API data op te halen.. Gebruikers met de rol Medewerker kunnen in ANS zo'n 'Api Token' creëeren.
Klik hier voor meer informatie over het maken van een API Token.
Voor Universiteit Leiden is het toevoegen (Post) of aanpassen (Patch) van gebruikers via API's in ANS is niet mogelijk. Als er aanpassingen nodig zijn, gaan deze via de ULCN koppeling. Evt. aanpassingen via een API worden overschreven met de informatie die ULCN aanlevert.
Itembankbeheer met API's
Door gebruik te maken van Api's voor itembankbeheer is het mogelijk om geautomatiseerd:
- Toevoegen van Uitgevers & Auteurs
- Importeren van Vragen
- Toevoegen van Domeinen en leerdoelen
Klik hier voor meer informatie.
Een webhook gebruiken.
De webhook functionaliteit geeft je de mogelijkheid om proactief geïnformeerd te worden over wijzigingen van bepaalde objecten in Ans. Je geeft aan op welk moment je data uit Ans ontvangt of realtime data-uitwisselt tussen Ans en andere platforms.
Klik hier voor meer informatie over webhooks.
Rapporten genereren via een API.
Via een API is het mogelijk om data voor analyses ( Inzichten in Ans terminologie) op te halen.
In het Help Center van ANS is een voorbeeld uitgewerkt waarin via API's een rapport wordt gegeneerd met aantal gepubliceerde toetsen in ANS op schoolniveau.
Klik hier voor het voorbeeld.