Northbound interface: Difference between revisions
(Updated page to add RESTful API) |
(Moved tbconfig example to Restful API page) |
||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:RESTful API and Northbound interface}} | {{DISPLAYTITLE:RESTful API and Northbound interface}} | ||
== | {| class="wikitable" | ||
|- | |||
|rowspan="3"|This article applies to: | |||
|'''Product''' | |||
|'''Version''' | |||
|- | |||
|Tmedia | |||
|2.9, 2.10, 3.0, 3.2 | |||
|- | |||
|SBC | |||
|2.9, 2.10, 3.0, 3.2 | |||
|} | |||
The RESTful API and Northbound interface allows a higher-level component to configure. This is particularly useful for deployment of large number of units in the field. | The RESTful API and Northbound interface allows a higher-level component to configure. This is particularly useful for deployment of large number of units in the field. | ||
== TelcoBridges and Northbound interface == | == TelcoBridges and Northbound interface == | ||
An external application using the RESTful API can now configure the TelcoBridges devices through its Northbound interface.<br> | |||
Some implementation, like the tbconfig tool provided by TelcoBridges can be used to configure the TelcoBridges devices through its Northbound interface. | Some implementation, like the tbconfig tool provided by TelcoBridges can be used to configure the TelcoBridges devices through its Northbound interface. | ||
| Line 13: | Line 24: | ||
=== Integration with EMS === | === Integration with EMS === | ||
The RESTful API (See wikipedia [http://en.wikipedia.org/wiki/Representational_state_transfer RESTful API] ) allows the provisioning of [[Tmedia]] VoIP gateway or [[ProSBC]]. The configuration of the device is seen as collections of resources than can be queried/modified through this interface. | |||
HTTP requests are sent to the [[Toolpack_Application:web_server|web server]] using standard HTTP methods(e.g., GET, PUT, POST, or DELETE). Data exchanged in requests and responses is in [http://en.wikipedia.org/wiki/JSON JSON] format. | HTTP requests are sent to the [[Toolpack_Application:web_server|web server]] using standard HTTP methods(e.g., GET, PUT, POST, or DELETE). Data exchanged in requests and responses is in [http://en.wikipedia.org/wiki/JSON JSON] format. | ||
| Line 19: | Line 30: | ||
More information on the TelcoBridges implementation of the [[Northbound_interface:RESTful|RESTful API here]] | More information on the TelcoBridges implementation of the [[Northbound_interface:RESTful|RESTful API here]] | ||
== References == | |||
[http://en.wikipedia.org/wiki/Representational_state_transfer Wikipedia RESTful API] | |||
[[Category:Glossary]] | [[Category:Glossary]] | ||
[[Category:Revise on Major]] | [[Category:Revise on Major]] | ||
Revision as of 15:06, 7 August 2023
| This article applies to: | Product | Version |
| Tmedia | 2.9, 2.10, 3.0, 3.2 | |
| SBC | 2.9, 2.10, 3.0, 3.2 |
The RESTful API and Northbound interface allows a higher-level component to configure. This is particularly useful for deployment of large number of units in the field.
TelcoBridges and Northbound interface
An external application using the RESTful API can now configure the TelcoBridges devices through its Northbound interface.
Some implementation, like the tbconfig tool provided by TelcoBridges can be used to configure the TelcoBridges devices through its Northbound interface.
Configuration
The Northbound interface offers multiple ways to configure your system:
Integration with EMS
The RESTful API (See wikipedia RESTful API ) allows the provisioning of Tmedia VoIP gateway or ProSBC. The configuration of the device is seen as collections of resources than can be queried/modified through this interface.
HTTP requests are sent to the web server using standard HTTP methods(e.g., GET, PUT, POST, or DELETE). Data exchanged in requests and responses is in JSON format.
More information on the TelcoBridges implementation of the RESTful API here