Changes

The common RESTful url format is:

The common RESTful url format is:

  http[s]://<SERVER>/<OBJECT>/<COMMAND>?<AUTH-TOKEN>=<VALUE>[&<ARG>=<VALUE>]..]

  http[s]://<SERVER>/<OBJECT>/<FUNCTION>?<AUTH-TOKEN>=<VALUE>[&<ARG>=<VALUE>]..]

For the beginning, API is not secure for reasons:

For the beginning, API is not secure for reasons:

* API is being provided only via HTTP;

* 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 ''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}}. Besides, particular {{Code|COMMAND}} can input and return data in [[Wikipedia:Json|JSON]] notation. If {{Code|COMMAND}} was failed, it returns the JSON directory that contains {{Code|error}} key with error message.

The ''OBJECT'' value is one of the [[#Objects|following]] objects. When ''FUNCTION'' and a set of ''ARG''s depend on ''OBJECT''. Besides, particular ''FUNCTION'' can input and return data in [[Wikipedia:Json|JSON]] notation. If ''FUNCTION'' was failed, it returns the JSON directory that contains {{Code|error}} key with error message.

== Objects ==

== Objects ==