Sie sehen sich die Dokumentation zu Apigee Edge an.
Sehen Sie sich die Apigee X-Dokumentation an. info
Um eine neue App zu registrieren, wählt der Entwickler auf der Seite „Meine Apps“ die Schaltfläche „Neue App hinzufügen“ aus.
Im Portal wird dann das Standardformular für die App-Registrierung angezeigt:
Standardmäßig muss der Entwickler nur den Namen der App, 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 zur Registrierung der App erforderlich sind
In diesem Thema wird beschrieben, wie Sie den App-Registrierungsprozess für Ihr Portal konfigurieren. In diesem Thema wird jedoch nicht beschrieben, wie Sie API-Produkte erstellen. Weitere Informationen finden Sie unter:
Sie können das Portal so konfigurieren, dass Entwickler je nach Rolle, die ihnen zugewiesen ist, keine Apps erstellen, löschen oder bearbeiten können. Sie können das Portal beispielsweise so konfigurieren, dass beim Registrieren eines Entwicklers eine einzelne Standard-App für alle Entwickler erstellt wird. Dann können nur einige Entwickler neue Apps hinzufügen, möglicherweise basierend auf einer Gebührenstruktur oder anderen Merkmalen des Entwicklers. Mithilfe von Rollen und Berechtigungen können Sie festlegen, welche Entwickler Apps erstellen, löschen und bearbeiten dürfen. Weitere Informationen finden Sie unter Nutzerkonten hinzufügen und verwalten.
API-Produkte angeben, die im Portal verfügbar sind
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
- Zugriff auf ein API-Produkt basierend auf Rollen einschränken
Zugriffsebene beim Erstellen eines API-Produkts angeben
Wenn Sie ein API-Produkt erstellen, geben Sie 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 basierend auf Rollen einschränken
Wenn Sie das Drupal-Modul „API Product Role Access“ aktivieren, können Sie die Rollen angeben, die auf jedes API-Produkt zugreifen können.
So schränken Sie den Zugriff auf ein API-Produkt basierend auf den Entwicklerrollen ein:
- Melden Sie sich als Nutzer mit Administrator- oder Berechtigungen zum Erstellen von Inhalten in Ihrem Portal an.
- Überprüfen Sie die Rollen und Nutzerzuweisungen im Dev-Portal:
- 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 nach Bedarf die Nutzer- und Rollenzuweisungen.
- Wählen Sie im Drupal-Verwaltungsmenü Konfiguration > Dev-Portal > Zugriffsrechte für API-Produktrollen aus.
- Wählen Sie die Rollen aus, die auf die einzelnen API-Produkte zugreifen sollen.
- Klicken Sie auf Save configuration (Konfiguration speichern).
Konfigurieren, wie Entwickler API-Produkte mit einer App verknüpfen
Wenn ein Entwickler eine neue App registrieren möchte, wählt er auf der Seite „Meine Apps“ die Schaltfläche „Neue App hinzufügen“ aus, um das Formular „App hinzufügen“ zu öffnen:
Je nachdem, wie Sie das Portal konfigurieren, kann der Entwickler bei der Registrierung der App ein oder mehrere API-Produkte auswählen, die mit der App verknüpft werden sollen. Alternativ können Sie ein Standardprodukt angeben, das allen Apps zugewiesen wird.
Im Portal sind die folgenden Konfigurationsoptionen verfügbar, um die Auswahl von API-Produkten bei der Registrierung einer App zu steuern:
- Verknüpfen Sie keine Apps mit einem API-Produkt.
- Verknüpfen Sie alle Apps mit einem oder mehreren Standard-API-Produkten (unten konfiguriert). Entwickler können der App keine weiteren API-Produkte hinzufügen.
- Die Auswahl eines einzelnen API-Produkts zulassen, aber nicht zwingend vorschreiben.
- Es muss ein einzelnes API-Produkt ausgewählt werden.
- Mehrere API-Produkte auswählen lassen, aber keine voraussetzen.
- Mehrere API-Produkte auswählen lassen und mindestens eines voraussetzen.
Sie können auch das HTML-Element steuern, das im Formular angezeigt wird, über das der Entwickler das API-Produkt auswählt. Zu den Optionen gehören:
- Drop-down-Listen
- Kästchen oder Optionsfelder Kästchen werden angezeigt, wenn der Entwickler mehrere API-Produkte auswählen kann. Optionsfelder werden angezeigt, wenn der Entwickler nur ein einzelnes API-Produkt auswählen kann.
So legen Sie die Option für die API-Produktauswahl fest:
- Melden Sie sich als Nutzer mit Administrator- oder Berechtigungen zum Erstellen von Inhalten in Ihrem Portal an.
- Wählen Sie im Drupal-Verwaltungsmenü Konfiguration > Einstellungen für das Dev-Portal > Anwendungseinstellungen aus.
- Maximieren Sie auf der Seite „Anwendungseinstellungen“ den Bereich API-Produkteinstellungen.
- Wählen Sie unter API-Produktverwaltung die Option aus, mit der die Auswahl des API-Produkts gesteuert wird.
- Wenn Sie die Option „Alle Apps mit einem oder mehreren Standard-API-Produkten verknüpfen (unten konfigurieren)“ auswählen, legen Sie unter Standard-API-Produkt ein Standardprodukt fest.
- Wählen Sie unter API-Produkt-Widget das HTML-Element aus, mit dem Entwickler die API-Produkte auswählen.
- Speichern Sie die Konfiguration.
Callback-URL-Verarbeitung konfigurieren
Wenn ein API-Proxy in Ihrem API-Produkt „Dreibeiniges OAuth“ (Grant-Typ des Autorisierungscodes) verwendet, müssen Entwickler bei der Registrierung ihrer Apps eine Callback-URL angeben. Die Callback-URL gibt normalerweise die URL einer Anwendung an, die einen Autorisierungscode im Namen der Clientanwendung erhalten soll. Außerdem wird dieser URL-String zur Validierung verwendet. Der Client muss diese URL an Apigee Edge senden, wenn Autorisierungscodes und Zugriffstokens angefordert werden. Der Parameter „redirect_uri“ muss mit dem registrierten Parameter übereinstimmen. Weitere Informationen finden Sie unter Grant-Typ „Autorisierungscode“ implementieren.
So steuern Sie die Callback-URL für die API-Produktauswahl:
- Melden Sie sich als Nutzer mit Administrator- oder Berechtigungen zum Erstellen von Inhalten in Ihrem Portal an.
- Wählen Sie im Drupal-Verwaltungsmenü Konfiguration > Dev-Portal-Einstellungen > Anwendungsattribute aus.
- Maximieren Sie auf der Seite „Anwendungseinstellungen“ den Bereich Einstellungen für Callback-URLs.
- Wählen Sie unter Callback-URL-Verarbeitung eine der folgenden Optionen aus.
- Eine Callback-URL ist für alle Entwickler-Apps erforderlich.
- Die Callback-URL ist für alle Entwickler-Apps optional.
- Eine Callback-URL ist weder erforderlich noch wird sie angezeigt.
- Speichern Sie die Konfiguration.
Analysen zur App-Nutzung anzeigen
Im Portal können Sie Analysen zur App-Nutzung aufrufen. Wenn die Anzeige von Analysen aktiviert ist, können App-Entwickler die Analysen für jede App auf der Seite „Meine Apps“ sehen. So können Entwickler beispielsweise die folgenden Analysen für eine App anzeigen:
- Durchsatz
- Maximale Antwortzeit
- Mindestantwortzeit
- Anzahl der Nachrichten
- Fehleranzahl
So aktivieren Sie Analysen im Portal:
- Melden Sie sich als Nutzer mit Administrator- oder Berechtigungen zum Erstellen von Inhalten in Ihrem Portal an.
- Wählen Sie im Drupal-Verwaltungsmenü Konfiguration > Dev-Portal > Anwendungseinstellungen aus.
- Maximieren Sie auf der Seite „Anwendungseinstellungen“ den Bereich Einstellungen für die App-Leistung.
- Aktivieren Sie das Kästchen Tab „Analytics für Entwickler-Apps“ anzeigen.
- Wählen Sie unter Umgebung, in der nach Analysedaten gesucht werden soll entweder Test oder Produktion aus. Für ein öffentlich zugängliches Portal wählen Sie in der Regel Produktion aus.
- Speichern Sie die Konfiguration.
So rufen Sie Analysen für eine App im Portal auf:
- Wählen Sie auf der Seite „Meine Apps“ den Namen der App aus.
- Wählen Sie die Analytics-Verknüpfung für die App aus.
- Wählen Sie die Art der angezeigten Analysen und den Zeitraum aus:
- Die ausgewählten Informationen werden angezeigt:
API-Schlüssel für ein API-Produkt manuell genehmigen oder widerrufen
Wenn ein Entwickler einer App ein API-Produkt 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 mit dem API-Produkt gebündelt sind, das mit der App verknüpft ist.
Sie steuern den Schlüsselgenehmigungsprozess für jedes API-Produkt, wenn Sie es erstellen:
Der Genehmigungsprozess kann:
- Automatisch: Wenn der Entwickler die App registriert, gibt das Portal einen genehmigten API-Schlüssel für das API-Produkt zurück. Sie können einen automatisch genehmigten Schlüssel später widerrufen.
- Manuell: Ein API-Schlüssel wird vom Portal zurückgegeben, wenn der Entwickler die App registriert. Der Schlüssel wird jedoch nicht für API-Produkte aktiviert, für die die manuelle Schlüsselgenehmigung verwendet wird. Ein Administrator muss den API-Schlüssel entweder in der Edge Management-Benutzeroberfläche oder in der API manuell genehmigen, bevor der Entwickler ihn zum Zugriff auf das API-Produkt verwenden kann. Sie können einen manuell genehmigten Schlüssel später widerrufen.
Weitere Informationen finden Sie unter API-Produkte erstellen.
Wenn Entwickler in Ihrem Portal einer App mehrere API-Produkte hinzufügen können, fügen sie möglicherweise einige Produkte mit automatischer Schlüsselgenehmigung und andere mit manueller Genehmigung 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.
Wenn ein Entwickler die Liste der API-Produkte für eine App und den Status der Schlüsselgenehmigung für das API-Produkt aufrufen möchte, wählt er auf der Seite „Meine Apps“ den Namen der App und dann den Link „Produkte“ aus:
In diesem Beispiel wird für das Premium Weather API-Produkt die manuelle Genehmigung verwendet und es wird auf die Genehmigung des Schlüssels durch einen Administrator gewartet. Für das kostenlose API-Produkt wird die automatische Genehmigung verwendet und die Verwendung des Schlüssels für den Zugriff darauf wurde genehmigt.
So genehmigen oder widerrufen Sie einen Schlüssel manuell:
- Melden Sie sich in der Edge-Benutzeroberfläche als Nutzer mit Administratorrechten für Ihre Organisation an.
- Wählen Sie rechts oben im Drop-down-Menü die Option API-Plattform aus.
- Wählen Sie Veröffentlichen > Entwickler-Apps aus, um die Liste der Entwickler-Apps zu öffnen.
- Klicken Sie auf die Schaltfläche Ausstehend, um eine Liste der Apps mit ausstehenden Schlüsselanfragen aufzurufen:
- Wählen Sie den Namen der App aus, die Sie genehmigen möchten.
- Klicken Sie auf der Seite mit den App-Details rechts oben auf die Schaltfläche Bearbeiten.
- Gehen Sie in der Liste der API-Produkte für die App unter Aktionen so vor:
-
Wenn Sie den Schlüssel genehmigen möchten, wählen Sie für jedes API-Produkt, für das eine manuelle Genehmigung erforderlich ist, die Schaltfläche Genehmigen aus.
-
Wenn Sie einen genehmigten Schlüssel widerrufen möchten, wählen Sie unter „Aktionen“ für ein API-Produkt die Schaltfläche Widerrufen aus, um den Zugriff zu widerrufen.
-
Wenn Sie den Schlüssel genehmigen möchten, wählen Sie für jedes API-Produkt, für das eine manuelle Genehmigung erforderlich ist, die Schaltfläche Genehmigen aus.
- Speichern Sie die App. Der API-Schlüssel ist jetzt genehmigt.
Caching von API-Produkten und Apps steuern
Informationen zu API-Produkten und Entwickler-Apps werden aus dem Portal heraus in Apigee Edge gespeichert. Das bedeutet, dass Änderungen an API-Produkten und ‑Apps über die Edge-Benutzeroberfläche oder ‑API vorgenommen werden können, ohne das Portal aufzurufen. Wenn ein Backend-Administrator beispielsweise ein neues API-Produkt hinzufügt, werden diese Informationen nicht sofort im Portal aktualisiert.
Damit das Portal immer mit dem Edge-Backend synchronisiert ist, können Sie das Aktualisieren des Portal-Caches manuell 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, dass die API-Produkte und Entwickler-App-Caches so häufig aktualisiert werden. In diesem Fall können Sie die Cache-Aktualisierung manuell auslösen. Wenn der Cron-Job jedoch jede oder alle zwei Stunden ausgeführt wird, hat die Zeit, die zum Aktualisieren der Caches erforderlich ist, möglicherweise keine große Auswirkung.
Standardmäßig ist das Portal so konfiguriert, dass die Caches für API-Produkte und Entwickler-Apps jedes Mal neu erstellt werden, wenn Cron ausgeführt wird.
So legen Sie fest, ob die Caches für das API-Produkt und die Entwickler-App jedes Mal neu erstellt werden sollen, wenn Cron ausgeführt wird:
- Melden Sie sich als Nutzer mit Administrator- oder Berechtigungen zum Erstellen von Inhalten in Ihrem Portal an.
- Wählen Sie im Drupal-Menü Konfiguration > Dev-Portal-Einstellungen > Anwendungseinstellungen aus.
- Klicken Sie das Kästchen API-Produkt- und Entwickler-App-Caches jedes Mal neu erstellen, wenn cron ausgeführt wird an oder entfernen Sie das Häkchen.
- Speichern Sie Ihre Einstellungen.
So aktualisieren Sie die Caches manuell:
- Melden Sie sich als Nutzer mit Administrator- oder Berechtigungen zum Erstellen von Inhalten in Ihrem Portal an.
- Wählen Sie im Drupal-Menü das Startsymbol > Alle Caches leeren aus.
Formularfelder für die Registrierung einer App 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. Im Portal können Sie diesem Formular neue Felder hinzufügen. Diese Felder können folgendermaßen sein:
- Erforderlich oder optional
- Sie werden durch verschiedene HTML-Elemente wie Textfelder, Optionsfelder und Kästchen dargestellt.
- Kann so eingestellt werden, dass es sich an einer beliebigen Stelle im Formular zwischen dem Feld „Callback-URL“ und dem Feld „Produkt“ befindet.
In diesem Video erfahren Sie, wie Sie das Formular für die App-Registrierung im Entwicklerportal anpassen.
Das folgende Formular enthält 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 zusammen mit allen anderen Feldern automatisch in Edge hochgeladen, wenn der Entwickler das Formular einreicht. Sie können diese Felder also in Edge aufrufen oder ändern oder über die Edge Management API über ein Script auf diese Felder zugreifen.
Die neuen Formularfelder finden Sie beispielsweise in der Edge-Verwaltungsoberfläche unter „Veröffentlichen“ > „Entwickler-Apps“ und dann unter dem Namen der App. Die neuen Feldwerte werden auf der Seite im Bereich „Benutzerdefinierte Attribute“ mit einem Namen angezeigt, der dem internen Namen des Felds entspricht:
Die Feldwerte werden auch im Bereich „Details“ der App auf der Seite „Meine Apps“ des Entwicklers angezeigt:
Der Entwickler kann die Werte auch bearbeiten, indem er auf der Seite „Meine Apps“ den Link „Bearbeiten“ für die App auswählt.
Im Folgenden wird beschrieben, wie Sie die Formulare zum Erstellen von Apps über die Administratoroberfläche konfigurieren. Mithilfe benutzerdefinierter Hooks können Drupal-Entwickler zusätzliche Anpassungen vornehmen, z. B. die Seite „Meine Apps“ ändern. Weitere Informationen zum Ändern des Verhaltens durch Code finden Sie in den App-API-Beispielen in der Datei /profiles/apigee/modules/custom/devconnect/devconnect_developer_apps/devconnect_developer_apps.api.php.
So fügen Sie dem Registrierungsformular für Apps ein Feld hinzu:
- Melden Sie sich als Nutzer mit Administrator- oder Berechtigungen zum Erstellen von Inhalten in Ihrem Portal an.
- Das Modul DevConnect App Attribute Management muss aktiviert sein.
- Wählen Sie im Drupal-Verwaltungsmenü Konfiguration > Dev-Portal-Einstellungen > Dev-Portal-App-Attribute aus.
- Klicken Sie oben auf der Seite auf die Schaltfläche Dev Portal App-Attribut hinzufügen.
- Konfigurieren Sie das Feld. Verwenden Sie für das oben gezeigte Feld „Kundennummer“ beispielsweise die folgenden Einstellungen:
- Interner Name = cust_id. Dies ist der Name der Variablen, mit der der Feldwert gespeichert wird.
- Öffentlicher Name = Kundennummer
- Beschreibung: Geben Sie Ihre Kundennummer ein.
- Klicken Sie das Kästchen für „Dieses Attribut erforderlich machen“ an.
- Klicken Sie das Kästchen für „Dieses Attribut anzeigen“ an.
- Widget = Textfeld
- Wählen Sie „Speichern“ aus, um zur Seite „App-Attribute“ im Dev Portal zurückzukehren.
- Wählen Sie Save Changes (Änderungen speichern) aus.
- Wählen Sie im Drupal-Menü das Startsymbol > Alle Caches leeren aus.
Möglicherweise müssen Sie den Browsercache leeren, damit das neue Feld im Formular angezeigt wird.
Wenn Sie ein optionales Feld hinzufügen möchten, in dem Entwickler die Plattform für die App angeben können, legen Sie die Feldattribute so fest:
- Interner Name = intended_platforms
- Öffentlicher Name = Plattformen
- Beschreibung: Geben Sie eine oder mehrere Plattformen für Ihre App an.
- Entfernen Sie die Häkchen aus den Kästchen für „Dieses Attribut als erforderlich kennzeichnen“.
- Klicken Sie das Kästchen für „Dieses Attribut anzeigen“ an.
- Widget = Liste mit Kästchen
- Wählen Sie „Speichern“ aus, um zur Seite „App-Attribute“ im Dev Portal zurückzukehren.
So ordnen Sie die Attribute im Formular neu an:
- Melden Sie sich als Nutzer mit Administrator- oder Berechtigungen zum Erstellen von Inhalten in Ihrem Portal an.
- Wählen Sie im Drupal-Verwaltungsmenü Konfiguration > Dev-Portal-Einstellungen > Dev-Portal-App-Attribute aus.
- Klicken Sie unter der Spalte „Name“ auf das Pluszeichen + und ziehen Sie das Element an die Stelle, an der es im Formular angezeigt werden soll.
- Speichern Sie die Änderungen.