API Integrations

1. Overview

The Provision Portal project offers REST, SOAP, and external NBI API integration for managing and monitoring CPE provisioning. This document describes each interface, including endpoints, message formats, authentication, and usage examples.

2. REST API

The complete REST API specification—including all endpoints, request and response schemas, and error definitions—is available via Swagger UI:

http://<API_SERVER_HOST>[:<PORT>]/prov-portal/swagger-ui/index.html#/

2.1. UI Controllers (Angular Frontend)

For detailed documentation of the UI controllers used by the Angular frontend application, see UI Controllers API.

The UI controllers include:

  • AuthController (/ui/auth) - Authentication and session management

  • DeviceController (/ui/device) - Domain management

  • ProvController (/ui/provision) - Device provisioning operations

  • ServerController (/ui/server) - Server configuration and logging

  • UserController (/ui/users) - User CRUD operations

3. SOAP API

The SOAP API exposes the same operations as the REST interface. All available SOAP operations, message formats, and fault definitions are described in the WSDL and associated XSDs, which can be retrieved here:

http://<API_SERVER_HOST>[:<PORT>]/prov-portal/soap/ProvWS?wsdl

4. Northbound API Integration

The portal integrates with the external Network Backend Interface (NBI) API to perform provisioning operations, retrieve device information, and manage transactions. All endpoints are available at the base URL ${environment.getProperty("northbound-api.base- url")}/api.

4.1. NBI API Endpoints

Method

Path

Description

POST

/api/Transaction

Retrieve tasks info (FTGetTransactionStatus) for a given transaction ID

PUT

/api/Rpc

Invoke remote procedure call (FTRPCInvoke)

PUT

/api/Parameter

Perform device parameter updates (FTSetDeviceParameters)

PUT

/api/UserInfo

Update device information (FTUpdateDeviceInfo)

PUT

/api/Device/Domain

Update device domain

POST

/api/Device/Info

Get device information

PUT

/api/Object

Add or modify objects on the device (FTAddObject)

POST

/api/Parameter/Transaction

Retrieve parameter transaction details (FTGetDeviceParametersByTranslD)

POST

/api/Device/Mac

Find CPE by WAN MAC address (FTFindCPEByWANMAC)

POST

/api/Device/Status

Check device online/offline status

DELETE

/api/Provision

Delete all provision data records (FTRemoveCPEProvisionData)

You can explore the full NBI API Swagger documentation here:

http://<API_SERVER_HOST>[:<PORT>]/FTACSWS_REST/swagger/ui/index#
Message Flow

  1. Provision Portal posts a callback URL to NBI upon batch creation.

  2. NBI invokes the callback with device status updates.

  3. Portal validates the payload and persists status, triggering downstream workflows.