云函数HMAC-SHA256加密 | potato cloud开放文档

# 云函数HMAC-SHA256加密

# 简要描述

云函数使用密钥对数据进行HMAC-SHA256加密，适用于需要密钥验证的场景

# 方法名称

hmacSha256

# 调用参数

参数名	必选	类型	说明
data	是	string	待加密的数据
secretKey	是	string	加密密钥

# 调用实例

// 调用方法
var res = potato.hmacSha256("hello world", "my_secret_key")
// 返回给调用接口
res

1
2
3
4

# 调用方法返回示例

5f4de4a8b9b7e7e8e8e8e8e8e8e8e8e8e8e8e8e8e8e8e8e8e8e8e8e8e8e8e8e8

# 返回参数

参数名	必选	类型	说明
sign	是	string	HMAC-SHA256签名值

# API调用参数

参数名	必选	类型	说明
name	是	string	函数名称
params	否	json	调用参数

# API调用实例

{
	"name":"testFun"
}

1
2
3

# API调用请求头

参数名	必选	类型	说明
Content-Type	是	string	此参数必传，当请求数据非json时此参数传对应格式如（multipartform-data，application/x-www-form-urlencoded，等）是json请传application/json
askKey	是	string	此参数必传,验证app的令牌
sign	否	string	此参数如果在app设置开启了验签是必传
time	否	string	当开启验签时，此参数为必传
apiUserToken	否	string	用户令牌
nonce	否	string	随机字符串(当开启V3验签此参数必传，且6分钟内不允许重复)

# API调用返回参数说明

参数名	类型	说明
code	string	状态码200成功,403权限异常或登录超时,500请求异常,203请求无数据
status	int	状态0删除1使用
data	object	返回内容，云函数如果没有返回结果则该值为空
res	object	执行返回数据
param	object	返回执行参数,可以忽略
nonce	string	随机字符串(当开启V3验签必返回次参数，且6分钟内不会重复)
sign	string	此参数如果在app设置开启了验签是必返
reqSign	string	请求签名
time	long	当开启验签时，此参数为必返回

# API调用返回示例

{
	"code": "200",
	"message": "",
	"status": true,
	"data": {
		"res": "5f4de4a8b9b7e7e8e8e8e8e8e8e8e8e8e8e8e8e8e8e8e8e8e8e8e8e8e8e8e8e8"
	},
	"pc": null,
	"time": null,
	"nonce": null,
	"sign": null,
	"reqSign": null
}

1
2
3
4
5
6
7
8
9
10
11
12
13

# 备注

数据或密钥为空时会抛出异常
更多返回错误代码请查看错误代码参考

← SHA256加密 HMAC-SHA512加密 →