Manifold API Testing with Postman

Testing and exploring the Manifold API is simple and efficient with Postman. We provide a step-by-step guide to help you set up and start testing the API quickly and effectively.

Prerequisites

  • Postman installed
  • Manifold API Token
  • Connection ID from your Manifold account

Setting Up Your Postman Environment

  1. Create a New Environment

    • In Postman, click on the "Environments" tab
    • Click "Add" to create a new environment
    • Name it "Manifold API"
  2. Add Environment Variables

    • Add the following variables:
      • base_url
      • api_token: [Your Manifold API Token]
      • connection_id: [Your Connection ID]
  3. Configure Request Headers Ensure each request includes:

    • X-API-KEY: {{api_token}}
    • Connection-Id: {{connection_id}}

Manual Postman Collection Setup

Since a pre-built collection is not available, create your requests manually:

List Connections Endpoint

  • Method: GET
  • URL: {{base_url}}/connections
  • Headers:
    • X-API-KEY: {{api_token}}

List Vehicles Endpoint

  • Method: GET
  • URL: {{base_url}}/vehicles
  • Headers:
    • X-API-KEY: {{api_token}}
    • Connection-Id: {{connection_id}}

List Safety Events Endpoint

  • Method: GET
  • URL: {{base_url}}/safety-events
  • Headers:
    • X-API-KEY: {{api_token}}
    • Connection-Id: {{connection_id}}
  • Query Params:
    • from: 2024-01-01T00:00:00Z
    • to: 2024-02-15T23:59:59Z

Why Use Postman?

  • Interactive Testing:

    • Send live requests to Manifold's API
    • Immediately view detailed responses
    • Validate API functionality in real-time
  • Powerful Error Handling:

    • Instantly debug request issues
    • View comprehensive error messages
    • Quickly adjust parameters and headers
  • Highly Customizable:

    • Create multiple environment configurations
    • Add custom scripts
    • Organize complex API workflows

Best Practices

  • Always protect your API token
  • Use environment variables for flexibility
  • Test in stages: connections, vehicles, events, reports
  • Leverage Postman's testing and monitoring features

Need Help?