ChannelEngine: import API specification into Postman

About this article

This article describes how to import ChannelEngine's API specification into Postman using a link.

Introduction

Before building your integration with ChannelEngine, test how data flows between your system and ChannelEngine via Postman. This article guides you through importing ChannelEngine's API specification into Postman.

Once imported, you have an overview of available resources, parameters, and authentication requirements, which allows you to test endpoints without manual configuration.

Import API specification into Postman

The most efficient way of importing the specification is via a direct link. Alternatively, you can download the raw file and upload it manually into Postman.

To import an API specification into Postman using a link:

1. Identify the API you want to test and copy its specification URL:
   • Merchant API spec
   • Channel API spec
   • Channel Management API spec
2. Open and log in to the Postman application.
3. Select your preferred Workspace from the top menu.
4. In the top-left corner, click Import.

5. In the Import popup window, paste the copied API specification URL into the input field and click Continue.

   

6. Review the import summary and click Import.

A new collection containing all the endpoints appears in your Postman sidebar. Now that ChannelEngine API specification is saved locally, you can start making test API calls.