# API调用统一说明
NICE综合管理平台提供的 API 和云平台提供给NICE综合管理平台的 API,Content-type 均使用 application/json 。
接口的调用使用 Bearer Token 方式,Token 使用 jwt 标准。
在NICE综合管理平台创建云平台时,云平台需要给NICE综合管理平台提供接收结果通知的 API 路径;创建成功后,系统会为云平台生成一对 app_id、secret。
jwt 的介绍详见官方文档https://jwt.io/introduction (opens new window),jwt 由 3 部分组成:
1、Header部分是固定内容。
{"alg":"HS256","typ":"JWT"}
2、Payload部分包含 2 个字段
| 字段 | 类型 | 必须 | 含义 |
|---|---|---|---|
| app_id | string | 是 | NICE综合管理平台分配给云平台的app_id |
| iat | int | 是 | 签发的UNIX时间戳,验证时需要验证签发时间在1分钟内 |
参数示例
{"app_id":"12345678","iat":1627354972}
3、Signature 使用 jwt 的标准加密方式,其中 secret 为NICE综合管理平台分配给云平台的 secret,加密算法如下:
HMACSHA256( base64UrlEncode(Header) + "." + base64UrlEncode(Payload), secret )
将 jwt 的 3 个部分的结果进行拼接,拼接方法如下:
base64UrlEncode(Header) + "." + base64UrlEncode(Payload) + "." + Signature
请求头使用Bearer Token,请求 header 中增加 Authorization,Authorization 的内容由 'Bearer' + 空格 + jwt 组成,假设 app_id 为 12345678 ,secret 为 1234567812345678 ,iat 为 1627354972 ,此时发起请求时需要在请求头中增加 Authorization 的 Key:
Authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhcHBfaWQiOiIxMjM0NTY3OCIsImlhdCI6MTYyNzM1NDk3Mn0.HoWoedYBGcgi0y4Brj90RMccpZ5uJpulwo6zgSWTKag