Using RESTful APIs with IBM Connect:Direct

IBM® Connect:Direct® Web Service RESTful APIs enables external business applications to integrate with IBM Connect:Direct. The Web Services RESTful APIs support Read, Create, Update/Replace, and Delete (CRUD) operations on resources using standard HTTP GET, POST, PUT, and DELETE methods and output resource data in a JavaScript Object Notation (JSON) format.

IBM Connect:Direct Web Service provide APIs for corresponding Connect:Direct functions such as, submitting a file transfer process, process control, fetching statistics , netmap update for remote nodes , user authorization , user proxy , secure plus configuration, and controlling tracing.

The RESTful APIs can be directly invoked through the following means so as to seamlessly integrated with external business applications:

  • Browser Interface
    • Web Services RESTful API documentation can be accessed in a web browser using the Swagger UI.
    • Swagger is REST API documentation framework that helps to developers design, build and consume the RESTful Web services.
  • REST Clients (e.g POSTMAN)

  • Command Line Interface (cURL)

  • Scripts-based RESTful API invocation
Note: Ensure a secure connection with Connect:Direct server before executing the Secure Plus APIs. For more information and example scenarios see the sections that follow.

What's new in v6.0.0.5

This Fix Pack introduces RESTful API documentation enhancements and capabilities that will accelerate your ability to develop, test, and document RESTful APIs built with Connect:Direct Web Services:
  • New improved look and feel to how parameters are now listed under an API definition.
  • Search functionality is now added to the RESTful API documentation page with a search dialog that appears at the top of the activity window. The search dialog delivers the user's search query to a find a specific RESTful API documentation.
  • Sign out option is now added under the User icon to enable users to sign out and disconnect of the RESTful API documentation page entirely.
  • The User icon also now includes an About option that describes additional information such as, Connect:Direct and Connect:Direct Web Services version, Node, operating system, and license information.
  • cURL commands are now included under RESTful API definitions so you can easily automate API testing using a script or REST clients.
  • Specific error codes and description are now handled under RESTful API definition>Responses.
  • API definitions now includes show/hide/expand/collapse link to control how applicable operations, parameters and responses display
  • Response returned in the RESTful API response can now be downloaded as a file attachment (JSON).
  • The interactive UI is now extended and customized to add IBM branding logo and improved look and feel.