Skip to content
Xpansiv Power (formerly A...
/
REST API
/
Sample Postman Collection
/
Postman Collection Files
Last updated

REST API Postman Collections

This page provides ready-to-use Postman collections for the APX MarketSuite REST API endpoints. These collections serve as a reference for developers to quickly test API functionality and integrate with their applications.

Getting Started

  1. Download the collections and environment files below
  2. Import them into your Postman application
  3. Configure the environment variables with your API credentials
  4. Start testing the API endpoints

Available Collections

Master Collection

  • File: REST API - DevPortal Master
  • Description: Comprehensive collection containing various REST API endpoints for MarketSuite
  • Use Case: For API reference and testing

Environment Configuration

Sandbox Environment

  • File: MarketSuite Sandbox Environment
  • Description: Pre-configured environment variables for the sandbox environment
  • Configuration: Add authentication credentials.

Usage Instructions

Importing Collections

  1. Open Postman
  2. Click "Import" in the top left
  3. Select "File" and choose the downloaded collection files
  4. The collections will appear in your Postman sidebar

Setting Up Environment

  1. Import the environment file using the same import process
  2. Select the "MarketSuite Sandbox DevPortal" environment from the dropdown
  3. Update the environment variables with your specific credentials:
    • apiUsername: Your API username
    • apiPassword: Your API password
    • clientId: Your client ID
    • clientSecret: Your client secret

Running Requests

  1. Expand the imported collections in your Postman sidebar
  2. Select any request to view its configuration
  3. Ensure the correct environment is selected
  4. Make sure the request has all the necessary parameters
  5. Click "Send" to execute the request

Support

For additional help with API integration or Postman collection usage, refer to:

Previous page
Next page