Changes

Sugar Network/API (view source)

Revision as of 01:34, 29 January 2012

490 bytes removed , 01:34, 29 January 2012

Line 9: Line 9:

The API is [[Wikipedia:Restful|RESTful]] and being served via HTTP(S) using [[Wikipedia:Json|JSON]] notation. The common RESTful request url format is:

−

http[s]://<SERVER>/<RESOURCE>[/<GUID|ACTION>[/<ACTION>]]?~~<AUTH-TOKEN>=<>[&~~<ARG>=<>]..]

+

http[s]://<SERVER>/<RESOURCE>[/<GUID|ACTION>[/<ACTION>]][?<ARG>=<>..]

When:

Line 18: Line 18:

Besides, particular request can send and receive data in [[Wikipedia:Json|JSON]] notation. If request processing was failed, the reply is a JSON directory that contains {{Code|error}} key with error message.

−

~~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 off-line schools.

−

~~In particular:~~

−

* API is being provided only via HTTP;

−

* The ''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.

== Commons ==

Alsroot

Bots, Bureaucrats, Check users, Administrators, Widget editors

5,705

edits