This page describes how to create and configure an OData Service API, access existing OData APIs, and edit the configuration settings of existing OData APIs within Jitterbit Harmony API Manager.
OData is a flexible, REST-based protocol that is used to query multiple unique data sources and transform the data into a single, standard data model to be consumed by other applications and services. A common use case for an OData Service API is retrieving data from SAP and multiple databases, such as Oracle, MySQL, and SQL Server, to be consumed by Salesforce Connect.
API Manager is accessed from the Harmony Portal. The credentials you use depend on whether or not 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:
View this video to preview the steps to create an OData Service API:
<iframe src="https://player.vimeo.com/video/270682193" 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 with the step number 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.
On each page of Publish New API:
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 (for additional information, see https://www.w3.org/TR/cors/). 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. Click Set to accept the time.
. The service URL is created from the fields populated in step 1:
: 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, or NA):
|Region||Region Base URL|
/Prod:This is determined by the selection in the Environment field of step 1 and is the value in the URL prefix field of an environment. The URL prefix field, limited to a maximum of 48 characters, is populated at the time an environment is created. 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 of step 1.
/sapCustomerData:The value in the Service Root field of step 1. In the example, we allowed the value entered in the API Name field to autofill the Service Root field using camel case.
Entity (Project): Click on Entity (Project) to display the list of the Entities and associated projects available in the environment selected in step 1. Select your Jitterbit Entity from the list.
Response Type: Click on Response Type to display the list of response types (Final Target, System Variable, No Response). Select an appropriate 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 a type.
The assigned selections display in the table at the bottom of the page as shown here:
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 an 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 of the settings and selections made in the previous steps, 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.
To use the OData Service API with Salesforce Connect, continue with Setting Up Salesforce Connect to Consume an OData Service API.