Direkt zum Hauptinhalt

Eine externe Anwendung registrieren

Ziel​

Ein externes System (eine Integration, einen Dienst oder eine Middleware) registrieren, damit es Parsware-APIs mit eigenen Anmeldeinformationen aufrufen kann.

Voraussetzungen​

  • Sie sind als Plattformadministrator beim Admin Control Center angemeldet.
  • Sie wissen, welche Scopes das externe System braucht (zum Beispiel Lesezugriff auf App-Daten).

Schritte​

  1. Öffnen Sie die Seite App-Registrierungen über die linke Navigation.
  2. Geben Sie einen Anwendungsnamen ein, der das externe System kennzeichnet.
  3. Wählen Sie aus der Liste die Scopes aus, die die Anwendung braucht. Jeder Scope gewährt eine bestimmte Art von Zugriff.
  4. Wählen Sie die Sicherheitsrollen, die die Anwendung innehat, falls vorhanden. Bleibt dieses Feld leer, sind das die geringsten Rechte: Die Anwendung darf die Plattform aufrufen und keinen Datensatz berühren. Ein Skript einer benutzerdefinierten API läuft als die Anwendung, unter diesen Rollen – eine Anwendung, deren Skripte Datensätze lesen oder schreiben, braucht also genau die eine Rolle, die das darf, und diese Rolle sollte nur in den Umgebungen Berechtigungen erhalten, die die Anwendung bedient.
  5. Wählen Sie App registrieren aus.
  6. Ein Bereich zeigt die neue Client-ID und das Client-Geheimnis. Kopieren Sie das Client-Geheimnis jetzt – es wird nur einmal angezeigt und kann nicht erneut abgerufen werden.

Was im Hintergrund passiert​

Die externe Anwendung wird zu einem registrierten API-Client. Sie authentifiziert sich mit ihrer Client-ID und ihrem Geheimnis, um ein kurzlebiges Zugriffstoken zu erhalten, und ruft dann Parsware-APIs mit diesem Token auf. Das Token ist auf genau die Scopes beschränkt, die Sie gewährt haben, nennt Ihren Mandanten und trägt die gewählten Rollen – und die entscheiden, welche Datensätze es erreichen darf.

Fehlerbehebung​

  • „Scope … can only be granted by the platform operator.“ – parsware.provision und parsware.portals.serve gehören den Servern des Plattformbetreibers (Website, Portal-Host) und stehen nicht in Ihrer Liste. Keine Ihrer Anwendungen braucht sie.
  • Eine widerrufene Anwendung antwortete noch eine Weile. Der Widerruf verhindert sofort jedes neue Token, aber ein Token, das sie bereits hat, prüft jeder Dienst selbst; es gilt bis zu seinem Ablauf weiter, höchstens eine Stunde. Um sie sofort abzuschneiden, entfernen Sie auch die Berechtigungen ihrer Rolle in dieser Umgebung: die werden bei jedem Aufruf geprüft.
  • „Scope … ist kein bekannter Plattform-Scope.“ – ein angeforderter Scope ist nicht im Katalog. Wählen Sie Scopes nur aus der angezeigten Liste aus.
  • „Rolle … existiert in diesem Mandanten nicht.“ – eine gewählte Rolle wurde gelöscht, bevor die Registrierung gespeichert wurde. Öffnen Sie den Bereich erneut und wählen Sie noch einmal.
  • „Mindestens ein Scope muss gewährt werden.“ – wählen Sie vor dem Registrieren mindestens einen Scope aus.
  • Sie haben das Client-Geheimnis verloren – das Geheimnis kann nicht wiederhergestellt werden. Widerrufen Sie die Registrierung und registrieren Sie die Anwendung erneut, um ein neues Geheimnis zu erhalten.

Verwandte Szenarien​

  • Eine externe Anwendung widerrufen.