Config接口--身份认证-火山引擎

文档中心

立即注册

导航

Config接口

最近更新时间：2023.02.17 11:49:59首次发布时间：2023.02.17 11:49:59

接口简介

支持使用方基于业务方案，前置配置一套固定套餐，包含服务端、H5端参数，并在实际请求时通过传入配置ID的方式，激活配置。此方案可有效减少请求H5时的链接长度、减少服务端API请求报文长度。

调用此接口，由于是从服务端发起请求，使用临时秘钥/长期秘钥均可。

限制条件

注意：此接口的配置优先级低于H5与服务端API参数的优先级。

配置上传接口

请求说明

名称	内容
接口地址	https://visual.volcengineapi.com
请求方式	POST
Content-Type	application/json

请求参数
（1）header请求参数
公共请求参数

名称	类型	是否必填	示例值	描述
X-Date	String	是	20201103T104027Z	使用UTC标准时间，日期精确到秒，格式：YYYYMMDD'T'HHMMSS'Z'。
Authorization	String	是	HMAC-SHA256 Credential={AccessKeyId}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature}	HMAC-SHA256：签名方法 Credential：签名凭证，其中， -AccessKeyId是访问密钥ID，可在访问密钥（Access Key）获取； -ShortDate是请求的短时间，使用UTC时间，精确到日。请使用格式：YYYYMMDD，例如：20180201 -Region默认为cn-north-1 -Service默认为cv SignedHeaders是参与签名计算的头部信息，content-type 和 host 为必选头部 Signature是签名，可在签名方法获取。注：我们提供了SDK及签名示例供您实现服务快速接入，具体可参考快速接入
X-Security-Token	String	否	无	指安全令牌服务（Security Token Service，STS）颁发的临时安全凭证中的SessionToken： 1.用户 / Service 访问自己的资源则可以使用 AK/SK 直接访问（长期 Token），无需填写该参数。 2.用户 / Service 通过扮演角色去调用接口时需要使用 STS。具体流程：先调用 AssumeRole 获得短期 token, 然后将该 Token 放入该参数去请求目标接口。

（2）Query请求参数

业务请求参数

参数	可选/必选	类型	说明
Action	必选	String	接口名，取值：CertConfigInit
Version	必选	String	版本号，取值：2022-08-31

（3）Body请求参数

业务请求参数

字段名	类型	必选/可选	说明
req_key	string	必选	此处请填写`cert_config_init`
config_name	string	必选	配置套餐名称
config_desc	string	可选	配置套餐描述
token_api_config	json	必选	服务端Token接口参数配置，详细请参考服务端Token接口中的Body请求参数部分
h5_config	json	必选	H5参数配置，详细请参考H5接入文档中的接入参数部分

token_api_config 支持的字段包括：

ref_source
liveness_type
motion_list
fixed_motion_list
motion_count
max_liveness_trial
tos_info（仅可设置endpoint, bucket, region三个字段）
callback_info

h5_config 支持的字段包括：

redirectUrl
source
bucket
endpoint
region
type
showResult
protocolName
protocolLink
demoteType
styleConf
protocolNav
protocolNavTitle

输出说明

（1）通用输出参数
请参考通用返回字段及错误码

（2）业务输出参数
data 字段说明

字段名	类型	必选/可选	说明	备注
config_id	string	必选	配置ID，可在Token接口或H5端传入，以激活配置

（3）输出示例

{
    "code":10000,
    "data":{
        "config_id": "",
    },
    "message":"Success",
    "request_id":"6838889517957515275",
    "time_elapsed":"41.897331ms"
}

错误码

（1）通用错误码
请参考通用返回字段及错误码

（2）业务错误码

HttpCode	错误码	错误消息	描述
200	10000	"Success"	成功

配置获取接口

用于用户查询已生效的配置参数。更新接口后续会上线，目前可联系我们后台进行更新。

请求说明

名称	内容
接口地址	https://visual.volcengineapi.com
请求方式	POST
Content-Type	application/json

请求参数
（1）header请求参数
公共请求参数

名称	类型	是否必填	示例值	描述
X-Date	String	是	20201103T104027Z	使用UTC标准时间，日期精确到秒，格式：YYYYMMDD'T'HHMMSS'Z'。
Authorization	String	是	HMAC-SHA256 Credential={AccessKeyId}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature}	HMAC-SHA256：签名方法 Credential：签名凭证，其中， -AccessKeyId是访问密钥ID，可在访问密钥（Access Key）获取； -ShortDate是请求的短时间，使用UTC时间，精确到日。请使用格式：YYYYMMDD，例如：20180201 -Region默认为cn-north-1 -Service默认为cv SignedHeaders是参与签名计算的头部信息，content-type 和 host 为必选头部 Signature是签名，可在签名方法获取。注：我们提供了SDK及签名示例供您实现服务快速接入，具体可参考快速接入
X-Security-Token	String	否	无	指安全令牌服务（Security Token Service，STS）颁发的临时安全凭证中的SessionToken： 1.用户 / Service 访问自己的资源则可以使用 AK/SK 直接访问（长期 Token），无需填写该参数。 2.用户 / Service 通过扮演角色去调用接口时需要使用 STS。具体流程：先调用 AssumeRole 获得短期 token, 然后将该 Token 放入该参数去请求目标接口。

（2）Query请求参数

业务请求参数

参数	可选/必选	类型	说明
Action	必选	String	接口名，取值：CertConfigGet
Version	必选	String	版本号，取值：2022-08-31

（3）Body请求参数

业务请求参数

字段名	类型	必选/可选	说明	备注
req_key	string	必选	此处请填写`cert_config_get`
config_id	string	必选	配置ID

输出说明

（1）通用输出参数
请参考通用返回字段及错误码

（2）业务输出参数
data 字段说明

字段名	类型	必选/可选	说明	备注
token_api_config	json	必选	服务端Token接口参数配置
h5_config	json	必选	H5端参数配置

（3）输出示例

{
    "code":10000,
    "data":{
        "token_api_config": {},
        "h5_config": {}
    },
    "message":"Success",
    "request_id":"6838889517957515275",
    "time_elapsed":"41.897331ms"
}

错误码

（1）通用错误码
请参考通用返回字段及错误码

（2）业务错误码

HttpCode	错误码	错误消息	描述
200	10000	"Success"	成功