Skip to Content

Changes for page REST API Documentation

Last modified by Scott Gagan on 2021/09/10 23:34
From version 16.1
edited by michaely
on 2015/07/09 14:10
Change comment: There is no comment for this version
To version 24.1
edited by Scott Gagan
on 2021/09/10 23:34
Change comment: Renamed back-links.

Summary

Details

Page properties
Parent
... ... @@ -1,0 +1,1 @@
1 +ISYMDEV.iSymphony Developer Documentation.WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.michaely
1 +XWiki.scottg
Content
... ... @@ -4,14 +4,14 @@
4 4  
5 5  {{toc maxLevel="2" indent="1"/}}
6 6  
7 -iSymphony provides a REST API that allows external applications and scripts to query and edit the configuration of the iSymphony server, and query live state of the iSymphony Server, along with the ability to execute actions, all via HTTP requests. The REST API has many uses including, but not limited to, integrating iSymphony configuration into existing configuration systems, auto provisioning of the iSymphony server, and development of custom applications and iSymphony widgets that depend on information provided by iSymphony. For example the iSymphony FreePBX module utilizes the REST Configuration API to synchronize the configuration between FreePBX and the iSymphony server.
7 +The iSymphony server provides a REST API that allows external applications to query and edit the configuration of the iSymphony server, query live state of the iSymphony Server, and execute actions, all via HTTP requests. The REST API has many uses including, but not limited to, integrating iSymphony configuration into existing configuration systems, auto provisioning of the iSymphony server, and development of custom applications, and iSymphony widgets, that depend on information provided by the iSymphony server. An example use case for this API is the iSymphony FreePBX module, which utilizes the configuration API to synchronize configuration between FreePBX and iSymphony.
8 8  
9 9  = Interfaces =
10 10  
11 11  The REST API is separated into two distinct interfaces.
12 12  
13 -* [[doc:Configuration API]] (**Available in iSymphony 3.1+**) - Provides access to the iSymphony configuration.
14 -* [[doc:Live API]]** (Available in iSymphony 3.2+**) - Provides access to the live state of the iSymphony server, and allows execution of actions.
13 +* [[doc:iSymphony Developer Documentation.REST API Documentation.Configuration API.WebHome]] (**Available in iSymphony 3.1+**) - Provides access to the iSymphony configuration.
14 +* [[doc:iSymphony Developer Documentation.REST API Documentation.Live API.WebHome]]** (Available in iSymphony 3.2+**) - Provides access to the live state of the iSymphony server, and allows execution of actions.
15 15  
16 16  = HTTP Methods =
17 17  
... ... @@ -99,7 +99,7 @@
99 99  
100 100  = Security =
101 101  
102 -By default the REST API will be restricted via HTTP Realm Auth and ACLs. The default credentials will be set to **manager:manag3rpa55word** and the ACLs will be set up to only allow connections from localhost. You can also secure the connection further with SSL encryption. See [[doc:ISYMDOCS.Security]] for more information.
102 +By default the REST API will be restricted via HTTP Realm Auth and ACLs. The default credentials will be set to **manager:manag3rpa55word** and the ACLs will be set up to only allow connections from **localhost**. You can also secure the connection further with SSL encryption. See [[doc:ISYMDOCS.Security]] for more information.
103 103  
104 104  {{info}}
105 105  When securing the rest API with SSL, URLs used to access the rest resources must use** https and port 55050**, instead of http and port 58080.