本篇梳理 O2OA 平台前端与后端接口的定位差异及调用入口。前端接口面向浏览器与移动端页面,可操作数据、组织、视图等对象;后端接口运行在服务器侧,遵循脚本规范并支持路径参数与多种认证方式。平台默认关闭外部对接口清单的访问,需由管理员账号开启输出权限后,再从中心服务器的服务列表逐项查看模块说明并试调,后端更适合承接数据查询与业务服务。
O2OA 是一个高度可定制的企业级开发平台,其 API(应用程序接口)分为前端和后端,各有不同用途。平台开放了全部后端 API 供开发者使用,开发者可以基于各类 API 构建符合实际业务需求的新服务或新业务,用于数据查询、业务接口服务等。
一、API 功能简介
1、前端 API:
O2OA 的前端 API 主要用于浏览器和移动端 H5 页面,基于用户所用浏览器的 Javascript 引擎,使用 Javascript 语法。前端 API 允许用户通过脚本访问和操作平台内的各种对象,包括 DOM 对象(文档对象模型),以及通过平台定义的 API 操作业务数据、组织、视图等对象。
2、后端 API:
O2OA 的后端 API 运行在服务器上,基于 JDK11 标准的 GraalVM,遵循 ECMAScript 5.1 规范。后端 API 允许用户通过脚本访问和操作平台内的各种对象,但与前端 API 不同,这些操作主要在服务器端执行。后端 API 还支持一些特定特性,如处理 url 路径参数和 body 参数,以及通过不同的认证方式进行接口认证等。
总体而言,O2OA 的 API 为开发者提供了丰富的接口和功能,可根据需要定制和扩展平台功能。无论前端还是后端 API,都为用户提供了访问和操作平台内各种对象与数据的工具,从而满足各类业务需求。
访问地址:http://www.o2oa.net/api 或者您私有化部署的服务器:http:// {server hostname}/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 | 考勤模块相关服务 |
为最大限度保障各类系统的安全性,O2OA开发平台默认关闭了从外部访问Restful API列表的权限。可使用管理员账号进入系统启用该访问权限,步骤如下:
c. 允许输出API文档页面,选择“是”
O2OA 的所有后端应用服务都是开放的 restful 服务,用户须拥有管理员权限方可查看平台服务列表。
1、使用 xadmin 或具有管理员权限(manager 角色)的用户登录 O2OA 服务器
2、访问中心服务器的服务列表:
访问地址:https://{servername}/x_program_center/jest/list.html
O2OA 服务 API 列表
点击中心服务器服务 API 列表中的具体应用服务,可访问对应应用服务的 API,如:
http://appserver_host/x_organization_assemble_authentication/jest/index.html
开发者可根据具体的服务说明了解服务的调用方式,也可填写参数进行调用测试。
相关问题讨论
前端 api 如何获取 其他账号的头像
O2OA 是一个高度可定制化的企业级开发平台,它的 API(应用程序接口)分为前端和后端,各自有不同的用途,平台为用户开放了全部的后端 API 供开发者使用,开发者可以根据各类 API 组织出符合实际业务需求的新服务或者新业务,用于数据查询,业务接口服务等。
查看原帖讨论 · 31,325 次浏览
相关内容
下一篇:没有了!