API & Integration Platform

Quick Start

Follow these steps to integrate with the Aevum Zenth API. All production endpoints require authentication and are served over HTTPS.

1. Generate an API Key

Navigate to /console/keys and create a new API key with the appropriate scope. Store it securely; do not commit it to version control.

2. Set the Base URL

3. Make a Request

    Bash
    Copy

curl "https://api.aevumzenth.com/v2/divisions" \
  -H "Authorization: Bearer AZENTH_API_KEY" \
  -H "Content-Type: application/json" \
  -H "X-AZ-App-Version: 1.0.0"

4. Parse the Response

    JSON
    Copy

{
  "data": [
    {
      "id": "div_energy_001",
      "name": "Aevum Energy & Power",
      "sector": "Renewables & Grid Infrastructure",
      "api_version": "v2.4",
      "status": "active"
    }
  ],
  "meta": {
    "request_id": "req_8f7a2b9c",
    "rate_limit_remaining": 482
  }
}

Authentication & Security

All API requests must be authenticated using Bearer tokens. Aevum Zenth supports OAuth 2.0 (Authorization Code & Client Credentials), API Keys, and IP Whitelisting for enterprise clients.

Core Endpoints

Explore the unified resource endpoints. Division-specific routes follow the pattern /v2/{division_slug}/{resource}.

Client SDKs

Official SDKs provide type-safe clients, automatic retries, exponential backoff, and division-specific helpers.

    pip install
    Copy

pip install aevum-zenth-sdk

    Python
    Copy

import aevum_zenth

# Initialize client
client = aevum_zenth.Client(
    api_key="AZENTH_API_KEY",
    env="production"
)

# Fetch real-time grid data
response = client.energy.grid.status(region="APAC-SOUTH")
print(response.data.load_mw)

    npm install
    Copy

npm install @aevum-zenth/sdk

    TypeScript
    Copy

import { AevumZenth } from "@aevum-zenth/sdk";

const client = new AevumZenth({
  apiKey: "AZENTH_API_KEY",
  timeout: 5000
});

const tracking = await client.logistics.track(
  "SHMT-8829-APAC"
);
console.log(tracking.location.lat);

    go get
    Copy

go get github.com/aevum-zenth/sdk-go/v2

    Go
    Copy

import "github.com/aevum-zenth/sdk-go/v2"

client := aevum.New(sdk.WithKey("AZENTH_API_KEY"))
ledger, err := client.Finance.Ledger.Submit(ctx, batch)
if err != nil {
    log.Fatalf("Submission failed: %v", err)
}

    Maven
    Copy

<dependency>
  <groupId>com.aevumzenth</groupId>
  <artifactId>az-sdk-java</artifactId>
  <version>2.4.1</version>
</dependency>

    Java
    Copy

AevumClient client = AevumClient.builder()
    .apiKey("AZENTH_API_KEY")
    .region(Region.EU_WEST)
    .build();

GridStatus status = client.energy()
    .grid()
    .getCurrentStatus();

Webhooks & Events

Subscribe to real-time events across divisions. Aevum Zenth guarantees at-least-once delivery with configurable retry policies and HMAC-SHA256 signature verification.

    POST /webhooks/subscribe
    Copy

{
  "url": "https://your-server.com/az-webhook",
  "events": ["logistics:shipment.arrived", "energy:grid.outage", "health:record.updated"],
  "secret": "whsec_8f7a2b9c...",
  "retry_policy": { "max_attempts": 5, "backoff": "exponential" }
}

Rate Limits & Tiers

Exceeding limits returns 429 Too Many Requests with Retry-After header. Enterprise clients can request dedicated API gateways.

Error Handling

All errors follow a consistent JSON structure. HTTP status codes indicate the category, while error_code provides machine-readable details.

    Error Response
    Copy

{
  "error": {
    "status": 403,
    "code": "INSUFFICIENT_SCOPE",
    "message": "Token lacks 'write:logistics' scope.",
    "request_id": "req_8f7a2b9c",
    "docs_url": "https://docs.aevumzenth.com/errors/403"
  }
}