v2.4.1 • Updated Dec 2026

Integration Guide

A comprehensive walkthrough for integrating with the Aevum Zenth platform. Covers authentication, API usage, webhook configuration, and SDK setup.

Overview

The Aevum Zenth REST API provides programmatic access to our multi-divisional services. Whether you're connecting to energy grids, querying healthcare datasets, or automating logistics workflows, our unified API gateway abstracts complexity while maintaining industry-specific compliance.

Platform Versioning: All endpoints use URL versioning (/v1/, /v2/). This guide references v2, which supports streaming, async operations, and enhanced OAuth 2.1 flows.

Prerequisites

Before integrating, ensure you have the following:

  • An active Aevum Zenth Developer account
  • API credentials (Client ID & Secret or Personal Access Token)
  • HTTPS-enabled server for webhooks
  • Compliance approval for regulated divisions (Healthcare, Finance, Aerospace)

Generate credentials via the Developer Console. All traffic must originate from approved IP allowlists for enterprise tiers.

Authentication

Aevum Zenth supports two primary authentication methods:

MethodUse CaseToken Expiry
Bearer TokenServer-to-server, background jobsNever (rotate manually)
OAuth 2.1User-facing apps, delegated access1 hour (refreshable)
API KeyLegacy systems, read-only accessNever (deprecated for writes)
HTTP Header
Authorization: Bearer az_live_7f9d2e8c4a1b3f6e0d5c9a8b7e6f4d3c
X-Zenth-Version: 2026-11-15
Content-Type: application/json
Security Notice: Never expose live tokens in client-side code. Use environment variables or a secrets manager. Tokens prefixed with az_test_ operate in the sandbox environment.

Making Requests

All API requests follow standard REST conventions. The base endpoint for v2 is:

Base URL
https://api.aevumzenth.com/v2

Request Format

Send JSON payloads with application/json content type. Pagination uses cursor-based navigation to ensure consistency with real-time data streams.

ParameterTypeDescription
limitintegerMax items per page (default: 50, max: 200)
cursorstringOpaque pagination token from X-Next-Cursor
expandstring[]Dot-notation paths to include nested resources

Code Examples

Interact with the Energy Division's load balancing endpoint across multiple languages.

cURL
curl -X POST https://api.aevumzenth.com/v2/energy/load-balance \
  -H "Authorization: Bearer $AZ_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"region": "US-EAST-1", "threshold": 0.85, "strategy": "predictive"}'
Python
import requests

client = requests.Session()
client.headers["Authorization"] = f"Bearer {AZ_TOKEN}"

response = client.post(
    "https://api.aevumzenth.com/v2/energy/load-balance",
    json={
        "region": "US-EAST-1",
        "threshold": 0.85,
        "strategy": "predictive"
    }
)
print(response.json())
JavaScript (Node.js)
const response = await fetch(
  'https://api.aevumzenth.com/v2/energy/load-balance', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${AZ_TOKEN}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    region: 'US-EAST-1',
    threshold: 0.85,
    strategy: 'predictive'
  })
}
);
console.log(await response.json());
Go
package main

import (
    "bytes"
    "encoding/json"
    "fmt"
    "net/http"
)

func balanceLoad(token string) {
    payload, _ := json.Marshal(map[string]interface{}{
        "region":    "US-EAST-1",
        "threshold": 0.85,
        "strategy":  "predictive",
    })
    req, _ := http.NewRequest("POST", "https://api.aevumzenth.com/v2/energy/load-balance", bytes.NewBuffer(payload))
    req.Header.Set("Authorization", "Bearer "+token)
    client := &http.Client{}
    resp, _ := client.Do(req)
    fmt.Println(resp.Status)
}

Webhooks & Event Streaming

Subscribe to real-time events without polling. Aevum Zenth supports both traditional HTTP POST webhooks and Server-Sent Events (SSE) for low-latency streams.

Configuring Endpoints

Register webhook URLs via the console or API. Each endpoint receives a JSON payload with a signature header for verification.

Webhook Payload
{
  "event": "division.aerospace.telemetry.update",
  "id": "evt_9a8b7c6d5e4f3g2h1i",
  "timestamp": "2026-12-15T08:32:14Z",
  "data": {
    "vehicle_id": "AZ-SAT-044",
    "altitude_m": 420000,
    "status": "nominal"
  }
}

Verify signatures using HMAC-SHA256 with your webhook secret. The signature is sent in the X-Aevum-Signature-256 header.

Error Handling & Rate Limits

The API uses standard HTTP status codes. Errors return a JSON object with machine-readable codes and developer-facing messages.

CodeStatusDescription
400Bad RequestInvalid parameters or malformed JSON
401UnauthorizedMissing or expired token
403ForbiddenInsufficient permissions or IP restriction
429Too Many RequestsRate limit exceeded (see below)
500Internal ErrorUpstream service failure (retry with backoff)

Rate Limiting

Requests are throttled based on your plan tier. Limits are tracked per token and reset every 60 seconds.

  • Standard: 500 req/min
  • Professional: 2,000 req/min
  • Enterprise: 10,000+ req/min (custom)

Monitor your quota via the X-RateLimit-Remaining header. Implement exponential backoff for 429 responses.

Official SDKs

Accelerate development with our maintained client libraries. All SDKs handle authentication, retries, pagination, and type safety.

Python

pip install aevum-zenth

Node.js

npm install @aevum/zenth-sdk

Go

go get github.com/aevumzenth/sdk-go

Ruby

gem install aevum_zenth
}