

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.

# Auswählen einer API-Schlüsselquelle in API Gateway
<a name="api-gateway-api-key-source"></a>

Wenn Sie einen Nutzungsplan einer API zuordnen und API-Schlüssel bei API-Methoden aktivieren, muss jede eingehende API-Anfrage einen [API-Schlüssel](api-gateway-basic-concept.md#apigateway-definition-api-key) enthalten. API Gateway liest den Schlüssel und vergleicht ihn mit den Schlüsseln im Nutzungsplan. Wenn die Schlüssel übereinstimmen, werden die Anforderungen entsprechend der Anforderungslimits und des Kontingents des Plans von API Gateway gedrosselt. Andernfalls wird eine `InvalidKeyParameter`-Ausnahme ausgelöst. Dadurch erhält der Aufrufer eine `403 Forbidden`-Antwort.

Ihre API Gateway-API kann API-Schlüssel aus einer von zwei Quellen erhalten:

**`HEADER`**  
Sie verteilen API-Schlüssel an Ihre Kunden und erfordern die Übermittlung des API-Schlüssels als `X-API-Key`-Header bei jeder eingehenden Anforderung. 

**`AUTHORIZER`**  
Sie lassen einen Lambda-Genehmiger den API-Schlüssel im Rahmen der Autorisierungsantwort zurückgeben. Weitere Informationen zur Autorisierungsantwort finden Sie unter [Ausgabe von einem API-Gateway-Lambda-Genehmiger](api-gateway-lambda-authorizer-output.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).

Das folgende Verfahren zeigt, wie Sie eine API-Schlüsselquelle für eine API auswählen.

------
#### [ AWS-Managementkonsole ]

**So wählen Sie eine API-Schlüsselquelle für eine API aus:**

1. Melden Sie sich bei der API Gateway-Konsole an.

1. Wählen Sie eine vorhandene API oder erstellen Sie eine neue.

1. Wählen Sie im Hauptnavigationsbereich **API-Einstellungen**. 

1. Wählen Sie im Abschnitt **API-Details** die Option **Bearbeiten** aus. 

1.  Wählen Sie unter **API-Schlüsselquelle** die Option `Header` oder `Authorizer` aus der Drop-down-Liste aus.

1. Wählen Sie **Änderungen speichern ** aus.

------
#### [ AWS CLI ]

Mit dem folgenden [update-rest-api](https://docs.aws.amazon.com/cli/latest/reference/apigateway/update-rest-api.html)Befehl wird eine API aktualisiert, sodass die API-Schlüsselquelle wie folgt festgelegt wird`AUTHORIZER`:

```
aws apigateway update-rest-api --rest-api-id 1234123412 --patch-operations op=replace,path=/apiKeySource,value=AUTHORIZER
```

Damit der Client einen API-Schlüssel übermittelt, setzen Sie im vorherigen Befehl `value` auf `HEADER`.

------
#### [ REST API ]

Wenn Sie eine API-Schlüsselquelle für eine API über die API Gateway-REST-API auswählen möchten, rufen Sie wie folgt [https://docs.aws.amazon.com/apigateway/latest/api/API_UpdateRestApi.html](https://docs.aws.amazon.com/apigateway/latest/api/API_UpdateRestApi.html) auf:

```
PATCH /restapis/fugvjdxtri/ HTTP/1.1
Content-Type: application/json
Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20160603T205348Z
Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160603/us-east-1/apigateway/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-date, Signature={sig4_hash}

{
  "patchOperations" : [
    {
        "op" : "replace",
        "path" : "/apiKeySource",
        "value" : "HEADER"
    }
  ]
}
```

Damit ein Genehmiger einen API-Schlüssel zurückgibt, legen Sie den `value` in der vorherigen `AUTHORIZER`-Eingabe auf `patchOperations` fest.

------