跳到主要内容

钉钉插件

Steedos可以集成钉钉，实现单点登录、消息推送和组织机构同步。

提示

此功能需要商业版授权才能使用。

钉钉集成​

单点登录

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

消息推送

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

同步通讯录

Steedos集成到钉钉后，可以将钉钉的通讯录同步到Steedos系统中。

如何集成钉钉​

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

创建钉钉应用​

请注册钉钉，并在钉钉后台（工作台->自建应用）创建“H5微应用”，以下说明都假设这里创建了一个名为“Steedos合同”的H5微应用。

设置钉钉开发管理​

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

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

应用首页地址：请配置Steedos服务的域名地址加上sso/dingtalk?corpid=$CORPID$后缀，比如https://www.test-dingtalk.com/sso/dingtalk?corpid=$CORPID$。

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

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

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

设置钉钉事件订阅​

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

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

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

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

设置钉钉权限管理​

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

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

设置钉钉版本管理与发布​

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

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

添加钉钉插件​

Steedos2.0服务默认集成了钉钉插件。

绑定钉钉应用​

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

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

在钉钉中使用Steedos​

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

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

以上所有就绪后，Steedos用户只要登录钉钉账户就可以在钉钉客户端上无缝使用Steedos服务了。

工作台​

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

消息​

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

用户同步​

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

同步钉钉账户id​

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