API-Produkte verwalten

Sie lesen gerade die Dokumentation zu Apigee Edge.
Zur Dokumentation zu Apigee X. info

In diesem Abschnitt wird beschrieben, wie Sie API-Produkte über die Apigee Edge-Verwaltungs-UI verwalten. Informationen zum Verwalten von API-Produkten über die API finden Sie unter APIs mit der Edge Management API veröffentlichen.

Eine Übersicht über API-Produkte finden Sie unter Was ist ein API-Produkt?.

Seite „API-Produkte“ erkunden

Greifen Sie wie unten beschrieben auf die Seite „API-Produkte“ zu.

API-Produkt hinzufügen

Fügen Sie wie unten beschrieben ein API-Produkt über die Benutzeroberfläche hinzu. Informationen zur Verwendung der Edge API finden Sie unter API-Produkte mit der API konfigurieren.

So fügen Sie ein API-Produkt über die Edge-Benutzeroberfläche hinzu:

1. Rufen Sie die Seite „API-Produkte“ auf, wie bereits in diesem Abschnitt beschrieben.
2. Klicken Sie auf +API Product.
3. Geben Sie die Produktdetails für Ihr API-Produkt ein.
   

   Feld	Beschreibung
   Name	Interner Name des API-Produkts. Sobald der API-Produkt erstellt wurde, können Sie den Namen nicht mehr ändern. Geben Sie im Namen keine Sonderzeichen an.
   Anzeigename	Anzeigename für das API-Produkt. Der Anzeigename wird in der Benutzeroberfläche verwendet und kann jederzeit bearbeitet werden. Wenn keine Angabe erfolgt, wird der Wert "Name" verwendet. Dieses Feld wird automatisch mit dem Wert "Name" ausgefüllt. können Sie den Inhalt bearbeiten oder löschen. Der Anzeigename kann Sonderzeichen enthalten.
   Beschreibung	Beschreibung des API-Produkts.
   Umgebung	Umgebungen, auf die das API-Produkt Zugriff gewährt. Beispiel: test oder prod.
   Zugriff	Zugriffsebene. Weitere Informationen finden sich unter Zugriffsebene.
   Zugriffsanfragen automatisch genehmigen	Aktivieren Sie die automatische Genehmigung von Schlüsselanfragen für dieses API-Produkt von einer beliebigen Anwendung aus. Deaktivieren Sie diese Option, um die manuelle Genehmigung von Schlüsseln erforderlich zu machen. Weitere Informationen finden Sie unter Anwendungen registrieren und API-Schlüssel verwalten (UI) und Schlüssel für Entwickleranwendungen (API).
   Quota	Kontingentlimit, auf das Sie in Kontingentrichtlinien verweisen möchten. Die Eingabe eines Kontingentwerts erzwingt nicht automatisch Einschränkungen für die Anzahl der Aufrufe, die über das Produkt erfolgen können. API-Proxys, auf die vom Produkt verwiesen wird, müssen die Kontingentrichtlinie enthalten, um das Kontingent zu erzwingen. Weitere Informationen finden Sie unter Kontingente.
   Erlaubte OAuth-Bereiche	Wenn Sie OAuth mit dem API-Produkt verwenden, geben Sie die erlaubten OAuth-Bereiche an, die das API-Produkt zulassen soll (z. B. „Lesen“ oder andere Bereiche, die Apps mit ihren API-Aufrufen senden). Geben Sie mehrere Bereiche als durch Kommas getrennte Liste an. Weitere Informationen finden Sie unter OAuth-Bereiche.

4. Fügen Sie die im API-Produkt verfügbaren API-Ressourcen hinzu, einschließlich der API-Proxys und Ressourcenpfade.

   Beispiel: Wenn Sie dem Produkt einen API-Proxy "music" mit dem Basispfad /music hinzufügen, erlaubt das API-Produkt Aufrufe von /music. Wenn Sie jedoch möchten, dass das API-Produkt nur den Zugriff auf den venues-Ressourcenpfad mit dem URI /music/venues zulässt, fügen Sie dem Produkt den Ressourcenpfad /venues hinzu. In diesem Fall sind Aufrufe an /music/venues?name=paramount erlaubt, Aufrufe an /music/artists?name=Jack%Johnson werden dagegen blockiert.

   Legen Sie einen bestimmten Ressourcenpfad fest oder legen Sie den Basispfad und alle möglichen Unterpfade fest, indem Sie den Ressourcenpfad als / angeben. Der Ressourcenpfad kann die Platzhalter /** und /* enthalten. Der doppelte Sternchen gibt an, dass alle Unterpfade des Basispfads unterstützt werden, aber nicht der Basispfad. Ein einzelnes Sternchen gibt an, dass nur URIs unterstützt werden, die sich eine Ebene unterhalb des Basispfads befinden. Informationen zum Konfigurieren des Verhaltens des Ressourcenpfads von „/“, „/*“ und „/**“ finden Sie weiter unten in diesem Abschnitt.

   So fügen Sie API-Ressourcen hinzu:

   1. Klicken Sie im Bereich „API-Ressourcen“ auf Proxy hinzufügen oder Pfad hinzufügen.
   2. Wählen Sie aus, ob Sie einen API-Proxy, einen Pfad oder beides, also API-Proxy und Pfad, hinzufügen möchten.

      

   3. Fügen Sie einen oder mehrere API-Proxys und Ressourcenpfade hinzu.

      Wichtige Hinweise:

      • Die von Ihnen definierten Ressourcenpfade gelten für alle dem API-Produkt hinzugefügten API-Proxys.
      • Inklusivere, weniger spezifische Ressourcenpfade haben Vorrang vor spezifischeren Pfaden. Beispiel: Wenn Sie / und /** hinzufügen, hat der Ressourcenpfad / Vorrang. Der Ressourcenpfad /** wird ignoriert.

      Beispiel:

      

   4. Klicken Sie auf Hinzufügen oder Weitere hinzufügen und starten (um zusätzliche API-Ressourcen anzugeben).
5. (Optional) Verwenden Sie den Bereich Apigee-Remote-Dienstziele , um das Produkt an ein oder mehrere Remote-Dienstziele zu binden. Wenn Sie den Apigee Envoy Adapter nicht verwenden, können Sie diese Einstellung ignorieren. Weitere Informationen finden Sie im Operations Guide for the Apigee Envoy Adapter.

6. (Optional) Im Bereich Benutzerdefinierte Attribute können Sie einem API-Produkt bis zu 18 benutzerdefinierte Attribute hinzufügen.

   Benutzerdefinierte Attribute sind Schlüssel/Wert-Paare, die auf viele Arten verwendet werden können, unter anderem die API-Proxy-Ausführung steuern. Sie können beispielsweise ein benutzerdefiniertes Attribut mit dem Namen deprecated mit dem Wert „true“ oder „false“ erstellen. Im API-Proxy-Ablauf können Sie den Wert des Attributs deprecated des API-Produkts prüfen (z. B. mit der Variablen verifyapikey.{policy_name}.apiproduct.deprecated, die automatisch verfügbar ist, nachdem Sie das benutzerdefinierte Attribut erstellt haben). Wenn der Wert „true“ (veraltet) ist, können Sie mit der Raise Fault-Richtlinie einen Fehler auslösen.

7. Klicken Sie auf Speichern.

Verhalten eines Ressourcenpfads von „/“, „/*“ und „/**“ konfigurieren

Die folgende Tabelle zeigt das Standardverhalten eines API-Produkts für verschiedene Ressourcenpfade. In diesem Beispiel hat der API-Proxy den Basispfad /v1/weatherapikey. Der API-Produktressourcenpfad gilt für das Pfad-Suffix nach dem Basispfad.

Anfrage-URI	Zugelassen für /	Zugelassen für /*	Zugelassen für /**	Zugelassen für /*/2/**	Zugelassen für /*/2/*
/v1/weatherapikey	J	Nein	Nein	Nein	N
/v1/weatherapikey/	J	Nein	Nein	Nein	N
/v1/weatherapikey/1	J	Ja	Ja	Nein	N
/v1/weatherapikey/1/	J	Ja	Ja	Nein	N
/v1/weatherapikey/1/2	J	Nein	Ja	Nein	N
/v1/weatherapikey/1/2/	J	Nein	Ja	Ja	N
/v1/weatherapikey/1/2/3/	J	Nein	Ja	Ja	J
/v1/weatherapikey/1/a/2/3/	J	Nein	Ja	Nein	N

In API-Produkten unterstützt ein Ressourcenpfad von / standardmäßig den Basispfad und alle Unterpfade. Beispiel: Ist der Basispfad des API-Proxys /v1/weatherapikey, so unterstützt das API-Produkt Anfragen an /v1/weatherapikey und alle Unterpfade wie /v1/weatherapikey/forecastrss . /v1/weatherapikey/region/CA und so weiter.

Sie können diese Standardeinstellung so ändern, dass der Ressourcenpfad von / nur dem Basispfad des API-Proxys entspricht. Das API-Produkt hat dann keinen Zugriff auf einen URI mit Elementen nach dem /. Wenn Sie diese Änderung vornehmen, würden in der Tabelle oben nur die ersten beiden Zeilen unter „Zulässig für /“ „J“ enthalten.

Um die Standardeinstellung zu ändern, muss ein Systemadministrator den Wert des features.isSingleForwardSlashBlockingEnabled Attributs für Ihre Organisation auf true setzen. Cloud-Kunden können diese Anfrage an den Apigee Edge-Support senden.

API-Produkt bearbeiten

So bearbeiten Sie ein API-Produkt:

1. Rufen Sie die Seite „API-Produkte“ auf, wie bereits in diesem Abschnitt beschrieben.
2. Klicken Sie in die Zeile des zu bearbeitenden API-Produkts.
3. Klicken Sie auf der Seite „API-Produkt“ auf Bearbeiten.
4. Bearbeiten Sie die Felder nach Bedarf.

   Sie können Ressourcen löschen, die Sie einem API-Produkt hinzugefügt haben. Das kann sinnvoll sein, wenn eine Ressource nicht richtig funktioniert oder mehr Entwicklung erfordert. Nach dem Löschen ist diese Ressource nicht mehr Teil des API-Produkts. Alle Anwendungen, die das API-Produkt verwenden, können nicht mehr auf die gelöschte Ressource zugreifen. Gelöschte Ressourcen werden aus dem Produkt entfernt, jedoch nicht aus dem System gelöscht. Sie können also weiterhin von anderen Produkten verwendet werden.

5. Klicken Sie auf Speichern.

Bei Apigee Edge for Public Cloud speichert Edge die folgenden Entitäten für mindestens 180 Sekunden im Cache, nachdem die Entitäten aufgerufen wurden.

• OAuth Zugriffstoken Daher kann ein widerrufenes Token noch bis zu drei Minuten lang erfolgreich sein, bis sein Cache-Limit abläuft.
• KMS-Entitäten (Key Management Service, Anwendungen, Entwickler, API-Produkte)
• Benutzerdefinierte Attribute für OAuth-Tokens und KMS-Entitäten.

API-Produkt löschen

Bevor Sie ein API-Produkt löschen können, müssen Sie die Registrierung aller Entwickler-Apps aufheben, die dem Produkt zugeordnet sind. Dazu können Sie die Anwendungen löschen oder die API-Schlüssel der App widerrufen.

So löschen Sie ein API-Produkt:

1. Rufen Sie die Seite „API-Produkte“ auf, wie bereits in diesem Abschnitt beschrieben.
2. Bewegen Sie den Mauszeiger über das API-Produkt in der Liste.
3. Klicken Sie auf .
4. Klicken Sie auf Delete , um den Löschvorgang zu bestätigen.