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.

Anweisungen zum Erstellen und Bereitstellen einer API mithilfe der API Gateway-Konsole finden Sie unter REST-API in Amazon API Gateway erstellen und Bereitstellen einer REST-API in Amazon API Gateway.

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 AWS Management Console an und öffnen Sie die API-Gateway-Konsole unter https://console.aws.amazon.com/apigateway.

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 Method Request (Methodenanforderung).

6. Wählen sie im Abschnitt Einstellungen die Option true für API-Schlüssel erforderlich aus.

7. Klicken Sie zum Speichern der Einstellungen auf das Häkchen.

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

Falls für die Option API Key Required 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 AWS Management Console an und öffnen Sie die API-Gateway-Konsole unter https://console.aws.amazon.com/apigateway.

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

3. Klicken Sie im Hauptnavigationsbereich von API Gateway auf API Keys (API-Schlüssel).

4. Wählen Sie im Dropdownmenü Aktionen die Option Create API key.

   

5. Gehen Sie in Create API Key wie folgt vor:

   1. Geben Sie einen API-Schlüsselnamen (beispielsweise MyFirstKey) in das Eingabefeld Name ein.

   2. Wählen Sie Auto Generate (Automatisch generieren) (damit API Gateway den Schlüsselwert generiert) oder Custom (Benutzerdefiniert) (wenn Sie den Schlüssel manuell eingeben möchten) aus.

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

   

6. Wiederholen Sie bei Bedarf die oben beschriebenen Schritte zum Erstellen weiterer API-Schlüssel.

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 AWS Management Console an und öffnen Sie die API-Gateway-Konsole unter https://console.aws.amazon.com/apigateway.

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

3. Klicken Sie im Hauptnavigationsbereich auf API Keys.

4. Wählen Sie im Dropdownmenü Aktionen die Option Import API keys.

5. Wählen Sie zum Laden einer CSV-Datei mit den Schlüsseln Select CSV File. Sie können die Schlüssel auch manuell eingeben. Weitere Informationen zum Dateiformat finden Sie unter API-Schlüsseldateiformat in API Gateway.

   

6. Wählen Sie Fail on warnings aus, damit der Import im Falle eines Fehlers gestoppt wird, oder wählen Sie Ignore warnings aus, damit gültige Schlüssel auch bei einem auftretenden Fehler importiert werden.

7. Wählen Sie Import aus, um mit dem Import der ausgewählten API-Schlüssel zu beginnen.

Nachdem der API-Schlüssel eingerichtet ist, können Sie den Nutzungsplan erstellen und verwenden.