Skip to main content

​
[1.0.0] - December 9, 2024

​
Added

  • First public release of the Third-Party API v1
  • API key-based authentication with Bearer tokens
  • Company-scoped access control
  • Scope-based permissions system
  • GET /vehicles - List vehicles with filtering and pagination
  • GET /vehicles/{id} - Get single vehicle details
  • Support for filtering by type, status, fuel type, and group
  • Full-text search by plate number and VIN
  • GET /inspection-templates - List available templates
  • POST /inspections - Submit new inspections
  • Support for multiple vehicles per inspection
  • Damage reporting with photo URLs
  • Location tracking (GPS coordinates)
  • Pagination with page/limit parameters (max 100 per page)
  • Consistent JSON envelope format (data, meta, errors)
  • OpenAPI 3.1 specification
  • Comprehensive error codes and messages
  • SHA-256 API key hashing
  • Constant-time key comparison
  • Fingerprint-based audit logging
  • Automatic key expiration support
  • Environment separation (sandbox/production)

​
Upcoming

​
Planned for v1.1 (Q1 2025)

Webhooks

Real-time notifications for inspection completion and vehicle status changes

Bulk Operations

Batch vehicle imports and bulk inspection submissions

Advanced Filtering

Custom field queries and complex filter combinations

Inspection History

Retrieve historical inspection data with date ranges

​
Under Consideration

  • GraphQL endpoint as alternative to REST
  • Real-time updates via WebSocket
  • Custom report generation API
  • Vehicle maintenance scheduling
  • Driver assignment management

​
Migration Guides

​
From Internal API

If you were previously using internal endpoints:
1

Update Authentication

Replace session-based auth with API key Bearer tokens
2

Update Response Handling

All responses now use { data, meta, errors } envelope
3

Update Pagination

Use page and limit query parameters (max 100 per page)
4

Update Error Handling

Handle standardized error codes (UNAUTHORIZED, FORBIDDEN, etc.)
5

Request Scopes

Ensure your API key has required scopes for each endpoint

​
Breaking Changes Policy

We take API stability seriously. Breaking changes will only occur in major version updates.

​
Minor Versions (1.x)

  • Additive changes only (new fields, endpoints)
  • No breaking changes
  • Backwards compatible

​
Major Versions (2.0)

  • Breaking changes allowed
  • New URL path (/v2/)
  • 6-month deprecation notice
  • Migration guide provided

​
Stay Updated

Email Notifications

Subscribe to API updates

RSS Feed

Follow our changelog feed

Status Page

Monitor API health

​
Feedback

We value your input! Share feedback on:
  • Missing features
  • API improvements
  • Documentation clarity
  • Integration challenges
Contact: api-feedback@inspecto.com