CloudServices/WheresMyFox: Difference between revisions

Line 70: Line 70:
In addition, packet identifiers have been reduced as much as possible. This is to both reduce bandwidth costs as well as require less time to exchange data (remember, this content is being converted and wrapped in JWS)
In addition, packet identifiers have been reduced as much as possible. This is to both reduce bandwidth costs as well as require less time to exchange data (remember, this content is being converted and wrapped in JWS)


=== Data Schema ===
==== Data Schema ====
Since each server system will be unique, it does not make sense to strictly specify the data storage method. Instead an example storage mechanism will be offered to illustrate how the server would manage data.
Since each server system will be unique, it does not make sense to strictly specify the data storage method. Instead an example storage mechanism will be offered to illustrate how the server would manage data.


Line 86: Line 86:
     <i>user</i> => ["<i>key</i>:<i>name</i>",...]              // A list of known keys & user friendly names for devices
     <i>user</i> => ["<i>key</i>:<i>name</i>",...]              // A list of known keys & user friendly names for devices


=== API ===
==== API ====
For this API discussion:
For this API discussion:


Line 95: Line 95:
Unless otherwise specified, all exchanged JSON blocks are wrapped in JWS (not shown here for simplicity).
Unless otherwise specified, all exchanged JSON blocks are wrapped in JWS (not shown here for simplicity).


==== POST /<i>$v</i>/init ====
===== POST /<i>$v</i>/init =====
Post the Init JSON block to the WMF server.  
Post the Init JSON block to the WMF server.  


Line 106: Line 106:
     200    {"id": $id}
     200    {"id": $id}


==== GET /<i>$v</i>/cmd/<i>$id</i> ====
===== GET /<i>$v</i>/cmd/<i>$id</i> =====
GET the next command from the Server. This call is triggered by a SimplePush version update.  
GET the next command from the Server. This call is triggered by a SimplePush version update.  


Confirmed users
1,018

edits