Happy Business Starts Here

Highlighted
Zuora Support Moderator

Postman collection for the Zuora REST API

If you use Postman to test the Zuora REST API, you might have tried importing the Zuora Swagger spec into Postman.

 

Importing the Zuora Swagger spec gives you a Postman collection that contains each API operation, but you often need to make a lot of modifications before you can successfully send a request. E.g., you may need to disable the parameters and headers that aren’t required, set the Authorization header, and paste in a request body sample from the API Reference.

 

To make it easier to test the Zuora REST API, we’ve created a collection that requires much less tweaking. Download the collection.

 

To import this collection into Postman, navigate to File > Import, then choose the JSON file that you downloaded. You’ll then see a collection called “Zuora REST API (2018-11-15)”:

 

postman_zuora_collection.png

 

The collection corresponds to Zuora Release 234 (R234), November 2018.

 

We don’t plan to provide an updated collection for each Zuora release. However, you can generate an up-to-date collection at any time using this Swagger converter. The Swagger converter is based on open source code from the Postman developers.

 

NOTE: The collection and Swagger converter linked above are provided for reference purposes only. We hope that you’ll find them useful, but they aren’t supported by Zuora. If you have any feedback, please reply to this post.

 

Using Postman

 

To get started using Postman to test the Zuora REST API, I’d thoroughly recommend watching @gelaimr's tutorial How to Use Postman. This tutorial includes a demo of how to generate an OAuth token for the Zuora REST API.

 

When you use “Generate an OAuth token” in the collection linked above, Postman saves the generated OAuth token in your active environment. Postman then automatically sets the Authorization header when you send other requests.

 

Visit the Postman documentation to learn more about environments.

Tags (3)