Skip to main content

​
What Are Postman Collections?

Postman collections are pre-configured API requests that make it easy to test the Revolv3 API without writing code. They include:
  • All API endpoints pre-configured
  • Example requests with sample data
  • Environment variables for easy switching
  • Documentation built into each request
Why use them:
  • Quick testing: Test API calls without writing code
  • Learn the API: See how requests should be structured
  • Debugging: Test specific endpoints when troubleshooting
  • Documentation: Built-in examples and descriptions

​
How to Get Postman Collections

To get the latest Revolv3 Postman collection:
  1. Contact Revolv3 Support
    • Your Onboarding Team will provide you access to these collections when you get your Sandbox Credentials
  2. What you’ll receive
    • Postman collection file
    • Instructions for importing
    • Environment files for sandbox and production
    • Documentation on how to use it

​
Using Postman Collections

Once you have the collection:
  1. Import into Postman
    • Open Postman
    • Click “Import”
    • Select the collection file
    • Import any environment files
  2. Set up your environment
    • Create or use the provided environment
    • Add your API key to environment variables
    • Set the API root URL
  3. Start testing
    • Browse the collection for the endpoint you need
    • Update request parameters as needed
    • Send requests and view responses

​
Benefits of Using Postman

  • No code required: Test APIs without writing integration code
  • Visual interface: See requests and responses clearly
  • Variable management: Store API keys and URLs in variables
  • Team sharing: Share collections with your team

​
Alternative Testing Methods

If you don’t use Postman, you can also test with:
  • curl: Command-line tool (examples in our docs)
  • Your own code: Write test scripts in your preferred language
  • Revolv3 Portal: Some operations can be tested in the web portal

​
Next Steps