B2B PRISM Live Studio connection overview

Available in Classic and VPC

To use B2B PRISM Live Studio, build the essential APIs (service APIs) for your service according to the specifications provided in this guide.

Reasons you must build service APIs

Service APIs serve as a gateway, facilitating the exchange of information between B2B PRISM Live Studio and your service for live streaming. Therefore, to ensure successful integration with your service, it is necessary to build and stably operate appropriate APIs in accordance with the specifications for your service.

Create new lives and view live data

B2B PRISM Live Studio must be able to create a new live broadcast and view data of the live broadcast to start streaming. Your service needs to forward the necessary streaming details such as streaming path (<example> RTMP URL) through service APIs to stream live on B2B PRISM Live Studio.

Check live status

B2B PRISM Live Studio periodically checks the current status of the live. If the service you're using forcefully terminates or blocks a specific live broadcast's streaming, B2B PRISM Live Studio notifies the streamer of the live status and ends the live accordingly.

Collect live metrics

Streamers can collect metric data of lives in progress, such as views, likes, and chats, and forward the data to themselves through B2B PRISM Live Studio.

Other connection features

Your service can offer convenience to streamers in their broadcasts by providing additional features required for live through APIs in B2B PRISM Live Studio. The provided additional features are as follows:

• Transfer and view chats
• Block and unblock chat users
• Register and unregister chat admins

How to use service APIs

The service APIs for B2B PRISM Live Studio must be built in compliance with the basic standards and security guidelines.

Using REST APIs

Be cautious of the following when using REST APIs:

• Service APIs follow the standard of REST API.
• Service APIs use GET, POST, PUT, and DELETE methods.
  • The OPTIONS and HEAD methods must never be exposed externally due to security concerns.
• If there is no data for the requesting channel or live, 404 Not Found must be provided as the HTTP status, not 200 OK or Empty Body.
• When requesting a list of resources such as channels, the list must be provided in descending order of edited time followed by descending order of created time.

Security and authentication

All service APIs must be provided through TLSv1.2 or higher SSL connections for security. The permissions of the service API must be provided through OAuth2.0 authentication.

• B2B PRISM Live Studio obtains an access token with access rights to the service API using the OAuth2.0 authentication provided by your service and uses this access token to call the service API.
• Register the following information when registering your service for OAuth2.0 authentication system:
  • client-id: publicly known string that the OAuth2.0 server uses to identify the client application.
  • client-secret: password that the OAuth2.0 server uses to authenticate the client's identity along with client-id.
• B2B PRISM Live Studio obtains the following information through OAuth2.0 authentication:
  • Access Token: string that the client uses to interact with the resource server on behalf of the user.
  • Refresh Token: the Refresh Token is used to obtain a new Access Token after the expiration of the current Access Token.
• For more information about OAuth2.0 integration, see the OAuth2.0 basic concept and integration guide.

Essential build and selective build APIs

The service APIs you need to build for your service are divided into the essential build APIs that must be built to utilize the features of B2B PRISM Live Studio and the selective build APIs to use additional features.

Essential build API

See the following details of the essential build APIs:

Selective build API

See the following details of the selective build APIs: