Getting Started
Postman is one of the most popular testing tools used for API testing. You can use the tool to create, test, and run APIs.
We have created the Postman collections with our APIs. You can go through all the API entities, and import the collections into your own workspace.
Run and test the APIs to see how to use them effectively according to your use case.
Import Collections and Run APIs
The following steps guide you how to import Collections and run APIs on Postman.
- Click on the "Run in Postman" button below. It will redirect you to postman's website.
- Choose whether to use the Postman web application or the installed application (Postman for Windows)
- Now, import the Capillary API Collection to a separate workspace on postman. Name the workspace.
- Once the collection is imported into your workspace, you will see the 4 major entities i.e "Customer, Transaction, Points, and Coupon". Each of these entities has some endpoints.
- Now to test and use these endpoints, first, you will have to authorize them with the help of the access token.
To generate an access token, go to the OAuth endpoint, it opens in a new tab. In Body enter your key and secret. and click on Send .
TheaccessToken
is generated if a valid key and secret are entered.
- To authorize any other API endpoint, click on that endpoint > Go to Headers > Enter the
accessToken
generated in front of theX-CAP-API-OAUTH-TOKEN
.
List of APIs included in Collection
Collections |
---|
Customer API collection |
Transaction API collection |
Points API collection |
Coupon API collection |