@sewise-dev
2016-12-22T10:12:10.000000Z
字数 3085
阅读 717
VPaas组件化
应用平台
编号 | 版本 | 说明 | 作者 | 日期 |
---|---|---|---|---|
1 | v1.0 | 1.创建文档 | Seven | 2016-12-13 |
凡是要使用应用能力的接口,双方需通过对比加密sign值,进行安全校验,否则接口不能使用。
加密算法:
sign = md5(shal(appid + time + random) + key);
每次调用接口时,可能获得正确或错误的返回码,开发者可以根据返回码信息调试接口,排查错误。
返回码 | 说明 |
---|---|
-1 | 系统繁忙,此时请开发者稍候再试 |
200 | 请求成功 |
403 | 禁止访问 |
404 | 异常错误 |
500 | 数据验证错误 |
40001 | 不合法的凭证,或者access_token无效。 |
40004 | 不合法请求 |
HTTP请求状态返回格式
返回字段 | 字段类型 | 说明 |
---|---|---|
status | Integer | 请求返回码(详细请见状态表) |
message | String | 返回描述 |
data | Array | 返回结果 |
错误样例
{
"status": 40013,
"message": {"0":"invalid appid"}
}
成功样例
{
"status": 200,
"data": {"access_token":"ACCESS_TOKEN","expires_in":7200}
}
/v1/app/create
application/json
POST
参数 必选 类型 说明 RequestBody userId 是 Int 用户uid name 是 String 应用名称 type 是 Int 类型 1.普通,2.内容商,3.开发商,4.平台(需传token)
200
返回字段 | 字段类型 | 说明 |
---|---|---|
status | int | 返回状态码 |
message | String | 返回错误信息 |
data | Array | 返回结果 |
Request
curl -X POST -H "Content-Type:application/json" -d {"userId":"13","name":"应用宝","type":"1"} http://app.sewise.com/v1/app/create
Response
{"status":200,"data":{"id":"31"}}
/v1/app/token
application/json
POST
参数 必选 类型 说明 RequestBody appId 是 String 应用appId appSecret 是 String 应用appSecret
200
返回字段 | 字段类型 | 说明 |
---|---|---|
status | int | 返回状态码 |
message | String | 返回错误信息 |
data | Array | 返回结果 |
Request
curl -X POST -H "Content-Type:application/json" -d {"appId":"ic89rf8705ztf6uip7","appSecret":"82n7n4iow01sfmzwjpfuo120v5n7erta"} http://app.sewise.com/v1/app/token
Response
{
"status": 200,
"data": {
"access_token": "bSjHgdh43NRbxZ9fOrTtjipynmcIh74fUr8u4Rnd",
"expire": "2016-12-23 17:55:54"
}
}
/v1/app/info
application/json
GET/POST
参数 必选 类型 说明 RequestBody appid 是 String 应用appID time 是 int 时间戳 random 否 int 随机数 sign 是 String 加密值 或
参数 必选 类型 说明 RequestBody token 是 String 授权码
200
返回字段 | 字段类型 | 说明 |
---|---|---|
status | int | 返回状态码 |
message | String | 返回错误信息 |
data | Array | 返回结果 |
Request
curl -X POST -H "Content-Type:application/json" -d http://app.sewise.com/v1/app/info?appid=ic89rf8705ztf6uip7&time=1481612242&sign=ee856df94a5e059043747fa242b84761&random=123456
http://app.sewise.com/v1/app/info?token=bSjHgdh43NRbxZ9fOrTtjipynmcIh74fUr8u4Rnd
Response
{"status": 200,
"data": {
"appId": "ic89rf8705ztf6uip7",
"userId": "1",
"appName": "平台应用号",
"appType": "4",
"appStatus": "1",
"creationDate": "2016-12-13 10:22:00",
"modifiedDate": "2016-12-13 10:22:00",
"isDelete": "N"
}
}
/v1/app/delete
application/json
GET/POST
参数 必选 类型 说明 RequestBody appid 是 String 应用appID time 是 int 时间戳 random 否 int 随机数 sign 是 String 加密值 或
参数 必选 类型 说明 RequestBody token 是 String 授权码
200
返回字段 | 字段类型 | 说明 |
---|---|---|
status | int | 返回状态码 |
message | String | 返回错误信息 |
data | Array | 返回结果 |
Request
curl -X POST -H "Content-Type:application/json" -d http://app.sewise.com/v1/app/delete?appid=ic89rf8705ztf6uip7&time=1481612242&sign=ee856df94a5e059043747fa242b84761&random=123456
http://app.sewise.com/v1/app/delete?token=5Pl5fnufusOgfDFLBvdar1hOw5pw87kXrRTcFLVQ
Response
{"status": 200,"message": "Delete success"}