Impostare le chiavi API utilizzando la console API Gateway

Per configurare le chiavi API, completa queste operazioni:

• Configura i metodi API in modo che richiedano una chiave API.

• Crea o importa una chiave API per l'API di una regione.

Prima di impostare le chiavi API, è necessario aver creato un'API e averla distribuita in una fase. Una volta creata una chiave API, non può essere modificata.

Per istruzioni su come creare e distribuire un'API utilizzando la console API Gateway, consulta rispettivamente Sviluppa API REST in API Gateway e Implementa le API REST in API Gateway.

Dopo aver creato una chiave API, è necessario associarla a un piano di utilizzo. Per ulteriori informazioni, consulta Creazione, configurazione e test dei piani di utilizzo con la console API Gateway.

Nota

Per informazioni sulle best practice da prendere in considerazione, consulta Best practice per le chiavi API e i piani di utilizzo.

Richiesta di una chiave API per un metodo

La procedura seguente mostra come configurare un metodo API in modo che richieda una chiave API.

Per configurare un metodo API in modo che richieda una chiave API

1. Accedere alla console API Gateway all'indirizzo https://console.aws.amazon.com/apigateway.

2. Scegliere una REST API.

3. Nel riquadro di navigazione principale di API Gateway, scegliere Resources (Risorse).

4. In Resources (Risorse) creare un nuovo metodo o sceglierne uno esistente.

5. Nella scheda Richiesta metodo, in Impostazioni richiesta metodo, scegli Modifica.

   

6. Seleziona Chiave API necessaria.

7. Selezionare Salva.

8. Distribuisci o ridistribuisci l'API per rendere effettivo il requisito.

Se l'opzione Chiave API necessaria è impostata su false e non si esegue la procedura precedente, la chiave API associata a una fase API non viene utilizzata per il metodo.

Creazione di una chiave API

Se hai già creato o importato chiavi API da usare con i piani di utilizzo, puoi ignorare questa procedura e quella successiva.

Per creare una chiave API

1. Accedere alla console API Gateway all'indirizzo https://console.aws.amazon.com/apigateway.

2. Scegliere una REST API.

3. Nel riquadro di navigazione principale di Gateway API, scegli Chiavi API.

4. Scegli Crea chiave API.

   

5. In Nome, immetti un nome.

6. (Facoltativo) In Description (Descrizione), immettere una descrizione.

7. In Chiave API, scegli Genera automaticamente per fare in modo che Gateway API generi il valore della chiave oppure scegli Personalizza per creare il tuo valore di chiave.

8. Selezionare Salva.

Importazione di chiavi API

La procedura seguente descrive come importare chiavi API da usare con i piani di utilizzo.

Per importare chiavi API

1. Accedere alla console API Gateway all'indirizzo https://console.aws.amazon.com/apigateway.

2. Scegliere una REST API.

3. Nel riquadro di navigazione principale, scegli Chiavi API.

4. Scegli il menu a discesa Operazioni e quindi Importa chiavi API.

5. Per caricare un file di chiavi con valori separati da virgole, scegli Scegli file. Puoi anche immettere le chiavi nell'editor di testo. Per informazioni sul formato del file, consulta Formato file chiave API di API Gateway.

6. Scegli Errore su avvertenze per arrestare l'importazione se si verifica un errore oppure Ignora avvisi per continuare a importare voci di chiavi valide in caso di presenza di avvisi.

7. Scegli Importa per importare le tue chiavi API.