Using Session Credentials with Postman

Learn how to use session credentials to access the Stax API with Postman

Stax allows you to access the Stax API via Postman using your session credentials. If you would like to learn more about session credentials, check out the documentation. Keep in mind that your session credentials are short-lived, so you will need to update your Authorization parameters within Postman when they expire.

Before you begin

• Your Stax role will dictate what API requests you are permitted to make
• You should have Postman installed on your computer (see Installing and updating Postman)
• Estimated time to complete: 15 minutes

Obtain your Session Credentials

1. Log in to the Stax console
2. Open the customer menu in the left hand nav (click the arrow next to your alias)
3. Click Profile
4. Make a note of the Access Key ID, Secret Access Key and Session Token. These form the credentials utilized within Postman

Configure a Postman Request

1. Open Postman

2. Open a new tab in Postman

3. Configure the the API request:

   • Find the API request in the API documentation (see the links here)
   • Select the appropriate method (GET, POST, DELETE, PUT) from the dropdown list in Postman
   • Enter the API URL into Postman - the URL format is https://api.<region>.staxapp.cloud/<version>/
   • Provide the required parameters

   Example Postman Request using the delete-stax-user API call

   • Method: DELETE
   • URL: https://api.au1.staxapp.cloud/20190206/users/123
   • Parameter {user_id_to_delete}: 123

   

4. Select the Authorization tab

5. Paste the Access Key, Secret Key and Session Token that you copied from Step 1 and select the AWS Region:

   • stax-au1: ap-southeast-2
   • stax-us1: us-east-2
   • stax-eu1: eu-central-1

   

6. Click Send

The successful response will be provided in the Response window at the bottom of your Postman window.