Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich. # API-Schlüssel für REST APIs in API Gateway einrichten 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](rest-api-develop.md) und [REST-APIs in API Gateway bereitstellen](how-to-deploy-api.md). Nach dem Erstellen eines API-Schlüssels muss dieser mit einem Nutzungsplan verknüpft werden. Weitere Informationen finden Sie unter [Nutzungspläne für REST APIs in API Gateway einrichten](api-gateway-create-usage-plans.md). **Anmerkung** Zu berücksichtigende bewährte Methoden finden Sie unter [Bewährte Methoden für API-Schlüssel und Nutzungspläne](api-gateway-api-usage-plans.md#apigateway-usage-plans-best-practices). **Topics** + [Festlegen der Erforderlichkeit eines API-Schlüssels für eine Methode](#api-gateway-usage-plan-configure-apikey-on-method) + [Erstellen Sie einen API-Schlüssel](#api-gateway-usage-plan-create-apikey) + [Importieren von API-Schlüsseln](#api-gateway-usage-pan-import-apikey) ## 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. ------ #### [ AWS-Managementkonsole ] **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](https://console.aws.amazon.com/apigateway). 1. Wählen Sie eine REST-API aus. 1. Klicken Sie im Hauptnavigationsbereich von API Gateway auf **Resources (Ressourcen)**. 1. Erstellen Sie unter **Resources** eine neue Methode oder wählen Sie eine vorhandene aus. 1. Wählen Sie auf der Registerkarte **Methodenanfrage** unter **Methodenanfrage-Einstellungen** die Option **Bearbeiten** aus. ![\[Einen API-Schlüssel einer Methode hinzufügen\]](http://docs.aws.amazon.com/de_de/apigateway/latest/developerguide/images/api-gateway-new-console-add-key-to-method.png) 1. Wählen Sie **API-Schlüssel erforderlich** aus. 1. Wählen Sie **Speichern**. 1. 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. ------ #### [ AWS CLI ] Der folgende [put-method](https://docs.aws.amazon.com/cli/latest/reference/apigateway/put-method.html)-Befehl erstellt eine `PUT`-Methode, die einen API-Schlüssel erfordert: ``` aws apigateway put-method \ --rest-api-id 1234123412 \ --resource-id a1b2c3 \ --http-method PUT \ --authorization-type "NONE" \ --api-key-required ``` Der folgende [update-method](https://docs.aws.amazon.com/cli/latest/reference/apigateway/update-method.html)-Befehl aktualisiert eine vorhandene Methode, sodass ein API-Schlüssel erforderlich ist: ``` aws apigateway update-method \ --rest-api-id 1234123412 \ --resource-id a1b2c3 \ --http-method PUT \ --patch-operations op="replace",path="/apiKeyRequired",value="true" ``` ------ #### [ REST API ] Führen Sie einen der folgenden Schritte aus, damit für eine Methode ein API-Schlüssel erforderlich ist: + Rufen Sie [https://docs.aws.amazon.com/apigateway/latest/api/API_PutMethod.html](https://docs.aws.amazon.com/apigateway/latest/api/API_PutMethod.html) auf, um eine Methode zu erstellen. Legen Sie `apiKeyRequired` in der Anforderungsnutzlast auf `true` fest. + Rufen Sie [https://docs.aws.amazon.com/apigateway/latest/api/API_UpdateMethod.html](https://docs.aws.amazon.com/apigateway/latest/api/API_UpdateMethod.html) auf, um `apiKeyRequired` auf `true` zu setzen. ------ ## Erstellen Sie einen API-Schlüssel Im folgenden Verfahren sehen Sie, wie Sie einen privaten API-Schlüssel erstellen. Wenn Sie Ihren API-Schlüssel importieren möchten, überspringen Sie diesen Schritt. ------ #### [ AWS-Managementkonsole ] **So erstellen Sie einen API-Schlüssel** 1. Melden Sie sich bei der API Gateway Gateway-Konsole unter [https://console.aws.amazon.com/apigatewayan](https://console.aws.amazon.com/apigateway). 1. Wählen Sie eine REST-API aus. 1. Wählen Sie im Hauptnavigationsbereich von API Gateway **API-Schlüssel**. 1. Klicken Sie auf **API-Schlüssel erstellen**. ![\[Erstellen von API-Schlüsseln für Nutzungspläne\]](http://docs.aws.amazon.com/de_de/apigateway/latest/developerguide/images/api-gateway-new-console-usage-plan-keys-choose-create-api-key-from-actions-menu.png) 1. Geben Sie unter **Name** einen Namen ein. 1. (Optional) Geben Sie unter **Description (Beschreibung)** eine Beschreibung ein. 1. 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. 1. Wählen Sie **Speichern**. ------ #### [ AWS CLI ] Der folgende [create-api-key](https://docs.aws.amazon.com/cli/latest/reference/apigateway/create-api-key.html)Befehl erstellt einen API-Schlüssel: ``` aws apigateway create-api-key \ --name 'Dev API key' \ --description 'API key for Devs' \ --enabled ``` ------ #### [ REST API ] Rufen Sie [https://docs.aws.amazon.com/apigateway/latest/api/API_CreateApiKey.html](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateApiKey.html) auf, um einen API-Schlüssel zu erstellen. ------ ## Importieren von API-Schlüsseln Das folgende Verfahren beschreibt, wie Sie API-Schlüssel importieren. Wenn Sie bereits einen API-Schlüssel erstellt haben, überspringen Sie diesen Schritt. ------ #### [ AWS-Managementkonsole ] **So importieren Sie API-Schlüssel** 1. Melden Sie sich bei der API Gateway Gateway-Konsole unter [https://console.aws.amazon.com/apigatewayan](https://console.aws.amazon.com/apigateway). 1. Wählen Sie eine REST-API aus. 1. Wählen Sie im Hauptnavigationsbereich **API-Schlüssel**. 1. Wählen das im Dropdown-Menü **Aktionen** und dann die Option **API-Schlüssel importieren**. 1. 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](api-key-file-format.md). 1. 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. 1. Wählen Sie **Import**, um Ihre API-Schlüssel zu importieren. ------ #### [ AWS CLI ] Der folgende [import-api-keys](https://docs.aws.amazon.com/cli/latest/reference/apigateway/import-api-keys.html)Befehl importiert einen API-Schlüssel: ``` aws apigateway import-api-key \ a--body fileb://keys.csv \ --format csv ``` ------ #### [ REST API ] Rufen Sie [https://docs.aws.amazon.com/apigateway/latest/api/API_ImportApiKeys.html](https://docs.aws.amazon.com/apigateway/latest/api/API_ImportApiKeys.html) auf, um einen API-Schlüssel aus einer Datei zu importieren. Weitere Informationen zum Dateiformat finden Sie unter [API-Schlüsseldateiformat in API Gateway](api-key-file-format.md). ------ Sie können den Wert des neuen API-Schlüssels nicht ändern. Nachdem Sie Ihre API erstellt haben, konfigurieren Sie einen Nutzungsplan. Weitere Informationen finden Sie unter [Nutzungspläne für REST APIs in API Gateway einrichten](api-gateway-create-usage-plans.md).