接口服務介紹
開發者接入云平臺服務,首先要進行 授權 和 認證 操作用來確認您的身份是否合法。
我們正常的認證至少需要認證上面提到的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