Skip to main contentCloud Native Bootcamp

API Connect

API Connect

API Connect is a way to quickly create API’s and microservices using Node.js and Java runtimes. API Connect allows you to easily create, run, manage and secure API’s in one offering.


api connect components


Cloud Manager

The Cloud Manager is used for on-premise API Connect instances. The Cloud Administrator will use the Cloud Manager UI for the following:

  • Define the Cluster of Management Servers, Gateways, and Containers.
  • Manage the topology of the servers and containers.
  • Manage the servers in the cloud.
  • Monitor Cloud Health.
  • Manager User Access Controls.
  • Adding user registries for authenticating users and securing APIs, and configure the secure transmission of data.

The Developer Toolkit

The developer toolkit provides the tools for modeling, developing, and testing APIs and LoopBack® applications. The developer toolkit includes a command line interface (CLI). It also incorporates LoopBack, an open source Node.js framework.

API developers use the API management functions in the API Manager or the CLI to create draft API definitions for REST and SOAP APIs, or for OAuth provider endpoints that are used for OAuth 2.0 authentication. The API definitions can be configured to add the API to a Product, add a policy assembly flow (to manipulate requests/responses), and to define security options and other settings. APIs can then be tested locally prior to publishing, to ensure they are defined and implemented correctly.

API Manager

The API Manager provides a user interface that facilitates promotion and tracking of APIs that are packaged within Products and Plans. API providers can move the Products through their lifecycle, and manage the availability and visibility of APIs and Plans.

Catalogs and Spaces are created in the API Manager to act as staging targets through which APIs, Plans, and Products are published to consumer organizations. API providers can stage their Products to Catalogs or Spaces, and then publish them to make the APIs in those Products visible on a Developer Portal for external discovery.

To control access to the available API management functions, users in the provider organization can be set up in the API Manager UI with assigned roles and permissions. API providers can also use the UI to manage the consumer organizations that sign up to access their APIs and Plans. Developer communities can additionally be created as a way of grouping together a collection of consumer organizations to whom a particular set of Products and Plans can be made available.

The API Manager UI also includes functions to manage the security of the API environment, and provides access to analytics information about API invocation metrics within customizable dashboard views.

API Gateways

Gateways enforce runtime policies to secure and control API traffic, provide the endpoints that expose APIs to the calling applications, and provide assembly functions that enable APIs to integrate with various endpoints. They also log and report all API interactions to the API Connect analytics engine, for real-time and historical analytics and reporting

Developer Portal

The Developer Portal provides a customizable self-service web-based portal to application developers to explore, discover, and subscribe to APIs.

When API providers publish APIs in the API Manager, those APIs are exposed in the Developer Portal for discovery and usage by application developers in consumer organizations. Application developers can access the Developer Portal UI to register their applications, discover APIs, use the required APIs in their applications (with access approval where necessary), and subsequently deploy those applications.

API Use Cases

Read about the use cases for APIs which cover Mobile, Social, Data, IoT, and more: Use Case Scenarios



API ManagementArticles on on API ManagementSee Article
InstallationInstalling API ConnectSee Docs
Working with the API Connect ToolkitCovers the differences between traditional messaging architectures and event-driven architectures.See Docs
Working with CatalogsDetails about working with Catalogs in API Connect.See Docs
Creating APIsCovers a deep-dive of Apache Kafka and IBM Event Streams, IBM’s Enterprise-grade event-streaming platform.See Docs
Managing APIsCovers managing API’s in API Connect.See Docs
API AnalyticsCovers getting the analytics for your API’s.See Docs
API Testing and MonitoringSetting up testing and monitoring for API’sSee Docs


Accessing API ConnectCreating and accessing an API Connect Instance.Access API Connect
Creating APIsCreating REST APIs using API Connect.Creating APIs
Importing an APIImport an existing OpenAPI 2.0 definition.Importing APIs