Teil 2: API-Schlüssel generieren und testen

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

Überarbeitet und zu API durch Anfordern von API-Schlüsseln sichern.

Ein Entwickler erstellt eine App , die Anfragen an Ihre APIs sendet, um auf Ihre Back-End-Dienste zuzugreifen. Um den Zugriff auf Ihre APIs zu steuern, können Sie festlegen, dass der Entwickler bei jeder Anfrage einen API-Schlüssel übergeben muss. Wenn der Schlüssel fehlt oder ungültig ist, schlägt die Anfrage fehl.

Beim Veröffentlichen werden Ihre APIs App-Entwicklern zur Nutzung zur Verfügung gestellt. Das Veröffentlichen von APIs kann allgemein durch die folgenden Aufgaben definiert werden:

  1. Erstellen Sie die API-Produkte in Apigee Edge, die Ihre APIs bündeln.
  2. Registrieren Sie App-Entwickler in Edge. Nur ein registrierter App-Entwickler kann eine App registrieren.
  3. Entwickler registrieren Apps in Edge, um auf API-Produkte zuzugreifen. Als Antwort erhält der Entwickler einen API-Schlüssel. Mit dem API-Schlüssel kann der Entwickler Anfragen an Ihre APIs senden.

Weitere Informationen finden Sie unter Einführung in die Veröffentlichung.

In der folgenden Tabelle sind einige der Begriffe definiert, die zum Registrieren von Apps und Generieren von Schlüsseln verwendet werden:

Begriff Definition
API-Produkt Ein Bundle mit API-Proxys in Kombination mit einem Serviceplan, der die Zugriffsbeschränkungen für diese APIs festlegt. API-Produkte sind der zentrale Mechanismus, den Apigee Edge für die Autorisierung und Zugriffssteuerung für Ihre APIs verwendet.
Entwickler Der API-Nutzer. Entwickler schreiben Apps, die Anfragen an Ihre APIs senden.
App Eine clientseitige App, die ein Entwickler registriert, um auf ein API-Produkt zuzugreifen. Durch die Registrierung der App beim API-Produkt wird der API-Schlüssel für den Zugriff auf die APIs in diesem Produkt generiert.
API-Schlüssel Ein String mit Autorisierungsinformationen, mit dem eine clientseitige App auf die Ressourcen zugreift, die vom API-Produkt bereitgestellt werden. Der API-Schlüssel wird generiert, wenn eine registrierte App mit einem API-Produkt verknüpft wird.

Voraussetzungen für diese Anleitung

In dieser Anleitung wird davon ausgegangen, dass Sie die erste Anleitung abgeschlossen haben, in der Sie einen API Proxy für den Zugriff auf die Yahoo Weather API erstellen. Wenn Sie die erste Anleitung noch nicht abgeschlossen haben, lesen Sie API durch Anfordern von API-Schlüsseln sichern.

Schritt 1: API-Produkt erstellen

  1. Klicken Sie in der Verwaltungs-UI auf den Veröffentlichen-Tab und dann auf Produkte.
  2. Klicken Sie auf (+) Produkt.
  3. Geben Sie in den Feldern des Dialogfelds „Produkt hinzufügen“ die folgenden Werte ein oder wählen Sie sie aus:
    Feld Wert
    Name Free API Product
    Anzeigename Free API Product
    Beschreibung Free API Product
    Umgebung Test
    Zugriff Nur intern
    Typ der Schlüsselgenehmigung Automatisch
    (der API-Schlüssel wird nach der Generierung automatisch genehmigt)
    Quota 10 Anfragen pro Stunde
    (beschränkt die Anzahl der Anfragen auf 10 pro Stunde)
    Erlaubte OAuth-Bereiche Leer lassen

    Das ausgefüllte Dialogfeld sollte so aussehen:

  4. Wählen Sie im Bereich „Ressourcen“ Folgendes aus:
    • API-Proxy: weatherapikey
    • Version: 1
    • Ressourcenpfad: /forecastrss**

      Der Ressourcenpfad gibt die Ressourcen-URIs an, auf die eine App mit dem Produkt zugreifen kann. In diesem Beispiel kann eine App mit diesem API-Produkt nur auf die /forecastrss Ressource im weatherapikey Proxy zugreifen. Der Zugriff auf andere Ressourcen im Proxy weatherapiproxy oder in einem anderen Proxy mit diesem API-Produkt ist nicht zulässig.

      Für den Ressourcenpfad sind Platzhalterzeichen zulässig. Der Platzhalter "/**" gibt an, dass alle Sub-URIs enthalten sind, also eine Ressource im Format /forecastrss/foo/bar. Der Platzhalter „/“ gibt an, dass nur URIs eine Ebene nach unten einbezogen sind. Weitere Informationen finden Sie unter API Produkte erstellen.

      In der Drop-down-Liste Ressourcenpfad werden alle bedingten Abläufe angezeigt, die für den angegebenen API-Proxy definiert sind. Der bedingte Ablauf eines API-Proxys definiert die Logik oder die Verarbeitungsschritte, die mit einem Ressourcenpfad verknüpft sind. Ein API-Produkt steuert den Zugriff auf diese Ressourcenpfade.
  5. Klicken Sie auf Ressource importieren. Der Ressourcenpfad wird hinzugefügt und der weatherapikey API-Proxy wird automatisch dem Bereich API-Proxys für Produkt hinzugefügt.
  6. Klicken Sie auf Speichern. Das neue Produkt wird auf der Seite „Produkte“ aufgeführt.

Weitere Informationen :

Schritt 2: Entwickler registrieren

Um einen API-Schlüssel zu generieren, registrieren Sie eine App und verknüpfen sie mit einem API-Produkt. Sie können eine App jedoch erst registrieren, nachdem Sie den Entwickler der App registriert haben.

  1. Klicken Sie in der Verwaltungs-UI auf den Veröffentlichen-Tab und dann auf Entwickler.
  2. Klicken Sie auf (+) Entwickler.
  3. Geben Sie im Dialogfeld „Neuer Entwickler“ die folgenden Werte ein:
    • Vorname: Jane
    • Nachname: Tutorial
    • E-Mail-Adresse: janetutorial@example.com
    • Nutzername: jtutorial
  4. Klicken Sie auf Speichern. Der neue Entwickler wird auf der Seite „Entwickler“ in der Liste der Entwickler angezeigt.

Weitere Informationen :

Schritt 3: App registrieren

Nachdem Sie ein API-Produkt und einen Entwickler haben, können Sie eine App beim API Produkt registrieren. Durch die Registrierung der App wird der API-Schlüssel für die mit der App verknüpften API-Produkte generiert. Sie können den Schlüssel dann an App-Entwickler weitergeben, damit sie über die App auf die Funktionen in den API Produkten zugreifen können.

  1. Klicken Sie in der API Platform-UI auf den Tab Veröffentlichen und dann auf Entwickler Apps.
  2. Klicken Sie auf (+) Entwickler-App.
  3. Geben Sie im Dialogfeld „App hinzufügen“ die folgenden Werte ein:
    • Anzeigename: Weather API Key App
    • Entwickler: Jane Tutorial (janetutorial@example.com)
    • Callback-URL: leer lassen
  4. Verknüpfen Sie die App mit einem Produkt:
    1. Klicken Sie im Bereich Produkte auf + Produkt.
    2. Wählen Sie Free API Product aus.
    3. Klicken Sie auf das Häkchen , um die Änderungen zu übernehmen.
  5. Klicken Sie auf Speichern. Die neue App wird auf der Seite „Entwickler Apps“ in der Liste der Apps angezeigt.
  6. Wählen Sie in der Liste der Apps „Weather API Key App“ aus. Dadurch wird die Detailseite für die App geöffnet.
  7. Da Sie beim Erstellen des API-Produkts Typ der Schlüsselgenehmigung: Automatisch ausgewählt haben, wird der API-Schlüssel automatisch genehmigt und Sie können ihn sofort sehen. Wenn Sie Genehmigungstyp: Manuell ausgewählt haben, müssen Sie in der Spalte „Aktionen“ für „Free API Product“ auf Genehmigen klicken, um den API Schlüssel zu genehmigen.
  8. Klicken Sie im Bereich „Produkte“ neben dem Eintrag für Free API Product in den Spalten Consumer-Schlüssel und Consumer-Secret auf Anzeigen, um die generierten Schlüssel anzuzeigen.

    Der Consumer-Schlüssel ist ein anderer Name für den API-Schlüssel und der einzige Schlüssel, den eine App benötigt, um über Ihren API-Proxy auf die Ressource „forecast“ zuzugreifen . Das Consumer-Secret wird zusammen mit dem Consumer-Schlüssel benötigt, um eine API über OAuth 2.0 zu sichern. Weitere Informationen finden Sie unter OAuth 2.0: Neuen API-Proxy konfigurieren.

Weitere Informationen :

Schritt 4: API-Schlüssel in einer Anfrage verwenden

Damit die VerifyAPIKey-Richtlinie ordnungsgemäß funktioniert, müssen Sie sie testen, indem Sie mit einem gültigen API-Schlüssel einen Aufruf an den API-Proxy senden. Sie können den API-Proxy in einem Browser, auf der Seite „Trace“ des API-Proxys, in der Apigee Console oder mit cURL anfordern. Die URL für die Anfrage hat das folgende Format:

http://{org-name}-test.apigee.net/v1/weatherapikey/forecastrss?w=12797282&apikey=IEYRtW2cb7A5Gs54A1wKElECBL65GVls

Ersetzen Sie {org-name} durch den Namen Ihrer Apigee-Organisation und geben Sie den richtigen Wert für „apikey“ an.

Suchen Sie in der Antwort nach dem folgenden Inhalt:

<rss xmlns:yweather="http://xml.weather.yahoo.com/ns/rss/1.0" xmlns:geo="http://www.w3.org/2003/01/geo/wgs84_pos#" version="2.0"> 
<channel> <title>Yahoo! Weather - Palo Alto, CA</title> 
<link>http://us.rd.yahoo.com/dailynews/rss/weather/Palo_Alto__CA/*http://weather.yahoo.com/forecast/USCA1093_f.html</link> 
<description>Yahoo! Weather for Palo Alto, CA</description> <language>en-us</language>

Wenn Sie den API-Schlüssel in der Anfrage weglassen oder einen ungültigen Schlüsselwert angeben, erhalten Sie eine Fehlermeldung im folgenden Format:

{"fault":{"faultstring":"Failed to resolve API Key variable null","detail":{"errorcode":"steps.oauth.v2.FailedToResolveAPIKey"}}}

Schritt 5: Nächste Schritte

Nachdem Sie eine Anfrage an die API gesendet haben, indem Sie den API-Schlüssel als Abfrageparameter übergeben haben, ändern Sie die API so, dass der Schlüssel als Header übergeben wird.

Fahren Sie mit API durch Anfordern von API-Schlüsseln sichern fort.