JavaScript SDK

When running the examples you will be asked to sign in with a Circuit sandbox account.

Example to logon and fetch conversations:

// Create the client with the client_id (aka app key), scope and optionally a redirect_uri
const client = new Circuit.Client({
  client_id: 'your client_id',
  scope: 'READ_USER_PROFILE,READ_CONVERSATIONS'
});

// Logon with OAuth2, then retrieve the logged on user's conversations
client.logon()
  .then(user => console.log('Successfully authenticated as ' + user.displayName))
  .then(client.getConversations)
  .then(conversations => conversations.forEach(c => console.log(c.convId)))
  .catch(console.error);
                        

See OAuth 2.0 for information on how to register an app.

Examples

Plunker examples

Short examples demonstrating one or more particular APIs. You can view the source, or fork your own plunker. A sandbox account is required to run the live examples. JS Bin examples use OAuth 2.0.

Stackblitz examples

Short examples demonstrating one or more particular APIs. You can view the source, or fork your own stackblitz. A sandbox account is required to run the live examples.

JS Bin examples

Short examples demonstrating one or more particular APIs. You can view the source, or clone your own JS Bin using the link at the top right of the live example. A sandbox account is required to run the live examples. JS Bin examples use OAuth 2.0.

GitHub examples

The source code of the examples below are on GitHub and are hosted on rawgit.