Satisfying Key and OAuth Token Generation Requirements

For a user to consume an API with the API key or an OAuth token, the following prerequisites must be met:

Ensure that you have configured the API Consumption Settings so that the API is configured for either API key authentication or OAuth2 authentication, as described in Configuring the API Consumption Settings.

Ensure that a run-time gateway instance (for example, Mediator) is up and running. For information on creating and managing gateways, see Run-Time Governance with CentraSite.

Sometimes you might have to require an approval to generate an API key or OAuth token. If you selected the Require Approval option when you configure the API's consumption settings, CentraSite will not generate the API key or OAuth token until the required approvals are obtained. However, if an approval workflow is not configured for the API, the key or OAuth token is generated.

Once the API key or OAuth 2.0 request is approved by the designated approvers, an email notification is sent to both the API provider and API consumer.

CentraSite provides predefined email templates intended to be used for the API key or OAuth token generation. By default, these templates are configured in the centrasite.xml file. But, if you do not want to use the predefined email templates, you can create your own templates and configure the centrasite.xml file as necessary. For more information on how to configure the email templates for API key or OAuth token generation, see Configuring the Email Templates for API Key or OAuth Token Generation.

For more information on how to configure the email notifications for API key or OAuth token generation in the CentraSite Business UI, see Configuring the API Consumption Settings.