Sugar Network/API: Difference between revisions
Created page with "This page describes the APi that Sugar Network clients use to interact with Sugar Network server. See also the introduction page and [[Sugar_Network/Architectur..." |
|||
| Line 2: | Line 2: | ||
== Overview == | == Overview == | ||
The API is [[Wikipedia:Restful|RESTful]] and being served via HTTP(S) using [[Wikipedia:Json|JSON]] notation. | |||
The common RESTful url format is: | |||
http[s]://<SERVER>/<OBJECT>[/<COMMAND>]?<AUTH-TOKEN>=value[&ARG=value[;ARG=value]..] | |||
For the beginning, API is not secure for reasons: | |||
* Implement initial version in short period of time; | |||
* The only users, for the beginning, are teachers and students from one-teacher scholls. | |||
In particular: | |||
* API is being provided only via HTTP; | |||
* 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}}. | |||
== Objects == | == Objects == | ||