You can use the official Pismo Postman collections and environment to test the Pismo REST APIs without having to manually create the collections or environment. While you can test all these APIs through the Pismo Developers Portal, Postman provides a way for you to customize and streamline your testing environment. Pismo has created a public workspace with shared collections and an environment on the Postman Public API network.

• All public Pismo endpoints - This collection includes all the Pismo public APIs in a single collection.
• Pismo cards collection - This collection shows you the basic calls used in creating an account and a credit card.

Getting Started

Step 1 - Download and install Postman

Step 2 - Fork Pismo collections and environments

The recommended way to work with a collection and environment is to fork them. This is similar to forking in Github. This lets you maintain your own customized local version and still pull in Pismo’s changes to the collection and environment over time. When using the Pismo collections, select the collection that matches your use case and fork the collection to create your own.

When creating your fork, select the Watch original collection box to enable Postman to send you emails when Pismo updates the collection so you can pull the changes into your fork and always stay up to date with the latest version of the collections. The following table contains links to fork a collection into a sandbox environment which is used for all collections.

Collection Name	Fork link
All public Pismo endpoints
Pismo cards collection

🚧

IMPORTANT: To keep your credentials, tokens, and sensitive data private, always fork into a private workspace.

Step 3 - Update environment variables

Once you have forked the collection and environment that matches your use case, you can update the environment variables with your credentials. When using basic authentication, you can acquire these keys from the Pismo Control Center. For more information, refer to Manage access keys.

📘

Note: You must update the variables for your Pismo key and authenticate before any calls will work.

When using OpenID authentication, update the pismo.group variable in the sandbox environment based on the endpoints you are testing. For more information on how to authenticate with OpenID, refer to Authenticate with OpenID.

Step 4 - Begin testing Pismo API endpoints

Most Pismo API endpoints require values that other endpoints return. Some Pismo collections are set up so that if you call the endpoints in a set order, the necessary values are automatically saved in the collection variables.

📘

Note: All endpoints can use a variable for the URL.