IBM API Connect

IBM® API Connect® is a complete, intuitive and scalable API platform that lets you create, expose, manage and monetize APIs across clouds. This means you and your customers can power digital applications and spur innovation.

Cloud CMS integrates with API Connect by providing an entry point to our API. You configure API Connect to expose the Cloud CMS API as a service and point your applications to this service instead of the normal (SAAS clients) endpoint.

On-Premise customers can create a similar service by referencing their own Cloud CMS API server cluster entry point as an API service in API Connect. If your cluster is available externally then you can use IBM's Cloud service API Connect. If not then you may need to host your own API Connect servers. More information on hosting your own API Connect service can be found at IBM

Create a service for your Cloud CMS API in your IBM Cloud portal under "API Management" and "API Gateway". From "Services" create a new service. Under "Managed APIs" click "Create API" and choose "Create an API Proxy". This creates a new API Service which is a proxy to an existing API; In this case the Cloud CMS API (either SAAS or your own cluster).

Complete the configuration form:

API Name: Choose an appropriate name such as "Cloud Production CMS API"

Base path for API: Enter a unique path prefix for this API service such as "/cloudcms-prod-api"

External Endpoint: (or your API cluster URL for on-premise customers)

Under "Security and Rate Limiting" disable "OAuth user authentication" as the CLoud CMS API is already protected by oAuth2.

"Rate Limiting" is optional. The Cloud CMS API server also supports rate limiting so you can use one or the other (or neither).

"CORS" is not necessary unless you plan to make API calls directly from a web browser which is not recommended.

Create the service and then go to the "Monitor" page. To test the new API Connect service, Copy the "Route" URL from "API Info". Paste this into a new browser window and append "/ping" to the url. The URL should look something like this:

You should see a JSON object returned which describes the Cloud CMS API server version and some other metadata similar to this:

        "vendor":"Gitana Software, Inc.",
        "product":"Cloud CMS","version":"3.2.64",
        "timestamp":"08-Jul-2021 18:34:13"

Configure Your Application

This is usually as easy as updating the baseURL property in the gitana.json file used by your application. For example:

On-Premise Options

See details in our API Server documentation