Getting Started

1. Obtain API Token

Contact your system administrator to generate an API token for your office. Each token is tied to:

• A specific office and database
• Configured rate limits
• Usage tracking and monitoring

2. Test Your Connection

Make a simple request to verify your token works:

curl -X GET "https://api.vto.cloud/client/fetchAll?per_page=1" \
  -H "X-Api-Token: your_token_prefix.your_token_secret"

const response = await fetch('https://api.vto.cloud/client/fetchAll?per_page=1', {
  headers: {
    'X-Api-Token': 'your_token_prefix.your_token_secret'
  }
});

const data = await response.json();
if (data.success) {
  console.log('Connection successful!', data);
} else {
  console.error('Error:', data.error);
}

Error: Invalid API token

import requests

headers = {'X-Api-Token': 'your_token_prefix.your_token_secret'}
response = requests.get('https://api.vto.cloud/client/fetchAll?per_page=1', headers=headers)
data = response.json()

if data['success']:
    print('Connection successful!')
    print(data)
else:
    print(f"Error: {data['error']}")

3. Handle the Response

All successful responses follow this standard format:

{
  "success": true,
  "data": [...],
  "pagination": {
    "total": 150,
    "page": 1,
    "per_page": 50,
    "total_pages": 3,
    "has_next": true,
    "has_previous": false
  },
  "timestamp": "2024-01-15T09:30:00+00:00"
}

Error responses include debug information when enabled:

{
  "success": false,
  "error": "Invalid API token",
  "code": 401,
  "details": {
    "message": "Token validation failed",
    "trace": null
  },
  "timestamp": "2024-01-15T09:30:00+00:00"
}

4. Enable Debug Mode (Optional)

For development and troubleshooting, enable debug mode:

curl -X GET "https://api.vto.cloud/client/fetchAll" \
  -H "X-Api-Token: your_token_here" \
  -H "X-Debug: 1"

curl -X GET "https://api.vto.cloud/client/fetchAll?debug=1" \
  -H "X-Api-Token: your_token_here"