Demystifying deepstream's HTTP API

The fourth one from the webinar series by deepstream, exploring it's features and concepts.

Transcript

1. demystifying deepstream’s HTTP API Srushtika Neelakantam @Srushtika | info@deepstreamhub.com srushtika.neelakantam@deepstreamhub.com
2. HTTP? Realtime?
3. • IoT, FTW. • Bulk dump. • No deepstream? No problem! • Fan of CGI languages? - We got you covered.
4. HTTP
5. AJAX POLLING AJAX LONG POLLING HTTP/2
6. HTTP isn’t realtime. Hence: Receive a Pub/Sub event Get record updates for Data-Sync Presence Subscribe Anything else that requires persistent connections. x x x x
7. general format <HTTP ENDPOINT URL> POST DAT A
8. with deepstream.io
9. config.yml
10. with deepstreamHub
11. application dashboard
12. authentication request { "type": "webhook", "email": "bob@example.com", "password": "y4b4d4b4d00" }
13. with deepstream.io localhost://8080/auth with deepstreamHub <HTTP AUTH URL> No Auth File Auth Webhook Auth No Auth Token Auth Email Auth Webhook Auth
14. authentication request { "type": "webhook", "email": "bob@example.com", "password": "y4b4d4b4d00" }
15. authentication response { "success": "true", "token": "aI2wYSh1FS_2WODD14bYZe1TfIyhAukl", "clientData": { "profileColor": "brown", "Id": "s64907sdkjdsif" } }
16. ERROR plain text messages with 4xx status codes
17. POST requests: • Emit an event. • Read a record. • Create and update a record. • Delete a record. • Make an RPC. • Query presence.
18. command format requests responses • topic • action • success • error • errorTopic • errorEvent
19. emitting an event { "topic": "event", "action": "emit", "eventName": "lights-on", "data": 134.52 }
20. reading a record { "topic": "record", "action": "read", "recordName": "my-record" }
21. reading a record { "topic": "record", "action": "read", "recordName": "my-record" } { "success": true, "version": 2, "data": { "foo": "bar" } } request response
22. record heads { "topic": "record", "action": "head", "recordName": "my-record" }
23. record heads { "topic": "record", "action": "head", "recordName": "my-record" } { "success": true, "version": 2 } request response
24. creating and updating a record { "topic": "record", "action": "write", "recordName": "users/123", "path": "firstname", "version": 6, "data": "Bob" }
25. creating and updating a record { "success": false, "error": "Record update failed. Version 6 exists for record \"users/123\".", "errorTopic": "record", "errorEvent": "VERSION_EXISTS", "currentVersion": 6, "currentData": { "firstname": "Alan", "lastname": "Smith" } } response
26. deleting a record { "topic": "record", "action": "delete", "recordName": "my-record" }
27. making an RPC { "topic": "rpc", "action": "make", "rpcName": "add-two", "data": { "numA": 2, "numB": 5 } }
28. making an RPC { "topic": "rpc", "action": "make", "rpcName": "add-two", "data": { "numA": 2, "numB": 5 } } { "success": true, "data": 7 } request response
29. querying presence { "topic": "presence", "action": "query" }
30. querying presence { "success": true, "users": [ "ac65902c-13ea-469c-91e6-2cdc8c31136d", "fba85ac8-02bd-98a7-bb42-b2526243b562", "aba325bd-dd23-aba4-3390-02763477453e" ] } response
31. batching HTTP requests
32. That’s all folks ! questions? @Srushtika | info@deepstreamhub.com srushtika.neelakantam@deepstreamhub.com