Software AG Products 10.5 | Using CentraSite | CentraSite and API Gateway Integration | Consumer Application Mapping Details
 
Consumer Application Mapping Details
This section describes how the consumer applications and their property values defined and published from CentraSite are mapped into API Gateway.
A consumer application is published from CentraSite to API Gateway in the following scenarios:
*When publishing Virtual Services, CentraSite sends a list of registered consumer applications along with the VSD of the service to API Gateway.
API Gateway, in turn, performs the following operations when a Virtual Service associated with the consuming applications is published:
*Creates a SOAP or REST API for the Virtual SOAP Service or Virtual REST Service.
*Create an applications for the consuming application.
*Registers an application to the API.
*When republishing Virtual Services, CentraSite sends the updated list of registered consumer applications along with the VSD of the service to API Gateway.
API Gateway, in turn, performs the following actions when a Virtual Service associated with the consuming applications is published:
*Updates the details of an existing application with the recent changes.
*Creates an application for the newly defined consuming application.
*Unregisters an application that has been recently removed from the API.
*When unpublishing Virtual Services, CentraSite also unpublishes the list of consumer applications that were registered to the service.
API Gateway, in turn, performs the following operations when a Virtual Service is unpublished:
*When synchronizing consumer applications, API Gateway performs the following actions:
*Create a new consumer application and registers to the required API.
*Updates the details of an existing consumer application and the application's registration status for an API.
*Any consumer application provided by CentraSite but not associated to the Virtual Service is removed.
*Requesting API keys and OAuth2 tokens
Publishing of consumer applications from CentraSite to API Gateway is performed by invoking the API Gateway Deployer Service. The Deployer Service creates an application in API Gateway for each consumer application, API key, and OAuth2 token specified in the API publish request.
Application
The following table summarizes the mapping of an Application in CentraSite to an Application in API Gateway:
CentraSite
API Gateway
Notes
Application
Application
Key
Application ID
When an application with an UUID, say, XXX, is published from CentraSite, any existing application with the same UUID XXX in API Gateway is overwritten.
Name
Name
Description
Description
Type
Type
Version
Version
Not applicable
API access key
Not applicable
Client ID
Not applicable
Client secret
Not applicable
Client name
Not applicable
Scopes
*Name
*Description
Not applicable
Token lifetime
Not applicable
Token refresh limit
Not applicable
Redirect URIs
Application Identifiers
The following table summarizes the mapping of an Application's Identification in CentraSite to an Application's Identifiers in API Gateway:
CentraSite
API Gateway
Notes
Identification token
Other identifiers
*Token
Beginning with version 10.1, API Gateway offers the option Token by which incoming messages from a particular application can be recognized at run-time.
From IP-V4 Address
IP address range
To IP-V4 Address
IP address range
From IP-V6 Address
IP address range
To IP-V6 Address
IP address range
Partner Id
Partner identifier
Beginning with version 10.1, API Gateway offers the parameter Partner identifier to specify the third-party partner's identity.
Consumer Certificate
Client certificates
Not applicable
Claims
Not applicable
Other identifiers
*Hostname
*Token
*Username
*WS-Security username
*XPath
Note:
When an application with an UUID, say, XXX, is published from CentraSite, any existing application with the same UUID XXX in API Gateway is overwritten.
API Key
The following table summarizes the mapping of an Application's API key:
CentraSite
API Gateway
Notes
API Key
Application
Key
Application ID
Name
Name
When an application with an UUID, say, XXX, is published from CentraSite, any existing application with the same UUID XXX in API Gateway is overwritten.
Not applicable
Description
Not applicable
Created
API Key String
API access key
Not applicable
Client ID
Not applicable
Client secret
Note:
The identifiers of an API key in CentraSite are not mapped to API Gateway.
Note:
When an application with an UUID, say, XXX, is published from CentraSite, any existing application with the same UUID XXX in API Gateway is overwritten.
OAuth2 Token
The following table summarizes the mapping of an Application's OAuth2 token:
CentraSite
API Gateway
Notes
OAuth2 Token Client
Application
Key
Application ID
OAuth2 Client Name
Name
When an application with an UUID, say, XXX, is published from CentraSite, any existing application with the same UUID XXX in API Gateway is overwritten.
Not applicable
Created
Not applicable
API access key
OAuth2 Client Id
Client ID
OAuth2 Client Secret
Client secret
Note:
The identifiers of an API key in CentraSite are not mapped to API Gateway.
Note:
When an application with an UUID, say, XXX, is published from CentraSite, any existing application with the same UUID XXX in API Gateway is overwritten.