API Basic

Call API the most basic information, please check carefully.

Headers

Request Headers

字段数据类型说明作用
X-UPA-APIKEYString请求 API KEY标识区分出来白标用户
X-UPA-REQUESTIDString请求唯一码请求幂等
X-UPA-TIMESTAMPString时间戳,毫秒请求时间,超过 60 秒后,超时,不响应此请求。防止重放攻击。
X-UPA-SIGNString签名签名,验证请求人的正确性。

Response Header

字段数据类型说明
X-UPA-REQUESTIDString请求唯一码,与请求 ID 相同,确保响应一致性
X-UPA-TIMESTAMPString响应时间戳,时间戳,毫秒

REQUESTID

REQUESTID 是每次请求和响应的唯一请求ID, 主要作用如下:

  • 确保请求唯一,会将该请求做幂等处理。
  • 唯一请求查询。
  • 响应与请求一致,利于您的架构调整。

APIKEY

APIKEY 是 UPay 分配的唯一请求的 Key,拥有该 Key 后方可拥有调用权限。

SIGN

验证请求的唯一值。

数据加密

部分接口需要对请求参数和响应内容通过私钥进行JWE加密,具体接口参见API List

请求

  • 白标用户通过白标用户生成的私钥对请求参数(除Header中的参数)通过私钥进行加密。请求格式如:
{
	"payload":"加密后的数据"
}

  • UPay获取到请求的参数通过白标用户在白标后台中设置的公钥进行解密;获取具体的参数数据。

响应

  • UPay通过私钥对响应数据进行JWE加密,响应格式如:
{
	"payload":"加密后的数据"
}
  • 白标用户获取到响应数据,通过UPay提供的公钥进行解密(公钥可以在白标后台获取),得到具体的响应数据

其他的请求信息

请参考具体接口细节