Skip to main content

​
Overview

The Inspecto API uses URL-based versioning to ensure stable contracts and smooth migrations. The current version is v1.

​
Version Format

Versions are included in the URL path: 
https://api.inspecto.com/api/third-party/v1/vehicles
                                          ^^
                                       version

​
Current Version: v1

Released: December 9, 2024 Features:
  • Vehicle management (read)
  • Inspection templates (read)
  • Inspection submission (write)
  • API key authentication
  • Rate limiting
  • Pagination

​
Version Policy

​
Minor Changes (Non-Breaking)

Added to existing versions without changing the URL:
  • New optional fields in responses
  • New query parameters
  • New endpoints
  • New error codes
Example: Adding a color field to vehicles 
{
  "id": "...",
  "plateNumber": "ABC-123",
  "color": "blue"  // New optional field
}
Your integration won’t break when we add new optional fields.

​
Major Changes (Breaking)

Require a new version (v2, v3, etc.):
  • Removing fields
  • Changing field types
  • Changing response structure
  • Removing endpoints
  • Changing authentication
Example: Changing plateNumber to licensePlate 
/api/third-party/v2/vehicles  // New version required

​
Version Headers

Every response includes the API version: 
X-Inspecto-API-Version: v1
You can also specify the version in your request (optional): 
X-Inspecto-API-Version: v1
If the version doesn’t match, you’ll receive a 400 error: 
{
  "errors": [{
    "code": "VERSION_MISMATCH",
    "message": "API version v2 not supported. Current version: v1"
  }]
}

​
Deprecation Policy

1

Announcement

6 months notice before deprecating any version
2

Deprecation Headers

Deprecated versions include warning headers
X-Inspecto-API-Deprecated: true
X-Inspecto-API-Sunset: 2025-06-01
3

Migration Period

Both old and new versions available during migration
4

Sunset

Old version removed after sunset date

​
Migration Guide

When a new version is released:
  1. Review the changelog for breaking changes
  2. Test in sandbox with the new version
  3. Update your integration to use the new endpoints
  4. Deploy gradually using feature flags
  5. Monitor for errors in production
  6. Complete migration before sunset date

​
Version Compatibility

VersionStatusSunset DateSupport Level
v1Current-Full support
v2Planned-Not yet available

​
Best Practices

Always use explicit version in URLs, don’t rely on defaults.
// Good
const BASE_URL = 'https://api.inspecto.com/api/third-party/v1';

// Bad
const BASE_URL = 'https://api.inspecto.com/api/third-party/latest';
Check for deprecation warnings in responses.
if (response.headers['x-inspecto-api-deprecated']) {
  const sunset = response.headers['x-inspecto-api-sunset'];
  console.warn(`API version deprecated. Sunset: ${sunset}`);
}
Start testing new versions as soon as they’re announced.
// Test v2 in sandbox
const sandboxClient = axios.create({
  baseURL: 'https://sandbox.inspecto.com/api/third-party/v2'
});
Design your integration to support version switching.
class InspectoClient {
  constructor(version = 'v1') {
    this.baseURL = `https://api.inspecto.com/api/third-party/${version}`;
  }
}

​
Checking API Version

You can check the current API version programmatically: 
const response = await client.get('/vehicles');
const version = response.headers['x-inspecto-api-version'];
console.log(`Using API version: ${version}`);

​
Future Versions

​
v2 (Planned Q2 2025)

Potential breaking changes under consideration:
  • GraphQL endpoint
  • Webhook support
  • Enhanced filtering syntax
  • Batch operations
v2 is not finalized. Subscribe to our changelog for updates.

​
Staying Updated

Changelog

Review all API changes and updates

Email Notifications

Subscribe to API update emails

Status Page

Monitor API health and incidents

Developer Blog

Read about upcoming features