Sugar Network/API: Difference between revisions
| Line 7: | Line 7: | ||
The common RESTful url format is: | The common RESTful url format is: | ||
http[s]://<SERVER>/<OBJECT> | http[s]://<SERVER>/<OBJECT>/<COMMAND>?<AUTH-TOKEN>=<VALUE>[&<ARG>=<VALUE>]..] | ||
For the beginning, API is not secure for reasons: | For the beginning, API is not secure for reasons: | ||
| Line 19: | Line 19: | ||
* The {{Code|AUTH-TOKEN}} is the {{Code|uid}} which is a hashed value from Sugar profile public SSH key (the same as JID value in Sugar Shell but without the domain part) that does not require any handshake procedures. | * The {{Code|AUTH-TOKEN}} is the {{Code|uid}} which is a hashed value from Sugar profile public SSH key (the same as JID value in Sugar Shell but without the domain part) that does not require any handshake procedures. | ||
The {{Code|OBJECT}} value is one of the [[#Objects|following]] objects. When {{Code|COMMAND}} and a set of {{Code|ARG}}s depend on {{Code|OBJECT}}. | The {{Code|OBJECT}} value is one of the [[#Objects|following]] objects. When {{Code|COMMAND}} and a set of {{Code|ARG}}s depend on {{Code|OBJECT}}. Besides, particular {{Code|COMMANDS}} can input and return data in [[Wikipedia:Json|JSON]] notation. | ||
== Objects == | == Objects == | ||