接口服务介绍
开发者接入云平台服务,首先要进行 授权 和 认证 操作用来确认您的身份是否合法。
我们正常的认证至少需要认证上面提到的2步,如果接入的为应用类功能的接口,需要在前2步认证授权完成后,通过取到的token等信息进行第3步 登录 的验证,返回成功后才可正常调用应用功能类接口。
一、获取授权
授权是指您在云平台注册后,分配给你的开发者信息Client ID,您需要传入Client ID验证您的身份是否合法。
请求成功将返回给你一个code码,您将利用该码进行第2步的操作( 获取许可 )。
HTTP标准包头字段(必填):
Accept : application/json; Content-Type : application/json;charset=UTF-8;
JSON请求示例
GET http://请求地址/authorize?client_id={ClientID}&response_type=code HTTP/1.1 Accept:application/json; Content-Type:application/json; charset=UTF-8;
属性说明
属性 | 类型 | 约束 | 说明 |
ClientID | String | 必选 | Client ID。 |
响应说明
属性 | 类型 | 说明 |
返回结果,例如:81db9558298148e582605345e3170f6c | 字符串 | (code)授权码 |
二、获取许可
当您正常进行授权认证后,我们即认为您的身份具有调用接口的可能性。
您需要把您之前获得的code码与分配给您的Client Secret进行许可认证操作。
HTTP标准包头字段(必填):
Accept : application/json; Content-Type : application/json;charset=UTF-8;
JSON请求示例
GET http://请求地址/accessToken?client_id={ClientID}&client_secret={client_secret}code&={code}&grant_type=authorization_code&redirect_uri=redirect_uri HTTP/1.1 Accept:application/json; Content-Type:application/json; charset=UTF-8;
属性说明
属性 | 类型 | 约束 | 说明 |
client_id | String | 必选 | Client 编号。 |
client_secret | String | 必选 | Client 密码。 |
code | String | 必选 | (code) 授权码。 |
{"expires_in":3600,"access_token":"819aad3546b1e944176ea666c9b28f1d"}响应结果JSON
响应说明
属性 | 类型 | 说明 |
expires_in | 3600 | token有效期,单位:秒 |
access_token | 819aad3546b1e944176ea666c9b28f1d | token字符串 |
您需要把您之前获得的token码和用户名密码作为参数去做验证确认此用户在工单系统中存在。三、登录
HTTP标准包头字段(必填):
Accept : application/json; Content-Type : application/json;charset=UTF-8;
JSON请求示例
GET http://请求地址/WorkPerform/login/{token字符串}/{username}/{password}HTTP/1.1 Accept:application/json; Content-Type:application/json; charset=UTF-8;
属性说明
属性 | 类型 | 约束 | 说明 |
响应结果JSON
{"result":"success","desc":"成功","code":"1"}
响应说明
属性 | 类型 | 说明 |
user | String | 登陆用户名 |
desc | String | 返回结果说明 |
status | String | 返回结果code。 |
以下是DEMO安装说明:
demo由于是调用工单Pass接口所以只需修改以下几点即可使用
一、修改配置项
修改文件地址:/Demo/base/resources.properties修改PASSURL(分配给你的Pass地址)修改CLIENT_ID(分配给你的开发者信息Client ID)
二、JDK版本
JDK环境必须用1.6及以上的版本
三、支持预览器版本
IE,搜狗。其他目前待完善
以下是功能类接口说明:
获取当前工号可发起的流程列表
获取当前工号可发起的流程列表
HTTP标准包头字段(必填):
Accept : application/json; Content-Type : application/json;charset=utf-8;
JSON请求示例
GET http://请求地址/Workquery/startProcessList/{token字符串}/{username用户工号} HTTP/1.1 Accept:application/json; Content-Type:application/json; charset=utf-8;
属性说明
属性 | 类型 | 约束 | 说明 |
响应说明
属性 | 类型 | 约束 | 说明 |
id | String | 必选 | 标识id |
username | String | 必选 | 用户名称 |
fkdept | String | 必选 | 部门标识 |
no | String | 必选 | 企业-工号 |
password | String | 无 | |
deptname | String | 必选 | 部门名称 |
salt | String | 必选 | 扩展字段 |
desc | String | 必选 | 返回结果说明 |
status | String | 必选 | 返回结果code。 |
HTTP/1.1 200 OK{响应JSON
"desc": "操作成功", "status": "000", "user": { "id": 0, "username": "1001", "fkdept": "100", "no": "HYCC-1001", "credentialsSalt": "1001", "password": "", "deptname": "集团总部", "salt": "" } }
获取所有流程列表
获取所有流程列表
HTTP标准包头字段(必填):
Accept application/json;Content-Type:application/json;charset=UTF-8;
JSON请求示例
GET http://请求地址/Workquery/processList/{token字符串} HTTP/1.1 Accept:application/json; Content-Type:application/json; charset=UTF-8;
响应说明
属性 | 类型 | 约束 | 说明 |
desc | String | 必选 | 返回结果说明 |
status | String | 必选 | 返回结果code。 |
no | String | 必选 | 流程ID |
name | String | 必选 | 流程名称 |
url | String | 必选 | 扩展连接字段 |
HTTP/1.1 200 OK{"desc":"操作成功","status":"000","list":[{"no":"001","name":"DEMOFORM","url":""}]}响应JSON
获取人员待办,在途,催单,历史数量
HTTP标准包头字段(必填):
Accept application/json; Content-Type:application/json;charset=UTF-8;
JSON请求示例
POST http://请求地址/Workquery/allSum/{token字符串}/{flowid流程ID,为null时查询所有流程}/{username工号} HTTP/1.1 Accept:application/json; Content-Type:application/json;charset=UTF-8;
响应说明
属性 | 类型 | 约束 | 说明 |
desc | String | 必选 | 返回结果说明 |
status | String | 必选 | 返回结果code。 |
todosum | String | 必选 | 用户待办数量 |
intransitsum | String | 必选 | 用户在途数量 |
historysum | String | 必选 | 用户历史数量 |
remindersum | String | 必选 | 用户被催单数量 |
HTTP/1.1 200 OK{"historysum":12,"desc":"操作成功","todosum":5,"status":"000","remindersum":1,"intransitsum":6}响应JSON