O2OA使用手册
第1章 功能简介及概述
第6章 平台部署与配置
  • 6.1 安装部署-在Windows系统中部署O2OA开发平台
  • 6.2 安装部署-在Linux系统中部署O2OA开发平台
  • 6.3 安装部署-通过Docker Hub快速部署docker镜像
  • 6.4 安装部署-在宝塔/PHPStudy中部署O2OA开发平台
  • 6.5 安装部署-O2OA开发平台之HTTP端口规划
  • 6.6 安装部署-平台服务器版本升级操作说明
  • 6.7 安装部署-私有化部署服务器架构推荐
  • 6.8 安装部署-O2OA开发平台集群部署配置及操作说明
  • 6.9 安装部署-在线部署自定义应用的WAR包和JAR包
  • 6.10 服务器配置与管理-​O2OA主要配置文件说明
  • 6.11 服务器配置与管理-服务器端口冲突和端口修改
  • 6.12 服务器配置与管理-如何修改服务器内存占用率?
  • 6.13 服务器配置与管理-如何访问和操作H2内置数据库
  • 6.14 服务器配置与管理-​如何在O2OA中使用MySQL数据库?
  • 6.15 服务器配置与管理-如何修改平台支持的数据库驱动包
  • 6.16 服务器配置与管理-O2OA使用openGauss(华为高斯数据库)配置
  • 6.17 服务器配置与管理-O2OA开发平台平台数据库配置信息样例
  • 6.18 服务器配置与管理-配置O2OA服务器连接O2云
  • 6.19 服务器配置与管理-O2OA实现服务器随操作系统自动启动
  • 6.20 服务器配置与管理-文件存储服务器配置
  • 6.21 服务器配置与管理-工作日节假日配置
  • 6.22 服务器配置与管理-为平台增加全文检索功能
  • 6.23 服务器配置与管理-消息提醒配置说明
  • 6.24 服务器配置与管理-自定义消息提醒
  • 6.25 服务器配置与管理-定制消息通知的内容
  • 6.26 服务器配置与管理-消息通知过滤
  • 6.27 服务器配置与管理-为待办创建配置邮件通知
  • 6.28 服务器配置与管理-待办待阅数据的查询操作和管理
  • 6.29 服务器配置与管理-​自动执行平台数据的备份与恢复
  • 6.30 服务器配置与管理-数据导出导入与系统数据备份
  • 6.31 ​服务器配置与管理-定期自动执行数据备份与恢复
  • 6.32 系统安全-O2OA作为认证中心实现基于OAUTH2单点认证
  • 6.33 系统安全-O2OA基于Nginx的SSL跳转、转发配置
  • 6.34 O2OA(翱途)开发平台如何基于nginx上下文分发的方式快速集群部署
  • 6.35 系统安全-访问日志相关配置
  • 6.36 系统架构-平台集群化部署之基于Nginx端口分发机制实现集群部署
  • 6.37 系统安全-审计日志相关配置
  • 6.38 系统安全-平台日志文件说明
  • 6.39 系统架构-基于nginx快速集群部署-上下文分发
  • 6.40 系统安全-O2OA日志输出设置log4j2.xml
  • 6.41 系统安全-用户密码初始化规则的设定
  • 6.42 系统安全-启用HTTPS(百度云版)
  • 6.43 系统安全-启用HTTPS(腾讯云版)
  • 6.44 系统安全-自签名SSL证书验证HTTPS功能
  • 6.45 系统安全-登录密码RSA加密
  • 6.46 系统安全-用户登录IP限制
  • 6.47 系统安全-在用户登录过程中启用图形验证码
  • 6.48 系统安全-平台部署之使用非root用户运行服务
  • 6.49 系统安全-O2Server启用国密加密设置
  • 6.50 系统安全-日志应用使用说明
  • 6.51 系统安全-用户重置密码操作
  • 6.52 系统安全-超级管理员(xadmin)密码修改
  • 6.53 系统安全-使用Web端运行服务器管理命令
  • 6.54 系统安全-o2server无法正常显示验证码解决办法
  • 6.55 O2OA(翱途)开发平台前端安全配置建议(一)
  • 第16章 开发知识及常见问题
  • 16.1 O2OA如何实现文件跨服务器的备份
  • 16.2 O2OA(翱途)服务器故障排查
  • 16.3 开发知识-让后端代理/接口脚本编写也能像前端一样用上debugger
  • 16.4 常见问题-SQLServer中创建新数据库使用哪个中文编码?
  • 16.5 O2OA(翱途)流程引擎中如何修改,定制流程的流转记录
  • 16.6 mysql数据库备份
  • 16.7 domain不正确的时候如何强制设置成正确的
  • 16.8 配置文件中使用密文存储密码
  • 16.9 常见问题-连接MySQL出现 Public Key Retrieval is not allowed 的错误
  • 16.10 常见问题-查看表结构
  • 16.11 常见问题-7.2及以上版本开启web代理后请求中没有正确使用web端口问题解决方式
  • 16.12 linux环境libreoffice安装及使用
  • 16.13 在O2OA中使用网络会议(二):Openmeetings与O2OA认证配置
  • 16.14 在O2OA中使用网络会议(一):Openmeetings-5.1.0亲手安装整理 Step-By-Step
  • 16.15 藕粉社区问答系列1
  • 16.16 藕粉社区问答系列2
  • 16.17 藕粉社区问答系列3
  • 16.18 快速入门-平台相关资料汇总
  • 16.19 快速入门-服务器总体介绍汇总
  • 16.20 快速入门-流程表单载入基础数据
  • 16.21 快速入门-常用表单脚本样例汇总
  • 16.22 快速入门-自定义表数据分页样例
  • 16.23 云服务器-阿里云ECS服务器的端口启用
  • 16.24 开发知识-React篇:在O2OA平台框架中使用React
  • 16.25 开发知识-React篇:在O2OA门户页面中使用React
  • 16.26 开发知识-Vue篇:在Vue应用中集成O2OA
  • 16.27 开发知识-Vue篇:使用Vue-CLI开发O2应用
  • 16.28 开发知识-Vue篇:在O2门户页面中使用Vue
  • 16.29 平台中使用Druid数据库连接及监控
  • 16.30 开发知识-在PAAS平台上部署O2OA开发平台
  • 16.31 开发知识-如何使用Tomcat架设webdav服务器
  • 16.32 开发知识-单个端口模式的Nginx和系统配置
  • 16.33 开发知识-Linux非root用户如何使用80端口启动O2OA
  • 16.34 开发知识-O2OA平台启用Eruda进行移动端调试
  • 16.35 开发知识-神通数据库安装
  • 16.36 开发知识-人大金仓数据安装
  • 16.37 开发知识-中标麒麟安装达梦数据库(DM8)
  • 16.38 开发知识-中标麒麟安装人大金仓详细步骤
  • 16.39 开发知识-使用VNC连接中标麒麟V7操作系统
  • 16.40 开发知识-鲲鹏(ARM)麒麟操作系统如何替换yum源?
  • 16.41 开发知识-数据优化知识点
  • 16.42 水印安全-附件水印|加密|文档格式转换图片|PDF
  • 16.43 消息队列-配置activeMQ、kafka消息队列
  • 16.44 常见问题-数据导出或者导入时发生OOM异常
  • 16.45 常见问题-如何让用户在首次登录时,必须对初始密码进行修改
  • 16.46 常见问题-如何在模块部署中控制模块的访问权限
  • 16.47 常见问题-如何在平台中开发Ftp文件上传文件的服务?
  • 16.48 常见问题-如何使用服务管理调用WebService
  • 16.49 常见问题-如何使用脚本调用外部服务
  • 16.50 常见问题-如何使用脚本控制流程自动流转
  • 16.51 常见问题-如何通过脚本调用系统内服务
  • 16.52 常见问题-接口代码疑惑解答汇总
  • 16.53 常见问题:Maven编译o2server错误: Java Heap Space
  • 16.54 常见问题-集群配置后启动报错:NullPointerException
  • 16.55 常见问题-服务器错误:can not decrypt token
  • 16.56 常见问题-IOS移动办公无法收到验证码
  • 16.57 常见问题-服务器和日志时间相差12小时的问题
  • 16.58 常见问题-为什么127.0.0.1可以访问但其他IP无法访问
  • 16.59 藕粉社区问答系列4
  • 16.60 开发知识-React篇:在React应用中集成O2OA

  • O2OA翱途开发平台前端API和后端API的访问以及使用

    时间:2024-05-11   

    O2OA是一个高度可定制化的企业级开发平台,它的API(应用程序接口)分为前端和后端,各自有不同的用途,平台为用户开放了全部的后端API供开发者使用,开发者可以根据各类API组织出符合实际业务需求的新服务或者新业务,用于数据查询,业务接口服务等。

    一、API功能简介

    1、前端API

            O2OA的前端API主要用于浏览器和移动端H5页面。这些API基于用户所使用的浏览器的Javascript引擎,使用Javascript语法。前端API允许用户通过脚本访问和操作平台内的各种对象,包括DOM对象(文档对象模型)以及通过平台定义的API操作业务数据、组织、视图等对象。

      • 脚本可以在后端(服务器端)和前端(浏览器端)执行。

      • 定义在流程中的脚本在后端执行;

      • 定义在表单等其他地方的脚本在前端执行。

      • 在表单和其他地方定义的脚本主要在前端执行。

    2、后端API

            O2OA的后端API则运行在服务器上。这些API基于JDK11标准的GraalVM,遵循ECMAScript 5.1规范。后端API允许用户通过脚本访问和操作平台内的各种对象,但与前端API不同的是,这些操作主要在服务器端执行。后端API还支持一些特定的特性,如处理url路径参数和body参数,以及通过不同的认证方式进行接口认证等。

            总的来说,O2OA的API为开发者提供了丰富的接口和功能,使得他们可以根据需要定制和扩展平台的功能。无论是前端还是后端API,都为用户提供了强大的工具来访问和操作平台内的各种对象和数据,从而满足各种业务需求。

    二、前端API文档访问说明:

            访问地址:http://www.o2oa.net/api 或者您私有化部署的服务器:http:// {server hostname}/api 


    1715394936358316.png

    三、前端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列表的访问权限,步骤如下:

      1. 用管理员身份(xadmin或者拥有Manager角色的用户)登陆O2OA开发平台;

      2. 选择服务器配置-服务器任务,如下图所示:

    1715397089361849.png

            c. 允许输出API文档页面,选择“是”

    image.png

    五、后端API的使用方式

    O2OA所有的后端应用服务都是开放的restful服务,用户可以在拥有管理员权限的前提下查看平台服务列表。

    1、服务地址列表访问

    1、使用xadmin或者拥有管理员权限(manager角色)的用户登录O2OA服务器

    2、访问中心服务器的服务列表:

    访问地址:https://{servername}/x_program_center/jest/list.html

    image.png

    O2OA服务API列表


    2、应用模块Restful服务说明

            点击中心服务器服务API列表中的具体应用服务列表,可以访问具体应用服务的API,如:

            http://appserver_host/x_organization_assemble_authentication/jest/index.html

    1577080855613-b0e4953a-1ae9-4572-b4d6-7dede2a28cab.png

            开发者可以根据具体的服务说明指引来了解服务的调用方式,也可以填写参数进行服务的调用测试。







    上一篇:服务集成-平台数据字典API使用说明

    下一篇:没有了!