Sugar Network/API: Difference between revisions

Line 7:

The common RESTful url format is:

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

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

For the beginning, API is not secure for reasons:

Line 19:

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

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

== Objects ==

@@ Line 7: / Line 7: @@
 The common RESTful url format is:
-  http[s]://<SERVER>/<OBJECT>/<FUNCTION>?<AUTH-TOKEN>=<VALUE>[&<ARG>=<VALUE>]..]
+  http[s]://<SERVER>/<OBJECT>/<ACTION>?<AUTH-TOKEN>=<VALUE>[&<ARG>=<VALUE>]..]
 For the beginning, API is not secure for reasons:
@@ Line 19: / Line 19: @@
 * 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 ''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.
+The ''OBJECT'' value is one of the [[#Objects|following]] objects. When ''ACTION'' and a set of ''ARG''s depend on ''OBJECT''. Besides, particular ''ACTION'' can input and return data in [[Wikipedia:Json|JSON]] notation. If ''ACTION'' was failed, it returns the JSON directory that contains {{Code|error}} key with error message.
 == Objects ==