In order to maintain the system secure and to avoid race conditions, browser clients cannot directly ask for subscriptions to Snorky. Instead, they need to ask to another party, usually your web application, to fetch the data and authorize a subscription.
The subscription process¶
- The browser client requests both the current data and a subscription. This can be done in a RESTful way with the header
- The web application sends to Snorky a subscription authorization request to one or more dealers. The web application receives a subscription token in return.
- The web application queries the database.
- The web application sends to the client both the data and the subscription token.
- The browser client shows the received data on the user interface, connects to Snorky and sends it the subscription token in order to receive updates.
The authorization request¶
DataSyncBackend provides the RPC command
DataSyncBackend.authorizeSubscription() to request a subscription token.
Requests a subscription authorization token.
Parameters: items (dict) –
Subscription items to be authorized.
Each item must be a dictionary with two properties:
In order to avoid race conditions, the database query must not be made until the subscription token has been received.
The subscription mechanism fits well into RESTful APIs. The recommended way to do this is with additional headers.
When a client wants to get both certain data and a subscription to updates in that data, it must send a header
When the server detects this header it must check client permissions and, if it is allowed to do so, it will ask Snorky for a subscription token for the kind of data requested.
For example, if the client requested the comments for the blog post with id 15, it will put in the subscription the dealer
CommentsByBlogEntry with query
Once received the token, the server will send it to the client in the response header
The server will query the database for the current comments in the blog entry
15 and write them in the response body.
Note this protocol is merely conventional. You can use whatever protocol you want to ask for subscriptions and return them later.