Developer Resources

Getting started

• Integrating Synumatic into your application requires two simple steps:
  ‍
  ‣ Add a reference to the Synumatic javascript file <script src="https://widget-app-source.s3.amazonaws.com/widget.min.js"></script>.
  ‣ Add <ng-widget></ng-widget> element to your entry point html file, with the parameters described below.
  ‍

Users

• Although it is possible for an end user to have have separate user accounts in your application and in Synumatic, the whole idea is to provide a seamless integration. To accomplish this, one of the first things you should do is configure single-sign-on (SSO). When doing so, the users in your application will automatically get a corresponding user account in Synumatic as well as seamlessly be signed-in to Synumatic whenever they sign in to your application.
  ‍

Add Synumatic to your app

• The Synumatic ng-widget element is the main entry point used when embedding Synumatic . It sets up a connection to a Synumatic server and handles real-time communication, event distribution, and more. Embedding Synumatic into an application starts with adding a reference to the Synumatic javascript file and initializing adding a single element:

Input Parameters

• userid - a unique user ID used to access your application

• name - user full name - Optional

• email - user email address - Optional

• username - a unique username used to access your application - Optional

• association - an internal group or association the user is assigned to

• clientid - a unique client ID provided by Synumatic