API Documentation

FastSpring API - Postman Examples

The FastSpring API is back-end service you can use to communicate with your FastSpring Store programatically, e.g. as an alternative to using the Dashboard. This is an advanced feature that requires some basic understanding of HTTP communication methods; GET, POST and DELETE are the primary methods used to communicate with the API.

Getting up and running with the API can be difficult but with the use of Postman, this process can be greatly simplified. This page is not going to go into great detail about how to use Postman, but rather how to import a collection of FastSpring API calls into Postman to give you a head start.

What is Postman?

Postman is the only complete API development environment, for API developers, used by more than 5 million developers and 100,000 companies worldwide.

Postman can be download from their website and provides a great deal of information about how to use the program.

The FastSpring API Postman Collection

You can download the collection here. This is a zip file that contains the JSON import for Postman.

Steps to use The FastSpring API Postman Collection

  • Install Postman if you have not already done this
  • Download the collection from above
  • Extract the zip file to a location on your computer
  • Launch Postman
  • Click the Import button in Postman
  • Either click the Choose Files button and navigate to the FastSpring API.postman_collection.json file and click open or drag and drop the FastSpring API.postman_collection.json file into the drop area in Postman
  • You should now have a collection named FastSpring API under the Collections tab
  • Right click the FastSpring API collection and select edit
  • Click on the Authorization tab
  • Fill out the Username and Password fields for your account and click Update. Information on getting this information can be found here.
  • The FastSpring API collection is now ready to use
  • More information about specific APIs can be found in our documentation.
Note: The examples in the FastSpring API collection hold placeholders for different values that are account specific. For example, under the Accounts folder, Get one account has a URL of https://api.fastspring.com/accounts/{account_id}. To use this API call, replace {account_id} with the account ID you are trying to look up. These placeholders appear in the URL as well as in the body of the request if a JSON object is expected like in the Sessions | "Create a session without overriding any default values" example.