User Guide Cancel

Integrate ColdFusion and API Manager

  1. ColdFusion Tools User Guide
  2. Performance Monitoring Toolset
    1. Overview of ColdFusion Performance Monitoring Toolset
    2. Auto-discovery of ColdFusion nodes and clusters
    3. Code profiler in ColdFusion Performance Monitoring Toolset
    4. Configure ColdFusion Performance Monitoring Toolset settings
    5. Install ColdFusion Performance Monitoring Toolset
    6. View cloud metrics
    7. Monitor GraphQL in Performance Monitoring Toolset
    8. Configure TLS/SSL and Authentication for Elasticsearch 8.x  in Performance Monitoring Toolset
    9. View cluster and node metrics
    10. View data source metrics
    11. View external services
    12. View incoming services
    13. View list of sites and busy connections
    14. View topology of sites
    15. Datastore Health Monitoring
    16. Performance Monitoring Toolset Update 1
    17. Secure Performance Monitoring Toolset with HTTPS/SSL
    18. Performance Monitoring Toolset deployment guide
  3. Use ColdFusion Builder
    1. About ColdFusion Builder
    2. System requirements | ColdFusion Builder
    3. Install ColdFusion Builder
    4. Edit code in ColdFusion Builder
    5. Manage servers in ColdFusion Builder
    6. Manage projects in ColdFusion Builder
    7. What's new in Adobe ColdFusion Builder (2018 release)
    8. Frequently Asked Questions (FAQ) | Adobe ColdFusion Builder (2018 release)
    9. Debug applications in ColdFusion Builder
    10. ColdFusion Builder workbench
    11. ColdFusion Builder extensions
    12. Debugging Perspective in ColdFusion Builder
    13. Build mobile applications using ColdFusion Builder
    14. Bundled ColdFusion Server
    15. Debug mobile applications in ColdFusion Builder
    16. Use extensions in ColdFusion Builder
  4. Coldfusion API Manager
    1. Overview of Adobe ColdFusion API Manager
    2. Features in ColdFusion API Manager
    3. Get started with ColdFusion API Manager
    4. Install ColdFusion API Manager
    5. Authentication types
    6. Create and publish APIs
    7. Administrator
    8. Subscriber
    9. Throttling and rate limiting
    10. Notifications
    11. Connectors
    12. Set up cluster support
    13. Integrate ColdFusion and API Manager
    14. Metrics and Logging in API Manager
    15. Generate Swagger documents
    16. Configure SSL
    17. Known issues in this release
    18. Policies in ColdFusion API Manager
    19. Create a Redis cluster
    20. Multitenancy in API Manager
    21. Docker images for ColdFusion API Manager

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. 

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.

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.

Get help faster and easier

New user?