用户工具

站点工具


wiki:v_interface_desp_old

1.API_TOKEN说明

API_TOKEN(简称token本平台的全局唯一接口调用凭据,调用各接口时都需API_TOKEN放入header存储关于。开发者需要进行妥善保存。API_TOKEN的存储至少要保留100个字符空间。API_TOKEN的有效期为长期有效,重复获取将导致上次获取的API_TOKEN失效。

API调用所需的API_TOKEN的使用及生成方式说明:

建议开发者使用中控服务器统一获取和刷新API_TOKEN,其他业务逻辑服务器所使用的API_TOKEN均来自于该中控服务器,不应该各自去刷新,否则容易造成冲突,导致API_TOKEN覆盖而影响业务;

开发者可以使用appkeymasterSecret调用本接口来获取API_TOKENappkeymasterSecret联系中消云获得。

2.业务接口调用方法

除“获取API_TOKEN”以外其它接口均需要在header中设置API_TOKEN

请求样例:

GET http: /login/api/1.0/auth/getToken HTTP/1.1

Host: xf.tandatech.com:4433/thirdPartyApi

API_TOKEN: aab8e8f2-9f5c-41c8-b370-e03e1bf2c726

Cache-Control: no-cache

3.服务器地址

  中消云提供“测试服务器”和“正式服务器”。

  (1).测试服务器

  在开发过程中,开发者可以在测试服务器上完成开发和调试工作。  

  测试服务器地址:(暂定)

替换字符

服务器地址

authServerUrl

https://xf.tandatech.com:4433/thirdPartyApi/login

projectServerUrl

https://xf.tandatech.com:4433/thirdPartyApi/ThreePlaceREST

testPageUrl

https://xf.tandatech.com:4433/thirdPartyApi


    (2).正式服务器

    第三方系统在开发完成之后,可申请获取正式服务器地址及appkeymasterSecret。获取地址及参数请联系中消云。   

4.返回说明

  (1).HTTP状态码

Code

描述

详细解释

200

OK

Success!

400

参数缺失

改请求有必填项无值

401

无权限

没有API_TOKEN或请求没有权限

500

内部服务错误

服务器内部出错了。请联系我们尽快解决问题。

502

无效代理

业务服务器下线了或者正在升级。请稍后重试。



(2).返回码

返回码

描述

000000

请求成功

L02100

appkey无效

L02201

appkey与masterSecret不匹配

P00000

服务器内部出错了。请联系我们尽快解决问题。

P00001

没有结果

P01000

输入参数错误

P02001

获取数据没有权限


wiki/v_interface_desp_old.txt · 最后更改: 2020/11/14 09:55 由 admin