This page describes how to create and configure a new API, access existing APIs, and edit the configuration settings of existing APIs.
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). Once you are logged into the Harmony Portal, you can access the My APIs landing page as follows:
TIP: Before creating an API, you should have already registered for Jitterbit Harmony (through the Jitterbit Harmony website). You will also need to set up at least one environment , agent group, user, role, and member (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 Quick Start Guide). A quick review of the Prerequisites section in the API Manager Quick Start Guide is also recommended prior to creating your API.
View this video to preview the steps to create a custom API.
<iframe src="https://player.vimeo.com/video/270389151" width="640" height="360" frameborder="0" allowfullscreen></iframe>
When you access API Manager, if no APIs exist in the selected organization, this page will be blank. Click New API in the upper right side of the page to get started:
Selecting New API opens the Publish New API page. The process of creating and publishing a new API consists of four steps, each step is a separate page, and the step number is highlighted at the top of the page.
You can navigate back to a previous step by selecting the step numbers on top of the page, or you can select Cancel at the bottom of each page to stop the process at any time.
All special characters, other than the underscore, are not allowed in the service root or the final API URL.
Enable CORS: Click the checkbox to enable CORS. A warning note displays. Review the warning and go to https://www.w3.org/TR/cors/ for additional information. Select Continue to enable CORS or Cancel to disable CORS and close the popup window.
Click within the date field to display a calendar to set a longer period to run in debug mode. Two weeks is the maximum time allowed to enable running in debug mode.
Select the day in the calendar.
Click in the time field. Click the up and down arrows to set the hour and minutes.
he service URL is created as the fields are populated within the settings in . Tstep 1:
https://JitterbitTrial######.jitterbit.org: This is the base API URL for your org. 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).
/ProdS: This is determined by the selection in the Environment field in step 1 and is the value in the URL Prefix field of the environment. The URL Prefix field is populated at the time the environment is created. The URL prefix is limited to a maximum of 48 characters. Detailed instructions for setting up environments are available within our existing Management Console documentation on the Environments page.
/v1.0: The value entered in the Version# field in step 1.
/contactList: This is the value in the Service Root field in step 1. In the example, we allowed the value entered in the API Name field to autofill the Service Root field using camel case.
Projects: Click on Projects to display the list of the projects available in the environment selected in step 1. Select your API Project from the list.
Response Type: Click on Response Type to display the list of response types (Final Target, System Variable, No Response). Select the Response Type from the list.
TIP: To help determine the correct response type, select each of the three types individually and hover over the information icon to display a description, requirements, and consequences of selecting each type.
The assigned selections display in the table at the bottom of the page as shown in the image below.
There are three types of authentication available in API Manager: Anonymous, Basic, and OAuth 2.0. OAuth 2.0 is currently limited to Google, Salesforce, or Okta as the identity provider (IdP). See Harmony API Security and Security Profiles for additional information.
Select: Click on Select to display a list of existing security profiles. Select the appropriate Profile from the list.
Create New Profile: If an existing profile is not appropriate, click on the Create New Profile link to open the Security Profiles page and create a new profile (see Security Profile Creation and Configuration). When you save the new profile, you are returned to step 3 to assign the new profile to the new API you are creating.
The Summary & Confirmation page displays all the settings and selections made within step 1 through step 3, allowing you to review, confirm, and edit the information prior to publishing the API. Each section of this page corresponds to a previous step.
apis-export.apkin your Downloads folder. This file can then be imported into a different environment or organization.
Select Continue to completely delete the API. Select Cancel if you want to close the popup window and return to the Summary & Confirmation page.
After selecting Save & Publish, the API is live and accessible based on the assigned security profiles and ready to be consumed by other applications and services.