Northbound interface: Difference between revisions

Latest revision as of 15:23, 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

Links

References

Wikipedia RESTful API

@@ Line 1: / Line 1: @@
-The Northbound interface allows a higher-level component to configure. This is particularly useful for deployment of large number of units in the field.
+{{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.
 == TelcoBridges and Northbound interface ==
-Starting with v2.9, EMS or the tbconfig tool can now configure the ''T''media its through the 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.
 == Configuration ==
@@ Line 9: / Line 23: @@
 The Northbound interface offers multiple ways to configure your system:
-=== tbconfig ===
+=== Integration with EMS ===
-The tbconfig tools allows user to directly modify your system's configuration trough multiple modes:
+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.
-* cli
+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.
-* shell
-* command line
-=== Integration with EMS ===
+More information on the TelcoBridges implementation of the [[Northbound_interface:RESTful|RESTful API here]]
-It is possible integrate the northbound interface into an EMS using http GET, PUT, POST and DELETE commands.
-== Dictionary ==
+== Links ==
-[[Web_Portal_Tutorial_Guide_v2.9|Dictionary v2.9]]
+*[[Toolpack_Application:tbconfig|tbconfig tool]]
+*[[restful_api_ruby_implementation|Ruby Implementation Example]]
+*[[Postman_tool_integration|Postman Tool Integration]]
+*[https://forums.freesbc.com/t720-download-full-active-configuration-and-other-things-from-webgui-in-json-format Download full Active Configuration]
+== References ==
+[http://en.wikipedia.org/wiki/Representational_state_transfer Wikipedia RESTful API]
 [[Category:Glossary]]
 [[Category:Revise on Major]]