ARIX verwendet den Kontext, um Anfragen einem Lizenz- und Datenbereich zuzuordnen. Der Kontext allein ist kein Zugangsnachweis. Zusätzlich müssen die anfragende Anwendung und die benötigten Funktionen freigeschaltet sein.
Zugang vorbereiten
Stimmen Sie vor der Integration mit uns ab:
- die HTTPS-Adresse und die erlaubten Kontexte;
- die ausgehenden IP-Adressen, unter denen der Server Ihre Anwendung sieht;
- die benötigten Befehle, etwa
search,record,notch,link; - das Anwendungssecret für geschützte Aufrufe;
- erlaubte Rollen und besondere Downloadregeln.
Ein gültiges Secret ersetzt weder die IP-Freigabe noch die Freigabe eines Befehls. Auch ein Benutzerlogin schaltet nicht automatisch weitere Schnittstellenfunktionen frei. Eine anonyme Suche ist kein zugesicherter Bestandteil des Zugangs.
Kontext aufbauen
Die klassische Form lautet:
LAND/STANDORT/SCHULE/BENUTZER
Nicht jede Integration verwendet alle Ebenen. Es gibt auch besondere Kontextnamensräume. Verwenden Sie die von uns zugewiesene Zeichenfolge; Standort- und Schulkennungen lassen sich nicht zuverlässig aus Ortsnamen ableiten.
Ein verkürzter Kontext kann einen größeren organisatorischen Bereich bezeichnen, liefert aber nicht automatisch alle Medien seiner Unterkontexte. Für eine konkrete Schule verfügbare Medien können beispielsweise aus Landes-, Standort- und Schullizenzen stammen. Die Lizenzprüfung entscheidet, was im angefragten Kontext verfügbar ist.
Kontext übertragen
Für neue Integrationen steht der Kontext im URL-Pfad:
https://arix.datenbank-bildungsmedien.net/XX/BEISPIEL
XX/BEISPIEL ist ein Platzhalter, kein nutzbarer Testzugang. Der vorhandene Einstieg akzeptiert weiterhin das Formularfeld context; wenn es vorhanden ist, überschreibt es den URL-Kontext. Vermeiden Sie widersprüchliche Angaben und verwenden Sie möglichst nur den URL-Pfad.
Schreiben Sie Kontexte nicht eigenständig in Großbuchstaben um. Insbesondere bei $/EDU/... ist die Schreibweise der Kennung nach diesem Präfix zu bewahren. Übernehmen Sie den zugewiesenen Kontext unverändert.
Mehrere Kontexte
Historische Such- und Lizenzprüfpfade unterstützen kommaseparierte Lizenzschlüssel. Daraus folgt keine allgemeine Mehrkontext-Unterstützung: Andere Schritte verwenden nur den ersten Kontext oder lösen den Client anhand der gesamten übergebenen Zeichenfolge auf. Insbesondere playinfo und das Lizenzverwaltungsinterface sind nicht als Sammelaufruf für mehrere Kontexte zu verwenden.
Für neue Integrationen einen Kontext pro Request verwenden. Einen Mehrkontext-Zugang nur nach ausdrücklicher Vereinbarung einsetzen und seine Ergebnisse separat prüfen.
Warum sich Ergebnisse unterscheiden können
Neben Lizenzen beeinflusst der Kontext die Datenquelle, Suchfelder und die Auflösung von Abspiel- und Downloadlinks. Zugänge können außerdem verschiedene Handler für denselben Befehl verwenden. Ein Ergebnis aus einer anderen Landes- oder Kundenintegration ist deshalb kein Sollwert für Ihren Zugang.
Für die Abnahme denselben Suchtext in einem ausdrücklich lizenzierten und einem nicht lizenzierten Testfall prüfen. Dabei die vereinbarte Rolle und die tatsächliche ausgehende IP verwenden. Keine fremden Schulkontexte als Testwerte ausprobieren.
Zur Übersicht: Einstieg in die ARIX-Schnittstelle