Developers

Introducing the Ops365 Partner API

Third-party systems can now read plans, customers, complaints, and bills over a scoped, key-authenticated REST API — without a staff login.

Operators increasingly run more than one system — accounting software, a CRM, a reporting dashboard. Until now, getting data out of Ops365 into those tools meant exports by hand. The Partner API lets those systems read an operator's own data directly, without anyone sharing a staff login.

🔌 REST API 🔑 Client ID + API Key 🎯 Scoped Keys 📄 Paginated

What You Can Read

Four read-only endpoints, each behind its own scope:

  • plans:read — GET /api/partner/v1/plans: the operator's active plan catalogue.
  • customers:read — GET /api/partner/v1/customers
  • complaints:read — GET /api/partner/v1/complaints
  • bills:read — GET /api/partner/v1/bills

Every endpoint returns a curated field list, not the internal database record: no photos, GPS coordinates, internal review workflow or history arrays. That keeps the shape small and stable even as the platform evolves underneath.

Two Credentials, Not One

Every request sends two headers:

  • X-Client-Id — the operator's permanent public identifier, like com.yourisp. Safe to keep in code and config.
  • X-Api-Key — a secret key issued from the operator's Integrations page. Treat it like a password.
Why two

A leaked API key on its own isn't enough to read anything — it has to match the operator's Client ID too. Keys are stored only as a one-way hash, shown once when created, and can be revoked instantly.

Example request

GET https://om.ops365.in/api/partner/v1/plans
X-Client-Id: com.yourisp
X-Api-Key: pk_<your key>

Scoped Keys

Each key carries only the scopes it was issued with. A reporting tool that only needs bills gets a bills:read key and nothing else. Keys are always tied to one operator — there is no way to widen a key to another operator's data.

Pagination and Rate Limits

  • Customers, complaints and bills are always paginated — ?page= and ?limit= (default 50, maximum 200), with page, limit, total and pages in every response.
  • Plans come back in one response, since a plan catalogue is small.
  • 300 requests per 15 minutes per IP address; beyond that the API returns 429.

Getting Access

Operators issue and revoke their own keys from Integrations → Partner API in the Ops365 dashboard, where their Client ID is also shown. If you're building an integration for an operator, ask them for a key with just the scopes you need.

Share this story

See what we have built

Explore the ISP / Cable Management platform — built in Amaravati, for operators across India.

Explore the Platform →