与企业微信集成

​

企业微信集成

单点登录

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

消息推送

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

同步通讯录

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

​

如何集成企业微信

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

​

创建企业微信应用

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

​

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

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

​

设置企业微信应用主页

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

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

​

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

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

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

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

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

​

设置企业微信事件订阅

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

同步方式：API接口

权限：API编辑通讯录

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

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

​

添加企业微信插件

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

​

绑定企业微信应用

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

• 企业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进行同步。