Northbound interface - Revision history

Luc Morissette: /* Links */

2023-08-07T19:23:55Z

Links

← Older revision		Revision as of 15:23, 7 August 2023
Line 35:		Line 35:
	*[[restful_api_ruby_implementation\|Ruby Implementation Example]]		*[[restful_api_ruby_implementation\|Ruby Implementation Example]]
	*[[Postman_tool_integration\|Postman Tool Integration]]		*[[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 ==		== References ==

Luc Morissette: /* Links */

2023-08-07T19:10:36Z

Links

← Older revision		Revision as of 15:10, 7 August 2023
Line 32:		Line 32:

	== Links ==		== Links ==
	[[Toolpack_Application:tbconfig\|tbconfig tool]]		*[[Toolpack_Application:tbconfig\|tbconfig tool]]
	[[restful_api_ruby_implementation\|Ruby Implementation Example]]		*[[restful_api_ruby_implementation\|Ruby Implementation Example]]
	[[Postman_tool_integration\|Postman Tool Integration]]		*[[Postman_tool_integration\|Postman Tool Integration]]

	== References ==		== References ==

Luc Morissette: /* References */

2023-08-07T19:10:27Z

References

← Older revision		Revision as of 15:10, 7 August 2023
Line 30:		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]]


			== Links ==
			[[Toolpack_Application:tbconfig\|tbconfig tool]]
			[[restful_api_ruby_implementation\|Ruby Implementation Example]]
			[[Postman_tool_integration\|Postman Tool Integration]]

	== References ==		== References ==

Luc Morissette: Moved tbconfig example to Restful API page

2023-08-07T19:06:47Z

Moved tbconfig example to Restful API page

← Older revision		Revision as of 15:06, 7 August 2023
Line 1:		Line 1:
	{{DISPLAYTITLE:RESTful API and Northbound interface}}		{{DISPLAYTITLE:RESTful API and Northbound interface}}
	=== '''''~~Applies to version(s): v2.9 and above~~''''' ~~===~~		{\| 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 ==
	~~Starting with version 2.9, an~~ external application using the RESTful API can now configure the TelcoBridges devices through its Northbound interface.<br>		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 ===
	~~Introduced in version 2.9, 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.		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]]

	~~=== tbconfig ===~~
	~~The [[Toolpack_Application:tbconfig\|tbconfig]] tools allows user to directly modify your system's configuration through multiple modes:~~

	* cli		== References ==
	* shell		[http://en.wikipedia.org/wiki/Representational_state_transfer Wikipedia RESTful API]
	* command line

	~~More information about [[Toolpack_Application:tbconfig\|tbconfig tool here]]~~
	[[Category:Glossary]]		[[Category:Glossary]]
	[[Category:Revise on Major]]		[[Category:Revise on Major]]

Luc Morissette: Updated page to add RESTful API

2023-01-11T17:00:29Z

Updated page to add RESTful API

← Older revision		Revision as of 13:00, 11 January 2023
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}}
			=== '''''Applies to version(s): v2.9 and above''''' ===

			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 ==
	Starting with v2.9, ~~EMS or~~ the tbconfig tool can ~~now~~ configure the TelcoBridges devices through its Northbound interface.		Starting with version 2.9, 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 ==		== Configuration ==

Luc Morissette at 15:08, 15 January 2020

2020-01-15T15:08:25Z

← Older revision		Revision as of 11:08, 15 January 2020
Line 2:		Line 2:

	== TelcoBridges and Northbound interface ==		== TelcoBridges and Northbound interface ==
	Starting with v2.9, EMS or the tbconfig tool can now configure the ~~''T''media~~ through its Northbound interface.		Starting with v2.9, EMS or the tbconfig tool can now configure the TelcoBridges devices through its Northbound interface.

	== Configuration ==		== Configuration ==

Luc Morissette at 15:07, 15 January 2020

2020-01-15T15:07:53Z

← Older revision		Revision as of 11:07, 15 January 2020
Line 7:		Line 7:

	The Northbound interface offers multiple ways to configure your system:		The Northbound interface offers multiple ways to configure your system:

			=== Integration with EMS ===
			Introduced in version 2.9, 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.

			More information on the TelcoBridges implementation of the [[Northbound_interface:RESTful\|RESTful API here]]

	=== tbconfig ===		=== tbconfig ===
Line 15:		Line 22:
	* command line		* command line

	More information about ~~tbconfig~~ [[Toolpack_Application:tbconfig\|here]]		More information about [[Toolpack_Application:tbconfig\|tbconfig tool here]]

	~~=== Integration with EMS ===~~
	Introduced in version 2.9, 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.

	~~More information on the TelcoBridges implementation of the [[Northbound_interface:RESTful\|RESTful API here]]~~

	[[Category:Glossary]]		[[Category:Glossary]]
	[[Category:Revise on Major]]		[[Category:Revise on Major]]

Luc Morissette: Updated page

2020-01-15T15:06:54Z

Updated page

← Older revision		Revision as of 11:06, 15 January 2020
Line 18:		Line 18:

	=== Integration with EMS ===		=== Integration with EMS ===
	Introduced in version 2.9, the RESTful API (See wikipedia [http://en.wikipedia.org/wiki/Representational_state_transfer RESTful API] ) allows the provisioning of a [[Tmedia]] VoIP gateway or a [[~~Tdev~~]] ~~development platform~~. The configuration of the device is seen as collections of resources than can be queried/modified through this interface.		Introduced in version 2.9, 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.

	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]]

	~~== Dictionary ==~~
	~~[[Web_Portal_Tutorial_Guide_v2.9\|Dictionary v2.9]]~~


	[[Category:Glossary]]		[[Category:Glossary]]
	[[Category:Revise on Major]]		[[Category:Revise on Major]]

Luc Morissette at 15:04, 15 January 2020

2020-01-15T15:04:36Z

← Older revision		Revision as of 11:04, 15 January 2020
Line 18:		Line 18:

	=== Integration with EMS ===		=== Integration with EMS ===
	Introduced in version 2.9, the [http://en.wikipedia.org/wiki/Representational_state_transfer RESTful API] allows the provisioning of a [[Tmedia]] VoIP gateway or a [[Tdev]] development platform. The configuration of the device is seen as collections of resources than can be queried/modified through this interface.		Introduced in version 2.9, the RESTful API (See wikipedia [http://en.wikipedia.org/wiki/Representational_state_transfer RESTful API] ) allows the provisioning of a [[Tmedia]] VoIP gateway or a [[Tdev]] development platform. 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.

Luc Morissette: Updated link to make it clearer

2020-01-15T15:03:43Z

Updated link to make it clearer

← Older revision		Revision as of 11:03, 15 January 2020
Line 22:		Line 22:
	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.

	More information [[Northbound_interface:RESTful\|here]]		More information on the TelcoBridges implementation of the [[Northbound_interface:RESTful\|RESTful API here]]

	== Dictionary ==		== Dictionary ==