第三方应用开发 运营规范 企业微信应用接入指引
企业微信应用接入指引

目录

  • 背景
  • 成为企业微信的服务商
  •       1. 流程图
  •       2. 线上申请流程
  •       3. 服务商平台
  •       4. 服务商助手
  • 应用接入流程完整图示
  • 应用开发
  •       1. 概述
  •       2. 创建应用
  •             2.1 创建网页应用
  •             2.2 创建小程序
  •             2.3 应用信息填写标准
  •                   2.3.1 基本信息填写
  •                   2.3.2 使用配置填写
  •                   2.3.3 回调配置填写
  •                   2.3.4 其他信息填写
  •             2.4 服务商级别开发信息填写标准
  •       3. 测试应用
  •             3.1 应用安装测试
  •             3.2 应用测试说明
  •       4. 上线应用
  •             4.1 应用上线流程
  •             4.2 应用上线说明
  • 应用推广
  •       1. 推广二维码
  •             1.1 二维码
  •             1.2 注册按钮
  •             1.3 授权接口
  •       2. 应用市场推荐
  •  

    背景

    • 企业微信保持完全开放的第三方合作策略,致力于和所有的合作伙伴携手为用户提供最优质的企业服务。
    • 本接入说明将帮助未注册或新注册的服务商快速了解企业微信服务商体系及如何将产品接入到企业微信上。
    • 企业微信支持网页应用和小程序两种类型应用的接入。

    成为企业微信的服务商

    1. 流程图

    2. 线上申请流程

    1. 企业微信服务商基于企业微信帐号体系创建,故需先创建一个新企业或准备一个已有企业。
      点此注册企业微信
    2. 完善基础资料,从服务商官网申请成为服务商
      点此申请成为服务商

    3. 服务商平台

    申请服务商成功后,将自动跳转到服务商管理后台(后续可以通过访问服务商官网 找到后台入口)

    服务商后台有6个导航页,功能介绍如下:

    导航页功能介绍
    首页总体情况概览及消息通知中心
    应用管理承载标准应用的【开发→推广→运营】的 整个流程,服务商可在这里快速将标准产品以H5应用/小程序的形式接入到企业微信
    硬件管理合作伙伴可以将硬件设备接入企业微信,再基于企业微信向企业提供软硬一体化的服务和解决方案
    解决方案管理合作伙伴可以根据不同行业及场景提供基于企业微信的解决方案,方案落地后,可以录入并创建专属推广页。获得客户认可的优质方案将可以获得企业微信推广资源支持
    客户管理企业微信设立了服务奖励基金,用于补贴为企业提供咨询服务并帮助企业用起企业微信的服务商。 奖励规则及说明
    服务商信息服务商基本信息、服务信息及权限管理

    4. 服务商助手

    服务商助手,是为了让企业微信服务商更方便的为客户提供服务所提供的工具。

    在服务商企业内,有服务商平台权限的成员,可以在企业微信工作台中使用「服务商助手」应用。

    功能功能介绍
    通知消息服务商可实时接收企业微信消息通知,便于查阅和追溯记录。消息通知包括:运营规范及政策通知 、接口更新 、新功能更新、系统通知、用户服务通知
    应用管理接收用户对已发布应用的评价,并可做「回复评论」和「申请屏蔽」等操作
    解决方案管理查看已发布的解决方案,并可转发到聊天、分享给微信好友及朋友圈查看方案咨询客户的基本信息,并可分配跟进人员、在线联系用户及更新服务状态
    客户管理1.查看由企业微信分配的客户的基本信息和活跃数据,并可分配跟进人员、在线联系用户及更新服务状态;2.客户报备,为企业提供了技术支持服务并帮助企业用起企业微信的服务商,可主动报备客户并获得现金补贴奖励。
    权限管理超级管理员可以在权限管理中配置“管理人员”、“开发人员”、“运营人员”的范围。被配置权限的成员可以在工作台中看到「服务商助手」应用,并可以登录web服务商平台,获得相关功能模块的管理权限。

     

    应用接入流程完整图示

    page_1.png

    应用开发

    1. 概述

    • 创建应用:登录服务商管理后台进入“标准应用服务”,在“本地应用”创建应用
    • 测试应用:应用创建成功后,服务商可自行对本地应用进行安装测试
    • 上线应用:应用提交上线申请,企业微信侧将对会对应用信息进行审核,审核通过后可以正式上线

     

    2. 创建应用

    2.1 创建网页应用

    创建应用详细步骤:
    登录服务商平台—进入“应用管理”—网页应用—创建应用—填写应用信息—创建完成,进入应用详情页修改并完善应用信息。

    2.2 创建小程序

    企业微信支持小程序的运行,小程序需要先在微信小程序平台审核和发布,然后在企业微信关联,整体的步骤稍微复杂,如下:

    1. 注册微信小程序开发者 前往注册;
    2. 开发微信小程序,适配企业微信帐号 查看文档;
    3. 在微信小程序平台发布小程序 前往发布;
    4. 在企业微信服务商后台关联小程序;

    关联小程序的详细步骤如下:
    登录服务商平台—进入“应用管理”—小程序—关联小程序—填写应用信息—关联完成,进入应用详情页修改并完善小程序信息。

    2.3 应用信息填写标准

    应用信息禁止涉及抄袭、侵权等违法行为,禁止使用夸大性、广告性和误导性的名称(如:“永久免费”、“热门”、”第一”等)。

    2.3.1 基本信息填写
    填写项填写标准
    应用类型支持应用类型:“普通应用”和“通讯录应用”
    “普通应用”用于企业OA、生产流程等办公的场景。具有读通讯录、发消息等权限;
    “通讯录应用”用于维护企业通讯录的场景,对企业的通讯录拥有根部门的读写权限,为避免通讯录被多方写乱,一家企业只能授权一个通讯录应用
    应用logo应用logo必须为正方形,像素为750﹡750,1M以内的jpg、png图片,不可使用企业微信logo或进行二次修改
    应用名称2-10个字,建议包含品牌名,不可使用特殊字符及特殊词汇 (如:“微信”、“特卖”、“企业微信”、“企微”、“抽奖”、“免费”等)
    应用标语2-10个字,需突出产品的功能亮点、给用户带来的独特价值。不可使用特殊字符及特殊词汇 (如:“微信”、“特卖”、“企业微信”、“企微”、“抽奖”、“免费”等)
    应用简介4-120个字,建议80个汉字左右,清晰描述应用功能和使用场景
    分类根据应用的功能及场景进行选择
    推荐的应用,在企业微信应用市场将根据行业分类进行展示
    通讯录权限遵循“权限最小化”原则,仅申请获取应用所必须的、最少属性的、最小范围的通讯录数据
    具体包括:个人使用且无需与其他成员协同的应用建议选择单个信息只读,如投票、考勤等场景;需要获取企业组织架构的应用可以选择基本信息只读,如审批、任务等场景
    企业客户权限开启后,应用可获取成员所选择的外部联系人的相关信息。需详细描述应用申请该权限所应用的场景
    成员敏感信息遵循“权限最小化”原则,默认未开启
    应用如需获取成员的头像、二维码等敏感信息,请在应用详情页中开启
    2.3.2 使用配置填写
    填写项填写标准
    应用主页用户从企业微信工作台进入应用时将直接跳转到对应的主页URL
    可信域名填写不带http:// 或https:// 头,可信域名必须通过ICP备案验证
    设置可信域名后支持应用的OAuth2授权、JSSDK调用等
    安装完成回调域名填写不带http:// 或https: //头的有效域名地址
    应用安装成功后会302跳转到该域名下的url,返回临时auth_code,再用此code换取永久授权码
    业务设置URL填写带https:// 头的有效URL链接
    授权企业的管理员可从企业微信后台的应用详情页免登录直接跳转该链接进行应用配置
    2.3.3 回调配置填写
    填写项填写标准
    数据回调URL填写带https:// 头的有效URL链接,填写URL时需要正确响应企业微信验证URL的请求
    用于接收托管企业微信应用的用户消息、进入应用事件、通讯录变更事件
    指令回调URL填写带https:// 头的有效URL链接,填写URL时需要正确响应企业微信验证URL的请求
    用于接收应用授权变更事件(应用添加、删除、修改)以及ticket参数,ticket说明详API接口说明
    2.3.4 其他信息填写
    填写项填写标准
    审批接口模板名称:1-10个字,模板介绍:1-200个字。不可使用特殊字符及特殊词汇 (如:“微信”、“特卖”、“企业微信”、“抽奖”、“免费”等)
    自定义菜单不可使用特殊字符及特殊词汇 (如:“微信”、“特卖”、“企业微信”、“抽奖”、“免费”等)
    价格对比表版本功能和定价策略必填,增值服务和额外说明选填。切勿修改表格的样式、sheet表的位置、名称和对单元格进行合并操作。版本功能行数建议在10-15行内,做一定的顺序调整,形成倒三角的样式。
    应用截图必须为IOS版的企业微信界面或小程序界面截图,五张,像素1242*2208,无水印的jpg、png格式,2M以内,可进行一定的设计来清晰直观呈现应用功能和特点

     

    2.4 服务商级别开发信息填写标准

    填写项填写位置填写标准
    白名单IP列表服务商信息->IP白名单建议填写
    只有白名单内的IP才能正常调用企业微信API,若后续IP有修改,需要及时进行列表更新
    系统事件接收URL标准应用服务->通用开发参数填写带http:// 或https:// 头的有效URL链接,填写URL时需要正确响应企业微信验证URL的请求
    用于接收通过推广二维码或者注册按钮成功注册企业微信的事件

    3. 测试应用

    3.1 应用安装测试

    企业微信提供两种安装测试途径:

    • 从服务商平台安装测试:服务商可在本地应用中对已创建的应用进行安装测试
    • 自行构造测试授权链接:调用设置授权配置接口,构造测试授权链接进行测试授权

    3.2 应用测试说明

    • 用于安装测试的企业微信帐号需服务商自行注册,每个应用支持同时添加10个测试企业微信账号;
    • 安装测试的企业微信帐号使用的是当前的应用配置信息,后续的修改不会进行同步;如需更新应用信息请重新授权安装;
    • 同一企业微信帐号,不支持同时安装测试应用和正式发布的应用;
    • 建议对应用进行可用性测试,确保在多个终端能正常使用,包含企业微信移动端(iOS、Android)、企业微信PC端(Windows、Mac)、微工作台(原企业号)端(iOS、Android)和web端

    4. 上线应用

    4.1 应用上线流程

    应用上线步骤:

    1. 提交上线:已认证企业微信的服务商,可进入应用管理—点击提交上线—勾选应用—提交上线(由企业微信团队对应用信息进行审核)
    2. 上线应用:审核通过—点击“已通过”状态—提交上线—上线成功

    4.2 应用上线说明

    • 发布应用必须进行企业微信账号认证;
    • 应用信息审核需1-2个工作日,为提高效率,建议在本地安装测试确认信息无误后再提交上线申请;
    • 审核结果将由“企业微信团队”向系统管理员推送,请系统管理员及时查看企业微信消息提醒;
    • 修改应用:在本地应用中修改信息并重新提交审核,发布后,所修改的应用信息才会覆盖到所有已授权的企业;
    • 应用logo、应用介绍、应用名称,这三项信息修改并重新发布后,将不会覆盖所有已授权的企业;
    • 下线应用:在“查看已上线应用”列表,进入应用详情页,可以下线应用。应用下线后将不再提供给新的企业授权使用,但不影响所有已授权的企业使用
    • 删除应用:在应用详情页可以删除应用。但曾经上线,且已被企业授权使用的应用不允许删除
    • 上线为应用的一个开发状态,只有申请推荐到应用市场的应用才可以被用户在市场中搜索和查看到

    应用推广

    应用上线后,即可配置相应的应用推广页面,从自有渠道将产品推广给自己的已有用户及新用户

    1. 推广二维码

    应用上线后,即可生成相应的推广二维码,从自有渠道将产品推广给自己的已有用户及新用户

    1.1 二维码

    生成推广二维码详细步骤:
    登录服务商管理后台—进入“标准应用服务”—推广二维码—创建推广二维码—填写相关信息—创建完成,进入推广二维码详情页查看二维码详细信息。

    1.2 注册按钮

    推广二维码实际上创建了一个企业微信推广包,包含了预定义的企业微信和应用,如果需要在图文中更好地引导用户使用应用,也可以直接用注册按钮的方式,注册按钮的获取路径为:
    登录服务商管理后台—进入“标准应用服务”—推广二维码—查看推广二维码详情,推广二维码详情页最底部有该推广包的注册按钮信息。
    在图文中嵌入注册按钮,用户点击按钮后,若用户未注册企业微信,将引导下载企业微信,在注册成功后会自动预装应用;若用户已注册企业微信,将引导用户直接将应用安装到企业中。点击查看接口文档

    1.3 授权接口

    使用第三方授权接口构造应用授权链接,已经注册企业微信的用户在你的网站上可以直接安装应用到他的企业微信中。  点击查看接口文档

     

    2. 应用市场推荐

    符合推荐规范并经过用户内测,审核优化,灰度测试后,可以在应用市场全量推荐

    推荐规范文档请查看《应用市场推荐规范》
    申请应用推荐的详细步骤:
    可在“企业微信->工作台->企业微信服务商助手”中联系渠道经理申请应用推荐审核。

    下一篇
    企业微信解决方案录入指引