Postman Collection

Use our official Postman collection to quickly test APIVerve endpoints and explore our APIs interactively.

View Collection

Access our pre-configured Postman collection with 200+ APIVerve endpoints.

View Collection

Setup Instructions

To get started with the APIVerve Postman collection:

  1. Open Postman application or web version
  2. Visit the collection link above and fork it to your workspace
  3. Set up environment variables for your API key
  4. Start testing endpoints by clicking "Send"

Environment Variables

Configure these variables in Postman:

Required Variables
baseUrl: https://api.apiverve.com/v1
apiKey: your_api_key_here

Testing Workflows

Use these common workflows to test APIVerve endpoints effectively:

Basic API Testing

Follow these steps to test individual endpoints:

  1. Select an endpoint from the collection
  2. Review the pre-filled parameters and headers
  3. Modify parameters as needed for your test case
  4. Click "Send" to execute the request
  5. Review the response and check the built-in tests
Example Test Script
pm.test("Status code is 200", function () {
    pm.response.to.have.status(200);
});

pm.test("Response has success status", function () {
    const responseJson = pm.response.json();
    pm.expect(responseJson.status).to.eql("ok");
});

pm.test("Response contains data", function () {
    const responseJson = pm.response.json();
    pm.expect(responseJson.data).to.not.be.null;
});

pm.test("Response structure is valid", function () {
    const responseJson = pm.response.json();
    pm.expect(responseJson).to.have.property('status');
    pm.expect(responseJson).to.have.property('data');
    pm.expect(responseJson).to.have.property('error');
});

Batch Testing with Collection Runner

Test multiple endpoints at once using Postman's Collection Runner:

  1. Click "Runner" in the Postman header
  2. Select the APIVerve collection or specific folders
  3. Choose your environment
  4. Set iterations and delays between requests
  5. Click "Run APIVerve" to execute all tests
Collection Runner Pre-Request Script
// Set delay between requests
setTimeout(function(){}, 1000);

// Generate random test data
pm.globals.set("randomEmail", pm.variables.replaceIn("{{$randomEmail}}"));
pm.globals.set("randomName", pm.variables.replaceIn("{{$randomFirstName}}"));
pm.globals.set("timestamp", new Date().getTime());

console.log("Running test for: " + pm.info.requestName);

API Monitoring

Set up continuous monitoring of critical endpoints:

  1. Select key endpoints you want to monitor
  2. Click "Monitor" in the collection menu
  3. Set monitoring frequency (every 5 minutes to daily)
  4. Configure notifications for failures
  5. View monitoring results in the Postman web dashboard
Monitor Test Script
pm.test("API is responding", function () {
    pm.response.to.have.status(200);
});

pm.test("Response time is acceptable", function () {
    pm.expect(pm.response.responseTime).to.be.below(5000);
});

pm.test("API returns valid data", function () {
    const responseJson = pm.response.json();
    pm.expect(responseJson.status).to.eql("ok");
    pm.expect(responseJson.data).to.not.be.empty;
});

// Log performance metrics
console.log("Response time: " + pm.response.responseTime + "ms");
console.log("Response size: " + pm.response.responseSize + " bytes");

Troubleshooting

Common issues and solutions when using the Postman collection:

  • Authentication Errors (401): Verify your API key is set correctly in the environment variables and is active in your dashboard
  • Request Timeouts: Check your internet connection - some endpoints may have longer processing times
  • Rate Limiting (429): Add delays between requests in Collection Runner or reduce test frequency
  • Missing Responses: Verify you're using the correct HTTP method and all required parameters are provided
Quick Fix

Most issues are resolved by ensuring your API key is properly configured in Postman's environment variables. Double-check your key is active and has the necessary permissions.

What's Next?

Continue your journey with these recommended resources

Was this page helpful?

Help us improve our documentation