1. 管理员向导
  2. 与钉钉、企业微信集成

企业微信集成

华炎魔方几乎没有考虑在手机浏览器上的使用效果。如果您希望使用手机来访问华炎魔方,推荐安装和使用我们的 手机客户端,您也可以考虑把华炎魔方集成到企业微信,以便在企业微信客户端中使用华炎魔方。

单点登录

华炎魔方集成到企业微信后,只要使用企业微信账户登录企业微信客户端,即可在企业微信中直接使用华炎魔方,而不需要再次使用华炎魔方账户来登录使用。

消息推送

华炎魔方集成到企业微信后,当其绑定的华炎魔方账户有通知消息时,企业微信会弹出消息提醒,可点击该消息直接进入华炎魔方查看或处理相关消息。

同步通讯录

华炎魔方集成到企业微信后,可以将企业微信的通讯录同步到华炎魔方系统中。

订阅通讯录事件

华炎魔方集成到企业微信后,在企业微信后台配置订阅事件,当企业微信通讯录修改时,会同步修改华炎魔方系统中的相关信息。

支持各种客户端

得益于企业微信本身支持各种手机、平板电脑、PC电脑等,华炎魔方集成进去后也可以在这些客户端上直接使用。

如何集成企业微信

在集成企业微信前,请确保您的华炎魔方项目已经绑定到某个可通过互联网访问进入的域名地址,只能通过局域网IP或外网IP地址访问的华炎魔方项目是不可以集成到企业微信的,以下说明均假定您的项目已经绑定到域名地址https://www.test-qywx.com

创建企业微信应用

请注册企业微信,并在企业微信后台(应用管理->应用)创建一个应用,以下说明都假设这里创建了一个名为“华炎魔方合同”的应用。

设置企业微信应用可见范围

请在企业微信后台,进入刚刚创建的“华炎魔方合同”应用,并编辑该应用的可见范围,只有该范围内的用户可以在其企业微信客户端中看到该应用,也只有这些用户可以收到来自该应用的消息推送通知。

设置企业微信应用主页

请在企业微信后台,进入刚刚创建的“华炎魔方合同”应用,并在“功能”栏中找到“工作台应用主页”并点击其下方的“设置应用主页”按钮来设置应用主页。

这里需要输入的是您的华炎魔方项目的域名访问地址加上/api/qiyeweixin/mainpage后缀,比如https://www.test-qywx.com/api/qiyeweixin/mainpage

华炎魔方集成企业微信的单点登录功能使用的就是`/api/qiyeweixin/mainpage`这个路径指向的接口。 \n

设置企业微信应用可信域名

请在企业微信后台,进入刚刚创建的“华炎魔方合同”应用,并在“开发者接口”栏中找到“网页授权及JS-SDK”并点击其下方的“设置可信域名”按钮来设置可信域名。

可作为应用OAuth2.0网页授权功能的回调域名:直接输入华炎魔方项目的域名访问地址即可,比如www.test-qywx.com

可调用JS-SDK、跳转小程序的可信域名(最多10个,需完成域名校验):直接输入华炎魔方项目的域名访问地址即可,比如www.test-qywx.com

域名归属验证:点击此处的“申请校验域名”链接并按提示操作,底下的“用于OAuth2.0回调的可信域名是否校验”勾选框也必须勾选。

要集成企业微信到华炎魔方,必须完成这里提到的“域名归属验证”,不排除其不支持`http`域名地址,推荐使用`https`域名地址。

设置企业微信事件订阅

请在企业微信后台,选择管理工具,点击“通讯录同步” 开启API接口同步进行相关配置。

同步方式:API接口

权限:API编辑通讯录

Secret: 查看或者重新获取,需要配置到华炎魔方系统-设置-公司设置-企业微信-Secret

设置接收事件服务器:Token和EncodingAESKey随机获取后,需要配置到华炎魔方系统-设置-公司设置-企业微信中;URL设置前请先确保已经将Token和EncodingAESKey配置到华炎魔方系统中,然后再配置华炎魔方服务的域名地址加上api/qiyeweixin/listen后缀,比如https://www.test-qiyeweixin.com/api/qiyeweixin/listen,一定要配置公网域名访问地址。

添加企业微信插件

华炎魔方2.0服务默认集成了企业微信插件。

华炎魔方1.23版本的服务,把企业微信集成到华炎魔方之前,请先在华炎魔方项目中安装和启用插件 @steedos/plugin-qywx

如何安装和启用插件请参考:华炎魔方插件

绑定企业微信应用

在启用企业微信插件之后,华炎魔方管理员可以在华炎魔方的“设置->公司设置->公司”界面看到新加了一栏“企业微信”,完善这些信息即可把企业微信应用绑定到华炎魔方中。

  • 企业ID(CorpId):在企业微信后台,“我的企业->企业信息”界面可以查看和复制该ID值。
  • AgentID:在企业微信后台,“应用管理->华炎魔方合同”界面可以查看和复制该ID值。
  • Secret:在企业微信后台,“应用管理->华炎魔方合同”界面可以查看和复制该ID值。
  • Token:在企业微信后台,“管理工具->通讯录同步->设置事件接受服务器”中随机生成。
  • AesKey:在企业微信后台,“管理工具->通讯录同步->设置事件接受服务器”中随机生成。

在企业微信中使用华炎魔方

把企业微信集成到华炎魔方之后,还需要在华炎魔方中配置每个用户的“企业微信账号”才能正常在企业微信中使用华炎魔方。

系统管理员可以通知需要在企业微信中使用华炎魔方的用户前往企业微信的通讯录中查找自己的“企业微信账号”,并把它复制下来,然后在华炎魔方的“设置->个人账户设置->我的资料”界面上编辑保存其“企业微信账号”信息;也可以统一由系统管理员在华炎魔方“设置->公司设置->用户”界面上维护每个用户在企业微信通讯录上的“企业微信账号”信息。

修改本地steedos-config.yml文件,添加tenant._id、api_key和log_path,可以在设置-个人账户设置-API Key菜单下,获取用户的API Key。

tenant:
  _id: ${STEEDOS_TENANT_ID}

qywx:
  api_Key: ${APIKEY} # API Key, 接口验证需要
  log_path: ${QYWX_LOGPATH} # 日志文件路径,默认是./qywx_server.log

如果是用docker部署的用户,请修改docker-compose.yml文件,添加APIKEY和QYWX_LOGPATH环境变量:

  steedos:
    image: steedos/steedos-project-template:2.0.40
    restart: always
    ports:
      - "3000:3000"
    volumes:
      - "./docker-volumes/steedos/storage:/app/storage"
    environment:
      - PORT=3000
      - ROOT_URL=http://localhost:3000
      - MONGO_URL=mongodb://mongo:27017/steedos
      - MONGO_OPLOG_URL=mongodb://mongo:27017/local
      - STEEDOS_CFS_STORE=local
      - STEEDOS_STORAGE_DIR=/app/storage
      - TRANSPORTER=redis://redis:6379
      - CACHER=redis://redis/1
      - APIKEY=n32D3LeG8aIq5_jiiss23ssesf023sPGe # 配置系统中的API Key
      - QYWX_LOGPATH="./qywx_server.log" # 日志默认路径
      - STEEDOS_TENANT_ID=7asfxossf8sfssss # 魔方id

以上所有就绪后,华炎魔方用户只要登录企业微信账户就可以在企业微信客户端上无缝使用华炎魔方服务了。

工作台

如果企业微信上集成了上述创建的“华炎魔方合同”项目,那么只要在手机或PC客户端登录了企业微信,就可以在其“工作台”栏上看到“华炎魔方合同”这个应用,直接点击即可进入应用主页。

消息

如果企业微信上集成了上述创建的“华炎魔方合同”项目,那么只要在手机或PC客户端登录了企业微信,当其绑定的华炎魔方账户上有推送通知消息时,企业微信客户端会主动通知用户收到推送通知,也可以在其“消息”栏上直接看到来自华炎魔方的消息列表。

用户同步

如果企业微信上集成了上述创建的“华炎魔方合同”项目,可以通过前台调用数据同步接口将企业微信通讯录同步到华炎魔方系统中,例如调用https://www.test-qiyeweixin.com/api/qiyeweixin/stockData,同步前如果华炎魔方系统中已经存在用户,需要将用户与企业微信中对应的用户进行绑定,这样在同步时就会更新已存在用户信息。

同步企业微信账户id

如果企业微信上集成了上述创建的“华炎魔方合同”项目,对于只需要同步企业微信账户id到华炎魔方系统的用户,在配置完权限管理后,可以调用https://www.test-qiyeweixin.com/api/sync/qywxId进行同步。

钉钉集成

华炎魔方几乎没有考虑在手机浏览器上的使用效果。如果您希望使用手机来访问华炎魔方,推荐安装和使用我们的 手机客户端,您也可以考虑把华炎魔方集成到钉钉,以便在钉钉客户端中使用华炎魔方。

单点登录

华炎魔方集成到钉钉后,只要使用钉钉账户登录钉钉客户端,即可在钉钉中直接使用华炎魔方,而不需要再次使用华炎魔方账户来登录使用。

消息推送

华炎魔方集成到钉钉后,当其绑定的华炎魔方账户有通知消息时,钉钉会弹出消息提醒,可点击该消息直接进入华炎魔方查看或处理相关消息。

同步通讯录

华炎魔方集成到钉钉后,可以将钉钉的通讯录同步到华炎魔方系统中。

订阅通讯录事件

华炎魔方集成到钉钉后,在钉钉后台配置订阅事件,当钉钉通讯录修改时,会同步修改华炎魔方系统中的相关信息。

支持各种客户端

得益于钉钉本身支持各种手机、平板电脑、PC电脑等,华炎魔方集成进去后也可以在这些客户端上直接使用。

如何集成钉钉

在集成钉钉前,请确保您的华炎魔方项目已经绑定到某个可通过互联网访问进入的域名地址,只能通过局域网IP或外网IP地址访问的华炎魔方项目是不可以集成到钉钉的,以下说明均假定您的项目已经绑定到域名地址https://www.test-dingtalk.com

创建钉钉应用

请注册钉钉,并在钉钉后台(工作台->自建应用)创建“H5微应用”,以下说明都假设这里创建了一个名为“华炎魔方合同”的H5微应用。

设置钉钉开发管理

请在钉钉后台,进入刚刚创建的“华炎魔方合同”应用,点击“开发管理”进行相关配置。

服务器出口IP:请配置服务器的公网ip,类似于白名单的功能。

应用首页地址:请配置华炎魔方服务的域名地址加上sso/dingtalk?corpid=$CORPID$后缀,比如https://www.test-dingtalk.com/sso/dingtalk?corpid=$CORPID$

PC端首页地址:建议配置和应用首页地址一样。

管理后台地址:不需要配置。

后缀中添加`$CORPID$`占位符,系统在跳转时会自动将url中的占位符替换成当前企业的corpid。

设置钉钉事件订阅

请在钉钉后台,进入刚刚创建的“华炎魔方合同”应用,点击“事件订阅”进行相关配置。

加密 aes_key: 随机生成,可随时刷新修改,生成后需要配置到华炎魔方系统-设置-公司设置-钉钉-AesKey

签名 token: 随机生成,可随时刷新修改,生成后需要配置到华炎魔方系统-设置-公司设置-钉钉-Token

请求网址: 请先确保已经将aes_key和token配置到华炎魔方系统中,然后再配置华炎魔方服务的域名地址加上api/dingtalk/listen后缀,比如https://www.test-dingtalk.com/api/dingtalk/listen,一定要配置公网域名访问地址。

设置钉钉权限管理

请在钉钉后台,进入刚刚创建的“华炎魔方合同”应用,点击“权限管理”进行相关配置。

开通通讯录管理相关的权限:企业员工手机号信息、邮箱等个人信息、个人手机号信息、钉钉通讯录关联组织读权限、通讯录部门信息读权限、维护通讯录的接口访问权限、成员信息读权限、根据手机号姓名获取成员信息的接口访问权限和通讯录部门成员读权限。

设置钉钉版本管理与发布

请在钉钉后台,进入刚刚创建的“华炎魔方合同”应用,并在“版本管理与发布”中选择可使用范围,在可使用范围内的员工可以在工作台中看到“华炎魔方合同”应用和收到推送消息。

确定使用范围后,点击“发布”使配置生效。

添加钉钉插件

华炎魔方2.0服务默认集成了钉钉插件。

华炎魔方1.23版本的服务,在把钉钉集成到华炎魔方之前,请先在华炎魔方项目中安装和启用插件 @steedos/plugin-dingtalk

如何安装和启用插件请参考:华炎魔方插件

绑定钉钉应用

在启用钉钉插件之后,华炎魔方管理员可以在华炎魔方的“设置->公司设置->公司”界面看到新加了一栏“钉钉”,完善这些信息即可把钉钉应用绑定到华炎魔方中。

  • 企业ID(CorpId):在钉钉后台,“首页”界面可以查看和复制该ID值。
  • AgentID:在钉钉后台,“应用开发->华炎魔方合同”的“凭证与基础信息”界面可以查看和复制该ID值。
  • AppKey:在钉钉后台,“应用开发->华炎魔方合同”的“凭证与基础信息”界面可以查看和复制该Key值。
  • AppSecret:在钉钉后台,“应用开发->华炎魔方合同”的“凭证与基础信息”界面可以查看和复制该Secret值。
  • AesKey:在钉钉后台,“应用开发->华炎魔方合同”的“事件订阅”界面可以查看和复制该aes_key值。
  • Token:在钉钉后台,“应用开发->华炎魔方合同”的“事件订阅”界面可以查看和复制该token值。

在钉钉中使用华炎魔方

把钉钉集成到华炎魔方之后,还需要在华炎魔方中配置每个用户的“钉钉userid”才能正常在钉钉中使用华炎魔方。

系统管理员可以通知需要在钉钉中使用华炎魔方的用户前往钉钉的通讯录中查找自己的“钉钉userid”,并把它复制下来,然后在华炎魔方的“设置->个人账户设置->我的资料”界面上编辑保存其“钉钉userid”信息;也可以统一由系统管理员在华炎魔方“设置->公司设置->用户”界面上维护每个用户在钉钉通讯录上的“钉钉userid”信息。

修改本地steedos-config.yml文件,添加tenant._id、api_key和log_path,可以在设置-个人账户设置-API Key菜单下,获取用户的API Key。

tenant:
  _id: ${STEEDOS_TENANT_ID}

dingtalk:
  api_Key: ${APIKEY} # API Key, 接口验证需要
  log_path: ${DING_LOGPATH} # 日志文件路径,默认是./ding_server.log

如果是用docker部署的用户,请修改docker-compose.yml文件,添加APIKEY和DING_LOGPATH环境变量:

  steedos:
    image: steedos/steedos-project-template:2.0.40
    restart: always
    ports:
      - "3000:3000"
    volumes:
      - "./docker-volumes/steedos/storage:/app/storage"
    environment:
      - PORT=3000
      - ROOT_URL=http://localhost:3000
      - MONGO_URL=mongodb://mongo:27017/steedos
      - MONGO_OPLOG_URL=mongodb://mongo:27017/local
      - STEEDOS_CFS_STORE=local
      - STEEDOS_STORAGE_DIR=/app/storage
      - TRANSPORTER=redis://redis:6379
      - CACHER=redis://redis/1
      - APIKEY=n32D3LeG8aIq5_jiiss23ssesf023sPGe # 配置系统中的API Key
      - DING_LOGPATH="./ding_server.log" # 日志默认路径
      - STEEDOS_TENANT_ID=7asfxossf8sfssss # 魔方id

以上所有就绪后,华炎魔方用户只要登录钉钉账户就可以在钉钉客户端上无缝使用华炎魔方服务了。

工作台

如果钉钉上集成了上述创建的“华炎魔方合同”项目,那么只要在手机或PC客户端登录了钉钉,就可以在其“工作台”栏上看到“华炎魔方合同”这个应用,直接点击即可进入应用主页。

消息

如果钉钉上集成了上述创建的“华炎魔方合同”项目,那么只要在手机或PC客户端登录了钉钉,当其绑定的华炎魔方账户上有推送通知消息时,钉钉客户端会主动通知用户收到推送通知,也可以在其“消息”栏上直接看到来自华炎魔方的消息列表。

用户同步

如果钉钉上集成了上述创建的“华炎魔方合同”项目,可以通过前台调用数据同步接口将钉钉通讯录同步到华炎魔方系统中,例如调用https://www.test-dingtalk.com/api/dingtalk/stockData,同步前如果华炎魔方系统中已经存在用户,需要将用户与钉钉中对应的用户进行绑定,这样在同步时就会更新已存在用户信息。

同步钉钉账户id

如果钉钉上集成了上述创建的“华炎魔方合同”项目,对于只需要同步钉钉账户id到华炎魔方系统的用户,在配置完权限管理后,可以调用https://www.test-dingtalk.com/api/sync/dingtalkId进行同步。