Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README.md #30

Merged
merged 2 commits into from
Nov 1, 2017
Merged

Update README.md #30

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c7f97ce
Update README.md
djpnewton Nov 1, 2017
123280b
Add auth_url note
djpnewton Nov 1, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Update README.md 
Add section about websocket authorization
  • Loading branch information
@djpnewton
djpnewton committed Nov 1, 2017
commit c7f97cebf7dde33641bff7797bf406d06ee47011
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,14 @@ matchengine

[HTTP Protocl](https://github.com/viabtc/viabtc_exchange_server/wiki/HTTP-Protocol) and [Websocket Protocl](https://github.com/viabtc/viabtc_exchange_server/wiki/WebSocket-Protocol) documents are available in Chinese. Should time permit, we will have it translated into English in the future.

## Websocket authorization

The websocket protocol has an authorization method (`server.auth`) which is used to authorize the websocket connection to subscribe to user specific events (trade and balance events).

To accomodate this method your exchange frontend will need to supply an internal endpoint which takes an authorization token from the HTTP header named `Authorization` and validates that token and returns the user_id.

Example response: `{"code": 0, "message": null, "data": {"user_id": 1}}`

## Donation

* BTC: 14x3GrEoMLituT6vF2wcEbqMAxCvt2724s
Expand Down