Das Interface licence verwaltet ausdrücklich dafür freigegebene Lizenzeinträge. Es ist keine allgemeine Leseschnittstelle für sämtliche Lizenzen eines Kunden. Benötigt werden notch, licence, ein Anwendungssecret und eine serverseitige Lizenzverwaltungskonfiguration für den Kontext.
Erproben Sie Schreiboperationen ausschließlich in einem mit uns vereinbarten Testkontext. Legen Sie dafür eigene Testeinträge an und entfernen Sie anschließend nur diese Einträge wieder. Verwenden Sie clear nicht zum Aufräumen einzelner Tests.
Challenge für Lizenzoperationen
<notch type="licence"/>
Aus <notch id="NOTCH_ID">NONCE</notch> wird wie beim Medienlink die Passphrase gebildet:
lowercase_hex(MD5(NONCE + ":" + SECRET))
Die Challenge unmittelbar verwenden; der reguläre Prüfer erlaubt höchstens 120 Sekunden. Eine link-Challenge ist nicht für licence gültig. Pro Operation eine neue Challenge anfordern.
Verwaltete Einträge auflisten
<licence id="NOTCH_ID" passphrase="HASH">
<list/>
</licence>
Schematische Antwort:
<list>
<r>
<f n="context">XX/BEISPIEL</f>
<f n="start">2026-01-01</f>
<f n="end">2026-12-31</f>
<f n="identifier">anbieter-12345</f>
</r>
</list>
Die Liste ist auf den konkreten Kontext, die erlaubten Verwaltungseinträge und gegebenenfalls ein Anbieterpräfix begrenzt. Sie kann leer sein, obwohl andere, etwa geerbte Lizenzen für die Wiedergabe existieren. Nur einen Kontext pro Request verwenden.
list liefert Kontext, Identifier, Beginn und Ende. Die Kennzeichen download und direct fehlen; sie lassen sich damit weder prüfen noch für eine Wiederherstellung sichern.
Lizenz anlegen oder ersetzen
<licence id="NOTCH_ID" passphrase="HASH">
<enter identifier="anbieter-12345"
start="2026-01-01" end="2026-12-31"
download="1" direct="1"/>
</licence>
| Attribut | Bedeutung und Standard |
|---|---|
identifier |
vollständige vereinbarte Medienkennung |
start |
Beginn als YYYY-MM-DD; Standard aktuelles Serverdatum |
end |
Ende als YYYY-MM-DD; Standard 2099-12-31 |
download |
gespeichertes Lizenzkennzeichen für Downloads, 0 oder 1; Standard 1 |
direct |
gespeichertes Lizenzkennzeichen für die Wiedergabe, 0 oder 1; Standard 1 |
Die Auswertung dieser Kennzeichen muss für Ihre Integration vereinbart sein. Ihr Setzen ist keine allgemeine Zugriffssperre: download="0" allein garantiert keine Downloadsperre, direct="0" allein keine Wiedergabesperre.
Boolesche Werte ausschließlich als 0 oder 1 übertragen, nicht als true oder false. Bestehende verwaltete Einträge desselben Mediums im Kontext werden vor dem Einfügen entfernt. Das ist eine ersetzende Operation, keine bloße Ergänzung. Datumswerte vor dem Senden validieren.
Mehrere enter-Elemente in einer Payload sind möglich. Eine atomare Alles-oder-nichts-Verarbeitung ist nicht zugesichert. Nach einem Timeout nicht blind wiederholen, sondern den Bestand mit list abgleichen.
Eine mögliche Antwort lautet:
<licence>1 added, 0 removed, 0 unknown</licence>
Diese Textzähler sind kein verlässlicher Nachweis für jede Einzeloperation. Identifier und Datumswerte anschließend mit list abgleichen. Die Kennzeichen download und direct lassen sich auf diesem Weg nicht überprüfen.
Optionale Auflösung von Signaturnummern
Wir können für Ihren Zugang die Auflösung reiner Signaturnummern bei enter freischalten. Ohne diese Vereinbarung vollständige Identifier verwenden. Die Option gilt nicht für remove.
Nicht auflösbare enter-Werte werden übersprungen und als unknown gezählt; andere Einträge derselben Anfrage können bereits geschrieben werden. Enthält die Anfrage nur unbekannte Einträge und keine gezählten Änderungen, kann die zusammenfassende Antwort fehlen. Eine leere Antwort daher nicht als Erfolg behandeln.
list liefert weiterhin vollständige Identifier. Für remove die Kennung aus dieser Liste verwenden. Eine spezielle Präfixkonfiguration ist ebenfalls möglich und muss beim Zugang vereinbart werden.
Einzelnen Eintrag entfernen
<licence id="NOTCH_ID" passphrase="HASH">
<remove identifier="anbieter-12345"/>
</licence>
Der Remove-Zähler wird im vorhandenen Handler auch dann erhöht, wenn zuvor kein passender Datensatz existierte. Er ist kein Nachweis einer tatsächlichen Löschung. Mit list nachprüfen.
Gesamten verwalteten Bereich leeren
<licence id="NOTCH_ID" passphrase="HASH">
<clear/>
</licence>
clear löscht tatsächlich Daten. Betroffen sind alle Einträge innerhalb der konfigurierten Kontext-, Herkunfts- und gegebenenfalls Präfixgrenzen. Es ist kein Dry-Run und kein Verbindungstest. Nur nach fachlicher Freigabe und mit einer vollständigen Sicherung der betroffenen Lizenzeinstellungen verwenden. Eine gespeicherte list-Antwort allein ist keine vollständige Sicherung.
Die Ausgabe kann neben <clear>… removed</clear> ein zusätzliches <licence>…</licence>-Element enthalten. Auch das Kombinieren verschiedener Unterbefehle kann mehrere oberste Elemente erzeugen. Deshalb für neue Clients pro Request nur eine Operationsart senden und das Antwortformat dieser Operation ausdrücklich berücksichtigen. Ein Parser, der immer genau einen licence-Wrapper erwartet, reicht nicht aus.
Zur Übersicht: Einstieg in die ARIX-Schnittstelle