Pismo API testing overview
You have multiple options for testing Pismo APIs:
- OpenAPI specifications, from a public GitHub repo
- Postman collections, using the Postman software application for building, using, and managing APIs
- Pismo Developers Portal using the interactive console
- curl a command-line tool
Pismo updates the Pismo OpenAPI specifications and Postman collections through the same automated publication pipeline. Although we offer these files without Pismo support, if you find a problem with the files, you can open a Pismo Service Desk ticket.
Prerequisites
You must have access to a sandbox account which includes server_key and server_secret values so that you can authenticate when using the sandbox with the interactive console, Postman collections, or using tools with OpenAPI files.
OpenAPI specifications
You can download all OpenAPI files available on the Pismo Developers Portal by going to the GitHub repository at github.com/PismoDevEx/pismo-api-specs.
This public repository contains the latest OpenAPI 3.1 specifications for Pismo APIs. Within minutes of publication, the updated OpenAPI file for every platform service appears. Because of this secure controlled pipeline, you cannot create outside commits or pull requests for this repository. We must ensure the published specifications remain synchronized with the authoritative source here in the Developers Portal.
Postman collections
To help you with testing, Pismo provides Postman collections and an environment. A collection is a set of API requests that you can share with others. Postman also enables you to create an environment for use with a collection. When you load a collection in Postman, you can read from and write to variables. For more information, refer to the Postman documentation.
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 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.
The Pismo Postman workspace has these collections:
- 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.
Related topics
Updated 5 days ago