调用方式
1 请求结构
1.1 服务地址
开发者需要根据自己的服务端所在地理区域,指定相应的接入地址,向 ZEGO 服务端发送请求。
为保障您的业务服务接入质量,请优先使用您的服务端所在地理区域的域名,作为接入地址,向 ZEGO 服务端发送请求。
ZEGO 支持如下地理区域的请求接入:
地理区域 | 接⼊地址 |
---|---|
中国⼤陆(上海) | ${PRODUCT}-api-sha.zego.im |
港澳台(⾹港) | ${PRODUCT}-api-hkg.zego.im |
欧洲(法兰克福) | ${PRODUCT}-api-fra.zego.im |
美⻄(加州) | ${PRODUCT}-api-lax.zego.im |
亚太(孟买) | ${PRODUCT}-api-bom.zego.im |
东南亚(新加坡) | ${PRODUCT}-api-sgp.zego.im |
统一接入地址(不区分区域) | ${PRODUCT}-api.zego.im |
其中,${PRODUCT}
为 ZEGO 提供的不同产品的不同服务,对应如下:
产品 | ${PRODUCT} 值 | 接入域名 |
---|---|---|
即时通讯 | zim | zim-api.zego.im |
鉴权(用于语音组件) | auth | auth-api.zego.im |
1.2 通信协议
ZEGO 服务端 API 的所有接口均通过 HTTPS 进行通信,提供安全的通信服务。
1.3 请求方法
ZEGO 服务端 API 支持以下 HTTP 请求方法:
- GET
- POST
所有请求参数(包括公共参数和业务参数)统⼀放在 Query,使⽤ GET 请求方法。特殊复杂的 API 参数放在 Body,使用 POST 请求方法。
2 公共参数
本节介绍了开发者调用 ZEGO 服务端 API 时使用的公共参数,包含了公共请求参数和公共返回参数。
2.1 公共请求参数
公共请求参数是每个接口都需要使用到的请求参数。
参数 | 类型 | 是否必选 | 描述 |
---|---|---|---|
AppId | Uint32 | 是 | AppId,ZEGO 分配的用户唯一凭证。 |
Signature | String | 是 | 签名,签名的生成请参考 3 签名机制。 |
SignatureNonce | String | 是 | 随机字符串。 |
SignatureVersion | String | 是 | 签名版本号,默认值为 2.0。 |
Timestamp | Int64 | 是 | Unix 时间戳,单位为秒。最多允许 10 分钟的误差。 |
请求示例:
https://zim-api.zego.im/?Action=QueryUserOnlineState
&AppId=1234567890
&Timestamp=1234567890
&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D
&SignatureVersion=2.0
&SignatureNonce=15215528852396
&UserId[]=221
2.2 公共返回参数
API 返回结果采用统一格式,返回的数据格式为 JSON。
每次调用接口,无论成功与否,都会返回公共参数。
参数 | 类型 | 描述 |
---|---|---|
Code | Number | 返回码。 |
Message | String | 请求结果的说明信息。 |
RequestId | String | 请求 ID。 |
返回示例:
{
"Code": 0,
"Message": "",
"RequestId": "8411281679140263090",
......
}
3 签名机制
为保证 API 的安全调用,ZEGO 服务端会对每个 API 的访问请求进行身份验证。开发者在调用 API 时,都需要在请求中包含签名 Signature 信息。
每次调用接口都需要生成新的签名。
3.1 密钥获取
Signature 通过使用 AppID 和 ServerSecret 进行对称加密的方法来验证请求的发送者身份。AppID 用于标识访问者的身份,ServerSecret 用于加密签名字符串和服务器验证签名字符串的密钥,必须严格保密,防止泄漏。
请联系 ZEGO 技术支持,申请需要接入 SDK 服务所需的 AppID 和 ServerSecret。
3.2 签名生成
- 签名参数说明
参数 | 含义 |
---|---|
AppId | 应用 ID。公共参数里的AppId,请联系 ZEGO 技术支持获取。 |
SignatureNonce | 随机字符串。公共参数里的 SignatureNonce,生成算法可参考下方签名示例。 |
ServerSecret | 应⽤密钥,请联系 ZEGO 技术支持获取。 |
Timestamp | 当前 Unix 时间戳,单位为秒。生成算法可参考下方签名示例,最多允许 10 分钟的误差。 |
计算签名所使用的 SignatureNonce 和 Timestamp 参数取值,需要和公共参数中的 SignatureNonce 和 Timestamp 参数取值保持一致。
- 签名生成算法
Signature = md5(AppId + SignatureNonce + ServerSecret + Timestamp)
- 签名字符串格式
签名采⽤ hex 编码(⼩写),⻓度为 32 个字符。
3.3 签名示例
ZEGO 提供多种编程语言的签名示例代码,开发者可根据实际情况进行参考。
Go 签名示例
import (
"crypto/md5"
"crypto/rand"
"encoding/hex"
"fmt"
"log"
"time"
)
// Signature=md5(AppId + SignatureNonce + ServerSecret + Timestamp)
func GenerateSignature(appId uint32, signatureNonce string, serverSecret string, timestamp int64) (Signature string){
data := fmt.Sprintf("%d%s%s%d", appId, signatureNonce, serverSecret, timestamp)
h := md5.New()
h.Write([]byte(data))
return hex.EncodeToString(h.Sum(nil))
}
func main() {
/*生成16进制随机字符串(16位)*/
nonceByte := make([]byte, 8)
rand.Read(nonceByte)
signatureNonce := hex.EncodeToString(nonceByte)
log.Printf(signatureNonce)
appId := 12345 //使用你的appId和serverSecret
serverSecret := "9193cc662a4c0ec135ec71fb57194b38"
timestamp := time.Now().Unix()
/* appId:12345
signatureNonce:4fd24687296dd9f3
serverSecret:9193cc662a4c0ec135ec71fb57194b38
timestamp:1615186943 2021/03/08 15:02:23
signature:43e5cfcca828314675f91b001390566a
*/
log.Printf("signature:%v", GenerateSignature(uint32(appId), signatureNonce, serverSecret, timestamp))
}
Python 签名示例
# -*- coding: UTF-8 -*-
import secrets
import string
import hashlib
import time
#Signature=md5(AppId + SignatureNonce + ServerSecret + Timestamp)
def GenerateSignature(appId, signatureNonce, serverSecret, timestamp):
str1 = str(appId) + signatureNonce + serverSecret + str(timestamp)
hash = hashlib.md5()
hash.update(str1.encode("utf8"))
signature = hash.hexdigest()
return signature
def main():
#生成16进制随机字符串(16位)
signatureNonce = secrets.token_hex(8)
#使用你的appId和serverSecret
appId = 12345
serverSecret = "9193cc662a4c0ec135ec71fb57194b38"
#获得10位unix时间戳
timestamp = int(time.time())
print(GenerateSignature(appId,signatureNonce,serverSecret,timestamp))
if __name__ == '__main__':
main()
Java 签名示例
import java.security.MessageDigest;
import java.security.SecureRandom;
public class Md5{
/**
* 字节数组转16进制
* @param bytes 需要转换的byte数组
* @return 转换后的Hex字符串
*/
public static String bytesToHex(byte[] bytes) {
StringBuffer md5str = new StringBuffer();
//把数组每一字节换成16进制连成md5字符串
int digital;
for (int i = 0; i < bytes.length; i++) {
digital = bytes[i];
if (digital < 0) {
digital += 256;
}
if (digital < 16) {
md5str.append("0");
}
md5str.append(Integer.toHexString(digital));
}
return md5str.toString();
}
// Signature=md5(AppId + SignatureNonce + ServerSecret + Timestamp)
public static String GenerateSignature(long appId, String signatureNonce, String serverSecret, long timestamp){
String str = String.valueOf(appId) + signatureNonce + serverSecret + String.valueOf(timestamp);
String signature = "";
try{
//创建一个提供信息摘要算法的对象,初始化为md5算法对象
MessageDigest md = MessageDigest.getInstance("MD5");
//计算后获得字节数组
byte[] bytes = md.digest(str.getBytes("utf-8"));
//把数组每一字节换成16进制连成md5字符串
signature = bytesToHex(bytes);
}catch (Exception e) {
e.printStackTrace();
}
return signature;
}
public static void main(String[] args){
//生成16进制随机字符串(16位)
byte[] bytes = new byte[8];
//使用SecureRandom获取高强度安全随机数生成器
SecureRandom sr = new SecureRandom();
sr.nextBytes(bytes);
String signatureNonce = bytesToHex(bytes);
long appId = 12345L; //使用你的appId和serverSecret,数字后要添加大写L或小写l表示long类型
String serverSecret = "9193cc662a4c0ec135ec71fb57194b38";
long timestamp = System.currentTimeMillis() / 1000L;
System.out.println(GenerateSignature(appId,signatureNonce,serverSecret,timestamp));
}
}
PHP 签名示例
<?php
function GenerateSignature($appId, $signatureNonce, $serverSecret, $timestamp)
{
$str = $appId.$signatureNonce.$serverSecret.$timestamp;
$signature = md5($str);
return $signature;
}
//生成16进制随机字符串(16位)
$signatureNonce = bin2hex(random_bytes(8));
//使用你的appId和serverSecret
$appId = 12345;
$serverSecret = "9193cc662a4c0ec135ec71fb57194b38";
$timestamp = time();
$signature = GenerateSignature($appId, $signatureNonce, $serverSecret, $timestamp);
echo $signature;
?>
Node.js 签名示例
const crypto = require('crypto');
//Signature=md5(AppId + SignatureNonce + ServerSecret + Timestamp)
function GenerateUASignature(appId, signatureNonce, serverSecret, timeStamp){
const hash = crypto.createHash('md5'); //规定使用哈希算法中的MD5算法
var str = appId + signatureNonce + serverSecret + timeStamp;
hash.update(str);
//hash.digest('hex')表示输出的格式为16进制
return hash.digest('hex');
}
var signatureNonce = crypto.randomBytes(8).toString('hex');
//使用你的appId和serverSecret
var appId = 12345;
var serverSecret = "9193cc662a4c0ec135ec71fb57194b38";
var timeStamp = Math.round(Date.now()/1000);
console.log(GenerateUASignature(appId, signatureNonce, serverSecret, timeStamp));
3.4 签名失败
存在以下签名失败的返回码,请开发者根据实际情况处理。
返回码 | 说明 |
---|---|
100000004 | 签名过期。 |
100000005 | 签名错误。 |