Instellen van de OKE-koppeling

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.
• Ik loop vast bij het aanmaken van de API-sleutel doordat ik in beide applicaties nog geen gegevens kan plaatsen – hoe ga ik verder?
  Wat je zou kunnen doen is eerst een API-sleutel aanmaken, maar de callback nog uitzetten en deze pas later aanzetten. 

Toets inplannen (flow 2)

• 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".

Resultaten (flow 3)

• Sommige resultaten van een toetsmoment worden niet teruggekoppeld, hoe komt dit?
  Het kan zijn dat kandidaten handmatig zijn toegevoegd aan het toetsmoment. Alleen studenten die via de koppeling zijn toegevoegd worden teruggekoppeld. 

• Hoe gaat Remindo om bij het doorgeven van verschillende resultaattypes?
  Afhankelijk van het resultaattype in Remindo en of er een cesuur is ingesteld, worden resultaten op verschillende manieren doorgegeven via OOAPI/OKE vanuit Remindo naar een toetsplanningsysteem. Per resultaat worden afhankelijke van het resultaattype een aantal verschillende waarden doorgegeven.

  Er zijn drie scenario's te onderscheiden:

  1. Bij een resultaat met het resultaattype cijfer (ongeacht of er een cesuur is ingesteld)
     • Via score wordt het behaalde cijfer doorgegeven.
     • Via pass wordt doorgegeven of een voldoende gehaald is: passed, failed of unknown indien er geen cesuur is ingesteld.
     • Via resultState wordt de status van het resultaat doorgegeven, omdat het cijfer bekend is zal dat completed zijn.
  2. Bij een resultaat met het resultaattype punten of percentage met cesuur
     • Via score wordt het behaalde percentage doorgegeven (of het percentage punten ten opzichte van maximaal te behalen punten).
     • Via pass wordt doorgegeven of een voldoende gehaald is: passed, failed.
     • Via resultState wordt de status van het resultaat doorgegeven, ook hier is dat completed.
  3. Bij een resultaat met het resultaattype punten of percentage zonder cesuur
     • Er wordt geen score teruggegeven.
     • Via pass wordt unknown doorgegeven om aan te geven dat (nog) onbekend is of het resultaat voldoende is of niet.
     • Via resultState wordt in progress doorgegeven, dit geeft een indicatie dat het resultaat (waarschijnlijk) nog aangepast zal worden.

Hoewel het resultaattype in Remindo in theorie kan veranderen, blijkt in de praktijk dat een toetsplanningssysteem hier niet altijd mee om kan gaan. Door bij scenario 3 geen waarde bij score door te geven wordt hier omheen gewerkt. Dit speelt over het algemeen alleen als een toets op een later moment genormeerd wordt en de cesuur pas na een aantal afnames (met terugwerkende kracht) wordt toegepast. Het is te verwachten dat een resultaat zonder cesuur later wordt omgezet in een cijfer met cesuur. Op dat moment is scenario 1 weer van toepassing. Remindo zal om die reden ook in de toetscatalogus die via OOAPI/OKE kan worden opgevraagd bij scenario 3 aangeven dat het (te verwachten) resultaat een cijfer zal zijn.

• Kunnen vragen en/of antwoorden via de OKE-koppeling bekend worden bij klanten van examenleveranciers?
  Via de koppeling worden enkel het behaalde cijfer en de verantwoordingsrapportage uitgewisseld. In deze verantwoordingsrapportage zitten geen vragen/antwoorden. Of een kandidaat in Remindo na het afronden van de toets de resultaten mag inzien en welke onderdelen daarvan is afhankelijk van de zichtbaarheidsinstellingen, maar dat wordt dus niet uitgewisseld met een extern systeem. Niet via de OKE-koppeling, als dat wel gewenst is moet dat door de school zelf geïmplementeerd worden via de Remindo-API.

Zittingsverslag (flow 4)

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

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 een ticket in te dienen.

• 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.

Mocht je nog vraag met bovenstaande niet beantwoord zijn, dien dan een ticket in; geef daarin zoveel mogelijke relevante informatie op.