Deutsch English (United States) Español (Latinoamérica) Français 日本語 简体中文
search shadow

Menu

Beiträge in diesem Abschnitt

Revizto-Entwicklerportal Folgen

Avatar
Mallory McClure
  • Aktualisiert

Das Entwicklerportal ermöglicht Kontoeigentümern und Kontoadministratoren, Revizto API-Integrationen zu verwalten. Sie können OAuth-Apps für Revizto API-Integrationen hinzufügen und verwalten, von Revizto verwaltete vorkonfigurierte Apps wie Revizto MCP Server aktivieren, steuern, welche Integrationen für Mitglieder im Organisationskonto verfügbar sind, und API-Benachrichtigungs-E-Mails verwalten.

Das Entwicklerportal verwendet OAuth 2.0 und ermöglicht es Benutzern, eine Drittanbieterintegration über den standardmäßigen Revizto-Anmelde- und Genehmigungsablauf zu autorisieren.

Vorhandene Integrationen auf Basis von Zugangscodes werden weiterhin unterstützt, um die Abwärtskompatibilität sicherzustellen. Neue Integrationen sollten das Entwicklerportal und die Registrierung von OAuth-Apps verwenden.

Siehe auch:

Erforderliche Berechtigungen

Benutzer mit der Kontorolle Kontoeigentümer oder Kontoadministrator können Apps im Entwicklerportal einsehen und verwalten. Sie können Ihre Kontorolle auf der Seite Kontoinformationen/Kontoinformationen verwalten im Revizto Workspace einsehen. Weitere Informationen finden Sie unter Konto- und Lizenzrollen. 

Standardbenutzer können unter App-Integrationen die im Konto aktiven Apps einsehen; sie können jedoch keine Apps hinzufügen oder bearbeiten, keine Client-Geheimnisse anzeigen und keine Einstellungen verwalten.

Die Revizto-Zugriffsrechte eines Benutzers gelten für die Integration, d. h., sie kann nur auf Daten zugreifen, auf die der autorisierte Revizto-Benutzer Zugriff hat.

Entwicklerportal aufrufen

Kontoeigentümer und Administratoren können OAuth-Apps über das Entwicklerportal im Revizto Workspace verwalten. Hier können Sie benutzerdefinierte Apps hinzufügen und verwalten, vorkonfigurierte Apps aktivieren oder deaktivieren, API-Benachrichtigungs-E-Mails verwalten und verfügbare Integrationen anzeigen.

So greifen Sie auf das Entwicklerportal zu:

  1. Melden Sie sich bei ws.revizto.com an.
    • Falls Sie ein Mitglied mehrerer Konten sind, achten Sie darauf, dass das korrekte Konto ausgewählt ist.

  2. Öffnen Sie das Dropdown-Menü Tools und wählen Sie dann Kontoinformationen verwalten. Wenn Kontoinformationen verwalten nicht angezeigt wird, siehe Erforderliche Berechtigungen. 

  1. Klicken Sie auf Entwicklerportal.

App-Integrationen für Standardbenutzer

Standardbenutzer haben keinen Zugriff auf das Entwicklerportal, können aber die Apps ihres Kontos unter App-Integrationen im Revizto Workspace anzeigen. 

App-Integrationen bietet eine Übersicht der verfügbaren Inhalte, einschließlich:

  • Aktive benutzerdefinierte Apps.
  • Aktive vorkonfigurierte Apps.
  • App-Beschreibungen.

Standardbenutzer können in App-Integrationen zwar allgemeine App-Informationen anzeigen, diese sind jedoch auf grundlegende Angaben zu den im Konto verfügbaren Apps beschränkt. Es werden keine zusätzlichen Details oder administrativen Funktionen angezeigt, darunter:

  • Inaktive Apps (benutzerdefiniert oder vorkonfiguriert).
  • Client-IDs der Apps.
  • Client-Geheimnisse der Apps.
  • Redirect-URIs der Apps.
  • Verwaltungsaktionen für Apps.

Wenn Sie erwarten, dass eine App verfügbar ist, sie aber nicht unter App-Integrationen sehen, wenden Sie sich an den Kontoeigentümer oder den Kontoadministrator.

So greifen Sie auf App-Integrationen zu:

  1. Melden Sie sich bei ws.revizto.com an.
    • Falls Sie ein Mitglied mehrerer Konten sind, achten Sie darauf, dass das korrekte Konto ausgewählt ist.

  2. Öffnen Sie das Dropdown-Menü Tools und wählen Sie dann Kontoinformationen.

  1. Klicken Sie auf App-Integrationen.

App-Typen

Im Entwicklerportal gibt es zwei App-Typen: vorkonfigurierte Apps und benutzerdefinierte Apps. 

Vorkonfigurierte Apps

Vorkonfigurierte Apps werden von Revizto oder Revizto-Partnern verwaltet und müssen nicht von einem Kontoeigentümer oder Kontoadministrator hinzugefügt werden. Kontoeigentümer und Kontoadministratoren können für eine vorkonfigurierte App weder die Client-ID, das Client-Geheimnis noch Redirect-URIs anzeigen oder bearbeiten; sie können die App nur aktivieren oder deaktivieren. Vorkonfigurierte Apps sind standardmäßig deaktiviert und müssen aktiviert werden, bevor Kontomitglieder sie verwenden können. 

Zu den vorkonfigurierten Apps gehört Revizto MCP Server, mit der Benutzer ihr Revizto-Konto mit einem KI-Tool ihrer Wahl verbinden können. Um eine Verbindung mit einem KI-Assistenten herzustellen, müssen Kontoeigentümer oder -administratoren zunächst die App „Revizto MCP Server“ im Entwicklerportal aktivieren. Weitere Informationen zur Einrichtung der Revizto MCP Server finden Sie unter KI-Tools mit Revizto MCP Server verbinden.

Benutzerdefinierte Apps

Benutzerdefinierte Apps hingegen werden von einem Kontoeigentümer oder Kontoadministrator zum Konto hinzugefügt. Die benutzerdefinierte App wird im Entwicklerportal eingerichtet, und der Kontoeigentümer oder die Kontoadministratoren verwalten die Komponenten, die erforderlich sind, um die Verbindung zwischen Revizto und der Drittanbieterintegration herzustellen. 

Die Einrichtung benutzerdefinierter Apps umfasst folgende Komponenten: Redirect-URIs, eine Client-ID, ein Client-Geheimnis und API-Benachrichtigungs-E-Mails.

Redirect-URIs

Eine Redirect-URI ist die Callback-Adresse, an die Revizto den Benutzer weiterleitet, nachdem die OAuth-Autorisierung genehmigt oder abgebrochen wurde. Die Adresse wird von der Drittanbieterintegration bereitgestellt und kann in der Dokumentation der Integration als Callback-URL bezeichnet werden.

Jede von der Drittanbieterintegration verwendete Redirect-URI muss im Entwicklerportal registriert werden. Beim Einrichten einer benutzerdefinierten App validiert Revizto Redirect-URIs anhand der folgenden Parameter:

  • Es ist mindestens eine Redirect-URI vorhanden. Mehrere Redirect-URIs werden ebenfalls unterstützt. 
  • Protokoll, Domäne und Pfad stimmen exakt überein. 
  • Die Groß-/Kleinschreibung stimmt überein. 
  • Produktive Redirect-URIs verwenden HTTPS (außer bei localhost).
  • Der Port muss bei Nicht-localhost-URIs übereinstimmen (für localhost wird der Port nicht validiert).
  • Ein abschließender Schrägstrich muss als Teil der URI exakt übereinstimmen.
  • Die URI enthält keine Wildcards.
  • Während der OAuth-Autorisierung muss die von der Drittanbieterintegration verwendete Redirect-URI exakt mit einer der im Entwicklerportal für die App registrierten Redirect-URIs übereinstimmen.
  • Es gibt keine doppelten Redirect-URIs innerhalb derselben benutzerdefinierten App. 

Zum Beispiel:

  • https://app.example.com/oauth/revizto/callback
  • https://integrations.company.com/revizto/oauth/callback
  • http://localhost:3000/oauth/revizto/callback

Wenn die Autorisierung aufgrund einer nicht übereinstimmenden Redirect-URI fehlschlägt, überprüfen Sie die Konfiguration der Drittanbieterintegration und die in der App im Entwicklerportal gespeicherten Redirect-URIs.

Client-ID und Client-Geheimnis

Wenn eine benutzerdefinierte App hinzugefügt wird, erstellt Revizto die Anmeldedaten Client-ID und Client-Geheimnis, die als Identitätsanmeldedaten für die Drittanbieterintegration dienen.

  • Client-ID: Im Entwicklerportal sichtbar und kopierbar. Die Drittanbieterintegration verwendet sie, um die OAuth-App zu identifizieren. 
  • Client-Geheimnis: Wird unmittelbar nach dem Hinzufügen einer App oder nach der Neuerzeugung des Client-Geheimnisses angezeigt. Nachdem der Anmeldedaten-Dialog geschlossen wurde, kann das Client-Geheimnis nicht erneut angezeigt oder kopiert werden. 

Nachdem Sie das Client-Geheimnis erhalten haben, speichern Sie es umgehend sicher in der Drittanbieterintegration oder im Geheimnis-Manager Ihres Unternehmens.

Wenn das Client-Geheimnis verloren geht, kann es gemäß den Schritten unter Client-Geheimnisse neu generieren neu generiert werden. Nach der Neugenerierung funktioniert das vorherige Client-Geheimnis sofort nicht mehr und Sie müssen die Drittanbieterintegration mit dem neuen Client-Geheimnis aktualisieren.

API-Benachrichtigungs-E-Mails

Die API-Benachrichtigungs-E-Mails in benutzerdefinierten Apps sind die technischen Kontakte für die App und Ihr Konto. Diese E-Mails können beim Hinzufügen oder beim Bearbeiten einer benutzerdefinierten App verwaltet werden. 

Revizto sendet wichtige API-bezogene Updates an diese E-Mail-Adressen, zum Beispiel:

  • API-Änderungen.
  • Abkündigungshinweise.
  • Hinweise zu Breaking Changes.
  • Updates zum Entwicklerportal und zu OAuth-Integrationen.

Verwenden Sie nach Möglichkeit ein freigegebenes Postfach, damit Ihre Organisation API-Updates unabhängig von Personalwechseln weiterhin erhält. 

Apps aktivieren und deaktivieren

Kontoeigentümer und Kontoadministratoren können sowohl vorkonfigurierte als auch benutzerdefinierte Apps aktivieren und deaktivieren. Der App-Status wird für das gesamte Konto übernommen. Standardbenutzer sehen unter App-Integrationen nur aktive Apps.

Wenn eine App deaktiviert wird, können Kontomitglieder die Drittanbieterintegration nicht mehr für den Zugriff auf Revizto verwenden; sämtlicher bestehender Zugriff und neue OAuth-Autorisierungsversuche werden blockiert. Wenn eine App reaktiviert wird, müssen Benutzer sie möglicherweise erneut autorisieren, indem sie sich mit ihrem Revizto-Benutzerkonto erneut anmelden.

So aktivieren oder deaktivieren Sie eine App:

  1. Navigieren Sie im Revizto Workspace zum Entwicklerportal.
  2. Suchen Sie die App, die Sie aktivieren oder deaktivieren möchten.

  3. Schalten Sie in der Spalte Aktiv der App den Schalter ein oder aus (Blau bedeutet aktiv).

  1. Klicken Sie im Bestätigungsdialog auf Aktivieren oder Deaktivieren, um zu bestätigen, dass Sie fortfahren möchten. 

    Sie können eine benutzerdefinierte App auch über den Schalter oben im Bearbeitungsbereich der App aktivieren oder deaktivieren und anschließend dieselben Bestätigungsschritte ausführen. 

Die Aktivierung oder Deaktivierung erfolgt sofort; Kontomitglieder müssen jedoch ggf. aktualisieren, um die Änderung zu sehen.

Benutzerdefinierte Apps hinzufügen

Eine benutzerdefinierte App ist eine OAuth-App, die zu einem Organisationskonto hinzugefügt wird. Benutzerdefinierte Apps können für Integrationen verwendet werden, die von Ihrer Organisation erstellt, von Ihrem Integrationsteam konfiguriert oder von einem Drittsystem eingerichtet werden, das OAuth-Anmeldedaten aus Ihrem Revizto-Konto benötigt.

So hinzufügen Sie eine benutzerdefinierte App hinzu:

Vor Sie eine benutzerdefinierte App hinzufügen, bestätigen Sie, dass Sie die Redirect-URIs der Drittanbieterintegration vorliegen haben, mit der Sie Revizto verbinden werden.

  1. Navigieren Sie im Revizto Workspace zum Entwicklerportal.

  2. Klicken Sie auf + Benutzerdefinierte App hinzufügen. 

  1. Geben Sie im Feld App-Name den Namen der App ein.
  2. Geben Sie im Feld Redirect-URIs eine oder mehrere Redirect-URIs ein. Jede URI muss die oben unter Redirect-URIs beschriebenen Parameter erfüllen. 
  3. Geben Sie im Feld Beschreibung bei Bedarf eine Beschreibung der App ein.
  4. Geben Sie im Feld Kontakte für API-Benachrichtigungen die E-Mail-Adressen der Benutzer ein, die API-bezogene Mitteilungen von Revizto erhalten sollen, einschließlich Änderungen, die sich auf Ihre Integrationen auswirken.

  5. Klicken Sie auf Hinzufügen unten im Bereich Benutzerdefinierte App hinzufügen.

  1. Kopieren Sie im Fenster Anmeldedaten der App die Client-ID und das Client-Geheimnis. Nachdem Sie das Fenster geschlossen haben, können Sie das Client-Geheimnis nicht erneut aufrufen. Speichern Sie diese Information daher an einem sicheren Ort. 

  2. Klicken Sie auf OK. 

  1. Hinzufügen Sie die neu erstellte Client-ID und das Client-Geheimnis der Drittanbieterintegration hinzu, um die Verbindung abzuschließen.

Nachdem Sie die benutzerdefinierte App gespeichert haben, wird sie automatisch aktiviert und unter Benutzerdefinierte Apps gespeichert. 

Benutzerdefinierte Apps bearbeiten

Kontoeigentümer und Kontoadministratoren können in benutzerdefinierten Apps den Namen, die Beschreibung, die Redirect-URIs und die API-Benachrichtigungs-E-Mails bearbeiten. Beide aktive als auch inaktive benutzerdefinierte Apps können bearbeitet werden. Wenn Sie ein neues Client-Geheimnis benötigen, siehe Client-Geheimnisse neu generieren.

So bearbeiten Sie eine benutzerdefinierte App:

  1. Navigieren Sie im Revizto Workspace zum Entwicklerportal.
  2. Klicken Sie auf die benutzerdefinierte App, die Sie bearbeiten möchten.

  3. Bearbeiten Sie im Bearbeitungsbereich der App die Felder, die Sie ändern möchten.

    Wenn Sie eine Redirect-URI ändern, müssen Sie auch die Konfiguration der Drittanbieterintegration aktualisieren, sonst schlagen OAuth-Autorisierungsversuche mit der ursprünglichen URI fehl.

  1. Klicken Sie unten im Bearbeitungsbereich der App auf Aktualisieren.

Benutzerdefinierte Apps löschen

Kontoeigentümer und Kontoadministratoren können benutzerdefinierte Apps löschen. Nur inaktive Apps können gelöscht werden. Durch das Löschen einer App wird sie dauerhaft aus den im Konto verfügbaren App-Integrationen entfernt.

So löschen Sie eine benutzerdefinierte App:

  1. Navigieren Sie im Revizto Workspace zum Entwicklerportal.
  2. Deaktivieren Sie die benutzerdefinierte App, die Sie löschen möchten.
  3. Klicken Sie in der Spalte Aktionen der App auf Löschen .
  4. Geben Sie im Fenster App löschen den App-Namen exakt so in das Bestätigungsfeld ein, wie er im Fenster angezeigt wird.

  5. Klicken Sie auf Löschen.

    Sie können eine inaktive benutzerdefinierte App auch löschen, indem Sie oben im Bearbeitungsbereich der App auf Löschen klicken und anschließend dieselben Bestätigungsschritte ausführen. 

Die App wird sofort gelöscht und sämtlicher bestehender Zugriff widerrufen. Wenn Sie dieselbe Drittanbieterintegration künftig erneut hinzufügen möchten, müssen Sie eine neue benutzerdefinierte App hinzufügen.

Client-Geheimnisse neu generieren

Wenn das Client-Geheimnis einer benutzerdefinierten App verloren gegangen, offengelegt wurde oder geändert werden muss, kann es neu generiert werden. Wenn ein Client-Geheimnis neu generiert wird:

  • Das vorherige Client-Geheimnis funktioniert sofort nicht mehr.
  • Das neue Client-Geheimnis wird nur einmal angezeigt.
  • Die Drittanbieterintegration muss mit dem neuen Client-Geheimnis aktualisiert werden, um weiterhin zu funktionieren.

So generieren Sie ein Client-Geheimnis neu:

  1. Navigieren Sie im Revizto Workspace zum Entwicklerportal.
  2. Suchen Sie die benutzerdefinierte App mit dem Client-Geheimnis, das Sie neu generieren möchten.
  3. Klicken Sie in der Spalte Aktionen der App auf Anmeldedaten anzeigen .

  4. Im Fenster Anmeldedaten der App klicken Sie auf Geheimnis neu generieren neben Client-Geheimnis.

  1. Klicken Sie im Bestätigungsfenster erneut auf Geheimnis neu generieren, um zu bestätigen, dass Sie fortfahren möchten. 
  2. Kopieren Sie im Fenster Anmeldedaten der App das neue Client-Geheimnis. Nachdem Sie das Fenster geschlossen haben, können Sie das Client-Geheimnis nicht erneut aufrufen. Speichern Sie diese Information daher an einem sicheren Ort. 

  3. Klicken Sie auf OK.

  1. Hinzufügen Sie das neu erstellte Client-Geheimnis der Drittanbieterintegration hinzu, um die Verbindung wiederherzustellen.

Fehlerbehebung

F: Ich kann keine benutzerdefinierte App hinzufügen.

A: Nur Kontoeigentümer und Kontoadministratoren können benutzerdefinierte Apps hinzufügen. Bitten Sie den Kontoeigentümer oder den Kontoadministrator, Ihre Kontorolle zu aktualisieren oder die App für Sie hinzuzufügen.


 

F: Ich habe das Client-Geheimnis für eine benutzerdefinierte App verloren.

A: Das Client-Geheimnis kann gemäß den Schritten unter Client-Geheimnisse neu generieren neu generiert werden. Sobald es neu generiert wurde, kopieren und speichern Sie das neue Client-Geheimnis umgehend an einem sicheren Ort und aktualisieren Sie die Drittanbieterintegration.


 

F: Kontomitglieder können ihr Revizto-Konto in der Drittanbieterintegration nicht autorisieren.

A: Überprüfen Sie Folgendes:

  • Der Status der betreffenden App ist Aktiv.
  • Die Drittanbieterintegration verwendet die korrekte Client-ID.
  • Die Drittanbieterintegration verwendet das aktuelle Client-Geheimnis.
  • Die Redirect-URI in der Drittanbieterintegration stimmt exakt mit einer in den App-Informationen aufgeführten Redirect-URI überein.
  • Der Benutzer hat Zugriff auf das Revizto-Konto.


 

F: Kontomitglieder konnten zuvor eine Verbindung zu einer App herstellen, jetzt jedoch nicht mehr.

A: Überprüfen Sie Folgendes:

  • Der Status der App ist weiterhin Aktiv.
  • Die App wurde nicht gelöscht.
  • Das Client-Geheimnis wurde nicht neu generiert, ohne die Drittanbieterintegration zu aktualisieren.


 

F: Ich sehe die App „Revizto MCP Server“ nicht in meinen verfügbaren Apps. 

A: Die App „Revizto MCP Server“ ist eine vorkonfigurierte App und muss für das Konto aktiviert werden. Bitten Sie den Kontoeigentümer oder den Administrator zu bestätigen, dass die App „Revizto MCP Server“ im Entwicklerportal aktiv ist.

Verwandte Beiträge