My APIs¶

Introduction¶

The My APIs page allows you to manage Custom APIs, OData Services, and Proxy APIs created through API Manager. This page describes the user interface of the My APIs page within API Manager.

For information on API configuration in API Manager, see API configuration.

Accessing the My APIs Page¶

The My APIs page is the landing page for API Manager, which is accessed directly through the Harmony Portal.

The My APIs page can also be accessed from the Harmony Portal menu, or from other pages within API Manager:

• From the Home or Downloads pages, or from the Cloud Studio, Vinyl, Marketplace, Management Console, EDI, or Citizen Integrator applications, use the Harmony Portal menu in the top left to go to API Manager > My APIs:

  

• From the Portal Manager, API Logs, Analytics, Security Profiles, Trusted IP Groups, or API Groups pages, use the API Manager navigation menu to select My APIs:

  

My APIs Page Header¶

Information about your organization, in-app navigation, controls to filter the display, and several actions are available along the top of the My APIs page:

• Base URL: The base API URL of the Harmony organization.
• API URLs Used: The number of currently used API URLs out of the total number of API URLs allowed by the organization's subscription. Currently used API URLs consist of those used by published Custom and OData APIs and their published clones. Draft APIs do not count as in-use API URLs.
• Proxy URLs Used: The number of currently used Proxy API URLs out of the total number of Proxy API URLs allowed by the organization's subscription. Currently used Proxy API URLs consist of those used by published Proxy APIs and their published clones. Draft APIs do not count as in-use API URLs.
• Navigation: Use the API Manager navigation menu to navigate between pages of API Manager, including Portal Manager, API Logs, Analytics, and Security Profiles.
• View: Click the tile view or list view icon to toggle the format used to display APIs on this page. Tile view is the initial default view. The next time you load the My APIs page, the last selected view is preselected.

• Filter By: These filters are available to limit the APIs displayed on this page. The next time you load the My APIs page, the last selected filters are preselected.

  • Environments: Use the dropdown to select one or more existing environments to limit APIs to those in the selected environments.
  • Profiles: Use the dropdown to select one or more existing security profiles to limit APIs to those that are assigned the selected security profiles.

  • Status: Use the dropdown to select one or more of these possible statuses:

    • Published: APIs that have been published and do not have an unpublished draft.

    • Published + Debugging: APIs that have been published and have an unpublished draft.

      Note

      This status is mislabeled; the word Debugging should read Draft.

    • Draft: APIs that have an unpublished draft and have not been published.

  • Types: Use the dropdown to select one or more API types, including Custom APIs, OData Services (OData APIs), and Proxy APIs.

• Export API: Click to open the API export screen, where you can export selected APIs in APK format (see Exporting and Importing APIs).

• Import API: Click to open the API import screen, where you can import APIs in APK format (see Exporting and Importing APIs).
• New Proxy: Available only if there is a Proxy API URL available, click to open the Proxy API configuration screen to create a new Proxy API (see Proxy API configuration).
• New API: Available only if there is an API URL available, click to open the API configuration screen to create a new Custom or OData API (see Custom API configuration or OData Service configuration).

Tile View¶

To access tile view, select the tile view icon:

Tile view displays APIs as tiles. Each tile has a front and a back that can be "flipped" over to reveal additional API information and actions. The front is displayed by default. The back is displayed on hovering over the tile:

• Front: The front of the tile shows the API name, version, environment, API type (Custom, OData, or Proxy), API status (Published, Published w/ Draft, or Draft), and last saved date (in DD/MM/YY format) in local browser time.

• Back: The back of the tile shows the API name, environment, API description, and name of the user who last edited the API. In addition, these actions are available:

  • View/Edit: Opens the API configuration screen (see Custom API configuration, OData Service configuration, or Proxy API configuration).

  • Actions: Click the actions menu icon to open a menu with additional actions:

    • API Logs: Opens the API Logs page, which displays processing and debug logs (if debug logging is enabled) for all APIs.

    • Analytics: Opens the Analytics page, which displays consumption and performance metrics for all APIs.

    • Clone: Opens the API configuration screen (see Custom API configuration, OData Service configuration, or Proxy API configuration), prepopulated with the configuration details of the cloned API and updated defaults for these fields:

      • API Name: The API name is prepended with Copy of.
      • Service Root: The service root is prepended with Copyof.
      • Version: The version is appended with -2. This number does not increment with additional clones.

    • Export: Initiates a download of the API to a file named apis-export.apk. This file can then be imported into a different environment or organization (see Exporting and Importing APIs).

    • Delete: Permanently deletes the API. On clicking Delete, a confirmation dialog is displayed to confirm that you want to permanently delete the API.

      Caution

      OpenAPI documentation displayed on the Portal page is not automatically updated when you delete an API. To update OpenAPI documentation, do so through the Portal Manager page.

  • Copy URL: Copies the API URL to your clipboard.

List View¶

To access list view, select the list view icon:

List view displays APIs in a table, with each column described below. Each column except for the Actions column can be sorted by clicking the column header. Additional actions are displayed by hovering over the API row:

• Name: The name of the API. Click the name to open the API configuration screen (see Custom API configuration, OData Service configuration, or Proxy API configuration). The color of the icon to the left of the API name indicates the category of the API status:

  Icon	Color	Category
  	Green	The API is published.
  	Yellow	The API is published with a draft.
  	Open Green	The API is a draft.

• Version Number: The version of the API, as entered during API configuration.

• Type: The type of API, either Custom (CUSTOM_API), OData (ODATA), or Proxy (API_PROXY).

• Environment: The environment where the API is stored.

• Last Edited: The last saved date (in M/D/YYYY format) in local browser time.

• Edited By: The name of the user who last saved the API.

• Actions: Hover over the API row to reveal additional actions:

  • Edit: Click the edit icon to open the API configuration screen (see Custom API configuration, OData Service configuration, or Proxy API configuration).

• Copy URL: Click the copy URL icon to copy the API URL to your clipboard.

  • Description: Click the description icon to view the API description.

  • Additional Actions: Click the actions menu icon to open a menu with additional actions:

    • API Logs: Opens the API Logs page, which displays processing and debug logs (if debug logging is enabled) for all APIs.
    • Analytics: Opens the Analytics page, which displays consumption and performance metrics for all APIs.

    • Clone: Opens the API configuration screen (see Custom API configuration, OData Service configuration, or Proxy API configuration), prepopulated with the configuration details of the cloned API and updated defaults for these fields:

      • API Name: The API name is prepended with Copy of.
      • Service Root: The service root is prepended with Copyof.
      • Version: The version is appended with -2. This number does not increment with additional clones.

    • Export: Initiates a download of the API to a file named apis-export.apk. This file can then be imported into a different environment or organization (see Exporting and Importing APIs).

    • Delete: Permanently deletes the API. On clicking Delete, a confirmation dialog is displayed to confirm that you want to permanently delete the API.

      Caution

      OpenAPI documentation displayed on the Portal page is not automatically updated when you delete an API. To update OpenAPI documentation, do so through the Portal Manager page.

• Row Count: The number of APIs displayed in the table.