四、相关特性接口

4.1 链接跳转对话

4.1.1 概述

借用分享的流程，链接跳转对话的流程如下：

  1. 网页js调用对接系统获取个人名片访问token
  2. 对接系统通过调用gateway接口，获取个人名片访问token，并返回给网页
  3. 网页js使用该token调用验证个人名片接口，客户端同时跳转个人对话窗口

4.1.2 接口

since 版本： 后台 0.14.0+ 客户端 2.7.10+ 2017.4.18 发布

4.1.2.1 获取个人名片访问token
  • 提供方：U聊服务端
  • 发起方：接入系统
  • 接口路径：/upchat-public-gateway/api/app/share/add
  • 调用方式：HTTP POST
  • 请求格式：application/x-www-form-urlencoded;charset=utf-8
  • 请求编码：UTF-8
  • 请求参数：
    1. apikey: 接口调用凭据
      1. type：分享类型
      2. 0-个人名片
      3. objectid：对象id
        • 个人： userid
      4. paras：可选。场景参数
  • 应答格式：application/json;charset=UTF-8
  • 应答编码：UTF-8
  • 应答数据：
    1. status：应答码，0表示成功，非0时异常信息见msg
    2. msg：异常信息；
    3. access_token：分享访问码
    4. expires:分享过期时间，秒为单位。-1为永久有效
  • 应答范例：
      {    "status":"0",
      "msg":"成功",
      "access_token":"BkxvK25+sfvqeFGRnbLwN+0xMcB\/89TP61r8mtHJm9HbSEw1NrX4biKVerwRjOIKQ2F9nTFQrb463mgXnNvQ+Q=="
      "expires":604429
  }
4.1.2.2 访问个人名片，跳转。js接口

网页需引入库 app.upchat_1.1.js 接口：UPSharePlugin.validateShare(success,fail,opt) 用途：验证分享链接，跳转到相应的聊天窗口 参数：success成功回调函数; fail失败回调函数; opt: {access_token:token} 返回：success,fail回调 返回字段：status：状态，取值 

* 0成功
* 1已失效 这种情况需要给出重试的机制
* 99服务器内部错误

4.2 加强认证--手势密码

4.2.1 概述

某些场景下，需要对页面的访问权限进行控制，由此产生了加强认证。其流程基本复用上述认证接口相关内容，概括如下：

  1. 网页js调用getGestrueSecurity(callback)方法，客户端弹起手势密码验证页面（用户首次使用时会弹出手势密码设置页面）；
  2. 验证手势密码结束后,通过callback函数返回结果给网页,若验证成功则返回security,失败则有网页自行处理下一步流程；
  3. 若验证成功，网页将security透传到对接系统， 对接系统通过调用gateway的checksecurity接口（注意type字段设置为1），获取用户个人信息，并返回给网页
  4. 网页js拿到用户信息进行后续相关业务

4.2.2 接口

since 版本： 后台 1.15.0 + 客户端 2.8.1+ 2017.6.30 发布

4.2.2.1 调起客户端手势密码验证页面获取security

网页需引入库 app.upchat_1.1.js 接口：UPSharePlugin.validateShare(success,fail,opt) 用途：验证分享链接，跳转到相应的聊天窗口 参数：success成功回调函数; fail失败回调函数; opt: {access_token:token} 返回：success,fail回调 返回字段：status：状态，取值 

* 0成功
* 1已失效 这种情况需要给出重试的机制
* 99服务器内部错误
4.2.2.2 获取个人信息
  • 提供方：U聊服务端
  • 发起方：接入系统
  • 接口路径：/upchat-public-gateway/api/app/checksecurity
  • 调用方式：HTTP POST
  • 请求格式：application/x-www-form-urlencoded;charset=utf-8
  • 请求编码：UTF-8

  • 请求参数：

    1. apikey: 接口调用凭据
      1. security: 用户信息访问凭证
      2. type: 客户端加强认证的方式 ("0"为无加强认证，"1"为手势密码加强认证)

  • 应答格式：application/json;charset=UTF-8

  • 应答编码：UTF-8
  • 应答数据：
    1. status：应答码，0表示成功，非0时异常信息见msg
    2. msg：异常信息；
    3. userinfo：用户信息
  • 应答范例：
      {    "status":"0",
      "msg":"成功",
      "userinfo":{
          "uid":"xxxx",
          "userid":"xxxxx",
          "domain":"xxxxx",
          "empname":"xxxxx",
          "gender":"xxxxx",
          "remark":"xxxxx",
          "icon":"xxxxx",
          "apikey":"xxxxx",
          "namefirst":"xxxxx",
          "empcode":"xxxxx",
          "mobileno":"xxxxx",
          "ecode":"xxxxx"
      }
  }

results matching ""

    No results matching ""