Appearance
接口调用方式
接口支持 http 及 https 两种访问方式,一般情况采用 https 访问,使用系统签发的证书进行双向 SSL 认证;使用 http 访问需要先调用登录接口获取到 hid,然后在调用其他接口时将 hid 通过 header 传递。hid 由两部分组成,以“,”分隔,后半部分是一个超时时间戳。登录接口详见“[[登录]]”。 注:不用每次调用接口前都登录获取 hid,只需在超时前重新获取即可。
HTTP 方式
| 项目 | 描述 | 备注 |
|---|---|---|
| 接口地址 | https://test.ynctky.com/tooan | 在后续文档中以 **** 表示 |
| 账号 | TooanClient | 注意大小写 |
| 密码 | xjTT31@45q | 注意大小写 |
HTTPS 方式
| 项目 | 描述 | 备注 |
|---|---|---|
| 接口地址 | https://test.ynctky.com:8443/tooan | 在后续文档中以 **** 表示 |
| 证书 | 联系业务人员 | |
| 证书密码 | 联系业务人员 |
价格单位统一以“分”为单位
如:1.2 元写做 120 分。
接口请求
json
GET https://test.ynctky.com/tooan/rest/front/ticket/ta
Content-Type: application/json;charset=UTF-8
hid:98201e94-2781-4dba-92e9-490246af966f,1615448398953上面的例子是一个标准的 GET 调用的请求,用户登录后获得的 token 要以 hid 的 HTTP 报文提交。
接口返回
json
{
"result": "98201e94-2781-4dba-92e9-490246af966f,1615448398953",
"retCode": 10000,
"retMessage": "",
"success": true
}| 标签名 | 类型 | 说明 |
|---|---|---|
| succes | boolean | 接口请求是否成功 |
| retCode | int | 返回(错误)代码。接口请求成功时返回代码为 10000,接口请求失败时会根据错误返回相应的错误代码。 |
| retMessage | string | 返回(错误)信息。接口请求成功时其值为空。 |
| result | 未知 | 是否有值、返回值的内容视接口而定。 |
**注意:**在后面的接口描述中,如无特殊需要,接口返回中的 success、retCode、retMessage 将不再说明。