Lizenzierte Systemzugriffe für Integrationen und Jobs
Zweck und Einsatzbereich
Abschnitt betitelt „Zweck und Einsatzbereich“NeuraPort prüft nicht nur angemeldete Benutzer, sondern auch nichtmenschliche Zugriffe wie API-Schlüssel, eingehende Webhooks und Hintergrundjobs gegen die gebuchten Produktmodule. Dadurch kann ein technischer Zugang gültig sein und trotzdem keine Aktion ausführen, wenn das erforderliche Modul gesperrt, abgelaufen, nur lesbar oder für die betroffene Organisationseinheit nicht aktiviert ist.
Diese Seite erklärt die Lizenzentscheidung und ihre sichtbaren Prüfpunkte. API-Schlüssel, Webhook-Ziele und Providerzugänge richten Sie in den jeweils verlinkten Schnittstellenbereichen ein. Die interne Ausführung eines Jobs und die technische Serviceidentität besitzen keine eigene Bedienmaske.
Voraussetzungen und Berechtigungen
Abschnitt betitelt „Voraussetzungen und Berechtigungen“Der fachlich benötigte Produktbereich muss als Mandantenmodul gebucht sein. Führt ein Vorgang eine Organisationseinheit mit, muss das Modul dort ausdrücklich aktiviert sein. Ein technischer Zugriff ersetzt nur die persönliche Benutzerzuordnung und Rollenprüfung; er ersetzt weder Mandantenlizenz noch OE-Freigabe.
| Aufgabe | Zuständigkeit und sichtbarer Bedienweg |
|---|---|
| Enforcement-Modus und Mandantenvertrag prüfen | Plattformadministrator unter Einstellungen → Produkte & Lizenzen |
| Mandantenmodul und seinen Status pflegen | Plattformadministrator unter Plattform · Produkte & Lizenzen |
| Gebuchte Module ansehen und auf Organisationseinheiten verteilen | Organisationsadministrator unter Einstellungen → Produkte & Lizenzen |
| API-Schlüssel und Webhooks verwalten | Organisationsadministrator oder Manager im Arbeitsbereich Public API beziehungsweise unter Einstellungen → API & Webhooks |
| Job- oder Webhook-Entscheidung auswerten | Plattformbetrieb anhand der technischen Überwachung; dafür ist keine Benutzeransicht belegt |
Integratoren können die fachliche Konfiguration vorbereiten und den Zugriff testen, ändern aber nicht automatisch Vertrag, Modulstatus oder OE-Freigabe. Für die Verwaltung des sichtbaren Lizenzbereichs ist eine Administratorrolle erforderlich. Die nichtmenschliche Prüfung verwendet keine Benutzerrolle und kein Benutzer-RBAC. Ein API-Schlüssel kann zusätzlich eigene Scopes besitzen; diese werden unabhängig von der Modulentscheidung geprüft.
Schritt-für-Schritt-Anleitung
Abschnitt betitelt „Schritt-für-Schritt-Anleitung“Voraussetzungen vor der Inbetriebnahme prüfen
Abschnitt betitelt „Voraussetzungen vor der Inbetriebnahme prüfen“- Halten Sie fest, welche Funktion die Integration oder der Job lesen, exportieren, schreiben oder automatisieren soll. Berücksichtigen Sie neben einem Schnittstellenmodul auch das fachliche Elternmodul, beispielsweise den betroffenen Transportbereich.
- Lassen Sie durch einen Plattformadministrator unter Einstellungen → Produkte & Lizenzen den angezeigten Enforcement-Modus, den Vertragsstatus und die benötigten Mandantenmodule prüfen. Der Modus wird in dieser Ansicht angezeigt, aber nicht dort geändert.
- Lassen Sie für einen OE-bezogenen Ablauf durch einen Organisationsadministrator unter Produkte & Lizenzen prüfen, ob das benötigte Modul in der betreffenden Spalte der Organisationseinheit eingeschaltet ist.
- Richten Sie erst danach den vorgesehenen technischen Zugang im zugehörigen Schnittstellenbereich ein. Übernehmen Sie keine Schlüssel, Secrets oder produktiven Nutzdaten in Tickets, Screenshots oder Handbuchnotizen.
- Testen Sie mit vollständig synthetischen Daten getrennt einen Lesevorgang und – falls benötigt – einen Schreib- oder Automationsvorgang. Ein erfolgreicher Lesezugriff belegt nicht, dass Schreiben oder Automationen erlaubt sind.
- Prüfen Sie bei einem Vorgang mit Organisationseinheit zusätzlich einen Datensatz genau dieser Einheit. Ein Test ohne OE-Bezug belegt deren Freigabe nicht.
- Lassen Sie fehlgeschlagene oder nur protokollierte Lizenzentscheidungen durch den Plattformbetrieb auswerten. Setzen Sie einen abgewiesenen Job nicht durch wiederholte Aufrufe oder einen anderen technischen Zugang fort.
Sichtbare und technische Prüfpunkte unterscheiden
Abschnitt betitelt „Sichtbare und technische Prüfpunkte unterscheiden“Die Oberfläche zeigt Vertrag, Modulstatus, Gültigkeit, Nutzung und OE-Zuordnung. Der Plattformbereich zeigt außerdem, ob Lizenzverstöße blockiert oder lediglich protokolliert werden. Nicht sichtbar sind die einzelne Systementscheidung, ein eigener Status je Serviceidentität und der Abbruch eines Hintergrundjobs. Ein fehlender sichtbarer Fehler ist deshalb kein Nachweis, dass die Lizenz technisch positiv entschieden wurde.
Feldreferenz
Abschnitt betitelt „Feldreferenz“| Feld | Pflicht | Bedeutung | Validierung |
|---|---|---|---|
| Mandant | Ja | Organisation, für deren Integration oder Job die Lizenz geprüft wird | Es muss ein vorhandener Mandantenkontext bestehen. Ein unbekannter Mandant gilt als nicht lizenziert. |
| Modul | Ja | Produktbereich, den der technische Vorgang benötigt | Das Modul muss für den Mandanten angelegt sein. Bei zusammengesetzten Vorgängen können Public API und ein fachliches Elternmodul gemeinsam erforderlich sein. |
| Aktion | Ja | Art des technischen Zugriffs | READ und EXPORT gelten als lesend; WRITE und AUTOMATION als schreibend. Hintergrundjobs werden als AUTOMATION geprüft. |
| Organisationseinheit | Bedingt | Fachliche Einheit des Ereignisses oder Datensatzes | Wird eine Einheit mitgeführt, muss das Modul dort ausdrücklich aktiviert sein. Ohne mitgeführte Einheit findet in dieser Systementscheidung keine OE-Freigabeprüfung statt. |
| Vertragsstatus | Ja, außer Sonderfall KI-Automatisierung | Zustand des Mandantenabonnements | EXPIRED oder ein überschrittenes Enddatum sperrt den Zugriff. PAST_DUE und CANCELED erlauben nur Lesen und Export. |
| Modulstatus | Ja | Freigabe des einzelnen Produktmoduls | Unterstützt werden ACTIVE, TRIAL, READ_ONLY und SUSPENDED. Ein fehlender Moduleintrag gilt als nicht gebucht. |
| Gültig bis | Nein | Befristung der Modulfreigabe | Ein überschrittener Zeitpunkt sperrt das Modul; bei einer abgelaufenen Testphase wird dies gesondert ausgewiesen. |
| Enforcement-Modus | Ja für den Betrieb | Bestimmt, ob eine negative Entscheidung nur protokolliert oder tatsächlich blockiert wird | ENFORCE blockiert Systemzugriffe und bricht geschützte Jobs ab. AUDIT protokolliert die Ablehnung, lässt den Ablauf aber weiterlaufen. OFF blockiert ebenfalls nicht. |
KI-Automatisierung ist im sichtbaren Lizenzbereich als Always-on · nicht deaktivierbar gekennzeichnet. Der Systempfad behandelt dieses Modul bei Vertragsstatus, Befristung, Sperre und Lesemodus als Sonderfall. Ein Moduleintrag bleibt dennoch erforderlich; bei mitgeführter Organisationseinheit gilt weiterhin deren Freigabe.
Status und mögliche Übergänge
Abschnitt betitelt „Status und mögliche Übergänge“| Ausgangszustand | Aktion | Ergebnis |
|---|---|---|
| Vertrag aktiv, Modul ACTIVE oder gültiges TRIAL, OE gegebenenfalls freigeschaltet | Lesen, Export, Schreiben oder Automation | Systemzugriff ist lizenzseitig erlaubt; weitere Authentifizierungs-, Scope- und Fachprüfungen bleiben bestehen. |
| Modul READ_ONLY oder Vertrag PAST_DUE beziehungsweise CANCELED | READ oder EXPORT | Zugriff bleibt lesend erlaubt. |
| Modul READ_ONLY oder Vertrag PAST_DUE beziehungsweise CANCELED | WRITE oder AUTOMATION | Entscheidung wechselt zu MODULE_READ_ONLY. Im Modus ENFORCE wird blockiert oder der geschützte Job abgebrochen. |
| Modul SUSPENDED, Vertrag EXPIRED, Modul nicht gebucht oder Testphase abgelaufen | Beliebige Aktion | Negative Lizenzentscheidung; im Modus ENFORCE kein Zugriff. |
| Modul in der mitgeführten Organisationseinheit nicht aktiviert | Beliebige Aktion | MODULE_NOT_ENABLED_FOR_UNIT; im Modus ENFORCE kein Zugriff. |
| Negative Entscheidung im Modus AUDIT oder OFF | Beliebige Aktion | Der Vorgang wird nicht durch diese Lizenzprüfung blockiert. Bei AUDIT wird die Abweichung protokolliert. |
| Vertrag, Modulstatus oder OE-Zuordnung wird korrigiert | Vorgang kontrolliert erneut starten | Die Lizenz wird beim nächsten geschützten Aufruf neu entschieden. Eine bereits abgebrochene Verarbeitung wird nicht automatisch als erfolgreich nachgeholt. |
Was im Hintergrund passiert
Abschnitt betitelt „Was im Hintergrund passiert“Für einen nichtmenschlichen Zugriff wertet NeuraPort Mandantenvertrag und Mandantenmodul aus. Ist eine Organisationseinheit Bestandteil des Vorgangs, kommt deren ausdrückliche Modulfreigabe hinzu. Anders als bei einem angemeldeten Benutzer werden weder Benutzerzuordnung noch Rollenrechte geprüft; an ihre Stelle treten die technische Identität und – je nach Zugang – zusätzliche Scopes oder Signaturprüfungen.
Lesen und Export bleiben bei READ_ONLY, PAST_DUE oder CANCELED möglich. Schreiben und Automationen werden negativ entschieden. Bei SUSPENDED, EXPIRED, fehlendem Modul oder abgelaufener Freigabe fällt auch der Lesezugriff negativ aus. Der Enforcement-Modus entscheidet anschließend, ob NeuraPort die Ablehnung nur protokolliert oder wirklich durchsetzt.
Geschützte Hintergrundjobs erhalten bei einer negativen Entscheidung im Modus ENFORCE einen Abbruch. Geschützte HTTP-Systemzugriffe werden mit einer Lizenzablehnung beendet. Die Tests belegen unter anderem den Jobabbruch bei einem gesperrten Modul, die Sperre eines eingehenden Webhooks bei einem gesperrten fachlichen Elternmodul und die Sperre eines öffentlichen Tracking-Links, wenn dessen Elternmodul nicht mehr aktiv ist. Sie belegen nicht, dass jeder vorhandene öffentliche oder interne Systemweg vollständig dieselbe Kaskade verwendet.
Die Lizenzdaten sind mandantenbezogen gespeichert; die OE-Freigabe verweist auf eine Organisationseinheit. Der Datenbankkontext begrenzt die Abfragen zusätzlich auf den gesetzten Mandanten. Ob eine einzelne Integration fachliche Daten sehen oder verändern darf, hängt darüber hinaus von deren eigener Authentifizierung, Scopes, Signaturprüfung und Datensatzfilterung ab.
Typische Fehler und Lösungen
Abschnitt betitelt „Typische Fehler und Lösungen“| Meldung oder Beobachtung | Ursache | Lösung |
|---|---|---|
| MODULE_NOT_LICENSED | Mandantenabo oder benötigtes Mandantenmodul fehlt. | Vertrag und benötigte Module unter Produkte & Lizenzen prüfen lassen. Bei zusammengesetzten Abläufen auch das fachliche Elternmodul berücksichtigen. |
| SUBSCRIPTION_EXPIRED | Das Abonnement ist abgelaufen oder sein Enddatum wurde überschritten. | Vertragsstatus durch den Plattformadministrator klären; Vorgang nicht über einen Ersatzkanal fortsetzen. |
| MODULE_TRIAL_EXPIRED | Die befristete Testfreigabe des Moduls ist abgelaufen. | Modul regulär freigeben oder den technischen Ablauf stoppen. |
| MODULE_SUSPENDED | Das benötigte Modul ist gesperrt. | Sperrgrund klären und erst nach administrativer Freigabe erneut testen. |
| MODULE_READ_ONLY | Ein schreibender Zugriff oder Job trifft auf READ_ONLY, PAST_DUE oder CANCELED. | Schreibende Prozesse pausieren; ein erfolgreicher Lesezugriff ist keine Schreibfreigabe. |
| MODULE_NOT_ENABLED_FOR_UNIT | Das Modul ist in der mitgeführten Organisationseinheit nicht aktiviert. | Zuordnung unter Produkte & Lizenzen durch einen Organisationsadministrator prüfen lassen. |
| Zugriff läuft trotz negativer Lizenzentscheidung weiter | Der Enforcement-Modus ist AUDIT oder OFF. | Plattformbetrieb informieren, Protokolle prüfen und den vorgesehenen Durchsetzungszustand klären. Die Oberfläche bietet keinen Schalter zur Änderung. |
| Job stoppt ohne sichtbare Meldung im Facharbeitsplatz | Der Systemabbruch besitzt keine eigene Benutzeransicht. | Technische Überwachung durch den Plattformbetrieb prüfen lassen; Modul, Vertragsstatus und gegebenenfalls OE dokumentieren. |
| Zugriff ohne OE-Bezug funktioniert, OE-bezogener Vorgang nicht | Nur beim zweiten Vorgang wurde eine Organisationseinheit mitgeführt und geprüft. | Genau die fachlich betroffene OE freischalten und den Test mit synthetischen Daten wiederholen. |