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 CollectionSetup Instructions
To get started with the APIVerve Postman collection:
- Open Postman application or web version
- Visit the collection link above and fork it to your workspace
- Set up environment variables for your API key
- Start testing endpoints by clicking "Send"
Environment Variables
Configure these variables in Postman:
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:
- Select an endpoint from the collection
- Review the pre-filled parameters and headers
- Modify parameters as needed for your test case
- Click "Send" to execute the request
- Review the response and check the built-in tests
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:
- Click "Runner" in the Postman header
- Select the APIVerve collection or specific folders
- Choose your environment
- Set iterations and delays between requests
- Click "Run APIVerve" to execute all tests
// 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:
- Select key endpoints you want to monitor
- Click "Monitor" in the collection menu
- Set monitoring frequency (every 5 minutes to daily)
- Configure notifications for failures
- View monitoring results in the Postman web dashboard
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
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.
Was this page helpful?
Help us improve our documentation