OSR:2019/toevoegen en wijzigen van endpoints: verschil tussen versies

Uit Kennisnet Developers Documentatie
Ga naar: navigatie, zoeken
(Request parameters)
Regel 35: Regel 35:
 
[[OSR:2019/JWT|JWT]]
 
[[OSR:2019/JWT|JWT]]
  
==Request parameters==
 
 
{|class="wikitable"
 
{|class="wikitable"
 
! style="text-align:left;"| Parameters
 
! style="text-align:left;"| Parameters
Regel 73: Regel 72:
 
'''*start_date: middernacht aan het begin van de opgegeven datum<br>
 
'''*start_date: middernacht aan het begin van de opgegeven datum<br>
 
'''*end_date: middernacht aan het einde van de opgegeven dag
 
'''*end_date: middernacht aan het einde van de opgegeven dag
 
  
 
==Voor wie?==
 
==Voor wie?==

Versie van 30 jan 2019 om 23:17

Inleiding

De leverancier moet de informatie over het endpoint zelf aanleveren.
Dit wijkt af van het OSO-project, waar een school in eerste instantie het endpoint (aanleverpunt) aanmaakt en de leverancier vervolgens het afleveradres erbij opslaat middels de call registreer aanleverpunt.

Om een endpoint aan te maken of te modificeren moet de leverancier gemandateerd zijn en het mandaat token gebruiken in de aanvraag voor het aanmaken van het endpoint.

Endpoints zijn specifiek voor een dienstversie en er kan eventueel ook een ingangsdatum worden meegegeven.

Bij deze service moet er ook een JWT token worden meegegeven. Hieronder is een link opgenomen hoe JWT toegepast moet worden voor het OSR


Post endpoints

Hieronder is een voorbeeld weergegeven van de POST operatie:

/api/v1/endpoints

{ 
"mandate_token": "6a47bfdd-81a7-46cd-b41f-d907e91ebdfc", 
"administration_id": "0000000700004HR77707", 
"service_version_namespace": "http://xml.eld.nl/schemas/Overstapservice/20170601", 
"url": "https://t2.nl", 
"attributes": "LAS", 
"start_date": "2019-01-01", 
"end_date": "2020-01-01" 
} 

Request Headers 
JWT: 
 
eyJhbGciOiJSUz 

Op de volgende pagina kan nadere informatie omtrent JWT gevonden worden: JWT

Parameters Omschrijving Verplicht/Optioneel
mandate_token Het mandaat token welke verkregen is door het mandaat op te vragen Verplicht
administration_id Uniek administratie kenmerk.
Dit moet goed afgestemd worden met de onderwijsinstelling, om eventuele problemen te voorkomen bij meerdere leveranciers die gemandateerd zijn voor de onderwijsinstelling en dienst combinatie.
Verplicht
service_version_namespace Namespace van de dienst Verplicht
url Technische locatie van de leverancier Verplicht
attributes Mogelijke attributen die ook opgeslagen moeten worden bij dit endpoint Optioneel
start_date* Start datum van het endpoint.
Indien dit niet meegegeven wordt, dan wordt de huidige datum hier automatisch ingevuld. start datum kan niet in het verleden liggen.
Optioneel
end_date* Eind datum van het endpoint. Einddatum kan niet in het verleden liggen Optioneel

*start_date: middernacht aan het begin van de opgegeven datum
*end_date: middernacht aan het einde van de opgegeven dag

Voor wie?

Deze service is beschikbaar voor leveranciers die gekwalificeerd zijn voor het OSR en die gemandateerd zijn voor een onderwijsinstelling
Voor TLS verbindingen (minimaal TLS 1.2) moet een aanvragende partij een geldige PKI overheidscertifcaat/ODOC certificaat gebruiken
Zie meer informatie over de API op https://osr-sb.kennisnet.nl/api/v1/doc