API Overview & Authentication

API Overview

The NexosOne DMS API provides programmatic access to system data and functionality, allowing you to integrate with external systems and build custom applications.

API Features

The API provides access to:

• Customer and vehicle data
• Job cards and workshop operations
• Parts inventory and stock levels
• Invoices and financial data
• Service history
• Booking calendar
• Reports and analytics

API Authentication

Secure API access using API keys:

1. Navigate to: System Administration / Settings / API
2. Generate API key
3. Copy and securely store API key
4. Use API key in API requests

API Key Management

• Generate multiple API keys
• Set key expiration dates
• Revoke keys if compromised
• Track API key usage
• Set permissions per API key

API Endpoints

RESTful API endpoints available:

• GET: Retrieve data
• POST: Create new records
• PUT: Update existing records
• DELETE: Remove records

API Base URL

All API requests use the base URL:

https://your-domain.com/api/v1/

Request Headers

Include required headers in all requests:

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
Accept: application/json

Response Format

All API responses are in JSON format:

{
  "success": true,
  "data": { ... },
  "message": "Success message"
}

Error Handling

API errors include:

• HTTP status codes (200, 400, 401, 404, 500)
• Error messages
• Error codes
• Validation errors

Rate Limiting

API requests are rate limited:

• Maximum requests per minute
• Rate limit headers in responses
• 429 status code when limit exceeded

API Documentation

Complete API documentation available:

• Endpoint reference
• Request/response examples
• Code samples
• Authentication guide