

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

# x-amazon-apigateway-apipropriété -key-source
<a name="api-gateway-swagger-extensions-api-key-source"></a>

 Spécifiez la source qui recevra une clé API pour limiter les méthodes d’API qui requièrent une clé. Cette propriété d’API est de type `String`. Pour plus d’informations sur la configuration d’une méthode pour exiger une clé d’API, consultez [Configuration d’une méthode pour utiliser des clés d’API avec une définition OpenAPI](api-key-usage-plan-oas.md).

Spécifiez la source de la clé d’API pour les demandes. Les valeurs valides sont :
+  `HEADER` pour recevoir la clé d’API à partir de l’en-tête `X-API-Key` d’une demande. 
+ `AUTHORIZER` pour la réception de la clé d’API à partir de l’élément `UsageIdentifierKey` à partir d’un mécanisme d’autorisation Lambda (anciennement appelé mécanisme d’autorisation personnalisée).



 

## x-amazon-apigateway-apiexemple de -key-source
<a name="api-gateway-swagger-extensions-api-key-source-example"></a>

L’exemple suivant définit l’en-tête `X-API-Key` en tant que source de clé d’API.

------
#### [ OpenAPI 2.0 ]

```
{
  "swagger" : "2.0",
  "info" : {
    "title" : "Test1"
   },
  "schemes" : [ "https" ],
  "basePath" : "/import",
  "x-amazon-apigateway-api-key-source" : "HEADER",
   .
   .
   .
}
```

------
#### [ OpenAPI 3.0.1 ]

```
{
  "openapi" : "3.0.1",
  "info" : {
    "title" : "Test1"
  },
  "servers" : [ {
    "url" : "/{basePath}",
    "variables" : {
      "basePath" : {
        "default" : "import"
      }
    }
  } ],
  "x-amazon-apigateway-api-key-source" : "HEADER",
   .
   .
   .
}
```

------