Skip to main content

Postman Collection for Endora API

Test and manage your Endora API endpoints with Postman's powerful testing capabilities. Our ready-to-use collection makes API testing simple and efficient.

What You'll Learn​

  • Export Postman collections
  • Test all API endpoints
  • Share collections with your team

Learn how to use Postman to test and manage your Endora API endpoints.

Getting Started​

What is Postman?​

Postman is a powerful API testing tool that allows you to:

  • Test APIs: Send requests and view responses
  • Organize Requests: Group related endpoints
  • Automate Testing: Create test scripts and collections
  • Share APIs: Collaborate with your team
  • Document APIs: Generate documentation automatically

Why Use Postman with Endora?​

  • Ready-to-Use Collections: Pre-configured requests for all endpoints
  • Environment Management: Easy switching between development and production
  • Automated Testing: Built-in test scripts for validation
  • Team Collaboration: Share collections with your development team

Exporting Your Collection​

From Endora Dashboard​

  1. Navigate to API Docs: Go to your project's API documentation
  2. Click Download: Find the "Download for Postman" button
  3. Download Collection: Save the JSON file to your computer
  4. Import to Postman: Use the file to import the collection

Importing the Collection​

Step-by-Step Import​

  1. Open Postman: Launch the Postman application
  2. Click Import: Use the "Import" button in the top-left corner
  3. Choose File: Select your downloaded collection JSON file
  4. Import Collection: Click "Import" to add the collection
  5. Verify Import: Check that all endpoints are available

Collection Structure​

After importing, you'll see organized folders:

 Endora API Collection
├──  Authentication
│   ├──  Login
│   └──  Refresh Token
├──  Users
│   ├──  Get All Users
│   ├──  Create User
│   ├──  Get User by ID
│   ├──  Update User
│   └──  Delete User
├──  Products
│   ├──  Get All Products
│   ├──  Create Product
│   └──  Update Product
└──  Orders
    ├──  Get All Orders
    └──  Create Order

Collection Import​

Learn how to import your Endora API collection into Postman.

Testing Your API​

Basic API Testing​

  1. Select Request: Choose an endpoint from your collection
  2. Check Headers: Verify authentication headers are set
  3. Send Request: Click "Send" to execute the request
  4. View Response: Check the response status and data
  5. Validate Results: Ensure the response matches expectations

Automated Testing​

Test Scripts​

Add automated tests to your requests:

// Test response status
pm.test("Status code is 200", function () {
    pm.response.to.have.status(200);
});

// Test response time
pm.test("Response time is less than 2000ms", function () {
    pm.expect(pm.response.responseTime).to.be.below(2000);
});

// Test response data
pm.test("Response has required fields", function () {
    const jsonData = pm.response.json();
    pm.expect(jsonData).to.have.property('id');
    pm.expect(jsonData).to.have.property('name');
});

Collection Runner​

Run all tests in your collection:

  1. Open Collection Runner: Click "Run" on your collection
  2. Select Tests: Choose which tests to run
  3. Configure Settings: Set iterations and delays
  4. Run Tests: Execute all tests automatically
  5. View Results: Check test results and failures

Team Collaboration​

Sharing Collections​

  1. Export Collection: Save your collection as a JSON file
  2. Share File: Send the file to team members
  3. Import Collection: Team members import the collection
  4. Sync Changes: Update and share changes as needed

Postman Workspaces​

  • Personal Workspace: Your private testing environment
  • Team Workspace: Shared workspace for your team
  • Public Workspace: Share collections publicly
  • Enterprise Workspace: Advanced collaboration features

Learn how to share collections and collaborate with your development team.

Advanced Features​

Newman CLI​

Run Postman collections from the command line:

# Install Newman
npm install -g newman

# Run collection
newman run collection.json -e environment.json

# Run with reporting
newman run collection.json -e environment.json -r html

CI/CD Integration​

Integrate Postman tests into your deployment pipeline:

# GitHub Actions example
- name: Run Postman Tests
  run: |
    npm install -g newman
    newman run collection.json -e environment.json

Best Practices​

Collection Organization​

  • Group Related Endpoints: Organize by functionality
  • Use Descriptive Names: Clear, meaningful request names
  • Add Documentation: Include descriptions and examples
  • Version Control: Track changes to your collections

Testing Strategy​

  • Test Happy Paths: Verify successful operations
  • Test Error Cases: Validate error handling
  • Test Edge Cases: Check boundary conditions
  • Performance Testing: Monitor response times

Next Steps​

Now that you have Postman set up:

  1. Test All Endpoints: Verify every API endpoint works correctly
  2. Create Test Scripts: Add automated validation
  3. Share with Team: Collaborate on API testing
  4. Integrate with CI/CD: Automate your testing pipeline

Your API testing is now professional and efficient!