O2OA是一個高度可定製化的企業級開發平臺,它的API(應用程序接口)分爲前端和後端,各自有不同的用途,平臺爲用戶開放了全部的後端API供開發者使用,開發者可以根據各類API組織出符合實際業務需求的新服務或者新業務,用於數據查詢,業務接口服務等。
一、API功能簡介
1、前端API:
O2OA的前端API主要用於瀏覽器和移動端H5頁面。這些API基於用戶所使用的瀏覽器的Javascript引擎,使用Javascript語法。前端API允許用戶通過腳本訪問和操作平臺內的各種對象,包括DOM對象(文檔對象模型)以及通過平臺定義的API操作業務數據、組織、視圖等對象。
-
-
腳本可以在後端(服務器端)和前端(瀏覽器端)執行。
-
定義在流程中的腳本在後端執行;
-
定義在表單等其他地方的腳本在前端執行。
-
在表單和其他地方定義的腳本主要在前端執行。
-
2、後端API:
O2OA的後端API則運行在服務器上。這些API基於JDK8標準的Nashorn,遵循ECMAScript 5.1規範。後端API允許用戶通過腳本訪問和操作平臺內的各種對象,但與前端API不同的是,這些操作主要在服務器端執行。後端API還支持一些特定的特性,如處理url路徑參數和body參數,以及通過不同的認證方式進行接口認證等。
總的來說,O2OA的API爲開發者提供了豐富的接口和功能,使得他們可以根據需要定製和擴展平臺的功能。無論是前端還是後端API,都爲用戶提供了強大的工具來訪問和操作平臺內的各種對象和數據,從而滿足各種業務需求。
二、前端API文檔訪問說明:
訪問地址:http://www.o2oa.net/api 或者您私有化部署的服務器:http:// {server hostname}/api
三、前端API接口概述
對象 |
||
業務數據(data) |
流程實例(workContext) |
內容管理實例(documentContext) |
組織(org) |
流程表單(form) |
頁面(page) |
視圖(view) |
數據字典(Dict) |
Action(Action) |
引用(include) |
方法定義(define) |
session(session) |
系統模塊說明
服務 |
|
x_processplatform_assemble_surface |
流程平臺相關服務 |
x_portal_assemble_surface |
門戶平臺相關服務 |
x_cms_assemble_control |
內容管理平臺相關服務 |
x_query_assemble_surface |
數據平臺相關服務 |
x_organization_assemble_express |
組織架構相關服務 |
x_file_assemble_control |
雲文件相關服務 |
x_meeting_assemble_control |
會議管理相關服務 |
x_bbs_assemble_control |
論壇相關服務 |
x_calendar_assemble_control |
日程管理相關服務 |
x_hotpic_assemble_control |
熱點信息相關服務 |
x_mind_assemble_control |
腦圖模塊相關服務 |
x_organization_assemble_personal |
個人設置相關服務 |
x_attendance_assemble_control.json |
考勤模塊相關服務 |
四、後端Restful API文檔(OpenAPI)訪問說明
爲了最大限度地保障各類系統的安全性,O2OA開發平臺默認關閉了從外部訪問Restful API列表的權限。我們可以使用管理員賬號進入系統啓用Restful API列表的訪問權限,步驟如下:
-
-
用管理員身份(xadmin或者擁有Manager角色的用戶)登陸O2OA開發平臺;
-
選擇服務器配置-服務器任務,如下圖所示:
-
c. 允許輸出API文檔頁面,選擇“是”
五、後端API的使用方式
O2OA所有的後端應用服務都是開放的restful服務,用戶可以在擁有管理員權限的前提下查看平臺服務列表。
1、服務地址列表訪問
1、使用xadmin或者擁有管理員權限(manager角色)的用戶登錄O2OA服務器
2、訪問中心服務器的服務列表:
訪問地址:https://{servername}/x_program_center/jest/list.html
O2OA服務API列表
2、應用模塊Restful服務說明
點擊中心服務器服務API列表中的具體應用服務列表,可以訪問具體應用服務的API,如:
http://appserver_host/x_organization_assemble_authentication/jest/index.html
開發者可以根據具體的服務說明指引來了解服務的調用方式,也可以填寫參數進行服務的調用測試。