Skip to end of metadata
Go to start of metadata

API Manager

Overview

Jitterbit offers the only end-to-end real-time API solution that provides connectivity, service creation, and API management all on a single cloud platform. Jitterbit gives today’s digital businesses the ability to access the most up-to-date information by creating real-time connectivity between your on-premise and cloud systems.

With Jitterbit you can expose any system as a secure, managed, real-time API that can be called and consumed by any other app. This means you can eliminate siloed technology, processes, and people, and enable seamless collaboration across departments, divisions, and other internal teams.

You can access the API Manager via the Harmony portal.

NOTE: The Harmony API platform was formerly referred to as Harmony LIVE! API.

Consolidated access to all API functionality from within the API Manager landing page. The API Manager consists of the following components, which are accessible based on user roles and permissions:

  • My APIs: 
    • The landing page where you create, edit, clone, delete, publish and manage all of your APIs.
    • View all of your APIs within one page in a card view format that includes the API name, description, lifecycle stage, last edit date and time stamp, edit by username. Hover over each card to view the API name, short description, version, View/Edit button.
    • Create and publish Custom and OData APIs following one easy 4 step process. Set the timeout or SSL only option and enable CORS or debug mode.
    • Clone an existing 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.
  • Portal Manager: 
    • The Portal Manager allows you to activate, customize, invite consumers, and control which APIs are exposed to consumers.
    • Automatically generates OpenAPI 2.0 (formerly known as Swagger 2.0) documentation for your APIs. 
      • OpenAPI requires CORS to be enabled for custom APIs.
      • API configuration changes will require you to select 'Regenerate Documents' in the Portal Manager to publish the changes.
    • Customize the auto generated OpenAPI documentation for each API via the embedded OpenAPI 2.0 editor within the portal.
    • Ability to customize your developer portal by importing your company logo, customize the portal header and description (for e.g. add terms and conditions, support information, contact us, etc.)
  • Portal:
    • The Portal allows API consumers to access OpenAPI 2.0 (formerly known as Swagger 2.0) documentation for the APIs you have published.

    • Internal and external developers can access the portal to discover, evaluate and consume APIs. 

    • Consumers can access the portal by invitation only. Consumers will receive an email with a direct link and instructions to complete their registration by creating a strong password and specifying a security question that will be used for password resets.

  • API Logs:
    • Enhanced API logging (includes debug logs) to provide publishers and consumers help in troubleshooting related issues.
    • Enhanced filtering options, date range options and visibility. 
    • View the summary log entry or expand to view the complete detail.
    • Ability to download logs as a CSV file.
  • Analytics:
    • Enhanced API analytics to provide publishers and consumers with metrics to track consumption and performance trends.
    • Multiple enhanced graphs for additional metrics.
    • Filter by environment, API, profile, status codes and versions as well as time periods and granularity of data (second, min, hour, day, week, month).
    • Ability to download analytics data as a CSV.
  • Security Profiles:  
    • Enhanced ability to create security profiles using anonymous, Basic and OAuth 2.0 authentication (with Google as the identity provider) with ability to restrict access based on domain names.
    • Ability to set rate limits, limit access to trusted IP ranges and set custom logging header.  

Frequently Asked Questions


Q: 
What is the concept behind the Harmony API Manager?

A: The Harmony API Manager allows you to design, orchestrate, and manage your APIs via 3 easy steps of (1) connect, (2) publish, and (3) manage. It provides real-time APIs for any cloud, on-premise, or mobile app.
 

Q: What can I connect with the Harmony API Manager?

A: You can connect anything. Design APIs with connectors for enterprise applications. Create composite APIs from multiple web services. Expose any ODBC or JDBC database as an API. You can create an API in any format (REST, SOAP, JSON, OData, etc.)

For an idea of specific endpoints you can connect, see Supported Endpoints and Protocols.

Q: Can I see a demo of the Harmony API Manager?

A: See this video demonstration of a custom API involving an "Internet of Things" use case: