Skip to content
Developerhome
Product homepage
Authentication Service

Download and set up Postman

  Less than to read

To see the Sage Authentication Service in action you can use Postman. Postman is a multi-platform REST client with an intuitive GUI for:

  • Configuring HTTP requests
  • Designing JSON payloads
  • Viewing HTTP responses

If you need help with Postman, they provide help and learning resources in the Postman Learning Center.

Make sure you have the ID and signing key of your Sage application before you use the Postman collection. You’ll need them to use the collection.

Step 1: Get Postman

Go to the Postman website to download and install Postman.

Step 2: Get the Postman collection and environment

Postman supports collections which are a pre-packaged bundles of API requests. To help the development and testing of your integration, we have provided the following Postman collection which covers the Sage Authentication Flow.

Select “Run in Postman” to create a fork of the collection directly into your Postman application.

Run in Postman

Or you can download the Authentication Service API Postman Collection.

Step 3: Setting the environment JSON

The environment JSON contains the details of the sandbox test environment. The environment JSON must also be imported into Postman so the collections can function.

  1. Unzip the JSON format file from the downloaded ZIP archive.
  2. Open Postman
  3. Select the manage environments option at the top right of the Postman UI
  4. From the manage environments view, select Import
  5. Select the choose files option and locate the environment JSON file
  6. Ensure the new environment is selected once imported

Step 4: Add your application’s signing key

Edit the Postman environment to add your applications signing key. Add this to the apiKey variable.

Step 5: Send the requests

Expand the subfolders and send the requests in the order they are listed.