Base URL & Versioning

Configure your API requests with the correct endpoint and version parameters to ensure compatibility, stability, and smooth migration across Aevum Zenth services.

Environment Endpoints

All API requests must be directed to the appropriate environment base URL. Authentication tokens and resources are scoped to their respective environments and are not cross-compatible.

Versioning Strategy

Aevum Zenth uses URL path versioning as the primary strategy for API compatibility. This ensures explicit version targeting, easy caching, and straightforward routing for developers.

While path versioning is primary, we also support Accept Header versioning for legacy integrations transitioning to newer versions:

Accept: application/vnd.aevumzenth.v2+json
Content-Type: application/json

Request Examples

cURL

curl -X GET https://api.aevumzenth.com/v1/accounts/me \r
  -H "Authorization: Bearer <YOUR_ACCESS_TOKEN>"

Python (requests)

import requests

base_url = "https://api.aevumzenth.com/v1"
headers = { "Authorization": f"Bearer {api_key}" }

response = requests.get(f"{base_url}/accounts", headers=headers)
print(response.json())

JavaScript (fetch)

const BASE = 'https://api.aevumzenth.com/v1';

const res = await fetch(`${BASE}/transactions`, {
  headers: { 'Authorization': `Bearer ${TOKEN}` }
});
const data = await res.json();

Version Lifecycle & Deprecation

We follow a strict version lifecycle policy to minimize disruption:

• Active: Fully supported, receives bug fixes and security patches.
• Maintenance: No new features, only critical security updates.
• Sunset: Announced 18 months in advance. Returns 200 but includes X-Sunset and Deprecation headers.
• Retired: Returns 410 Gone with migration documentation link.

Version Metadata Headers

Every response includes versioning context to assist with automation and lifecycle management:

Troubleshooting

400 Bad Request: Missing Version

This occurs when the version segment is omitted from the URL path. Ensure your base URL follows the pattern https://api.aevumzenth.com/v{major}/.

404 Not Found on Valid Endpoint

Resource endpoints frequently change between major versions. Verify that the requested path exists in the current API reference for your target version.

CORS / Preflight Failures

The API enforces strict CORS policies. Include your registered origin in the Origin header. Sandbox environments allow * for development testing.