Skip to main content

Authentication

Learn how to authenticate with the Pricing Insights API.

API Keys​

All API requests require authentication using an API key. The token is created by Super Dispatch — please contact us to have one generated.

info

Authentication uses a static token passed via the X-API-Key header. There is no OAuth flow or token exchange.

Using Your API Key​

Include your API key in the X-API-Key request header:

curl -X POST "https://pricing-insights.superdispatch.com/api/v1/recommended-price" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "pickup": { "zip": "89506" },
    "delivery": { "zip": "90248" },
    "vehicles": [
      { "type": "sedan", "make": "Toyota", "model": "Camry", "year": "2023", "is_inoperable": false }
    ]
  }'

Security Best Practices​

  • Never share your API key — keep your credentials secure
  • Use HTTPS — all API calls must be made over HTTPS
  • Rotate keys periodically — contact support to reissue a key
  • Use environment variables — store keys outside of source code

Authentication Errors​

If the token is missing or invalid, the API responds with 401 Unauthorized:

{
  "meta": { "status": "fail" },
  "data": {
    "message": "Token provided is invalid",
    "details": []
  }
}

If you have exceeded your usage quota, the API responds with 403 Forbidden. See Response Handling for the full list of error responses.