Einrichten von API-Schlüsseln mit der API-Gateway-Konsole

Um API-Schlüssel einzurichten, gehen Sie wie folgt vor:

• Konfigurieren Sie API-Methoden, um einen API-Schlüssel erforderlich zu machen.

• Erstellen oder importieren Sie einen API-Schlüssel für die API in einer Region.

Vor der Einrichtung von API-Schlüsseln müssen Sie eine API erstellt haben und diese in einer Stufe bereitgestellt haben. Nach der Erstellung eines API-Schlüsselwerts kann dieser nicht geändert werden.

Anweisungen zum Erstellen und Bereitstellen einer API mithilfe der API Gateway-Konsole finden Sie unter Entwickeln Sie REST APIs in API Gateway und Stellen Sie REST APIs in API Gateway bereit.

Nach dem Erstellen eines API-Schlüssels muss dieser mit einem Nutzungsplan verknüpft werden. Weitere Informationen finden Sie unter Erstellen, Konfigurieren und Testen von Nutzungsplänen mit der API Gateway-Konsole.

Anmerkung

Zu berücksichtigende bewährte Methoden finden Sie unter Bewährte Methoden für API-Schlüssel und Nutzungspläne.

Festlegen der Erforderlichkeit eines API-Schlüssels für eine Methode

Im folgenden Verfahren wird beschrieben, wie Sie festlegen, dass für eine API-Methode ein API-Schlüssel erforderlich ist.

So konfigurieren Sie, dass für eine API-Methode ein API-Schlüssel erforderlich ist

1. Melden Sie sich bei der API Gateway Gateway-Konsole unter https://console.aws.amazon.com/apigatewayan.

2. Wählen Sie eine REST-API aus.

3. Klicken Sie im Hauptnavigationsbereich von API Gateway auf Resources (Ressourcen).

4. Erstellen Sie unter Resources eine neue Methode oder wählen Sie eine vorhandene aus.

5. Wählen Sie auf der Registerkarte Methodenanfrage unter Methodenanfrage-Einstellungen die Option Bearbeiten aus.

   

6. Wählen Sie API-Schlüssel erforderlich aus.

7. Wählen Sie Save (Speichern) aus.

8. Stellen Sie die API bereit (oder erneut bereit), damit die Änderung wirksam wird.

Wenn für die Option API-Schlüssel erforderlich der Wert false festgelegt ist und Sie die vorherigen Schritte nicht ausführen, wird keiner der API-Schlüssel, die einer API-Stufe zugeordnet sind, für diese Methode verwendet.

Erstellen eines API-Schlüssels

Sofern Sie bereits API-Schlüssel für die Nutzungspläne erstellt oder importiert haben, können Sie diesen und den nächsten Abschnitt überspringen.

So erstellen Sie einen API-Schlüssel

1. Melden Sie sich bei der API Gateway Gateway-Konsole unter https://console.aws.amazon.com/apigatewayan.

2. Wählen Sie eine REST-API aus.

3. Wählen Sie im Hauptnavigationsbereich von API Gateway API-Schlüssel.

4. Klicken Sie auf API-Schlüssel erstellen.

   

5. Geben Sie unter Name einen Namen ein.

6. (Optional) Geben Sie unter Description (Beschreibung) eine Beschreibung ein.

7. Wählen Sie für API-Schlüssel die Option Automatisch generieren, damit API Gateway den Schlüsselwert generiert, oder wählen Sie Benutzerdefiniert, um Ihren eigenen Schlüsselwert zu erstellen.

8. Wählen Sie Save (Speichern) aus.

Importieren von API-Schlüsseln

Im folgenden Verfahren wird beschrieben, wie Sie API-Schlüssel für Nutzungspläne importieren.

So importieren Sie API-Schlüssel

1. Melden Sie sich bei der API Gateway Gateway-Konsole unter https://console.aws.amazon.com/apigatewayan.

2. Wählen Sie eine REST-API aus.

3. Wählen Sie im Hauptnavigationsbereich API-Schlüssel.

4. Wählen das im Dropdown-Menü Aktionen und dann die Option API-Schlüssel importieren.

5. Wählen Sie zum Laden einer CSV-Datei Datei auswählen aus. Sie können die Schlüssel auch im Texteditor eingeben. Weitere Informationen zum Dateiformat finden Sie unter API-Schlüsseldateiformat in API Gateway.

6. Wählen Sie Fehler bei Warnungen aus, damit der Import im Falle eines Fehlers angehalten wird, oder wählen Sie Warnungen ignorieren aus, damit gültige Schlüssel auch bei einem auftretenden Fehler importiert werden.

7. Wählen Sie Import, um Ihre API-Schlüssel zu importieren.