Updating Platform Settings

You can adjust the default time zone and manage the Developer Portal from the Platform Settings page in the Management Portal.

Topics

• Setting the Default Time Zone

• Enabling or Disabling the Developer Portal

• Changing the Developer Portal URL

Setting the Default Time Zone

You can set the default time in which API Platform displays API usage and analytics data.

This allows everyone to view the same data regardless of the time zone in which they access the platform. As an example, Susan access the Management Portal from the US west coast and Tony accesses from the US east coast. If the default time zone is set to PST, Susan and Tony view the same API usage data when viewing analytics charts filtered to show data from Today, though Tony’s “today” starts at 3AM local time due to the time differential.

You must be assigned the Administrator role to set the default time zone.

To set the default time zone:

1. Click the Platform Settings tab.
2. On the General Settings page, select the time zone you want to use to display API usage and analytics data from the Time Zone Settings list, .
3. Click Save.

The default time zone is set. Analytics charts and other data are displayed in this time zone.

Enabling or Disabling the Developer Portal

Use the Platform Settings page to enable or disable the Developer Portal. Users attempting to access the Developer Portal when it is disabled receive a 404--Not Found error. You must be assigned the Administrator role to disable the Developer Portal.

To disable the Developer Portal:

1. Click the Platform Settings tab.
2. Click the (Developer Portal Settings) tab.
3. Click the Developer Portal switch to move it to the OFF position.
4. Click Save.

The developer portal is now disabled.

Note:

You can enable the Developer Portal by reversing these steps: click the Developer Portal switch to move it to the ON position, and then click Save.

Changing the Developer Portal URL

Change the Developer Portal URL if you have deployed it on premise. When you change the Developer Portal URL in the Management Portal, publication and preview links are updated to point to this location. You must be assigned the Administrator role to change the Developer Portal URL.

To change the Developer Portal URL

1. Click the Platform Settings tab.
2. Click the (Developer Portal Settings) tab.
3. In the Portal Server URL Configuration section, click the Custom button.
4. Enter the URL at which the APIs page on the Developer Portal can be accessed, such as http://example.com:7201/developers/apis.

   Note:

   The APIs page is available at <the Developer Portal base URL/apis>.

5. Click Save.

The Developer Portal URL has been changed. You can see the updated URL on the APIs List page for published APIs and other places throughout the Management Portal.

Hiding or Showing OAuth Client ID and Secret and Application Keys in the Developer Portal

Use the Client Security options on the Platform Settings page in the Management Portal to show or hide OAuth client IDs and secrets or application keys in the Developer Portal.

You must be assigned the Administrator role to configure the Client Security options.

1. Click the Platform Settings tab.
2. Click the (Developer Portal Settings) tab.
3. Configure Client Security options:
   1. Deselect Show OAuth 2.0 Client ID and Secret to hide, or select to display, these properties in the Developer Portal. This option is selected by default.
   2. Deselect Show Application Key to hide, or select to display, these properties in the Developer Portal. This option is selected by default.
4. Click Save.

The Client Security options you deselected are hidden, and the options you selected are displayed, in the Developer Portal.