WebSync: Documentation
Getting Started
Getting started with WebSync is easy!
-
Get a free account to login.
You will need an account to manage your domains. -
Register your domain to use WebSync.
A unique key is used to identify each of your domains. -
Add WebSync to your application!
Drop the latest client javascript into your page and start sending and receiving messages!
That's it! Check out the tutorials to learn more about how to integrate WebSync
with your applications.
Public vs. Private Keys
Each domain has both a public and private key.
- The public key is intended to be used when (a) security is not an issue or (b) the key is visible to the end user (i.e. in the JavaScript client).
- The private key is intended to be used when (a) secured access is important or (b) the key cannot be viewed by end users (i.e. in a proxy).
All client methods can be secured by requiring the private key to operate.
Check out the Portal to configure private key
requirements for your domain.
Channel Names
Channel names must start with a forward slash (/) and be composed
of alphanumeric characters. Additional forward slashes
may be used to organize channels (e.g. /myapplication/chat
and /myapplication/activity).
There are two reserved channels: /meta and
/websync. Channel names may not start with these
values.
Developing on Localhost
Domain keys can be configured to allow or deny connections from localhost.
Typically, you would allow connections from localhost while actively
developing and then deny them once the application is in production.