对接说明 - 橙讯开放平台基线

添加应用并获取应用授权信息请参考开发前准备

下载SDK文件(最近更新：2024-11)。

js-sdk 为第三方应用提供橙讯基础能力对接服务，包括统一身份认证，分享/转发，选择通讯录等能力。

引入并初始化(如果是vite构建的又不支持commonjs的可使用cx-es-sdk.js)

初始化过程能够动态获取橙讯app所支持的能力，橙讯app添加和修改能力后，无需再重新引入新的js-sdk。

支持两种引入方式

通过import引入

 import {cxJsBridgeWebApiInit} from 'xxx/cx-sdk'
 let cxApi=null;
 export const  getCxApi=async (appKey)=>{
     return cxApi || await cxJsBridgeWebApiInit(appKey);

 }

通过 script 标签引入 【不推荐】

一般应用于不兼容ES6 语法的项目。

    <script src="xxx/cx-sdk.js"></script>
    var cxApi=null;
    cxSdk.cxJsBridgeWebApiInit(appKey,function(data){
       cxApi=data;
    },function(error){
        console.log(error)
    })

调用方法

以下是三种调用方式：

以单点登录获取授权码为例

Promise链式调用

cxApi.login(params).then((data)=>{
    // toDo
}).error(e=>{
   // toDo
)

利用 async/await【捕捉错误信息需要在 catch 中】

  async function getOAuthCode (params){
            try{
                const data=await cxApi.login(params);
                return data；
            }catch(e){
                return false;
            }
   }

普通调用(一般适用于以script标签引入)

cxApi.login(
    {
        appKey:"xxx",
        enterpriseId:'xxxx',
        onSuccess:(data)=>{
        // toDo
        },
        onFail:(error)=>{
            // toDo
        }
    }
);

4:获得sdk版本号（橙讯4.0.2版本后支持）

注：今后可根据versionCode 适配适配不同的接口能力，如下载文件和打开文件需要在 versionCode>=1 后支持

对接注意事项：

1：如果调用成功，成功回调中只返回data中内容，不返回code=0，不需要判断 code=0,如果调用失败返回格式·{code:xx,msg:'xxxx'}
2：如果调用中出现错误，请查看错误码。