Explore use cases for getting to production quicker

Welcome to our use-case-based tutorials providing a collection of feature-rich introductory examples that span NSP's key functional areas. The tutorials describe step-by-step workflows with links to sample scripts in a variety of programming languages for each use case.


List of all NSP API tutorials

Access & Authentication APIs

Discover the required API services for initially accessing, authenticating and locating NSP API services prior to using any of the NSP functional areas

Analytics APIs

Learn how to use APIs to embed NSP Analytics reports that provides dashboard views of a variety of network conditions, patterns and trends into your own applications

Carrier SDN Inventory APIs

Learn about the API services for retrieving Carrier SDN inventory data managed by the NSP platform

Cross-Domain Coordinator APIs

Discover the API services for enabling the automatic discovery of cross domain links between IP and optical networks. They can also be used for IGP optical correlation and analysis of link layer interconnects

Device Administrator APIs

Learn about REST services that allow API clients to define mediation policies for discovering and administering devices using the NSP’s MDM framework

Fault Management APIs

Learn about the APIs that provides alarm monitoring, correlation, and troubleshooting of the network. These APIs also allows you to filter alarm lists, identify root causes, determine alarm impacts and perform alarm management

Getting Started - My First NSP API Client

Learn to develop your first NSP API Client that accesses NSP API services as well as perform a few basic configuration requests on the NSP Platform

Getting Started with Postman Samples

Get started quicker with our feature-rich library of API sample requests using the Postman API Development Platform

IP MPLS & Optical Inventory APIs

Discover how you can use NSP APIs to retrieve and filter inventory data from a multilayer network that includes IP/MPLS or Optical network elements

IP/MPLS Management APIs

Learn about the REST API services that allows API clients to perform a variety of operations such as inventory management, network configuration and assurance on an NSP managed IP/MPLS network

Kafka Notification Service

Learn about NSP’s notification service that allows API Client applications to receive and monitor notifications that originate from NSP managed networks

Modeled Device Configurator APIs

Learn about RESTCONF APIs that allow API clients to configure parameters on compatible NEs managed by the NSP’s MDM framework

Network Elements and Services Inventory APIs

Discover the API services that allows you to retrieve inventory information on NSPs physical network elements, network services and related objects

Network Optimisation APIs

Learn about the API services that initiates requests on the Carrier SDN’s Network Resource Controller (NRC) modules that centralizes path computation and performs network optimization on SDN networks

NSP API Design Guide

Learn about common NSP API Design features, general prerequisites and dependencies and guidance on developing API applications on various NSP redundant architectures

OAM Testing and Monitoring APIs

Learn about the APIs that allows for the testing of network services by activating a variety of OAM tests and then collecting the results periodically for further monitoring and analysis

Performance & Telemetry KPI Statistics Monitoring APIs

Discover the Assurance REST APIs that will allow you to monitor network performance information based on certain KPIs, in real-time or periodically for later analysis

Service Fulfillment APIs

Discover the NSP APIs that triggers the execution of routing algorithms that allocates network resources for SDN services, and then deploys the services to a multi-layer, multi-vendor network

User and Session Management APIs

Learn about the REST API services for managing user accounts that reside on the local NSP user database that is applicable for Carrier SDN-only installations

Workflow Management APIs

Discover the APIs that allows you to perform network automation tasks on an NSP managed network using NSP’s workflow management framework