Northbound interface:RESTful - Revision history

Allyntree at 18:20, 16 August 2024

2024-08-16T18:20:56Z

← Older revision		Revision as of 14:20, 16 August 2024
Line 2:		Line 2:

	= TelcoBridges HTTP RESTful Northbound Interface =		= TelcoBridges HTTP RESTful Northbound Interface =
	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.		The [http://en.wikipedia.org/wiki/Representational_state_transfer RESTful API] is used to provision a [[Tmedia]] VoIP gateway or a [[Tdev]] development platform. The configuration of the device is seen as collections of resources than can be queried and 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 httprestapi, since it was not working with .gz

2023-08-11T13:35:35Z

Updated link to httprestapi, since it was not working with .gz

← Older revision		Revision as of 09:35, 11 August 2023
Line 341:		Line 341:

	= Ruby implementation example =		= Ruby implementation example =
	This ruby script ([[Media:~~Httprestapi~~.~~rb.gz‎~~\|httprestapi]]) is an example of how to use TelcoBridges RESTful Northbound Interface.		This ruby script ([[Media:httprestapi.zip\|httprestapi]]) is an example of how to use TelcoBridges RESTful Northbound Interface.
	* The script can be executed from any computer having access to the management web interface.		* The script can be executed from any computer having access to the management web interface.
	* The script can also be copied on the internal host of a ''T''media and executed from a SSH client (as shown in the examples below using <nowiki>127.0.0.1:12358</nowiki>).		* The script can also be copied on the internal host of a ''T''media and executed from a SSH client (as shown in the examples below using <nowiki>127.0.0.1:12358</nowiki>).

Luc Morissette: /* HTTP port */

2023-08-07T19:14:44Z

HTTP port

← Older revision		Revision as of 15:14, 7 August 2023
Line 325:		Line 325:
	=== HTTP port ===		=== HTTP port ===
	The HTTP port for RESTful access is the same as for the Web interface. By default, HTTP port is 12358.		The HTTP port for RESTful access is the same as for the Web interface. By default, HTTP port is 12358.
	Therefore the RESTful URIs should looks something like: '''<br><nowiki>http://~~TMG_IP_ADDR~~:12358/@[collection_name]/@[resource_name]</nowiki>'''		Therefore the RESTful URIs should looks something like: '''<br><nowiki>http://[Management_IP]:12358/@[collection_name]/@[resource_name]</nowiki>'''

	=== Credentials ===		=== Credentials ===

Luc Morissette: /* Download Active Configuration */

2023-08-07T19:14:18Z

Download Active Configuration

← Older revision		Revision as of 15:14, 7 August 2023
Line 355:		Line 355:
	= Download Active Configuration =		= Download Active Configuration =
	It is possible to download the current active configuration directly from the Web portal in a json file. <br>		It is possible to download the current active configuration directly from the Web portal in a json file. <br>
	Please follow ~~these instructions~~ to add this capability:		Please follow this link to the forums to add this capability:
	[https://forums.freesbc.com/t720-download-full-active-configuration-and-other-things-from-webgui-in-json-format Download full Active Configuration]		[https://forums.freesbc.com/t720-download-full-active-configuration-and-other-things-from-webgui-in-json-format Download full Active Configuration]

Luc Morissette: /* Download Active Configuration */

2023-08-07T19:13:54Z

Download Active Configuration

← Older revision		Revision as of 15:13, 7 August 2023
Line 354:		Line 354:

	= Download Active Configuration =		= Download Active Configuration =
	It is possible to download the current active configuration directly from the Web portal in a json file. Please follow these instructions to add this capability:		It is possible to download the current active configuration directly from the Web portal in a json file. <br>
			Please follow these instructions to add this capability:
	[https://forums.freesbc.com/t720-download-full-active-configuration-and-other-things-from-webgui-in-json-format Download full Active Configuration]		[https://forums.freesbc.com/t720-download-full-active-configuration-and-other-things-from-webgui-in-json-format Download full Active Configuration]

Luc Morissette: Added link to forums for downloading active configuration

2023-08-07T19:13:27Z

Added link to forums for downloading active configuration

← Older revision		Revision as of 15:13, 7 August 2023
Line 352:		Line 352:
	* The application tool can be run from any computer having access to the management web interface.		* The application tool can be run from any computer having access to the management web interface.
	Please follow this link for more information: [[Postman_tool_integration\|Postman Tool Integration]]		Please follow this link for more information: [[Postman_tool_integration\|Postman Tool Integration]]

			= Download Active Configuration =
			It is possible to download the current active configuration directly from the Web portal in a json file. Please follow these instructions to add this capability:
			[https://forums.freesbc.com/t720-download-full-active-configuration-and-other-things-from-webgui-in-json-format Download full Active Configuration]

Luc Morissette at 19:09, 7 August 2023

2023-08-07T19:09:40Z

← Older revision		Revision as of 15:09, 7 August 2023
Line 2:		Line 2:

	= TelcoBridges HTTP RESTful Northbound Interface =		= TelcoBridges HTTP RESTful Northbound Interface =
	~~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.		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.

	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: Added link to tbconfig

2023-08-07T19:06:03Z

Added link to tbconfig

← Older revision		Revision as of 15:06, 7 August 2023
Line 330:		Line 330:
	The credentials (user/password) used to authenticate a RESTful client application are the same as for the WebPortal.		The credentials (user/password) used to authenticate a RESTful client application are the same as for the WebPortal.
	Users can be managed from the Web interface under /users. The same path is used to manage users by the RESTful interface.		Users can be managed from the Web interface under /users. The same path is used to manage users by the RESTful interface.

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

			* cli
			* shell
			* command line

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

	= Ruby implementation example =		= Ruby implementation example =

Luc Morissette: Moved Ruby implementation to new page

2023-08-07T18:56:36Z

Moved Ruby implementation to new page

@@ Line 335: / Line 335: @@
 * The script can be executed from any computer having access to the management web interface.
 * The script can also be copied on the internal host of a ''T''media and executed from a SSH client (as shown in the examples below using <nowiki>127.0.0.1:12358</nowiki>).
+Please follow this link for more information: [[restful_api_ruby_implementation|Ruby Implementation Example]]
 = Postman tool integration =

Luc Morissette: Move postman section to a new page

2023-08-07T18:52:51Z

Move postman section to a new page

@@ Line 408: / Line 408: @@
 * Postman tool is another example of how to use TelcoBridges RESTful Northbound Interface.
 * The application tool can be run from any computer having access to the management web interface.
+Please follow this link for more information: [[Postman_tool_integration|Postman Tool Integration]]