Skip to end of metadata
Go to start of metadata

Introduction

The My APIs page is the API Manager landing page where you create, edit, clone, delete, publish, and manage all your APIs.

  • View all your APIs within one page in a card view or list view format. 
  • Statistics display the number of URLs that are currently published and in use against the total number of APIs provided under the organization's subscription. 
  • Create and publish Custom and OData APIs following one easy 4 step process.
  • Clone an existing Jitterbit API to create a new version of the existing API or create a new API with the ability to save it as a draft until you are ready to publish.
  • Create an API Proxy that passes through traffic to an existing external API and provides security and governance in a standard manner. 

TIP: Before creating an API, you should have already registered for Jitterbit Harmony, set up an environment and Agent Group (as described in the Jitterbit Quick Start Tutorial), and created a project (as described in the Cloud Studio Quick Start Guide or the Design Studio Quickstart Guide). A quick review of the Prerequisites section in the API Manager Quick Start Guide is also recommended prior to creating your API.

My APIs Index

API Manager is accessed from the Harmony Portal. The credentials you use depend on if your organization and account is configured to use Single Sign-On (SSO)

From the Harmony Portal landing page, select the API Manager card:

The My APIs index page displays, showing the repository of any existing APIs for the selected organization:

The My APIs index is the default API Manager landing page. To return to the My APIs index after switching to another view, use the My APIs dropdown:

To return to the API Manager landing page from other pages within the Harmony Portal:

  • From any page within the Harmony Portal, use the orange hamburger menu in the top left to select API Manager > My APIs.
  • From any page within API Manager, click the logo or words API Manager in the top left next to the hamburger menu.

URLs

  • Base URL: The base API URL for your org displays at the top of the My APIs page. The base URL is composed of your organization's org number, assigned at the time the subscription license is purchased (Format: JitterbitTrial#####), and your Harmony region (APAC, EMEA, NA).
    • APAC Region Base URL: JitterbitTrial#####.Jitterbit.cc
    • EMEA Region Base URL: JitterbitTrial#####.Jitterbit.eu
    • NA Region Base URL: JitterbitTrial#####.Jitterbit.net
  • API URLs Used: The subscription license purchased by your organization determines how many API URLs are allotted to your org. The number of API URLs currently used, and the number of API URLs allotted to your org, display at the top of the My APIs page. The number of API URLs used against your total allotment includes published Custom and published OData APIs. Cloned APIs are included once they are published. APIs that are saved as a draft are not included until they are published. Any API that is saved as Published with Draft is included as one URL being used.
  • Proxy URLs Used: The subscription license purchased by your organization determines how many Proxy URLs are allotted to your org. The number of Proxy URLs currently used, and the number of Proxy URLs allotted to your org, display at the top of the My APIs page. Proxy URLs that are published are included in your usage total. Cloned Proxy URLs are included in the usage total once they are published. Proxy URLs that are saved as a draft are not included until they are published. Any Proxy URL that is saved as Published with Draft is included as one URL being used.

Filter By

The Filter by dropdowns are usable from both the card view and the list view to limit the APIs displayed. The filters allow you to drill down and display APIs based on specific criteria across any combination of environments, profiles, statuses, or versions as needed.

Each filter displays a dropdown list of criteria from which you can select one or multiple criteria. The default value for each filter is All

The filters display along the top of the page to the right of the My APIs dropdown menu. Each filter is described below.

  • Environments: The dropdown displays a list of the environments created within the Organization. Click the checkbox to select one environment to display only APIs created in that environment. You can also select more than one environment to display a larger subset of your APIs. 

    NOTE: The available environments are for your selected organization. To switch organizations, in the top navigation bar, use the dropdown that appears between your name and Help. The default organization can be set from your My Account page (see Default Organization under Jitterbit Harmony Portal). 

  • Profiles: The dropdown displays a list of the security profiles created within the Organization. Click the checkbox to select one security profile to display only the APIs assigned to the selected profile. You can also select multiple profiles to display a larger subset of your APIs.
  • Status: The dropdown displays the API statuses. Click the checkbox to select one status. You can also select multiple statuses to view a larger subset of your APIs.

  • Types: The dropdown displays the API type. Click the checkbox to select one type or multiple boxes to select multiple types. 

Export an API

APIs can be exported from the API Index and saved to an .APK file. Click the Export API link. This opens the Export API page, where you will select an environment to export from and select one or more APIs to export. The selected APIs are exported to apis-export.apk in your default download folder. This file can then be imported into a different environment or organization. See API Exports and Imports for additional information.

Import an API

APIs that have been exported from API Manager can be imported from the API index. Click the Import API link. This opens the Import API page, where you will select the .APK file to import from and the environment to import into. You will then select one or more APIs to import from the .APK file. See API Exports and Imports for additional information.

Create a New Proxy

To create a new Proxy, click the New Proxy button.

For detailed instructions to create a new Proxy , see API Proxy

Create a New API

To create a new API, click the New API button.

For detailed instructions to create a new API, see API Creation and Configuration

View or Edit an Existing API

Existing APIs are displayed in the API index in either card view or list view.

Card View

Card view is the default view. If you are not in card view, to return to it, click the tile icon:

In card view, APIs are displayed as tiles, referred to as index cards. Each API index card 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 upon hovering over the card:

  • Front: The front of the card shows the API name, version, environment, API type (Custom, OData, Proxy), API status (Published, Draft, Published w/Draft), and last edited date and time, displayed as the local browser time.
  • Back: Hover over the card to display the back. The back of the card 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: Click the View/Edit button to open the API Summary and Confirmation page.
      • Within the Summary and Confirmation page:
        • Select the edit icon  to the right of the Settings section to change the API name or API description, as well as the time out, SSL, CORS, verbose logging, or debug logging settings. 
        • Select the edit icon  to the right of the Operations section to change the project, operation to trigger, method or response type.
        • Select the edit icon to the right of the Security Profiles section to change the assigned profile or create a new security profile. 
        • For detailed instructions to create or edit an API, see API Creation and Configuration.
    • Actions: Click the actions menu icon  to open a menu with additional actions:
      • API Logs: This opens the API Logs page, which displays processing logs as well as debug logs (if debug logging is enabled) for any API that has been executed.
      • Analytics: This opens the Analytics page, which displays the consumption and performance metrics for all your APIs.
      • Clone: This creates an exact copy of the existing draft or published API, except for the API Name, Service Root, and Version fields. The phrase "Copy of" is appended to the beginning of the text in the API Name and Service Root fields. The text "-2" is appended to the end of the existing version. The cloned API is immediately opened in a new Summary & Confirmation window. You can rename the API, edit selected information and then Save & Publish as a new API. You can change the version of the existing API and then Save as Draft until you are ready to publish the new version.
      • Export: This automatically exports the selected API to a file named apis-export.apk in your Downloads folder. This file can then be imported into a different environment or organization.
    • Copy URL: Click on this link to copy the API URL to your clipboard. You can then paste the URL into a browser and execute the API.

List View

To toggle to list view, click the list icon:

In list view, APIs are displayed in table format, with each column described below. Each column except for the one on the far right can be sorted by clicking on the column header.

  • Name: The name of the API. Clicking on the name opens the API Summary and Confirmation page.
  • Version #: The version of the API. You may have multiple versions of the same API including published and draft versions.
  • Environment: The environment where your API project resides, and the API is stored and executed.
  • Last Edited: The date and time the API was last published or saved as a draft, displayed as the local browser time.
  • Edited By: The name of the user who last published or saved the API as a draft.
  • Actions (...): Hover over the API row to reveal the actions in the rightmost column:
    • Edit: Click the edit icon  to view or edit the API and display the API Summary and Confirmation page. 
    • Copy Link: Click the copy link iconto 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: This opens the API Logs page, which displays processing logs as well as debug logs (if debug logging is enabled) for any API that has been executed.
      • Analytics: This opens the Analytics page, which displays the consumption and performance metrics for all your APIs.
      • Clone: This creates an exact copy of the existing draft or published API, except for the API Name, Service Root, and Version fields. The phrase "Copy of" is appended to the beginning of the text in the API Name and Service Root fields. The text "-2" is appended to the end of the existing version. The cloned API is immediately opened in a new Summary & Confirmation window. You can rename the API, edit selected information and then Save & Publish as a new API. You can change the version of the existing API and then Save as Draft until you are ready to publish the new version.
      • Export: This automatically exports the selected API to a file named apis-export.apk in your Downloads folder. This file can then be imported into a different environment or organization.


On This Page

Last updated:  Dec 06, 2019

  • No labels