Eduterm:Voorwaarden: verschil tussen versies

Uit Kennisnet Developers Documentatie
Ga naar: navigatie, zoeken
k (Admin heeft pagina OBKAPI:SLS hernoemd naar Eduterm:SLS)
Regel 1: Regel 1:
== 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'':<br />
+
== Gebruikersvoorwaarden ==
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'':<br />
+
Aan het gebruik van Eduterm worden door Kennisnet voorwaarden verbonden welke in deze
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.
+
Gebruiksvoorwaarden zijn opgenomen. Gebruiker gaat akkoord met de Gebruiksvoorwaarden
 +
voordat zij kunnen gebruik kan maken van de Dienst.
  
''performance'':<br />
+
* [https://www.kennisnet.nl/fileadmin/kennisnet/publicatie/Kennisnet_aansluitvoorwaarden_catb__eduterm.pdf Gebruikersvoorwaarden].
Voor alle aangeboden zoekopdrachten geldt een gemiddelde responsetijd van 0.6 seconden.
 
  
=== databronnen ===
+
== Service Level Specification (SLS) ==
{{:OBKAPI:Endpoints}}
 
=== 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.
 
{| class="wikitable"
 
|-
 
! 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 ===
+
Voor Eduterm geldt de SLS die onderdeel uitmaakt van de Overeenkomst die tussen Kennisnet en haar Dienstafnemers tot stand is gekomen. In deze SLS beschrijft Kennisnet haar dienstverlening en de Beschikbaarheid daarvan zo helder en meetbaar mogelijk.  
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 ==
+
*[https://www.kennisnet.nl/fileadmin/kennisnet/publicatie/Kennisnet-Service-Level-Specification.pdf Service Level Specification].
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'':<br />
 
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'':<br />
 
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 [http://kn.nu/servicemeldingen 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 [http://kn.nu/servicemeldingen mailinglijst]. De totale tijd, waarin de platformdienst niet beschikbaar is door onderhoud en wijzigingen, wordt beperkt tot maximaal 8 uur per maand.
 
  
 
[[Category:Eduterm]]
 
[[Category:Eduterm]]
 
[[Category:SLS]]
 
[[Category:SLS]]

Versie van 29 jan 2019 om 14:29


Gebruikersvoorwaarden

Aan het gebruik van Eduterm worden door Kennisnet voorwaarden verbonden welke in deze Gebruiksvoorwaarden zijn opgenomen. Gebruiker gaat akkoord met de Gebruiksvoorwaarden voordat zij kunnen gebruik kan maken van de Dienst.

Service Level Specification (SLS)

Voor Eduterm geldt de SLS die onderdeel uitmaakt van de Overeenkomst die tussen Kennisnet en haar Dienstafnemers tot stand is gekomen. In deze SLS beschrijft Kennisnet haar dienstverlening en de Beschikbaarheid daarvan zo helder en meetbaar mogelijk.