Dokumentation for Materialeplatformens REST API, version 4-2

Servicen nås gennem en række endpoints, med URL'en opbygget således: https://materialeplatformen.emu.dk/materialer/api/v<version>/<endpoint>

Oversigt

Vi har følgende endpoints:

Versioner

REST API'et understøtter flere versioner af både DANLOM og DKLOM. Dette gøres gennem versions-angivelsen af REST-servicens endpoint.

REST API versionDANLOM versionDKLOM version
33
44.0
4-14.1
4-24.2
11.0
1-11.1

Bemærk, at for DKLOM gælder, at kun det endpoint, der henter enkeltdata er understøttet. Der findes ingen DKLOM for søgning eller lister. Manipulation af data i Materialeplatformen - PUT og DELETE kald - understøttes kun i DANLOM.

Autentificering

For at benytte REST-servicen skal man autentificeres. Dette gøres ved at tilføje enten en parameter, auth, eller (foretrukket) en speciel header, X-Authorization, til sit request. Indholdet skal være '{id} {tidsstempel} {checksum}', dvs. tre dele med mellemrum imellem.

{id}
Skal være id på brugeren, f.eks. 'A00035' (hvilket er Styrelsen for It og Lærings id).
{tidsstempel}
Aktuelt klokkeslet tilføjes for at nedsætte risikoen for "genafspilningsangreb". Skal angives som sekunder siden midnat 1. januar, 1970 UTC.
{checksum}
Tilføjes for at sikre mod at kunne udgive sig for en anden. Checksummen består af en HMAC-SHA1 hashing af '{id} {tidsstempel}' med brugerens unikke kode som nøgle. Hashen Base64 encodes derefter. Nøglen udleveres af Styrelsen for It og Læring.

Eksempelkode