纷享销客开发者手册 纷享销客开发者手册
  • APL开发手册
  • PWC开发手册
  • OpenAPI 文档
  • 快速入门
  • API 授权流程
  • API 基础说明
  • OpenAPI
  • 免登集成方案
  • 客户端开发
  • 常见问题
  • OpenApi V1版本 (opens new window)
  • 简体中文
  • English
  • 快速入门
  • API 授权流程
  • API 基础说明
  • OpenAPI
  • 免登集成方案
  • 客户端开发
  • 常见问题
  • OpenApi V1版本 (opens new window)
  • 简体中文
  • English
  • 快速入门

  • API授权流程

  • API基础说明

  • OpenAPI

  • 免登集成方案

  • 客户端开发

    • 接入指南

    • JavaScript

      • 容器
        • 设备
        • 启动器
        • Webview
        • 弹层
        • 纷享服务
        • 媒体
        • 通用
      • UI

    • 常见问题

    目录

    容器

    # 容器

    接口名 接口描述
    runtime.getVersion 获取终端版本号
    runtime.getCurrentUser 获取当前用户信息
    runtime.requestAuthCode 获取临时授权码用于免登业务
    runtime.showUpdate 提示版本升级

    # 获取终端版本号

    代码样例

    FSOpen.runtime.getVersion({
        onSuccess: function(resp){
            alert('当前终端版本号是:' + resp.ver);
        },
        onFail: function(error){
            alert('接口调用失败,错误码:' + error.errorCode);
        }
    });
    

    方法名:FSOpen.runtime.getVersion JS版本:2.0.0 客户端支持版本:5.4.0及以上

    成功回调返回参数:

    参数 类型 说明
    ver String 版本号信息,如'5.3.0'。

    # 获取当前用户信息

    代码样例

    FSOpen.runtime.getCurrentUser({
        onSuccess: function(resp){
            alert('当前用户信息:' + JSON.stringify(resp));
        },
        onFail: function(error){
            alert('接口调用失败,错误码:' + error.errorCode);
        }
    });
    

    方法名:FSOpen.runtime.getCurrentUser JS版本:2.0.0 客户端支持版本:5.4.0及以上

    成功回调返回参数:

    参数 类型 说明
    user Object 返回当前用户的具体信息,详细字段如下表所示。

    user对象参数说明:

    参数 类型 说明
    userId String 用户ID
    nickname String 用户昵称
    email String 用户电子邮箱
    avatarUrl String 用户头像
    position String 用户职位信息

    # 获取免登授权码

    免登授权码主要用于通过服务器接口换取用户身份(用户ID),参考用户级授权 。

    代码样例

    FSOpen.runtime.requestAuthCode({
        onSuccess: function(resp) {
            alert('免登授权码信息:' + JSON.stringify(resp));
        },
        onFail: function(error) {
            alert('接口调用失败,错误码:' + error.errorCode);
        }
    });
    

    方法名:FSOpen.runtime.requestAuthCode JS版本:2.0.0 客户端支持版本:5.4.0及以上

    成功回调返回参数:

    参数 类型 说明
    code String 免登授权码,主要用于通过服务器接口换取用户身份。

    客户端同时提供一个更为便捷的JS API,可直接获取到当前用户信息,请参考接口获取当前用户信息

    # 提示版本升级

    弹出升级提示,在Android上用户点击确定后可跳转到应用市场直接升级。

    代码样例

    FSOpen.runtime.showUpdate({
        message: '当前版本有更新。'
    });
    

    方法名:FSOpen.runtime.showUpdate JS版本:2.0.0 客户端支持版本:5.4.0及以上

    调用参数说明:

    参数 类型 必须 说明
    message String 是 升级提示文本
    概述
    设备

    ← 概述 设备 →

    • 跟随系统
    • 浅色模式
    • 深色模式
    • 阅读模式