Mit den Konto-Endpunkten legen Sie Benutzer an und aktivieren vorhandene Freischaltcodes für ihr Buchregal. Diese Anleitung beschreibt die ALKM-API, nicht die manuelle Einlösung in der Edupool-Oberfläche.
Sie benötigen einen Manager-Schlüssel mit passenden Produkt- und Kontoauskunftsberechtigungen. Setzen Sie die Bash-Variablen aus dem Einstieg. Verwenden Sie zunächst ausschließlich Testkonten: Die folgenden Aufrufe schreiben Daten; eine Kontoanlage kann je nach Reseller-Konfiguration eine E-Mail auslösen.
Konto anlegen
Erstellen Sie lokal eine Datei konto.json mit restriktiven Dateirechten. Ersetzen Sie E-Mail und Passwort durch die Daten eines freigegebenen Testkontos. Das gezeigte Passwort ist nur ein Platzhalter.
{
"email": "testkonto@example.invalid",
"password": "HIER-EIN-EIGENES-SICHERES-PASSWORT-EINSETZEN",
"surname": "Muster",
"name": "Alex",
"institution": false
}
Senden Sie die Datei ausschließlich über HTTPS:
curl --silent --show-error --include \
-H "x-api-key: $ALKM_API_KEY" \
-H 'Content-Type: application/json' \
"$ALKM_BASE_URL/user/manage/create" \
--data-binary @konto.json
Nehmen Sie die Datei nicht in die Versionsverwaltung auf und entfernen Sie sie nach dem Test. ALKM erhält das Passwort im JSON-Body; HTTPS schützt den Transport. Eine Passwortregel lässt sich aus der Schnittstelle allein nicht ableiten. Vereinbaren Sie die Anforderungen vor dem produktiven Einsatz.
Fiktive Erfolgsantwort:
{"code":1,"message":"OK","user_id":"$/csu/123/bk","institution_id":456}
Speichern Sie user_id unverändert. Sie ist ein String; institution_id ist eine Zahl. Die nachfolgenden Beispiele verwenden die fiktive ID $/csu/123/bk, die Sie ersetzen müssen.
Konto auslesen und ändern
curl --silent --show-error --include \
-H "x-api-key: $ALKM_API_KEY" \
-H 'Content-Type: application/json' \
"$ALKM_BASE_URL/user/manage/info" \
--data-binary @- <<'JSON'
{"identifier":"$/csu/123/bk"}
JSON
Alternativ senden Sie {"email":"testkonto@example.invalid"}. Bei der Auskunft heißt das ID-Feld identifier, bei Änderungen und Aktivierungen user_id. Die Auskunft liefert direkt die Kontodaten, ohne code: 1-Hülle. Eine fehlende Auskunft kann auch an den Sichtbarkeitsrechten Ihres Schlüssels liegen.
curl --silent --show-error --include \
-H "x-api-key: $ALKM_API_KEY" \
-H 'Content-Type: application/json' \
"$ALKM_BASE_URL/user/manage/update" \
--data-binary @- <<'JSON'
{"user_id":"$/csu/123/bk","name":"Alexandra"}
JSON
Änderbar sind email, surname, name, street und city, nicht Passwort oder Institutionsstatus. Der Aufruf ist auf die passende Reseller-Anlagekennung beschränkt. Lesen Sie die Daten anschließend erneut aus: code: 1 belegt hier nicht, dass tatsächlich ein Datensatz geändert wurde.
Freischaltcode aktivieren
curl --silent --show-error --include \
-H "x-api-key: $ALKM_API_KEY" \
-H 'Content-Type: application/json' \
"$ALKM_BASE_URL/user/manage/licence/activate" \
--data-binary @- <<'JSON'
{"user_id":"$/csu/123/bk","activation_code":"BEISPIEL-CODE"}
JSON
Ersetzen Sie BEISPIEL-CODE durch den erhaltenen Produkt- oder Warenkorb-Code. Erfolg wird mit {"code":1,"message":"OK"} gemeldet. Der Aufruf registriert die Aktivierung und legt die zugehörige Antares-Lizenz an.
Zur Kontrolle:
curl --silent --show-error --include \
-H "x-api-key: $ALKM_API_KEY" \
-H 'Content-Type: application/json' \
"$ALKM_BASE_URL/user/manage/licence/active" \
--data-binary @- <<'JSON'
{"user_id":"$/csu/123/bk"}
JSON
Prüfen Sie die zurückgegebenen Produktnummern unter licences und den Zugriff im Buchregal. Die Liste enthält aktive Codezuordnungen innerhalb Ihrer Berechtigungen; sie ist kein vollständiger Nachweis, dass jede Lizenz zeitlich noch gültig ist.
Lizenz vom Konto entziehen
Der folgende Aufruf entzieht die Zuordnung tatsächlich. Verwenden Sie ihn nur für den gewünschten Entzug, nicht als Statusprüfung.
curl --silent --show-error --include \
-H "x-api-key: $ALKM_API_KEY" \
-H 'Content-Type: application/json' \
"$ALKM_BASE_URL/user/manage/licence/revoke" \
--data-binary @- <<'JSON'
{"user_id":"$/csu/123/bk","activation_code":"BEISPIEL-CODE"}
JSON
Prüfen Sie nach code: 1 erneut die aktive Liste und den Zugriff. Der Code selbst wird nicht gelöscht. Dieser Aufruf ist keine allgemeine Stornierung des Codes und garantiert keine spätere Wiederaktivierbarkeit. Stimmen Sie Rückgabe- und Übertragungsabläufe vorab ab.
Bei Timeouts oder Teilfehlern zuerst den tatsächlichen Zustand prüfen. Kontoanlage und Aktivierung dürfen nicht als beliebig wiederholbare Vorgänge behandelt werden.
Zugang einrichten: Einstieg in die ALKM-API. Codes erzeugen: Ersten Freischaltcode per API erzeugen. Fehlerbehebung: ALKM-Antworten und fehlgeschlagene Aufrufe.