3.3.0

Initialization

Before initializing the SDK, you need to decide on an authentication method.

Authentication

The web SDK offers two methods of authentication.

  • The first, most preferred and most secure method is to implement the authentication step in your backend solution and then provide the token to the front-end web SDK component. This is the Token Method.

  • The second method is to allow the web SDK to execute authentication from the UI. This is the API Key Method.

Warning: The API Key Method is extremely unsecure and is not recommended for production environments.

Token Method

Contrary to what the name implies, you will still require an API key for this approach. The only difference is that the web SDK will never directly make use of the API key and will instead only receive a token.

Sybrin will provide you with an orchestration API endpoint, along with a personalized API key (If you have not received this, please contact us).

To use this method:

  • Excute a POST call to the authentication endpoint provided to you by Sybrin, adding your API key to an apiKey header on the request. The response will include a token (AuthToken property).

  • Provide the token returned from the API request to your front-end solution.

  • Set the token on the authToken property of your Sybrin.Identity.Options instance.

API Key Method

This method is much simpler, but also much less secure.

To use this approach:

  • Set the API key provided to you by Sybrin on the apiKey property of your Sybrin.Identity.Options instance.

  • Set the authentication endpoint provided to you by Sybrin on the authEndpoint property of your Sybrin.Identity.Options instance.

Initialization

Token Method

This is the preferred approach.

Please follow the steps described here. The JavaScript API may then be initialized as follows:

var options = new Sybrin.Identity.Options({
    authToken: 'your-auth-token-here',
    dataExtractionEndpoint: 'your-data-extraction-endpoint-here'
});

var identity = new Sybrin.Identity.Api();

identity.initialize(options);

The options object may be used to configure the API as desired.

API Key Method

This approach is not secure and is not recommended for production environments.

Please follow the steps described here. The JavaScript API may then be initialized as follows:

var options = new Sybrin.Identity.Options({
    apiKey: 'your-api-key-here', 
    authEndpoint: 'your-auth-endpoint-here'
    dataExtractionEndpoint: 'your-data-extraction-endpoint-here'
});

var identity= new Sybrin.Identity.Api();

identity.initialize(options);