API Reference

This guide is based on SNAP Postman Collection

Postman Installation

  1. Go to the official Postman Website
    1. Visit: https://www.postman.com/downloads
  2. Choose your operating system
    1. Select Windows, macOS, or Linux depending on your OS.
  3. Download the installer
    1. Click the download button and wait for the file to finish downloading.
  4. Run the installer
    1. On Windows: Double-click the .exe file
    2. On macOS: Open the .zip or .dmg file and drag Postman to your Applications
    3. On Linux: Extract and run the binary or install via Snap (sudo snap install postman)
  5. Launch Postman
    1. Open Postman from your Applications or Start Menu.
  6. Sign up or log in
    1. Create a Postman account or log in with an existing one (you can also skip login if you prefer offline use).

Forking a Postman Collection

  1. Open the collection link
    1. Open SNAP Postman Collection in your browser.
  2. Click “Fork”
    1. In the top-right corner of the collection view, click the “Fork” button.
  3. Choose your workspace
    1. Select your personal or team workspace where you want to save the forked collection.
    2. (Optional) Rename the fork.
  4. Click “Fork Collection”
    1. The collection is now copied into your workspace.
    2. You can start making requests and editing as needed!

Set Up Environment Variables for SNAP

  1. In Postman, go to the left sidebar and click on the “Environments” icon (or use the gear icon ⚙️ at the top right).

  2. Click “+ Add” to create a new environment.

  3. Give it a name like Sandbox or Production.

  4. Add your variables (this is the mandatory variables, how to get can be seen on snap prerequisite):

    Variable NameInitial ValueCurrent Value
    client_idyour_client_id_hereyour_client_id_here
    client_secretyour_client_secret_hereyour_client_secret_here
    private_keyyour_private_key_hereyour_private_key_here
  5. Click “Save”.

  6. In the top-right corner of the Postman app, select your new environment from the environment dropdown.

Run the Request

  1. Open your forked collection.
  2. Run the helper folder to install some dependencies
  3. Choose the request you want to test.
  4. Hit Send — the pre-request script will auto-generate timestamp, x_external_id, and signature using your environment variables.