直播流鉴权配置

鉴权功能处于内测阶段，使用前请联系 sales@agora.io。

设置时间戳鉴权密钥

为指定域名设置时间戳鉴权密钥。

HTTP 请求

PATCH https://api.sd-rtn.com/v1/projects/{appid}/fls/domains/{domain}

路径参数

参数	类型	描述
appid	String	必填。在声网控制台获取的 App ID。
domain	String	必填。域名名称。

请求包体

请求包体为 JSON Object 类型，包含以下字段：

参数	类型	描述
authKey	String	必填，长度不超过 128 个字符。时间戳鉴权密钥。

HTTP 响应

如果返回的 HTTP 状态码为 200，表示请求成功。

如果返回的 HTTP 状态码非 200，表示请求失败。你可以参考 HTTP 状态码了解可能的原因。

示例

请求行

PATCH https://api.sd-rtn.com/v1/projects/{your_appid}/fls/domains/{your_domain} HTTP/1.1

请求 body

{
    "authKey": "{your auth key}"
}

响应行

HTTP/1.1 200 OK

设置回源鉴权配置

设置回源鉴权的配置信息。

HTTP 请求

PATCH https://api.sd-rtn.com/v1/projects/{appid}/fls/settings/streamauth/webhook

路径参数

参数	类型	描述
appid	String	必填。在声网控制台获取的 App ID。

请求包体

请求包体为 JSON Object 类型，包含以下字段：

字段	类型	描述
enabled	Bool	必填。是否开启回源鉴权。
url	String	选填。回源鉴权服务器的地址。
secret	String	选填。回源鉴权密钥。使用回源鉴权密钥生成签名的流程与消息通知服务一致，详见验证签名。

HTTP 响应

如果返回的 HTTP 状态码为 200，表示请求成功。

如果返回的 HTTP 状态码非 200，表示请求失败。你可以参考 HTTP 状态码了解可能的原因。

示例

请求行

PATCH https://api.sd-rtn.com/v1/projects/{your_appid}/fls/settings/streamauth/webhook HTTP/1.1

请求 body

{
    "enabled": true,
    "url": "www.test.com/auth/callback",
    "secret": "{ncs_secret}"
}

响应行

HTTP/1.1 200 OK

获取回源鉴权配置

获取回源鉴权的配置信息。

HTTP 请求

GET https://api.sd-rtn.com/v1/projects/{appid}/fls/settings/streamauth/webhook

路径参数

参数	类型	描述
appid	String	必填。在声网控制台获取的 App ID。

HTTP 响应

如果返回的 HTTP 状态码为 200，表示请求成功。响应包体中包含以下字段：

字段	类型	描述
enabled	Bool	必填。是否开启回源鉴权。
url	String	选填。回源鉴权服务器的地址。
secret	String	选填。回源鉴权密钥。使用回源鉴权密钥生成签名的流程与消息通知服务一致，详见验证签名。

如果返回的 HTTP 状态码非 200，表示请求失败。你可以参考 HTTP 状态码了解可能的原因。

示例

请求行

GET https://api.sd-rtn.com/v1/projects/{your_appid}/fls/settings/streamauth/webhook HTTP/1.1

响应 body

{
    "enabled": true,
    "url": "www.test.com/auth/callback",
    "secret": "{ncs_secret}"
}

响应行

HTTP/1.1 200 OK

回源鉴权请求格式

声网向你的回源鉴权服务器发送请求时，会使用以下参数：

参数	类型	必选	描述
host	String	是	推流或者播流域名。
entryPoint	String	是	发布点。
streamName	String	是	流名称。
cdnIp	String	否	CDN 节点的 IP 地址。
clientIp	String	否	客户端的 IP 地址。
token	String	否	鉴权信息。
requestId	String	否	请求 ID。

你需要按照以下标准返回 HTTP 状态码：

• 200：回源鉴权通过。
• 401：回源鉴权失败。

HTTP 状态码

状态码	描述
200	请求成功。
400	参数非法，如 appid 或者 domain 为空。
401	未经授权的（客户 ID/客户密钥匹配错误）。
404	服务器无法根据请求找到资源，即请求的域名不存在，或者请求的 URI 路径非法。
500	服务器内部错误，无法完成请求。
504	服务器内部错误。充当网关或代理的服务器未从远端服务器获取请求。