Configurare le chiavi API utilizzando l'API REST di 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 informazioni su come creare e distribuire un'API mediante chiamate API REST, consultare rispettivamente restapi:create e deployment:create.

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

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 o importazione di chiavi API

Per creare o importare una chiave API, procedi in uno dei seguenti modi:

• Invoca apikey:create per creare una chiave 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. Per sapere come configurare un piano di utilizzo, consultare Creazione, configurazione e test dei piani di utilizzo mediante la CLI e l'API REST di API Gateway.