API & Integrations
Welcome to the API & Integrations hub for NMS Prime. This is the entry point for customers, partners, and integrators who want to connect external systems to NMS Prime. It is intentionally kept separate from the internal Developer Documentation so that integration topics are easy to find without reading the full contributor manual.
NMS Prime exposes a REST/JSON API that lets you inspect, create, modify, and delete platform objects (contracts, modems, QoS profiles, phone numbers, and more). The authoritative machine-readable reference is the OpenAPI specification at nmsprime.com/api.
What you can do with the API
Synchronise customer, contract, and subscription data with external CRM/ERP systems.
Automate provisioning of modems, MTAs, and telephone numbers.
Query device and service status (for example modem online state).
Trigger operational actions such as restarting a modem or MTA.
Integrate availability, ordering, and self-service front-ends with the platform.
In this section
Topic | Description |
|---|---|
API overview | High-level introduction to the NMS Prime API: transport, data format, base URL, and object model. |
Authentication & credentials | How to obtain credentials and authenticate API requests, including required roles and access scope. |
OpenAPI reference | The authoritative endpoint and schema reference. See nmsprime.com/api. |
Common workflows & recipes | Worked examples (curl / Python) for frequent tasks such as creating a contract or provisioning a modem. |
Error handling & versioning | Validation errors, response conventions, API versioning, and backward-compatibility guarantees. |
Application-specific APIs | Endpoints exposed by individual NMS Prime applications (for example availability and order portal APIs). |
Quick start
The API is REST/JSON based. A minimal request to list QoS objects looks like this:
curl -u YOUR_API_USER:YOUR_SECRET https://YOUR_HOST/admin/api/v0/QosCredentials, authentication scheme, and endpoint paths should always be confirmed against your installed NMS Prime version and the current OpenAPI specification, as they may differ between releases.
Getting help
For integration questions, feature requests, or support, use the ServiceDesk and Support Tickets process, or reach out via the community forum.
Maintainer note: This page is a scaffold for the new top-level API & Integrations section. The child pages listed under In this section still need to be created and populated, and the legacy NMS Prime API content should be reviewed (BasicAuth, api@localhost, /api/v0) and migrated here.