API-Produkte verwalten

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

Verwalten Sie API-Produkte mithilfe der Apigee Edge-Verwaltungsoberfläche, wie in diesem Abschnitt beschrieben. Informationen zum Verwalten des API-Produkts mit der API finden Sie unter Edge-Management-API zum Veröffentlichen von APIs verwenden.

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

Seite 'API-Produkte' erkunden

Rufen Sie die API-Produktseite wie unten beschrieben auf.

API-Produkt hinzufügen

Fügen Sie ein API-Produkt über die Benutzeroberfläche hinzu, wie unten beschrieben. Informationen zur Verwendung der Edge-API finden Sie unter API-Produkte mithilfe 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. Sie können den Namen nicht mehr bearbeiten, nachdem das API-Produkt erstellt wurde. 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 Apps registrieren und API-Schlüssel verwalten (Benutzeroberfläche) und Entwickler-App-Schlüssel (API).
   Kontingent	Kontingentlimit, auf das Sie in Kontingentrichtlinien verweisen möchten. Durch die Eingabe eines Kontingentwerts werden nicht automatisch Einschränkungen für die Anzahl der Aufrufe erzwungen, die über das Produkt erfolgen können. API-Proxys, auf die vom Produkt verwiesen wird, müssen die Kontingentrichtlinie enthalten, um das Kontingent durchzusetzen. Weitere Informationen finden Sie unter Kontingente.
   Erlaubte OAuth-Bereiche	Wenn Sie OAuth mit dem API-Produkt verwenden, zulässige OAuth-Bereiche, die das API-Produkt zulassen soll (z. B. Lese- oder andere Bereiche, die Apps mit ihren API-Aufrufen senden). Geben Sie mehrere Bereiche in einer durch Kommas getrennten Liste an. Siehe 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 untergeordneten Pfade fest, indem Sie den Ressourcenpfad als / angeben. Der Ressourcenpfad kann die Platzhalter /** und /* enthalten. Der doppelte Sternchen-Platzhalter gibt an, dass alle untergeordneten Pfade des Basispfads unterstützt werden (aber nicht der Basispfad). Ein einzelnes Sternchen bedeutet, dass nur URIs unterstützt werden, die eine Ebene unter dem Basispfad liegen. Weitere Informationen finden Sie unter Verhalten des Ressourcenpfads '/', '/*' und '/**' konfigurieren, wie später in diesem Abschnitt beschrieben.

   So fügen Sie API-Ressourcen hinzu:

   1. Klicken Sie im Abschnitt „API-Ressourcen“ auf Proxy hinzufügen oder Pfad hinzufügen.
   2. Wählen Sie aus, ob Sie einen API-Proxy, einen Pfad oder sowohl einen API-Proxy als auch einen API-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 Hinzufügen und weitere starten, um weitere API-Ressourcen anzugeben.
5. (Optional) Verwenden Sie den Abschnitt Apigee-Remote-Dienstziele, um das Produkt an ein oder mehrere Remote-Dienstziele zu binden. Wenn Sie nicht den Apigee Envoy-Adapter verwenden, können Sie diese Einstellung ignorieren. Weitere Informationen finden Sie in der Betriebsanleitung für den Apigee Envoy-Adapter.

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

   Benutzerdefinierte Attribute sind Schlüssel/Wert-Paare, die auf unterschiedliche Weise verwendet werden können, einschließlich der Steuerung der API-Proxy-Ausführung. Sie können beispielsweise ein benutzerdefiniertes Attribut namens deprecated mit dem Wert „true“ oder „false“ erstellen. In Ihrem API-Proxy-Ablauf können Sie den Wert des Attributs deprecated des API-Produkts prüfen (z. B. mithilfe der Variablen verifyapikey.{policy_name}.apiproduct.deprecated, die nach dem Erstellen des benutzerdefinierten Attributs automatisch verfügbar ist). Wenn der Wert „true“ (eingestellt) ist, können Sie mit der Richtlinie „Fehler auslösen“ einen Fehler ausgeben.

7. Klicken Sie auf Speichern.

Verhalten eines Ressourcenpfads von '/', '/*' und '/**' konfigurieren

In der folgenden Tabelle wird das Standardverhalten eines API-Produkts für verschiedene Ressourcenpfade beschrieben. In diesem Beispiel hat der API-Proxy den Basispfad /v1/weatherapikey. Der API-Produktressourcenpfad gilt für das Pfadsuffix 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	N	N	N	N
/v1/weatherapikey/	Ja	N	N	N	N
/v1/weatherapikey/1	Ja	Ja	Ja	N	N
/v1/weatherapikey/1/	Ja	Ja	Ja	N	N
/v1/weatherapikey/1/2	Ja	Nein	Ja	N	N
/v1/weatherapikey/1/2/	J	Nein	Ja	Ja	N
/v1/weatherapikey/1/2/3/	J	Nein	Ja	Ja	Ja
/v1/weatherapikey/1/a/2/3/	Ja	Nein	Ja	N	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.

Zum Ändern der Standardeinstellung muss ein Systemadministrator den Wert der Property features.isSingleForwardSlashBlockingEnabled in Ihrer Organisation auf true festlegen. Cloud-Kunden können diese Anfrage an den Apigee Edge-Support richten.

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 Produktseite der API auf Bearbeiten.
4. Bearbeiten Sie die Felder nach Bedarf.

   Sie können Ressourcen löschen, die Sie einem API-Produkt hinzugefügt haben. Dies ist sinnvoll, wenn eine Ressource nicht richtig funktioniert oder weiterentwickelt werden muss. Nach dem Löschen gehört diese Ressource nicht mehr zum API-Produkt. Apps, die das API-Produkt verwenden, können nicht mehr auf die gelöschte Ressource zugreifen. Gelöschte Ressourcen werden aus dem Produkt entfernt, aber nicht aus dem System gelöscht, sodass sie weiterhin von anderen Produkten verwendet werden können.

5. Klicken Sie auf Speichern.

Mit Apigee Edge for Public Cloud behält Edge die folgenden Entitäten mindestens 180 Sekunden lang im Cache, nachdem auf die Entitäten zugegriffen wurde.

• OAuth Zugriffstoken Dies bedeutet, dass ein widerrufenes Token möglicherweise weiterhin bis zu drei Minuten gültig ist, bis sein Cache-Limit abgelaufen ist.
• 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.