Eduterm:SLS

Uit Kennisnet Developers Documentatie
Ga naar: navigatie, zoeken

Eduterm-symbol.png Eduterm: SLS

De Dienst

Wat wordt er geleverd? Een zoekopdrachten-interface met verschillende uitvoerformaten, queries en databronnen. De verschillende componenten van dit bovenstaande worden onder bepaalde voorwaarden geleverd. Deze voorwaarden zijn uitgewerkt in de volgende paragrafen.

zoekopdrachten interface

De software die ingevoerde queries vertaald naar zoekopdrachten voor de betreffende databronnen, API-key toegang regelt, en de databron antwoorden vertaalt naar het gevraagde uitvoerformaat. Voor dit component zijn de volgende aspecten van belang.

versies en levensduur:
Er kunnen verschillende versies van de software naast elkaar in productie zijn. Deze versies zijn afzonderlijk aanroepbaar via het versienummer in de url; bijv. obk-api.kennisnet.nl/0.7/ In principe is een nieuwe versie backwards-compatible met een oude versie, en worden alle verzoeken naar een oude url geredirect naar de nieuwste versie. Indien dit niet mogelijk is, wordt een oude versie tenminste 1 jaar in de lucht gehouden onder productie service level.

uptime:
In principe wordt er gestreefd naar 100% uptime. Indien de software niet up is, is de reactietijd binnen kantoortijden <2 uur. De oplostijd is binnen een werkdag.

performance:
Voor alle aangeboden zoekopdrachten geldt een gemiddelde responsetijd van 0.6 seconden.

databronnen

De databronnen zijn afzonderlijke RDF stores die door de OBK-API bevraagd worden met de SPARQL querytaal. De verschillende databronnen worden getypeerd door hun levensduur, mate van onderhoud, en tussentijdse dynamiek.

type release changelog migratie communicatie
productie bron rolling* X X X
set bron versioned* X X X
staging bron onbekend
  • versioned release: Bij grote wijzigingen wordt periodiek een volledig nieuwe release gemaakt, waarbij de oude versie ook blijft bestaan. Tussentijds kan het voorkomen dat een bugfix release wordt gedaan.
  • rolling release: Grote wijzigingen worden in dezelfde databron verwerkt.

Een voorbeeld van een productie bron is de volledige OBK databron. Een voorbeeld van een set bron is de Kennisnetset-2015.01.

queries

Voor elke query kunnen er 1-3 varianten bestaan. Een "latest" rolling-release query en 2 static queries. In principe werken alle klanten op de rolling release tenzij ze dit expliciet aanvragen voor een query.

type voorbeeld release verwijdering
latest, rolling Kerndoelen 2 weken na release nieuwe query niet
nieuw Kerndoelen20150901 wanneer de query inhoudelijk is aangepast en door ons getest niet, pas wanneer deze variant de status "oud" krijgt
oud Kerndoelen20150101 wanneer een nieuwe query wordt gereleased 3 maanden na release van een nieuwe query

uitvoerformaten

Er zijn momenteel vier uitvoerformaten beschikbaar; csv, json, html en xml. Indien er formaten niet-backwards compatible worden vervangen, blijven de originele tenminste 2 jaar beschikbaar na het uitbrengen van het vervangende formaat.

De Klant

Op verzoek kunnen wij de klant toegang geven tot 1 of meerdere queries. Het verlenen van deze toegang gaat middels een API-key. Deze key is bedoeld voor 1 dienst van de klant, of om mee te testen, een zgn dienst-API-key of een ontwikkel-API-key.

Een klant kan een toegangsverzoek doen voor een bestaande query of een nieuwe query. In het geval van een bestaande query zal dit over het algemeen gehonoreerd worden. In het geval van een nieuwe query gaat dit in overleg met de product owner van de OBK-API. Hierbij wordt de klantwens gerelateerd aan efficiency en onderhoudbaarheid van onze dienstverlening.

De communicatie rondom toegang en queries verloopt via info@edustandaard.nl.

gebruik:
Het gebruik van de OBK-API wordt door ons gemonitord. Wanneer we merken dat de dienst naar ons inzicht niet normaal wordt gebruikt, en dit eventueel een gevaar oplevert voor de continuering van de dienstverlening, zullen wij tijdelijk de toegang tot OBK-API ontzeggen. We zullen hierna contact opnemen met de klant in kwestie.

communicatie:
Om optimaal met onze klanten te communiceren over technische en inhoudelijke wijzigingen, vragen wij van elke klant contactgegevens in de vorm van email en telefoonnummer. Service-affecting zaken zullen we waar mogelijk van tevoren de OBK-API mailinglist communiceren.

Algemeen service, support, onderhoud

Kennisnet levert service, support en onderhoud op werkdagen tussen 9:00 en 17.00 uur. Er kan onderhoud verricht worden aan onderliggende componenten, zoals de Onderwijs Community Cloud. Wanneer deze werkzaamheden service-affecting zijn worden ze minimaal 3 werkdagen van te voren ingepland en gecommuniceerd via de OCC mailinglijst. De totale tijd, waarin de platformdienst niet beschikbaar is door onderhoud en wijzigingen, wordt beperkt tot maximaal 8 uur per maand.