Getting Started with the Nova API

The Nova API is a JSON-over-HTTPS API for partner distribution, MVNO admin
operations, and integration webhooks. This guide walks you from zero to a
first authenticated request in about five minutes.

1. Pick an environment

Replace <mvno> with the MVNO short-name you have been onboarded against
(e.g. megsapp). All endpoints are versioned under /api/v1.

2. Get credentials

Two credential types exist:

• Partner API key — issued from the partner portal under Settings → API
  Keys. Used for server-to-server calls. Sent as x-api-key: <key>.
• Bearer JWT — issued by the relevant …/auth/login endpoint. Used for
  interactive (portal-style) sessions. Sent as Authorization: Bearer <jwt>.

See Authentication for the full breakdown.

3. Make your first call

curl --request GET \
  --url 'https://api-uat.megsapp.85.group/api/v1/partners' \
  --header 'x-api-key: <YOUR_PARTNER_API_KEY>'

A successful response uses the standard envelope (see
Response envelope):

{
  "data": [
    { "uuid": "…", "name": "Acme Distribution", "type": "BRANCH", … }
  ],
  "pagination": { "total": 12, "page": 1, "limit": 20, "totalPages": 1, "hasNext": false, "hasPrev": false }
}

4. Read the reference

Every endpoint in the API Reference has a request schema, a
sample response, and a Try It button. The reference is regenerated from
the source code on every release — what you see is what is deployed.

5. What to read next

• Authentication — keys, JWTs, rotation, scopes.
• Environments — base URLs, IP allowlisting.
• Response envelope — the { data } / { data, pagination } /
  { error } contract.
• Errors — the error code catalogue and how to handle them.
• Webhooks — receiving payment, survey, and DMA callbacks.
• Rate limits — quotas and 429 semantics.
• Changelog — backwards-compatible changes and deprecations.