Online authentication

This document describes how to obtain the license file and the implementation steps of online authentication.

The license file refers to the software license and contains the following:

• Authorized time
• Authorized Platform
• Authorized SDK version
• Authorized features

To implement the AI features provided by the ZegoEffects SDK, an online user privilege authentication is required.

Online user privilege authentication refers to the process in which a client accesses the ZegoEffects Server, applies for a license file, and performs network authentication.

Understand the process

We now provide two online authentication methods for you to implement the online authentication:

• Send requests from your app client to the ZegoEffects Server
• Send requests from your own business server to the ZegoEffects Server

Method	Send requests from your app client	Send requests from your business server
Process	The app client accesses to the ZegoEffects SDK to get the AuthInfo. The ZegoEffects SDK returns the AuthInfo to app client. The app client sends an URL request to ZegoEffects Server with the AppID and AuthInfo. The ZegoEffects Server returns the license file (as License parameter) to app client. Import the resource and model files. The app client creates a ZegoEffects object with the License file. Enables the AI Effects feature to start implementing image processing.	The business server directly sends an URL request to the ZegoEffects Server through the public gateway interface. The ZegoEffects Server returns the license file (as License parameter) to the business server. The business server distributes the license file to app client. (this must be implemented by your own.) Import the resource and model files. The app client creates a ZegoEffects object with the license file. Enables the AI Effects feature to start implementing image processing.
Diagram	Client Request Flow	Server Request Flow
Advantages	Easy to use and integrate. You don't need to build your own business server or manage your authentication file.	Using your own business backend server, the request network will be relatively stable. And the probability of hitting the DNS cache increases because the server is relatively stable. You can set authentication capabilities and manage authentication files on your own app client, providing high flexibility.

Get the license

Before you start to implement user privilege authentication in your app, contact the ZEGO team to apply for the AppID and AppSign for online user privilege validation.

Method 1: Send requests from your app client

1. Get the authentication info from the ZegoEffects SDK

To get the authentication information, call the getAuthInfo method with the AppSign you get in the previous step.

NSString* authInfo = [ZegoEffects getAuthInfo:appSign]; 

2. Request for a license file from ZegoEffects Server

To get the license file after you get the authentication information, construct a message body that meets the following, and send the request to the ZegoEffects Server.

• URL: https://aieffects-api.zego.im?Action=DescribeEffectsLicense&AppId=xxxxxxxx&AuthInfo=xxxxxxxx
• Method: GET
• Content format: JSON
• Parameter:

• Sample message:

curl -X GET --data https://aieffects-api.zego.im?Action=DescribeEffectsLicense&AppId=xxxxxxxx&AuthInfo=xxxxxxxx

Method 2: Send requests from your business server

Your business server constructs a message body through the public gateway interface and directly sends a request to the ZegoEffects Server to apply for an license file. The message body structure is as follows:

• URL: https://aieffectscgi-api.zego.im?Action=CgiDescribeEffectsLicense
• Method: GET
• Content format: JSON
• Parameter:

• Sample message:

  Untitled

  curl -X GET https://aieffectscgi-api.zego.im?Action=CgiDescribeEffectsLicense?AppId=1&Signature=1302668869d55ab3f6114af4ba6e5580&SignatureNonce=3f15d0b95f6e480b&SignatureVersion=2.0&Timestamp=1635940599
  

  1

  Copied!

ZegoEffects Server returns a message

The following is the sample message returned by the ZegoEffects Server:

{
    "Code": 0,
    "Message": <message>,
    "Data": {
        "License": <license>
    }
}

The code value in the returned filed varies based on the online authentication methods:

Among which, the returned field Data:

Import the license

To activate the features you want, you need to import the license file to the ZegoEffects SDK.
To import the license file, do the following:

1. Get the license file from the returned field Data > License.
2. Call the create method, and pass the license file to the ZegoEffects SDK.
3. Create a ZegoEffects SDK object.

// Before create a ZegoEffects SDK obejct, call the setResources method and import related resources and models.
// Pass the license file, create a ZegoEffects SDK object.
NSString* license = @"xxxxxxxx";
ZegoEffects* effects = [ZegoEffects create:license];

// Before create a ZegoEffects SDK obejct, call the setResources method and import related resources and models.
// Pass the license file, create a ZegoEffects SDK object.
String license = "xxxxxxx";
ZegoEffects mEffects = ZegoEffects.create(license, applicationContext);