Configurazione di chiavi API per REST API in Gateway API - Amazon API Gateway
Richiesta di una chiave API per un metodoCreazione di una chiave APIImportazione di chiavi API

Configurazione di chiavi API per REST API in Gateway API

Per configurare le chiavi API, completa queste operazioni:

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

  • Crea o importa in una Regione una chiave API per l’API.

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 Sviluppo di REST API in Gateway API e Implementazione di REST API in Gateway API.

Dopo aver creato una chiave API, è necessario associarla a un piano di utilizzo. Per ulteriori informazioni, consulta Configurazione di piani di utilizzo per REST API in Gateway API.

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.

AWS Management Console
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.

    Aggiunta di una chiave API a un metodo

  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.

AWS CLI

Il comando put-method seguente crea un metodo PUT che richiede una chiave API:

aws apigateway put-method \
    --rest-api-id 1234123412 \
    --resource-id a1b2c3 \
    --http-method PUT \
    --authorization-type "NONE" \
    --api-key-required

Il comando update-method seguente aggiorna un metodo esistente in modo che richieda una chiave API:

aws apigateway update-method \
    --rest-api-id 1234123412 \
    --resource-id a1b2c3 \
    --http-method PUT \
    --patch-operations op="replace",path="/apiKeyRequired",value="true"
REST API

Per configurare un metodo in modo che richieda una chiave API, procedi in uno dei seguenti modi:

  • Invoca method:put per creare un metodo. Imposta apiKeyRequired un true nel payload di richiesta.

  • Invoca method:update per impostare apiKeyRequired su true.

Creazione di una chiave API

La procedura seguente mostra come creare una chiave API. Non tenere conto di questo passaggio se si desidera importare la chiave API.

AWS Management Console
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.

    Creazione di chiavi API per i piani di utilizzo

  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.

AWS CLI

Il comando create-api-key seguente crea una chiave API:

 aws apigateway create-api-key \
    --name 'Dev API key' \
    --description 'API key for Devs' \
    --enabled
REST API

Invoca apikey:create per creare una chiave API.

Importazione di chiavi API

La procedura seguente descrive come importare le chiavi API. Non tenere conto di questo passaggio se è già stata creata una chiave API.

AWS Management Console
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.

AWS CLI

Il comando import-api-keys seguente importa una chiave API:

aws apigateway import-api-key \
    a--body fileb://keys.csv \
    --format csv
REST API

Invoca apikey:import per importare una chiave API da un file. Per il formato file, consulta Formato file chiave API di API Gateway.

Non è possibile modificare il valore della nuova chiave API. Dopo aver creato l’API, si configura un piano di utilizzo. Per ulteriori informazioni, consulta Configurazione di piani di utilizzo per REST API in Gateway API.