App-Registrierung konfigurieren

Sie sehen die Dokumentation zu Apigee Edge.
Zur Apigee X-Dokumentation weitere Informationen

Entwickler nutzen die Seite „Meine Apps“ im Portal für Entwicklerdienste, um Apps zu registrieren. Entwickler greifen über das Hauptmenü des Portals auf die Seite „Meine Apps“ zu:

Um eine neue App zu registrieren, klickt der Entwickler auf der Seite „Meine Apps“ auf die Schaltfläche „Neue App hinzufügen“.

Das Portal zeigt dann das standardmäßige Registrierungsformular für Apps an:

Standardmäßig muss der Entwickler nur den App-Namen, die Callback-URL und die Liste der API-Produkte angeben, die der App hinzugefügt werden sollen.

Als API-Anbieter haben Sie die vollständige Kontrolle über den App-Registrierungsprozess. Sie können beispielsweise Folgendes konfigurieren:

  • Die Liste der im Portal verfügbaren API-Produkte
  • Ob es ein Standard-API-Produkt gibt
  • Ob die Callback-URL erforderlich ist
  • Ob der API-Schlüssel manuell oder automatisch für ein API-Produkt genehmigt wird
  • Ob auf der Seite „App hinzufügen“ weitere Informationen erforderlich sind, um die App zu registrieren

In diesem Thema wird beschrieben, wie Sie den App-Registrierungsprozess für Ihr Portal konfigurieren. In diesem Thema wird jedoch nicht beschrieben, wie API-Produkte erstellt werden. Weitere Informationen:

Sie können das Portal so konfigurieren, dass Entwickler keine Anwendungen basierend auf der dem Entwickler zugewiesenen Rolle erstellen, löschen oder bearbeiten können. Sie können das Portal beispielsweise so konfigurieren, dass bei der Registrierung des Entwicklers eine einzelne Standard-App für alle Entwickler erstellt wird. Dann erlaubst du nur einigen Entwicklern, neue Apps hinzuzufügen, möglicherweise auf der Grundlage einer Gebührenstruktur oder anderer Merkmale des Entwicklers. Mit Rollen und Berechtigungen können Sie festlegen, welche Entwickler Anwendungen erstellen, löschen und bearbeiten können. Weitere Informationen finden Sie unter Nutzerkonten hinzufügen und verwalten.

Im Portal verfügbare API-Produkte angeben

Es gibt zwei Möglichkeiten, die API-Produkte anzugeben, die verfügbar sind, wenn ein Entwickler auf das Portal zugreift:

Zugriffsebene beim Erstellen eines API-Produkts angeben

Wenn Sie ein API-Produkt erstellen, geben Sie die Option für die Zugriffsebene des Produkts an, wie unten dargestellt:

Weitere Informationen dazu, wie sich die Zugriffsebene auf die Verfügbarkeit des API-Produkts im Drupal 7-Entwicklerportal auswirkt, finden Sie unter Zugriffsebene.

Zugriff auf ein API-Produkt anhand von Rollen einschränken

Durch Aktivieren des Drupal-Moduls für den API-Produktrollenzugriff können Sie die Rollen angeben, die auf die einzelnen API-Produkte zugreifen können.

So schränken Sie den Zugriff auf ein API-Produkt basierend auf den Entwicklerrollen ein:

  1. Melden Sie sich in Ihrem Portal als Nutzer mit Administrator- oder Berechtigungen zum Erstellen von Inhalten an.
  2. Prüfen Sie die Rollen und Nutzerzuweisungen des Entwicklungsportals:
    • Wählen Sie im Drupal-Verwaltungsmenü Personen > Berechtigungen > Rollen aus und fügen Sie die Entwicklerrollen und Berechtigungen nach Bedarf hinzu oder bearbeiten Sie sie.
    • Wählen Sie im Drupal-Verwaltungsmenü Personen aus und bearbeiten Sie Nutzer- und Rollenzuweisungen nach Bedarf.
  3. Wählen Sie im Drupal-Verwaltungsmenü Konfiguration > Dev Portal > API-Produktrollenzugriff aus.
  4. Wählen Sie die Rollen aus, die Zugriff auf die einzelnen API-Produkte haben sollen.
  5. Klicken Sie auf Save configuration (Konfiguration speichern).

Konfigurieren, wie ein Entwickler API-Produkte mit einer App verknüpft

Um eine neue App zu registrieren, klickt ein Entwickler auf der Seite „Meine Apps“ auf die Schaltfläche „Neue App hinzufügen“, um das Formular „App hinzufügen“ zu öffnen:

Je nachdem, wie Sie das Portal konfigurieren, kann der Entwickler ein oder mehrere API-Produkte auswählen, die bei der App-Registrierung mit der App verknüpft werden sollen. Alternativ können Sie ein Standardprodukt angeben, das allen Apps zugewiesen wird.

Die folgenden Konfigurationsoptionen stehen auf dem Portal zur Verfügung, um die Auswahl der API-Produkte bei der Registrierung einer App zu steuern:

  • Verknüpfen Sie Apps nicht mit einem API-Produkt.
  • Verknüpfen Sie alle Apps mit einem oder mehreren Standard-API-Produkten (unten konfiguriert). Entwickler können der App keine anderen API-Produkte hinzufügen.
  • Auswahl eines einzelnen API-Produkts zulassen, aber nicht erforderlich.
  • Die Auswahl eines einzelnen API-Produkts ist erforderlich.
  • Auswahl mehrerer API-Produkte zulassen, aber keine erforderlich
  • Auswahl mehrerer API-Produkte zulassen (mindestens eines erforderlich)

Sie können auch das HTML-Element steuern, das auf dem Formular angezeigt wird, über das der Entwickler das API-Produkt auswählt. Zu den Optionen gehören:

  • Drop-down-Listen.
  • Kästchen oder Optionsfelder Es werden Kästchen angezeigt, wenn der Entwickler mehrere API-Produkte auswählen kann. Optionsfelder werden angezeigt, wenn der Entwickler nur ein API-Produkt auswählen kann.

So legen Sie die Option für die API-Produktauswahl fest:

  1. Melden Sie sich in Ihrem Portal als Nutzer mit Administrator- oder Berechtigungen zum Erstellen von Inhalten an.
  2. Wählen Sie im Drupal-Verwaltungsmenü Konfiguration > Entwicklerportaleinstellungen > Anwendungseinstellungen aus.
  3. Maximieren Sie auf der Seite „Anwendungseinstellungen“ den Bereich API-Produkteinstellungen.
  4. Wähle unter API-Produktbehandlung die Option für die API-Produktauswahl aus.
  5. Wenn Sie die Option „Alle Apps mit einem oder mehreren API-Standardprodukten verknüpfen (unten konfiguriert) verknüpfen“ angeben, legen Sie unter Standard-API-Produkt ein Standardprodukt fest.
  6. Wählen Sie unter API-Produkt-Widget das HTML-Element aus, mit dem Entwickler die API-Produkte auswählen.
  7. Speichern Sie die Konfiguration.

Verarbeitung von Callback-URLs konfigurieren

Wenn ein API-Proxy in Ihrem API-Produkt dreibeiniges OAuth (Autorisierungscode-Erteilungstyp) verwendet, müssen Entwickler bei der Registrierung ihrer Apps eine Callback-URL angeben. Die Callback-URL gibt normalerweise die URL einer Anwendung an, die dafür vorgesehen ist, einen Autorisierungscode im Namen der Clientanwendung zu empfangen. Außerdem wird dieser URL-String zur Validierung verwendet. Der Client muss diese URL an Apigee Edge senden, wenn er Autorisierungscodes und Zugriffstokens anfordert, und der Parameter „redirect_uri“ muss mit dem Parameter übereinstimmen, der registriert ist. Weitere Informationen finden Sie unter Berechtigungstyp „Autorisierungscode“ implementieren.

So legen Sie die Callback-URL für die API-Produktauswahl fest:

  1. Melden Sie sich in Ihrem Portal als Nutzer mit Administrator- oder Berechtigungen zum Erstellen von Inhalten an.
  2. Wählen Sie im Drupal-Verwaltungsmenü Configuration > Dev Portal Settings > Application Attributes (Konfiguration > Entwicklerportaleinstellungen > Anwendungsattribute) aus.
  3. Maximieren Sie auf der Seite „Anwendungseinstellungen“ den Bereich Callback-URL-Einstellungen.
  4. Wählen Sie unter Umgang mit Callback-URLs eine der folgenden Optionen aus.
    • Eine Rückruf-URL ist für alle Entwickler-Apps erforderlich.
    • Die Callback-URL ist für alle Entwickler-Apps optional.
    • Die Callback-URL ist weder erforderlich noch wird sie angezeigt.
  5. Speichern Sie die Konfiguration.

Analysen zur App-Nutzung anzeigen

Das Portal kann Analyseinformationen zur App-Nutzung anzeigen. Wenn die Anzeige von Analysedaten aktiviert ist, können App-Entwickler die Analysedaten für jede App auf der Seite "Meine Apps" sehen. Beispielsweise kann ein Entwickler die folgenden Analysedaten für eine App anzeigen:

  • Durchsatz
  • Maximale Antwortzeit
  • Minimale Antwortzeit
  • Anzahl der Nachrichten
  • Fehleranzahl

So aktivieren Sie Analysen im Portal:

  1. Melden Sie sich in Ihrem Portal als Nutzer mit Administrator- oder Berechtigungen zum Erstellen von Inhalten an.
  2. Wählen Sie im Drupal-Verwaltungsmenü Configuration > Dev Portal > Application Settings aus.
  3. Maximieren Sie auf der Seite „Anwendungseinstellungen“ den Bereich Einstellungen für die App-Leistung.
  4. Klicken Sie das Kästchen Tab „Entwickler-App-Analysen“ anzeigen an.
  5. Wählen Sie für Umgebung zur Abfrage von Analysedaten entweder Test oder Produktion aus. Bei einem öffentlich verfügbaren Portal wählen Sie in der Regel Produktion aus.
  6. Speichern Sie die Konfiguration.

So zeigen Sie Analysen für eine App im Portal an:

  1. Wählen Sie auf der Seite „Meine Apps“ den Namen der App aus.
  2. Wählen Sie den Link Analytics für die App aus.
  3. Wählen Sie den anzuzeigenden Analysetyp und den Zeitraum aus:
  4. Die ausgewählten Informationen werden angezeigt:

API-Schlüssel für ein API-Produkt manuell genehmigen oder widerrufen

Wenn ein Entwickler ein API-Produkt zu einer App hinzufügt und die App dann registriert, gibt das Portal dem Entwickler den API-Schlüssel für diese App zurück. Der Entwickler verwendet diesen API-Schlüssel dann, um auf die API-Proxys zuzugreifen, die vom mit der App verknüpften API-Produkt gebündelt sind.

Sie steuern den Schlüsselgenehmigungsprozess für jedes API-Produkt, wenn Sie das API-Produkt erstellen:

Der Genehmigungsprozess kann folgendermaßen aussehen:

  • Automatisch: Ein genehmigter API-Schlüssel wird vom Portal für das API-Produkt zurückgegeben, wenn der Entwickler die App registriert. Sie können einen automatisch genehmigten Schlüssel später widerrufen.
  • Manuell: Vom Portal wird ein API-Schlüssel zurückgegeben, wenn der Entwickler die App registriert. Für API-Produkte, die die manuelle Schlüsselgenehmigung verwenden, wird der Schlüssel jedoch nicht aktiviert. Ein Administrator muss den API-Schlüssel manuell in der Edge-Management-Benutzeroberfläche oder der API genehmigen, bevor er vom Entwickler für den Zugriff auf das API-Produkt verwendet werden kann. Sie können einen manuell genehmigten Schlüssel später widerrufen.

Weitere Informationen finden Sie unter API-Produkte erstellen.

Wenn ein Entwickler in Ihrem Portal mehrere API-Produkte zu einer App hinzufügen kann, fügt er möglicherweise einige Produkte mit automatischer Schlüsselgenehmigung und andere mit manueller Schlüsselgenehmigung hinzu. Der Entwickler kann den zurückgegebenen API-Schlüssel sofort für alle automatisch genehmigten API-Produkte verwenden, während er auf die endgültige Genehmigung für die Produkte wartet, die eine manuelle Genehmigung erfordern.

Um die Liste der API-Produkte für eine App und den Status der Schlüsselgenehmigung für das API-Produkt zu sehen, wählt ein Entwickler den Namen der App auf der Seite „Meine Apps“ und dann den Link „Produkte“ aus:

In diesem Beispiel verwendet das Premium Weather API-Produkt die manuelle Genehmigung und wartet darauf, dass ein Administrator den Schlüssel genehmigt. Für das kostenlose API-Produkt wird die automatische Genehmigung verwendet und die Verwendung des Schlüssels für den Zugriff wurde genehmigt.

So genehmigen oder widerrufen Sie einen Schlüssel manuell:

  1. Melden Sie sich bei der Edge-Management-UI als Nutzer mit Administratorberechtigungen für Ihre Organisation an.
  2. Wählen Sie im Drop-down-Menü oben rechts API-Plattform aus.
  3. Wählen Sie Veröffentlichen > Entwickler-Apps aus, um die Liste der Entwickler-Apps zu öffnen.
  4. Wählen Sie die Schaltfläche Ausstehend aus, um die Liste der Apps mit ausstehenden Schlüsselanfragen aufzurufen:

  5. Wählen Sie den Namen der App aus, die Sie genehmigen möchten.
  6. Wählen Sie auf der Seite mit den App-Details rechts oben die Schaltfläche Edit (Bearbeiten) aus.
  7. Gehen Sie in der Liste der API-Produkte für die App unter Aktionen so vor:
    • Wählen Sie zum Genehmigen des Schlüssels für jedes API-Produkt, das eine manuelle Genehmigung erfordert, die Schaltfläche Genehmigen aus.

    • Wenn Sie einen genehmigten Schlüssel widerrufen möchten, wählen Sie unter Aktionen für ein API-Produkt zum Widerrufen des Zugriffs die Schaltfläche Widerrufen aus.

  8. Speichern Sie die App. Der API-Schlüssel ist jetzt genehmigt.

Caching von API-Produkten und Anwendungen steuern

Informationen zu API-Produkten und Entwickler-Apps werden remote vom Portal in Apigee Edge gespeichert. Das bedeutet, dass Änderungen an API-Produkten und -Anwendungen über die Edge-Benutzeroberfläche oder API ausgeführt werden können, ohne das Portal zu durchlaufen. Wenn beispielsweise ein Back-End-Administrator ein neues API-Produkt hinzufügt, wird das Portal nicht sofort mit diesen Informationen aktualisiert.

Damit das Portal synchron mit dem Edge-Back-End bleibt, können Sie manuell eine Aktualisierung des Portal-Caches auslösen, die Caches automatisch aktualisieren, wenn der Cronjob des Portals ausgeführt wird, oder beides. Wenn Sie den Cronjob beispielsweise so konfigurieren, dass er häufig ausgeführt wird, z. B. alle 5 oder 10 Minuten, möchten Sie möglicherweise nicht so häufig die API-Produkte und die Caches der Entwickleranwendung aktualisieren. In diesem Fall können Sie die Cache-Aktualisierung dann manuell auslösen. Wenn der Cronjob jedoch alle oder zwei Stunden ausgeführt wird, hat die für die Aktualisierung der Caches erforderliche Zeit möglicherweise keine großen Auswirkungen.

Standardmäßig ist das Portal so konfiguriert, dass das API-Produkt und die Entwickler-App bei jeder Ausführung von Cron neu erstellt werden.

So geben Sie an, ob das API-Produkt und die Entwickler-App bei jeder Ausführung von Cron neu erstellt werden sollen:

  1. Melden Sie sich in Ihrem Portal als Nutzer mit Administrator- oder Berechtigungen zum Erstellen von Inhalten an.
  2. Wählen Sie im Drupal-Menü Configuration > Dev Portal Settings > Application Settings (Konfiguration > Dev-Portal-Einstellungen > Anwendungseinstellungen) aus.
  3. Klicken Sie das Kästchen Caches von API-Produkten und Entwickler-Apps bei jeder Ausführung von Cron neu erstellen an oder entfernen Sie das Häkchen.
  4. Speichern Sie Ihre Einstellungen.

So aktualisieren Sie die Caches manuell:

  1. Melden Sie sich in Ihrem Portal als Nutzer mit Administrator- oder Berechtigungen zum Erstellen von Inhalten an.
  2. Wählen Sie im Drupal-Menü das Symbol für die Startseite > Alle Caches leeren aus.

Formularfelder für die Registrierung einer Anwendung anpassen

Wenn der Entwickler eine App registriert, wird im Portal das Standardformular angezeigt:

Als API-Anbieter können Sie dieses Formular ändern, um den Entwickler aufzufordern, zusätzliche Informationen wie eine Kundennummer, die Zielplattform der App oder andere Informationen anzugeben. Das Portal bietet Ihnen die Möglichkeit, diesem Formular neue Felder hinzuzufügen. Folgende Felder sind möglich:

  • Erforderlich oder optional
  • Werden durch verschiedene HTML-Elemente wie Textfelder, Optionsfelder oder Kontrollkästchen angezeigt
  • Kann so festgelegt werden, dass es an einer beliebigen Stelle im Formular zwischen dem Feld „Callback-URL“ und dem Feld „Produkt“ erscheint

In diesem Video erfahren Sie, wie Sie das App-Registrierungsformular, das im Entwicklerportal verfügbar ist, anpassen können.

Im folgenden Formular sehen Sie beispielsweise ein Pflichtfeld für die Kundennummer und ein optionales Feld für die Zielplattform:

Wenn Sie dem Formular neue Felder hinzufügen, werden die Feldwerte automatisch zusammen mit allen anderen Feldern in Edge hochgeladen, wenn der Entwickler das Formular einreicht. Das bedeutet, dass Sie diese Felder in Edge anzeigen oder ändern oder die Edge-Verwaltungs-API verwenden können, um über ein Skript auf diese Felder zuzugreifen.

Rufen Sie beispielsweise die neuen Formularfelder in der Edge-Verwaltungs-UI auf. Klicken Sie dazu auf „Veröffentlichen“ > „Entwickler-Apps“ und wählen Sie dann den App-Namen aus. Die neuen Feldwerte werden im Bereich „Benutzerdefinierte Attribute“ der Seite mit einem Namen angezeigt, der dem internen Namen des Felds entspricht:

Die Feldwerte werden auch im Detailbereich der App auf der Seite „Meine Apps“ des Entwicklers angezeigt:

Der Entwickler kann die Werte auch bearbeiten, indem er auf der Seite „Meine Apps“ auf den Link „Bearbeiten“ für die App klickt.

In den folgenden Verfahren wird beschrieben, wie Sie die Formulare zur Anwendungserstellung über die Administratoroberfläche konfigurieren. Ein Drupal-Entwickler kann mithilfe von benutzerdefinierten Hooks zusätzliche Anpassungen vornehmen, einschließlich der Änderung der Seite „Meine Apps“. Weitere Informationen zum Ändern des Verhaltens über Code finden Sie in den Anwendungs-API-Beispielen in der Datei: /profiles/apigee/modules/custom/devconnect/devconnect_developer_apps/devconnect_developer_apps.api.php.

So fügen Sie dem App-Registrierungsformular ein Feld hinzu:

  1. Melden Sie sich in Ihrem Portal als Nutzer mit Administrator- oder Berechtigungen zum Erstellen von Inhalten an.
  2. Achten Sie darauf, dass das Modul DevConnect App Attribute Management aktiviert ist.
  3. Wählen Sie im Drupal-Verwaltungsmenü Configuration > Dev Portal Settings > Dev Portal App Attributes (Konfiguration > Entwicklungsportal-Einstellungen > Dev-Portal-App-Attribute) aus.
  4. Wählen Sie oben auf der Seite die Schaltfläche Add Dev Portal App Attribute (Entwicklerportal-App-Attribut hinzufügen) aus.
  5. Konfigurieren Sie das Feld. Verwenden Sie beispielsweise für das oben gezeigte Feld „Kundennummer“ die folgenden Einstellungen:
    • Interner Name: cust_id Dies ist der Name der Variablen, die zum Speichern des Feldwerts verwendet wird.
    • Öffentlicher Name = Kundennummer
    • Description (Beschreibung): Geben Sie Ihre Kundennummer ein.
    • Aktivieren Sie das Kontrollkästchen für dieses Attribut erforderlich .
    • Aktivieren Sie das Kontrollkästchen Dieses Attribut anzeigen.
    • Widget = Textfeld
    • Wählen Sie „Speichern“ aus, um zur Seite „App-Attribute“ des Entwicklerportals zurückzukehren.
  6. Wählen Sie Save Changes (Änderungen speichern) aus.
  7. Wählen Sie im Drupal-Menü das Symbol für die Startseite > Alle Caches leeren aus.
    Unter Umständen müssen Sie den Cache Ihres Browsers leeren, bevor das neue Feld im Formular angezeigt wird.

Wenn du ein optionales Feld für den Entwickler hinzufügen möchtest, um die Plattform für die App anzugeben, lege die Feldattribute so fest:

  • Interner Name = vorgesehen_platforms
  • Öffentlicher Name = Plattformen
  • Beschreibung: Geben Sie mindestens eine Plattform für die App an.
  • Entfernen Sie die Häkchen aus den Kästchen neben „Dieses Attribut verlangen“.
  • Klicken Sie das Kästchen für Dieses Attribut anzeigen an.
  • Widget = Liste der Kästchen
  • Wählen Sie „Speichern“ aus, um zur Seite „App-Attribute“ des Entwicklerportals zurückzukehren.

So ordnen Sie die Attribute im Formular neu an:

  1. Melden Sie sich in Ihrem Portal als Nutzer mit Administrator- oder Berechtigungen zum Erstellen von Inhalten an.
  2. Wählen Sie im Drupal-Verwaltungsmenü Configuration > Dev Portal Settings > Dev Portal App Attributes (Konfiguration > Entwicklungsportal-Einstellungen > Dev-Portal-App-Attribute) aus.
  3. Wählen Sie das Pluszeichen + unter der Spalte „Name“ aus und ziehen Sie die Eigenschaft an die Stelle, an der sie im Formular angezeigt werden soll.
  4. Speichern Sie die Änderungen.