1.8 客户端API

一、客户端API介绍

YonBIP移动端标准产品中，友空间、友空间私有版，YonBuilder移动开发平台（打包独立APP）的底层技术已统一为使用同一个标准容器（移动底座SDK），同时提供统一的开发工具YonStudio、原生插件、移动安全和开发管理，开发人员通过标准HTML5技术即可开发Android & iOS原生APP以及H5轻应用、友空间小程序和其他各类小程序，帮助用户在一个技术栈、一套 API 的统一标准下简单高效的开发移动多端应用，可满足全领域应用场景需求。接入友空间的H5轻应用或小程序，在调用原生能力时，可参考本文档帮助说明调用对应的API，实现相关功能。 客户端API架构

二、客户端API接入

1. API调用标准

移动应用开发可使用YonBuilder低代码开发平台或基于标准HTML5组件化的开发模式快速开发移动应用，包括友空间、友空间私有版H5轻应用、小程序，独立APP等。 应用中涉及操作系统或终端设备原生能力时，API调用统一使用MTL.js和API.js，二者共同提供多终端适配的的原生功能访问能力。

2. MTL.js

MTL.js是原生API的统一标准：MTL.js包含了友空间、友空间私有版、微信小程序3端通用的符合B端业务特点的常见API能力，以及单点登录、连接YonBuilder、友户通、领域产品等用友业务特色相关的API能力，能够覆盖绝大多数B端业务功能。MTL.js可通过离线打包或CDN在线两种方式引入。

详细文档地址：https://developer.yonyou.com/docs/Client-API/MTL/mtl

调用示例

// 保留当前窗口，新开窗口跳转到应用内的某个页面
mtl.navigateTo({
  url: 'https://www.baidu.com',
  orientation: 1,
  navShow:0,
  success: function(res) {
    // 成功回调
  },
  fail: function(err) {
    var message = err.message; // 错误信息
  }
});

3. API.js

API.js核心功能：提供覆盖了友空间、友空间私有版、微信、钉钉原生小程序等终端与业务无关的全量API，满足 C 端业务特点， MTL.js运行在APP端时，底层依赖API.js。API.js已内置或编译于目标终端中（如友空间、友空间私有版），无需进行单独引入，其中的API直接调用即可

详细文档地址：https://developer.yonyou.com/docs/Client-API/API

调用示例

// 保留当前窗口，新开窗口跳转到应用内的某个页面
api.navigateTo({
    url: './detail/index.html',
    success: function(res) {
        // 成功回调
    }
});

4. API 调用优先级

调用优先级：MTL.js > API.js > 原生插件扩展 首先通过检索MTL.js文档，查询其中是否具有符合需求的API，有则通过mtl.xxx()进行调用；无则继续检索API.js文档，查询其中是否具有符合需求的API，有则通过api.xxx()进行调用，无则使用原生技术开发插件进行API扩展。

是否仍需要帮助？ 请保持联络！
最后更新于 2024/04/24