API  /  For tenants, partners, and integrators

An API designed for the people building on top of ISPCQ.

RESTful JSON, multilingual, scoped, audited. Forty-plus endpoints across customer, contract, billing, and network operations. The same surface Aelita uses internally is what tenants and partners get for their own integrations. Reference documentation is supplied directly.

RESTful JSON 40+ endpoints 5 access tiers ACL v2 scoped IP-whitelisted keys Audit-logged
The principle

Most ERPs ship an API as a checkbox. ISPCQ ships it as a product.

Every vendor matrix says "API: yes." What that usually means: a handful of read-only endpoints, undocumented quirks, no rate-limit story, no auth model beyond a static token, no audit trail, and a webhook story that consists of "you can poll us."

The result is that integrators spend the first month of the engagement reverse-engineering what the API actually does, the second month working around what it can't do, and the third month convincing the vendor to add the missing endpoint.

The ISPCQ API was built against real production demands from day one. Aelita uses it for every AI capability she ships. Reseller portals use it for partner-managed customer portfolios. Internal cron jobs use it for billing reconciliation, network monitoring, and dispatch automation.

That means the surface is exercised, the auth is tested, the rate limits are calibrated, and the documentation reflects what actually exists, not what was promised in a deck.

What's exposed

Six layers across the operational surface.

The full reference goes to tenants and integrators with their access keys. Below is the architectural shape so a CTO can evaluate the fit before the conversation.

01
Customer & contract surface
Profile / contracts list / coverage / search

Read customer profiles, contract lists with status filtering, billing-balance summaries, address coverage checks, multi-criteria customer search. The customer-and-contract surface is the most-trafficked part of the API and the one most integrators start with.

  • Full customer profile with active contracts and billing summary
  • Contract list per customer with status and effective-status filters
  • Address coverage check (geocoded, with delivery type and nearby-area hints)
  • Customer search by email, phone, name, VAT, registration number
  • Termination eligibility check + execution endpoint with reason capture
02
Network operations
ONU / signal / outage / port / reboot

Per-contract network state. Live ONU status with optional realtime OLT query for the freshest signal data. ARPING for layer-3 connectivity. ONU port link status for cable-vs-router diagnosis. Outage-cluster detection. Remote ONU reboot with cooldown and audit log.

  • ONU status with signal, equipment, and outage-correlation context
  • ARPING with configurable probe count (1-10)
  • ONU LAN port link status (up / down / unsupported)
  • Outage detection with port-specific and OLT-wide classification
  • Remote ONU reboot, 5-minute cooldown, fully audited
  • Service stop / start (gated by network:write scope)
03
Billing & payments
Balance / debit / payments / invoices / verify

Read access to the billing layer with the same depth the operations team sees. Balance with debit / credit semantics, debit-order health and reject history, payment history (multi-channel), tolerance status for service-expiry risk, paginated invoice history, payment verification by amount / date / reference.

  • Balance with currency, status, and display formatting
  • Debit-order health with reject history and consecutive-reject tracking
  • Multi-channel payment history (bank, gateway, ledger views)
  • Tolerance status with risk classification
  • Paginated invoices with status and period
  • Payment verification (amount / date / reference matching)
04
Auth & access tiers
5-tier rate limiting / scoped permissions

API-key authentication via X-API-Key header or Authorization Bearer. Five access tiers (internal, service, partner, customer, public) with calibrated rate limits. ACL v2 scopes for fine-grained permission control. Per-key IP whitelisting. Customer-tier keys auto-restricted to their own UCN.

  • Tiered rate limits: 1000/min internal, 100/min service, 60/min partner, 30/min customer, 10/min public
  • Per-key IP whitelist (silent 403 on mismatch to keep logs clean)
  • Wildcard, category, and specific scopes (customers:read, network:write, billing:*, etc.)
  • Customer-tier keys scoped to linked UCN automatically
  • Reseller-tier keys scoped to managed-customer set via ACL v2 roles
05
Multilingual & consistent
URL-prefix language / standardized envelope

Error messages translated via URL prefix (`/en/api/v1/...`, `/af/api/v1/...`). Every response uses the same envelope shape: success boolean, data payload, meta block with request_id, timestamp, version, response time. Error codes are stable strings (UNAUTHORIZED, RATE_LIMITED, INVALID_UCN, CUSTOMER_NOT_FOUND, ...) so client code can branch reliably.

  • Multilingual error messages by URL prefix
  • Standardized response envelope (success / data / meta)
  • Stable error codes for client-side branching
  • Request ID on every response for correlation with server logs
  • Per-response timing telemetry
06
Audit & observability
ACL v2 audit / contract notes / API log

Sensitive operations (ONU reboot, service stop, contract termination, MAC update) write three audit records: ACL v2 audit log (compliance-grade, immutable), a contract note visible in the ERP timeline, and a dedicated API log file for forensics. Every API call carries a unique request ID surfaced in response headers and server logs.

  • ACL v2 audit log: immutable, exportable for regulators
  • Contract notes auto-created for sensitive operations
  • Dedicated API log file with request / response / timing
  • Per-request correlation ID surfaced in response headers
  • Rate-limit headers (Limit / Remaining / Reset / Day-Limit / Day-Remaining)
What partners build on it

Three things tenants and integrators have already shipped.

Reseller portals. Partner-managed customer portfolios. Resellers see only their own customers (per-key scoping enforced by ACL v2), can view billing balances, raise terminations, update MAC addresses, and run remote diagnostics. The portal is theirs; the operational surface is ours.

Customer-facing apps. Mobile and web applications where the end customer self-services: pay a bill, check balance, see signal quality, reboot their own ONU, request a plan change. The customer-tier key is auto-scoped to the linked UCN so the app cannot leak across customers.

Internal automation. Cron-driven reconciliation, monitoring integrations, dispatch automations, status-page feeds, third-party CRM syncs. The same API surface that powers Aelita is available for the team's own scripts, with the same auth and audit story.

Used by
Aelita (internal AI)
Powers
Reseller portals
Drives
Customer self-service
Feeds
Internal automation
Integrates
Third-party CRMs
Surfaces
Status pages
Operations & release cadence

Versioned. Deprecated cleanly. Released often.

An API is not a one-shot deliverable; it is a long-running contract with the people who built against it. ISPCQ's release discipline reflects that.

01
Versioned URL surface.
Endpoints live under `/api/v1/`. Major versions stay supported until tenants and integrators have moved off them. Minor versions add capability without breaking existing clients. Patch versions are bug-fix only.
02
Clean deprecation path.
Deprecated endpoints return 410 Gone with a structured error pointing at the replacement endpoint. No silent removals. No surprise breaking changes. The deprecation window is measured in months, not days.
03
Release cadence is fast and observed.
v1.0 shipped 2025-12-22. v1.6.0 shipped 2026-01-10. Six minor versions in three weeks. The pace reflects a team that uses the API daily, not one that documents and hopes. Each release ships with a changelog entry covering new endpoints, bug fixes, security changes, and the files modified.
04
Integrator support is a real channel.
When an integrator hits a missing endpoint, an unclear error, or a documentation gap, that goes into the same backlog the platform itself feeds from. Roadmap items get prioritised based on real partner pull, not speculative demand.
Get access

Reference documentation goes to tenants and integrators directly.

The full API reference (endpoint listings, request and response shapes, error tables, scope requirements, audit details) is provided privately to tenants and integrators on confirmation of an integration relationship. The marketing surface is this page; the working surface is shipped to the people building against it.

Email us with what you're building and the expected scope (read-only, write, full). We'll provision keys at the appropriate tier with the right IP whitelist and reply with the current reference within one business day. No automated sales sequences.

What we'll need

Who is building
Internal team / partner ISP / customer-facing app
Scope
Read-only, write, network ops, billing
Source IPs
For per-key IP whitelisting
Expected volume
To select the right access tier