Overview

API Manager facilitates the management of APIs that are exposed through REST or SOAP services. To experience seamless integration with ColdFusion APIs, you can access ColdFusion REST services from API Manager.

The admin portal available with the API Manager lets you define the ColdFusion discovery server. Once such a ColdFusion discovery server is set, you can readily import REST services defined in the ColdFusion server with just a single click. With minimal configuration, you can readily publish the APIs associated.

Starting API Manager with ColdFusion

You can start API Manager from ColdFusion in either of the following ways: 

  • Provide ColdFusion's home directory while installing API Manager.. API Manager is installed in a separate directory.
  • Provide the –Dapim.home={application-home} flag in <ColdFusion Home>.

Remote

If you have already installed API Manager and you want to discover REST services published in ColdFusion, add the ColdFusion server configuration according to the following steps:

  1. Start API Manager in Administrator mode. 
  2. Click CF Discovery Server Configuration on the left pane. 
  3. Add the configuration values. 
ColdFusion Discovery Server Configuration

Set API Manager flags in ColdFusion

From ColdFusion Administrator > Settings page, you can set the flag for REST discovery service as shown in the following screenshot.

Allow REST Discovery

If you select the Allow REST Discovery check box option, then API Manager discovers REST services automatically. If you clear this option, then REST services do not appear in API Manager's Publisher page while importing APIs. 

Note:

If you clear this check box during CF startup and enable later, you can perform one of the following:

  • Restart the ColdFusion server.
  • Reinitialize the REST service to make the service available in API Manager.

This work is licensed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License  Twitter™ and Facebook posts are not covered under the terms of Creative Commons.

Legal Notices   |   Online Privacy Policy