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โ€‹

  • โœ… Import and configure Postman collections
  • โœ… Set up environment variables
  • โœ… Test all API endpoints
  • โœ… Automate API testing
  • โœ… Share collections with your team

๐Ÿ“น Postman Integration Overviewโ€‹

๐ŸŽฅ

Postman Integration Overview

Replace this entire section with your Postman integration overview video

Video Placeholder: Insert your Postman integration overview video here

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

๐Ÿ“น Postman Setupโ€‹

๐ŸŽฅ

Postman Setup

Replace this entire section with your Postman setup demonstration

Video Placeholder: Insert your Postman setup demo here

Learn how to set up Postman for testing your Endora API endpoints.

๐Ÿ“ฅ 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

Collection Contentsโ€‹

Your exported collection includes:

  • All API Endpoints: Every endpoint from your schema
  • Sample Requests: Pre-configured requests with examples
  • Authentication: API key authentication setup
  • Environment Variables: Configurable base URLs and tokens
  • Test Scripts: Automated validation tests

๐Ÿ“น Collection Exportโ€‹

๐ŸŽฅ

Collection Export

Replace this entire section with your collection export demonstration

Video Placeholder: Insert your collection export demo here

See how to export your API collection from the Endora dashboard.

๐Ÿ“ฅ 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โ€‹

๐ŸŽฅ

Collection Import

Replace this entire section with your collection import demonstration

Video Placeholder: Insert your collection import demo here

Learn how to import your Endora API collection into Postman.

๐Ÿ”ง Environment Configurationโ€‹

Setting Up Environment Variablesโ€‹

Create environment variables for easy configuration:

VariableExample ValueDescription
base_urlhttps://api.endora.space/v1/your-projectBase URL for your API
api_keyyour-api-key-hereYour API authentication key
project_idyour-project-idYour project identifier

Environment Setup Stepsโ€‹

  1. Create Environment: Go to Postman โ†’ Environments โ†’ Add New Environment
  2. Add Variables: Add the variables listed above
  3. Set Values: Enter your actual values
  4. Select Environment: Choose your environment from the dropdown
  5. Test Configuration: Verify the environment is working

๐Ÿ“น Environment Setupโ€‹

๐ŸŽฅ

Environment Setup

Replace this entire section with your environment setup demonstration

Video Placeholder: Insert your environment setup demo here

Learn how to configure environment variables for your API testing.

๐Ÿงช 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

Advanced Testing Featuresโ€‹

  • Pre-request Scripts: Set up data before requests
  • Test Scripts: Automatically validate responses
  • Collection Runner: Run multiple tests in sequence
  • Newman CLI: Run tests from command line
  • CI/CD Integration: Integrate with your deployment pipeline

๐Ÿ“น API Testingโ€‹

๐ŸŽฅ

API Testing

Replace this entire section with your API testing demonstration

Video Placeholder: Insert your API testing demo here

See how to test your API endpoints using Postman's powerful testing features.

๐Ÿ”„ 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

๐Ÿ“น Automated Testingโ€‹

๐ŸŽฅ

Automated Testing

Replace this entire section with your automated testing demonstration

Video Placeholder: Insert your automated testing demo here

Learn how to set up automated testing for your API endpoints.

๐Ÿ‘ฅ 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

๐Ÿ“น Team Collaborationโ€‹

๐ŸŽฅ

Team Collaboration

Replace this entire section with your team collaboration demonstration

Video Placeholder: Insert your team collaboration demo here

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

๐Ÿ“น Advanced Featuresโ€‹

๐ŸŽฅ

Advanced Features

Replace this entire section with your advanced features demonstration

Video Placeholder: Insert your advanced features demo here

Explore advanced Postman features for professional API testing and automation.

๐ŸŽฏ 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!