API-Portal Configuration Parameters

SOA Governance and API Management : Administering API Portal : Configuring API-Portal : Configuring CentraSite, Mediator, and API-Portal : API-Portal Configuration Parameters

This section contains a description of the parameters you can specify in the API-Portal configuration file (apiportal.properties). This configuration file contains parameters specific to API-Portal data analysis. The file is located in the Software AG_directory \API-Portal\server\bin\work\work_apiportalbundle_m\base\webapps\abs\WEB-INF\classes\com\aris\modeling\server\webapp\apiportal\configuration directory.

To set parameters in the apiportal.properties file, stop API-Portal, and then edit the file directly with a text editor. After you save the changes, restart (start) API-Portal.

The server uses default values for many of the parameters. If a parameter has a default, it is listed with the description of the parameter. If the service request must be routed through a proxy server, these properties specify the proxy server alias for the proxy server through which API-Portal routes the HTTP/S request.

apiportal.analytics.

apiportal.analytics.enabled

Specifies whether API-Portal collects analytics data. When the apiportal.analytics.enabled parameter is set to true, API-Portal collects analytics data. When the parameter is set to false, API-Portal does not collect analytics data. The default is true.

apiportal.analytics.enabled.category

When API-Portal is set to collect analytics data, use the apiportal.analytics.enabled.category property to identify which categories of data will be collected. API-Portal analytics collects three different categories of data: PageViews, UserAudit, and AccessTokenAudit. If you specify multiple categories, separate the names with commas (,).

The default is PageViews,UserAudit,AccessTokenAudit

apiportal.proxy.

apiportal.proxy.url

Specifies the proxy server URL used to communicate with the services through the Internet.

Use the format http://host:port

where host is the host name or IP address of the proxy server and port is the port number of the proxy server.

apiportal.proxy.username

Optional. If your proxy server requires authentication, use this parameter to specify the username the proxy server uses to authenticate incoming requests.

apiportal.proxy.password

Optional. If your proxy server requires authentication, use this parameter to specify the password the proxy server uses to authenticate incoming requests.

apiportal.proxy.noProxyHosts

Specifies the servers that API-Portal connects to directly and not through a proxy server.

Use the format host_1|host_2|host_n

where host is the host name or IP address of the server. You can specify a list of servers, each separated by a |. You can also specify a wildcard character (*) for matching.

For example:

apiportal.proxy.noProxyHosts=localhost|127.0.0.1|*.int.abc.org

apiportal.geo.

apiportal.geo.service.url

When resolving the location of the user who is accessing API-Portal based on the IP address of the client, API-Portal uses the external service, telize.com, to resolve the location based on the IP address of the client.

The value for this property must be: http://www.telize.com/geoip/

If you are using a proxy server, ensure that you also set the properties apiportal.proxy.url, apiportal.proxy.username, and apiportal.proxy.password to ensure API-Portal can communicate the external service.

Contact Support | Community | Feedback