How do I get started with the Phenix WebSDK?

Owned by JK Phenix, created
Last updated: May 21, 2021
1 min read

To get started with the Phenix WebSDK, follow the steps outlined in this page.

Instructions

  1. Review the Phenix documentation and examples:

    1. Overview documentation

    2. Publisher documentation and GitHub example

    3. Viewer documentation and GitHub example

  2. Include the Phenix WebSDK in your application (available via package managers such as npm or bower, or request it directly from Phenix). If using NPM, be sure to use version 6.14.11, as version 7 is not supported by Phenix at this time.

  3. Download and install Phenix EdgeAuth into your workflow. Sample code in a few languages can be found in this GitHub repository

  4. See the admin API documentation for creating a channel, or create a channel by logging into the Phenix customer portal

 

EdgeAuth (also sometimes known as TokenAuth) is the preferred method of authentication. Phenix EdgeAuth is functionally similar to what many CDNs call Token Authentication.

Once downloaded and installed into your user authentication workflow, Phenix EdgeAuth allows you to quickly and easily generate secure digest tokens without requiring any network connectivity to the Phenix system. Digest tokens can be configured in various ways to control aspects like viewing, publishing, channel restrictions and the length of the token validity.

Related articles

©2020-2021 Phenix Real Time Solutions, Inc.