API Gateways settings

Access  ARCAD-API Server →  Embedded Production Server → API Gateway Settings

ARCAD-API is compatible with any API gateway, however some configuration is required to use some of them. In the production server, you can set up and configure the connections to the API gateways.

Reference

The ARCAD-API Server's default configuration for API gateways are defined in the its configuration view. Refer to:

Defining the APIGEE Edge Settings,

Defining the API Gateway General Settings.

ARCAD-API provides the necessary mechanisms to register a Web Service in  Google APIGEE as an API Proxy.

These settings allows the gateway administrator to define the information required:

  • to connect to the APIGEE server,
  • to define the target organization,
  • to define some technical information related to the registration of an API Proxy.

Define the APIGEE settings

APIGEE Admin. URL
The URL of the APIGEE server.
APIGEE Login and APIGEE Password
The user login and password to connect to the APIGEE server.
APIGEE Organization
The name of the target organization.
APIGEE Environement
The name of the environment on which the ARCAD API credential will be created.
Credential ARCAD API KVM name
The name of the Key Value Map used to register the ARCAD API credential.

Save the changes (, Ctrl+S or File > Save).

The registration of an APIGEE API Proxy is done by sending a zip file to the APIGEE server. This zip file contains a directory where all the required definition .xml files are stored.

The definition of an APIGEE API Proxy could contain a lot of sub-definitions to match the Enterprise policies. Because ARCAD API is not a APIGEE server front-end (this means that it does not provide a Graphical User Interface to APIGEE), it is not possible to define all these parameters at ARCAD API level.

To solve this point, ARCAD API offers the capability to import APIGEE API Proxy Declaration Templates that will be used during the registration process.

A template is a zip file that contains all the required definition of an APIGEE API Proxy in which we will substitute some value, before registering an API Proxy, to make it point to the right web service.

Step 1   To access the New APIGEE Templates wizard, either click the Create icon in the toolbar, or right-click anywhere in the list and select Create.

Step 2   Define the Name and Description for the template. These values are required to create a new template but can be edited later.

Note

 Editing a template allows you to only change the name or the description of the template. If you want to change the template content, you need to use the  Update Template option.

Step 3   In the File Name field, click the  Browse icon to select an API Proxy zip file.

Step 4   Check the Variabilize the package before import box to add automatically the substitution variables at the right place.

Step 5    Click Finishto start the import of the information from the file.

Result   When the import is finished, the new template is created and is displayed in the  APIGEE Templates search view. The template can now be used to define an APIGEE API Proxy.

Important!

When you update an APIGEE template, all the configuration defined previously for the template will be lost.

Step 1   To update a template, either right-click on it in the  APIGEE Templates search view then select  Update, select the item then click the Update icon in the toolbar.

Step 2   In the File Name field, click the  Browse icon to select a new API Proxy zip file.

Step 3   Check the Variabilize the package before import box to add automatically the substitution variables at the right place.

Step 4    Click Finishto start the import of the information form the file.

Result   When the import is finished, the template is updated and is displayed in the  APIGEE Templates search view.

For the package variabilization process, some substitution variables are added in the following files:

  • apiproxy.xml
  • targets/default.xml

On the apiproxy.xml file

The /APIProxy/Basepaths text is replaced by:

Copy 
/${arcadapi.versiontag}/${arcadapi.rootcontext}

On the targets/default.xml file

The TargetEndpoint/HTTPTargetConnection/URL text is replaced by:

Copy 
${arcadapi.baseurl}${arcadapi.execroute}/${arcadapi.packagecode}/${arcadapi.versiontag}/${arcadapi.rootcontext}

The TargetEndpoint/HTTPTargetConnection/URL/Path text is replaced by:

Copy 
${arcadapi.execroute}/${arcadapi.packagecode}/${arcadapi.versiontag}/${arcadapi.rootcontext}
Important!

The name of the proxy descriptor file must absolutely be apiproxy.xml. It means that you need to change its name manually if you decide to import a template based on a downloaded API Proxy revision because in that case, the name of the descriptor file is by default the name of the related API proxy.

Substitution Variable
Substitution Variable Value
${arcadapi.versiontag} The Version Number of the selected version tag
${arcadapi.rootcontext} The Web Service of the selected version tag
${arcadapi.baseurl} The public URL of the ARCAD-API Server
${arcadapi.execroute} /arcapi/exec
${arcadapi.packagecode} The code of the related Production Package
Important!

The value used to replace the variable ${arcadapi.baseurl} comes from the field ARCAD-API Base URL of the ARCAD-API - Commons Settings/API Gateway General Settings server settings.

The values used to create the KVM ARCAD-API Credential comes from the fields ARCAD-API Use*r and *ARCAD-API Password of the ARCAD-API - Commons Settings/API Gateway General Settings server settings.

Reference

Refer to Defining the API Gateway General Settings.

The web services provided by ARCAD API can be invoked from a  WSO2 gateway using JSON Web Token-based authentication.

The WSO2 API Gateway can be used to call ARCAD API Web Service using a JWT as an authentication mechanism. To validate a JWT, the WSO2 Public Key used to encode the token is required.

Define the WSO2 settings

WSO2 API Manager Admin. URL
The URL of the WSO2 API Manager server.
Login and Password
The user login and password to connect to the WSO2 API Manager server.
Organization
The name of the target organization.
Client ID and Secret ID
The Client ID and the Client Secret ID of the target organization.
JWT Validation - Validation public key
Enter the WSO2 Public Key in to the Validation Public Key field of the JWT Validation section. To find the WSO2 Public Key, you need to export it from the wso2carbon.jks file.

Save the changes (, Ctrl+S or File > Save).

Define the  Kong gateway connection properties.

Kong API Administration URL

Enter the Admin URL to connect to the Kong Server.

http://<kong_server_address>:<admin_port>

Generally the port used is 8001.

Define the Kong settings

Reference

For more information about registering your API(s) on the Kong server, refer to Promoting versions to the Kong server.