OOAPI

OKE-koppeling op basis van de OOAPI-standaard

Het is vanaf nu mogelijk om applicaties van verschillende leveranciers met Remindo te koppelen. Dit gaat heel eenvoudig via de OKE-koppeling (Onderwijs Koppeling Examinering). Hiermee kunnen toetsmomenten geautomatiseerd overgezet worden in Remindo vanuit de planning en geeft Remindo ook automatisch een terugkoppeling van toetsresultaten. Daarmee is het handmatig importeren en exporteren van gegevens verleden tijd en worden fouten voorkomen. Doordat de OKE-koppeling een open standaard is (op basis van de Open Onderwijs API), is er bovendien geen langdurig implementatietraject nodig. Op deze manier is het voor het mbo mogelijk om het examenproces in te richten met applicaties van verschillende leveranciers wanneer de leverancier voldoet aan deze open standaard. De OKE-koppeling is specifiek ontwikkeld voor het examenproces in het mbo en maakt gebruik van OOAPI versie 5. De OKE-koppeling gaat uit van drie functionaliteiten: deelnemerregistratie (SIS), toetsplanning en logistiek systeem (TPS) en toetsafnamesysteem (TAS). Remindo wordt in dit geval als toestafnamesysteem ingezet. Tussen deze drie functionaliteiten bevinden zich zes koppelvlakken/ informatiestromen. Meer informatie over de OKE-koppeling is te vinden op edustandaard.nl.

Instellen van de OKE-koppeling op basis van de OOAPI-standaard in Remindo

De koppeling kan ingesteld worden door de rol ‘beheerder’ in de afname-omgeving van Remindo. Heb je deze instelling niet, neem dan contact op met de beheerder van de afname-omgeving. Waarschijnlijk is dit de examenleverancier van je afname-omgeving.

1. Ga naar de betreffende afname-omgeving van Remindo die je wil koppelen.
2. Ga naar Beheer > Instellingen.
3. Klik op het tabblad API.

4. Klik op de knop “Open Onderwijs API Documentatie”.

5. Klik op de knop “+ Nieuwe API-sleutel voor OOAPI”.

6. Het formulier is al ingevuld met de juiste informatie om via OOAPI te koppelen:

   • Authenticatiemethode: X-API-Key header / OAuth Client Credentials
   • Beschikbare API-aanroepen: Schakel enkel OOAPI-endpoints in
   • Ingeschakelde callbacks: Open Onderwijs API (OOAPI)

7. Vul het formulier aan met:

   • Naam van de koppeling en emailadres van technisch contactpersoon
   • Gegevens voor de callback, deze ontvang je van de applicatie waarmee je wil koppelen:
     • Callback-URL
     • Access Token URL
     • Client ID
     • Client Secret
     • Scope
   • Sla het formulier op.

8. Kopieer API-URL, X-API-key en Access Token URL en configureer deze gegevens in de te koppelen applicatie

De X-API-key bevat een Client ID en een Client secret, het gedeelte voor de ':' is het ID, daar achter staat de secret.

9. De OOAPI-koppeling is gereed.

Veelgestelde vragen

• Als je als school meerdere afname-omgevingen hebt, hoe werkt het dan? In elke afname-omgeving van Remindo moet de OOAPI apart ingesteld worden.

• In Remindo zie ik het tabblad 'Instellingen' niet. Wat moet ik doen? De beheerder van de omgeving stelt de rechten van de omgeving in. Neem contact op met de beheerder van jouw omgeving als je geen toegang hebt tot de instellingen-pagina.

• Kunnen alle Remindo-omgevingen gekoppeld worden via de OOAPI? Voor meer informatie over de planning en aangesloten partijen verwijzen we door naar edustandaard.nl.

• Ik maak gebruik van een ander planningssysteem en/of SIS. Kan Remindo hiermee koppelen via de OOAPI? Voor meer informatie over de planning en aangesloten partijen verwijzen we door naar edustandaard.nl.

• Kan de inhoud van het zittingsverslag aangepast worden? Nee, de onderdelen van het zittingsverslag kunnen niet aangepast worden.

• Hoe maak ik toetsmomenten aan als ik gebruik maak van Eduarte? Als je Eduarte inzet als toetsplanningssysteem kun je meer informatie vinden in de Handreiking "Toetsmoment instellen in Remindo vanuit Eduarte".

Accounts en rollen

• Worden kandidaten via de OOAPI/OKE-koppeling aangemaakt of worden bestaande accounts hergebruikt? Wanneer kandidaten al op de juiste manier in Remindo staan, dan zullen deze accounts hergebruikt worden. Een eventuele indeling in groepen blijft bestaan. Kandidaten worden gekoppeld op het code/kenmerk-veld in Remindo (deze wordt ook door het SIS doorgegeven).

• Kloppen de rollen op digitaal-examineren.nl van beheerder, begeleider en auteur? Binnen Remindo hebben rollen een aantal basisrechten en daarnaast een aantal instelbare rechten. Hierdoor kan elke rol zo ingesteld worden dat het bij de functie binnen een organisatie past. Hoe de rollen zijn ingesteld heeft niets met de OKE-koppeling te maken. De koppeling zorgt er enkel voor dat mensen aan een toetsmoment gekoppeld worden. Vanuit Eduarte worden personen enkel als kandidaat of surveillant gekoppeld aan een toetsmoment.

• Wat kan er gewijzigd worden in de rollen van begeleiders? De instelling van rollen wordt niet gedaan via de OKE-koppeling. Het is afhankelijk van de examenleverancier hoe rollen zijn ingesteld. De koppeling heeft in feite alleen betrekking op kandidaten en surveillanten, omdat de koppeling gaat over toetsmomenten. Elke begeleidende rol kan als surveillant gekoppeld worden aan het toetsmoment.

• Op basis van welke gegevens worden studenten / gebruikers gekoppeld aan bestaande accounts?
  • Account ID
  • Studentnummer
  • E-mailadres

Het account ID is de gebruikersnaam. Remindo doet eerst een check op Account ID. Vinden we precies 1 gebruiker, dan gebruiken we dat account. Zo niet, dan kijken we of er precies één student is waarbij er een studentnummer in het code/kenmerk veld staat. Zo niet, dan kijken of er precies één student is met het opgegeven e-mailadres. Zo niet, dan dan wordt een student aangemaakt waarbij de gebruikersnaam de Account ID is (tenzij die al in gebruik is, bijvoorbeeld door een begeleider), het studentnummer komt in het code/kenmerk veld en het e-mailadres wordt opgenomen als e-mailadres. Ook de meegegeven naam wordt opgeslagen. Hetzelfde geldt voor begeleiders.

Wanneer op basis van andere gegevens kandidaten/ gebruikers gekoppeld worden, dan kan deze mapping worden aangepast zodat bijvoorbeeld als gebruikersnaam het studentnummer wordt gebruikt. Als dit gewenst is kan dit worden aangeven bij Paragin door te mailen naar support@paragin.com.

• Wanneer wordt de student als ‘afwezig’ geregistreerd in het SIS als de toets niet is afgenomen? Er wordt één keer per uur bij de toetsmomenten die zijn afgerond gecontroleerd of er studenten stonden ingeschreven die nooit gestart zijn. Dit wordt via de OOAPI/OKE-koppeling teruggekoppeld.