-
Notifications
You must be signed in to change notification settings - Fork 2
V4 API
huang wei edited this page Sep 14, 2018
·
14 revisions
-
1、创建一个ApiApplication,获得
appid
和appsecret
(由我们提供) -
2、获得Namespace的
id
(由我们提供) -
3、构建
Authorization
headerheader值的形式:
appid
:encoded_data
appid
:为第一步获取到的appidencoded_data
:以appsecret
为key,用JWT的HS256
进行加密,加密payload为{"namespace_id":id}
(id为Integer)示例:
appid: 56dc47367f8c775cf2318aa29345af558ad8aa2835bc3cc1d4416abfa94bd721 appsecret: 7bb73122837c4befb9c6593287f73a5e915415fe29f5aeb182717b66e873e96b namespace_id: 1
JWT的
-
HEADER
为:{"typ":"JWT","alg":"HS256"}
-
PAYLOAD
为:{"namespace_id":1}
计算出
encoded_data
为:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1lc3BhY2VfaWQiOjF9.z-RcFpDiYBXAO8i88M_x1JpJRr6CDMo8sb1rU6dw-0E
最终构建出
Authorization
header的值为:56dc47367f8c775cf2318aa29345af558ad8aa2835bc3cc1d4416abfa94bd721:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1lc3BhY2VfaWQiOjF9.z-RcFpDiYBXAO8i88M_x1JpJRr6CDMo8sb1rU6dw-0E
可以用jwt.io进行测试
实际使用中,处于安全的考虑,最好在payload中加入过期时间,如:
{"namespace_id":1,"exp":1535553256}
-
- 参数
-
per_page
每页多少个,默认24
,范围1~100
-
page
页数
-
- 接口返回 Header (如果返回有以下Header,表示数据有分页)
- X-SLP-Current-Page: 当前页数
- X-SLP-Total-Pages: 总页数
- X-SLP-Total-Count: 总个数
- 例:
GET /api/v4/yaw/flows/:id/journeys?per_page=30&page=3
Error Code | Meaning |
---|---|
403 | Unauthorized - 授权失败,参考上方的2种授权方式 |
404 | Not Found - 没有找到请求的资源 |
422 | Unprocessable - 更新资源时,验证失败 |
500 | Internal Server Error - 服务器有问题,请联系我们 |