Generate api key

1. Sign in to the Developer Portal.

   https://<hostname>:9443/devportal

2. Click APIs and click on the respective API (e.g., PizzaShackAPI).

3. Click API Keys from the left menu of the API.

   

4. Click Generate API Key and provide a Key Name.

   

5. Optionally, configure the validity period before generating the key.

   By default, the API Key does not expire. To set an expiry, select the required validity period option from the drop-down. For a custom validity period, enter the expiry time in days.

6. Click GENERATE API KEY.

7. Copy the generated API key.

   

Once the API key is generated, the steps to use it depend on whether the API requires a subscription. Follow the relevant section below.

For subscription-enabled APIs

A valid subscription must exist and the generated API key must be associated with a subscribed application before it can be used to invoke the API.

1. Click Subscriptions from the left menu of the API.

2. Select an application and a throttling policy.

   Note

   API Keys can be associated with any application type — JWT or OAuth.

3. Click Subscribe.

   

4. Click Associate on the API key to link it to the subscribed application.

   

5. Select the application from the drop-down and click ASSOCIATE.

   

   Alternatively, you can associate the API key from the subscribed application's API Keys page.

   

   Select the API and the generated API key from the drop-down and associate.

   

For subscriptionless APIs

The generated API key can be used directly to invoke a subscriptionless API without any subscription or application association.

Optionally, you can associate the API key with an application to gain usage insights and analytics. To do so, follow steps 4–5 above.