接口调用
介绍 卡游售卖机开放平台 接口的调用方法。
本章节介绍 卡游售卖机开放平台 接口的调用方法。
POST参数
| 参数 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| apiId | String | 是 | 【应用ID】由 卡游售卖机开放平台 分配给各客户独立使用的应用ID |
| sign | String | 是 | 【API签名】算法签名见备注。注意：签名密码(appSecret)统一由 卡游售卖机开放平台 授予 |
| nonce | String | 否 | 【随机字符串】生成签名用随机字符串(最多128个字符) |
| timestamp | Number | 是 | 【时间戳】生成签名用时间戳，格式为当前的时间的Unix时间戳，单位为秒(如1582535800) |
| target_type | String | 是 | 【业务类型】目前支持的类型为 公众号：GZH；网点：SIT；雇员：EMP |
| target | String | 是 | 【额外参数】若业务类型为公众号，则target为【公众号】的apiId；若业务类型为【网点】，则target为网点代号；若业务类型为【雇员】，则target为员工工号； |
| content | String | 是 | 【业务参数】 JSON格式的序列化后进行BASE64加密，如果没有业务参数 可不填此字段 |
sign字段签名规则
将参数项（apiId, timestamp, nonce, target_type, target, content）按照英文字母顺序排列
例如:
apiId : t8hUA6PNVSS6f1cb93e2
content : MjIlM0ElNUMlMjJoZWxsbyUyMGZyb20lMjBjaGluYSU1QyUyMiU3RCU3RCU1RCU3RCU3RA==
nonce : abcdefg
target : LH16
target_type : SIT
timestamp : 1505872800
排序后的参数按照key+value的形式拼接成字符串
apiIdt8hUA6PNVSS6f1cb93e2contentMjIlM0ElNUMlMjJoZWxsbyUyMGZyb20lMjBjaGluYSU1QyUyMiU3RCU3RCU1RCU3RCU3RAnonceabcdefgtargetLH16target_typeSITtimestamp1505872800
生成的字符串首尾拼接运营平台提供apiId所对应的appSecret, 如提供的appSecret为ABCDEFG的情况下，字符串生成如下：
ABCDEFGapiIdt8hUA6PNVSS6f1cb93e2contentMjIlM0ElNUMlMjJoZWxsbyUyMGZyb20lMjBjaGluYSU1QyUyMiU3RCU3RCU1RCU3RCU3RAnonceabcdefgtargetLH16target_typeSITtimestamp1505872800ABCDEFG
用md5加密转大写后字符串并得到sign
sign = MD5("ABCAPIIDT8HUA6PNVSS6F1CB93E2CONTENTMJILM0ELNUMLMJJOZWXSBYUYMGZYB20LMJBJAGLUYSU1QYUYMIU3RCU3RCU1RCU3RCU3RA==NONCEABCDEFGTARGETSITTARGET\_TYPELH16TIMESTAMP1505872800ABC")
签名前字符串为:
MD5 hash后字符串为:5f6a4ad74cf12286a4074ae38ad5723d
注意事项
- 为了保证接口服务质量，timestamp的失效时间为5分钟
- http报文头中添加头信息，json格式:
content-type:application/json - 若无特殊说明，文档中仅以json格式作为示范
接口返回字段
| 返回值 | 类型 | 说明 |
|---|---|---|
| code | 数字 | 【返回值】0：成功；其他：失败) |
| message | 字符 | 【失败信息】 |
| content | 字符 | 【业务数据】返回的JSON类型业务数据 |
| requestid | 字符 | 【业务唯一请求ID】 |