Configura API le chiavi utilizzando la console Gateway API - Amazon API Gateway

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

Configura API le chiavi utilizzando la console Gateway API

Per configurare API le chiavi, procedi come segue:

  • Configura API i metodi per richiedere una API chiave.

  • Crea o importa una API chiave per loro API in una regione.

Prima di impostare API le chiavi, è necessario averne creata una API e distribuita in una fase. Dopo aver creato un valore API chiave, non può essere modificato.

Per istruzioni su come creare e distribuire e utilizzare la console API Gateway, vedete rispettivamente Sviluppa REST APIs in API Gateway eImplementazione REST APIs in Gateway API. API

Dopo aver creato una API chiave, è necessario associarla a un piano di utilizzo. Per ulteriori informazioni, consulta Crea, configura e testa i piani di utilizzo con la console API Gateway.

Nota

Per informazioni sulle best practice da prendere in considerazione, consulta Le migliori pratiche per API chiavi e piani di utilizzo.

Richiede una API chiave per un metodo

La procedura seguente descrive come configurare un API metodo per richiedere una API chiave.

Per configurare un API metodo in modo da richiedere una API chiave
  1. Accedere alla console API Gateway all'indirizzo https://console.aws.amazon.com/apigateway.

  2. Scegli un RESTAPI.

  3. Nel pannello di navigazione principale del API Gateway, scegli Risorse.

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

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

    Aggiungi una API chiave a un metodo
  6. Seleziona APIla chiave richiesta.

  7. Selezionare Salva.

  8. Implementa o ridistribuisci il API affinché il requisito abbia effetto.

Se l'opzione APIchiave richiesta è impostata su false e non si eseguono i passaggi precedenti, per il metodo non viene utilizzata alcuna API chiave associata a una API fase.

Crea una API chiave

Se hai già creato o importato API chiavi da utilizzare con i piani di utilizzo, puoi saltare questa procedura e la successiva.

Per creare una chiave API
  1. Accedi alla console API Gateway all'indirizzo https://console.aws.amazon.com/apigateway.

  2. Scegli un RESTAPI.

  3. Nel pannello di navigazione principale del API Gateway, scegli i APItasti.

  4. Scegli Crea API chiave.

    Crea API chiavi per i piani di utilizzo
  5. In Nome, immetti un nome.

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

  7. Per APIchiave, scegli Generazione automatica per fare in modo che API Gateway generi il valore della chiave oppure scegli Personalizzato per creare il tuo valore di chiave.

  8. Selezionare Salva.

Importa API chiavi

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

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

  2. Scegli un RESTAPI.

  3. Nel riquadro di navigazione principale, scegli i APItasti.

  4. Scegli il menu a discesa Azioni, quindi scegli Importa API chiavi.

  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 APIFormato del file API della chiave 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 API chiavi.