How does jsConnect work?
In order for jsConnect to work you'll have to put some code on your site that identifies your users in a way that Vanilla can understand. Vanilla then requests this information when the user wants to sign in and synchronizes the user with Vanilla. In order to make this request for information Vanilla uses technology called jsonp. This allows us to send your cookies from your site to you and obtain login information.
This is the basic story of jsConnect, but it gets a bit more complicated than that in actual implementation because the information must be secured. We do this by sharing a secret key with your site and using it to sign requests so we know it comes from you.
Two Flavours of jsConnect SSO
There are two implementations of SSO that jsConnect supports. You can implement either of the methods or both as they serve different purposes.
Method 1: Site-Wide SSO
You implement site-wide SSO when Vanilla is as a full site. With this method you need to create a page that provides your login information in jsonp format.
Method 2: Embedded SSO
Vanilla also has the ability to be embedded in an html page either as an entire site or just as embedded comments. With this scenario you need to create a special SSO string that can be passed to the embedded Vanilla and provide login information.
If your site is using Wordpress then we make a plugin that allows you to use SSO with your Wordpress site. It also helps you set up an embedded forum and embedded comments on your site. You can get the plugin here.
jsConnect Client Libraries
While writing the client code for jsConnect is pretty straightforward, it can be a little bit difficult to secure the connection. Because of this we provide client libraries for four of the more popular languages. If we provide a client library that you can use then we highly recommend using it.
All of these libraries are open source and maintained on github:
- PHP jsConnect client library
- Ruby jsConnect client library
- Java jsConnect client library
- .NET jsConnect client library
All of these libraries have one file with all of the library code you'll need and one file that gives an example usage. They also have a readme that tells you which file is which. Please note that these libraries don't yet support embedded SSO.
Manually Implementing jsConnect
If your site is programmed in a language that doesn't have a client library then we provide documentation on our jsConnect protocol. Have a look at the jsConnect technical documentation part 1 and part 2.