WordPlus Cloud realtime HTTP API
Your server sends events to rooms and users, and asks the pages of a user and waits for their replies. It reads the rooms someone is in, who is in each and its history, who is online, the group calls and live streams going on and who is in them, what your app uses, and the deliveries of its webhook. It takes a user out of everything at once, takes people out of rooms, calls and streams, mutes and ends calls, and moderates the chat of a stream as its moderators do. All with signed HTTPS requests. WordPlus Cloud tells your server what happens with a signed webhook.
The packages for Node (@wordplus/realtime), PHP (wordplus/realtime-php) and Python (wordplus-realtime) make
these requests for you. From any other language, sign them as signing requests shows. Every
request carries three headers: X-WordPlus-Site (your app key), X-WordPlus-Timestamp (unix seconds) and
X-WordPlus-Signature.
The examples use a helper that signs and sends a request, wordplus( method, path, body ), the same in every
language, given in full on signing requests.
Authentication
- API Key: site
- API Key: timestamp
- API Key: signature
Your app key, WORDPLUS_SITE.
Security Scheme Type: | apiKey |
|---|---|
Header parameter name: | X-WordPlus-Site |
The time of the request in unix seconds, within 5 minutes of the server clock.
Security Scheme Type: | apiKey |
|---|---|
Header parameter name: | X-WordPlus-Timestamp |
Hex HMAC-SHA256, under the publish key HMAC-SHA256(secret, "wordplus-realtime publish v1"), of
"{timestamp}\n{METHOD}\n{path with query, as sent}\n{sha256 hex of the body}" (signing requests).
Security Scheme Type: | apiKey |
|---|---|
Header parameter name: | X-WordPlus-Signature |
Contact