# 开发指南

# 开发前必读

# 好未来内部应用后端接口接造物神封装的后端接口,地址:http://doc.openapi.zhiyinlou.com/docs/zws/yach/notice,”知音楼(Yach)相关“部分。

# userid机制

地址:通讯录管理

# 接入流程

  1. 申请开通应用 地址:开通应用
  2. 申请开通接口权限 地址:接口权限申请
  3. 在知音楼应用内接入身份验证免登流程:身份验证流程
  4. 接入通讯录能力(前提是申请开通了通信录权限组):通讯录管理
  5. 接入消息通知能力(前提是申请开通了消息通知权限组):消息通知

# 身份验证流程

  1. 业务方知音楼工作台页面调用知音楼前端提供的jsapi获取应用免登授权码
  2. 获取到免登码后业务方前端将code传给业务方后端调用免登code码获取用户基本信息接口获取当前登录用户唯一标识userid。
  3. 业务方后端可以调用通过userid获取用户详情接口获取用户详情
  4. 业务方后端获取用户详情后自己保持当前登录状态。

# 开通应用

正式环境: 联系刘欣老师(liuxin22@tal.com)相关审批通过后会在正式环境开通应用地址创建应用。

测试环境: 联系刘欣老师(liuxin22@tal.com)相关审批通过后会在测试环境开通应用地址创建应用。

# 接口权限申请

# 权限类型

基础权限

1、消息通知

2、身份验证

高级权限通讯录

1、通讯录只读权限

2、通讯录写权限

高级权限微应用

1、日志

2、周报

特殊权限

1、非对外定制接口

# 申请权限

发送邮件到guofeng2@tal.com表明要申请的权限组,并抄送刘欣老师(liuxin22@tal.com)。

# 获取access_token

# 调取开放平台对外开放的所有接口都需要该凭证

# host: https://yach-oapi.zhiyinlou.com 正式环境

# host: https://yach-oapi-dev.zhiyinlou.com 开发环境 (具备调试条件)

# host: https://yach-oapi-test.zhiyinlou.com 测试环境 (具备调试条件)

# host: https://yach-oapi-pre.zhiyinlou.com 预发布环境

# 概述

名称
地址 /gettoken
请求方式 GET
参数 见【参数】
返回值 见【返回值】

# 参数

参数 参数类型 必须 说明
appkey String 应用的唯一凭证
appsecret String 应用秘钥

【注意】正常情况下access_token有效期为7200秒,有效期内重复获取返回相同结果。

返回值

{
    "code": 200,
    "msg": "",
    "obj": {
        "access_token": "fw8ef8we8f76e6f7s8df8s"
    }
}

# FAQ

1、通用组件应用和Yach开放平台关系

答:通用组件应用是在通用组件开放平台申请的应用,Yach开放平台审批后创建的应用,两个应用没有从属关系。

2、应用是对接通用组件能力还是对接Yach开放平台能力

答:如果当前应用是通用组件应用那么就对接通用组件开放平台提供的能力,如果是Yach开放平台应用那么就调用Yach开放平台的能力,如果业务方分别在两个开放平台都申请了应用那么是都可以调用相关能力的。

3、通用组件应用能调用Yach开放平台相关能力吗?

答:可以,目前通用组件开放平台已对接Yach开放平台相关能力,只要是在通用组件申请的应用,如果通用组件开放平台对外提供了相关Yach开放平台能力那么是可以直接对接的。

4、知音楼工作台应用是通用组件应用还是Yach开放平台的应用

答:知音楼自定义工作台是通用组件提供的应用平台(包含在通用组件申请的应用和部门在Yach开放平台申请的应用),知音楼默认工作台是Yach开放平台默认应用平台。

5、如何把Yach开放平台的应用放到知音楼自定义工作台

答:将Yach开放平台默认应用的链接地址发送给通用组件负责人(张金海老师),通用组件相关技术老师配置知音楼自定义工作台即可。

6、开发、测试环境调不通

答:Yach开放平台目前有开发环境、测试环境、预发布、生成环境。在开发测试的时候调节客户端、后端接口一定要将环境切到对应的环境例如:开发对开发、测试对测试,否则接口会调用失败。

7、调试过程中报错咋办我找谁呢

答:将自己的请求记录Log 包括请求参数和返回接口。请求接口地址包含chengjiukehu.com或者100tal.com报错找通用组件相关技术老师,提供相关参数排查相关原因。请求接口地址包含yach-oapi的找Yach开放平台后端郭峰老师。

8、工作台看不到应用

答:知音楼自定义工作台应用找不到可以找通用组件张金海老师协调相关资源来定位问题有可能是(应用开放范围不包括当前登录的员工),开放平台默认工作台应用没开放非常有可能是Yach管理后台没有对外开放,可以找刘欣老师。

9、工作台提示yach验证code失败

答:苹果手机摇一摇切换到测试环境再试,安卓手机确保使用yach测试环境的安装包。

10、工作台提示无该yachid的账号信息

答:正确开通方式:联系通用组件老师提供开通账号的姓名、手机号、部门开通账号,然后通用组件老师开通对应账号的yach账号。错误开通方式:直接在yach管理后台或者数据库添加yach账号,最终导致当前用户依赖于通用组件的单点登录、消息能力将不能用。

上次更新: 9/16/2020, 6:36:54 PM
foo