Skip to main content

Postman Collections

API People provides official Postman collections to help you quickly explore, test, and integrate with our APIs in a reliable and user‑friendly environment.

Using Postman for API Testing​

Postman is a powerful and user-friendly platform that simplifies API development, testing, and debugging. With its intuitive interface, you can easily craft requests, inspect responses, manage environment variables, and collaborate with your team.

Postman is available as both a desktop application (Windows, macOS, and Linux) and a web-based client you can use directly in your browser.

To help you get started quickly, we provide the following resources:

  • API Collections: Organized by service (e.g., Payments, Customers, Accounts), these collections include all supported HTTP methods, request and response examples, and required headers and parameters.

  • Preconfigured Environments: Ready-to-use environment files containing key variables like base_url, client_id, and access_token, allowing you to authenticate and customize requests with minimal setup.

Get Started​

To start testing the API People API using the postman collection, follow steps below:

  1. Download and Install Postman.

  2. Download the postman files below:

  3. In Postman, click Import and upload the API People Collection and Environment JSON files.

  4. Configure the following Environment Variables:

    • base_url (for sandbox or production)
    • client_id and client_secret (for OAuth 2.0)
    • access_token (after you obtain it)
    • Any other variables your tests require (for example, x-correlation-id)

  5. Use the organized collection to send live API calls. Inspect formatted responses, error messages, and headers directly in the Postman UI.

info

All endpoints documented in the API Reference are included in the Postman collection, ensuring consistency and ease of testing.