SOAP API & Integration
This document provides detailed information about integrating with the Service API using SOAP, including WSDL definitions, message formats, and client library recommendations.
1. Overview
The Service API is implemented as a SOAP web service that exposes TR-069 device management capabilities to external systems. All interactions with the Service API follow the SOAP 1.1 protocol and WS-I Basic Profile.
3. 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("nbi.url")}.
3.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://<NBI_API_SERVER_HOST>[:<PORT>]/iot-webservice/swagger-ui/index.html