目录
背景成为企业微信开发者 1. 流程图 2. 线上申请流程 3. 企业微信开发者中心应用接入流程完整图示应用开发 1. 概述 2. 创建应用 2.1 创建网页应用 2.2 应用信息填写标准 2.2.1 基本信息填写 2.2.3 应用权限与能力 2.2.3 使用配置填写 2.2.4 回调配置填写 2.2.5 其他信息填写 2.2.6 填写ip白名单 3. 测试应用 3.1 应用安装测试 3.2 应用测试说明 4. 上线应用 4.1 应用上线流程 4.2 应用上线说明 5. 应用二维码背景
- 企业微信保持完全开放的第三方合作策略,致力于和所有的合作伙伴携手为用户提供最优质的企业服务。企业微信开发者,是在企业微信内提供应用开发服务的开发伙伴,面向任何有意向、有能力的程序开发人员。
- 本接入说明将帮助企业微信开发者快速了解企业微信开发体系及如何基于企业微信快速创建个人主体的第三方应用。
- 企业微信开发者仅支持网页应用接入。
成为企业微信开发者
1. 流程图
2. 线上申请流程
- 企业微信开发者基于企业微信账号体系创建,需先成为企业微信的用户,即创建一个新企业或加入一个已有企业。
点此注册企业微信
- 前往企业微信开发者中心,申请成为企业微信开发者。
点此申请成为开发者
3. 企业微信开发者中心
企业微信开发者中心,是面向开发者提供集工具、社区和文档一体的开发者平台。
功能 | 功能介绍 |
---|
工具 | 1. 支持创建、管理和发布开发者个人主体的第三方应用。2.可使用集成在线接口调试、错误码查询、JSApi签名等便捷的工具资源。 |
社区 | 开发者可在社区内提问、讨论,与社区开发者们一起互动交流,让所有的疑惑都能找到答案,让开发更加轻松简单。 |
文档 | 1.参考官方教程和代码示例,快速上手应用开发。2.全面、丰富、清晰的接口手册,涵盖各类开发场景,帮助开发者更好地基于企业微信开发应用。 |
应用接入流程完整图示
应用开发
1. 概述
- 创建应用:登录开发者中心进入,在“工具”创建应用。
- 测试应用:应用创建成功后,开发者可自行对应用进行安装测试。
- 上线应用:应用提交上线申请,企业微信侧将对会对应用信息进行审核,审核通过后可以正式上线。
2. 创建应用
2.1 创建网页应用
创建应用详细步骤:
登录开发者中心—进入“工具”—网页应用—创建应用—填写应用信息—创建完成,进入应用详情页修改并完善应用信息。
2.2 应用信息填写标准
应用信息禁止涉及抄袭、侵权等违法行为,禁止使用夸大性、广告性和误导性的名称(如:“永久免费”、“热门”、”第一”等)。
2.2.1 基本信息填写
填写项 | 填写标准 |
---|
应用logo | 应用logo必须为正方形,像素为750﹡750,1M以内的jpg、png图片,不可使用企业微信logo或进行二次修改 |
应用名称 | 2-10个字,不可使用特殊字符及特殊词汇 (如:“微信”、“特卖”、“企业微信”、“企微”、“抽奖”、“免费”等) |
应用标语 | 2-10个字,需突出产品的功能亮点、给用户带来的独特价值。不可使用特殊字符及特殊词汇 (如:“微信”、“特卖”、“企业微信”、“企微”、“抽奖”、“免费”等) |
应用简介 | 4-120个字,建议80个汉字左右,清晰描述应用功能和使用场景 |
分类 | 根据应用的功能及场景进行选择 推荐的应用,在企业微信应用市场将根据行业分类进行展示 |
2.2.3 应用权限与能力
- 应用权限
开发者个人主体的应用,暂不支持修改应用权限,默认拥有权限”通讯单个基本信息只读”:允许通过调用OAuth的方式来读取当前进入应用的用户的基本信息(参见“OAuth接口”)。暂不支持包括组织架构、企业客户、日程、直播、打卡、审批等其他企业敏感权限。
- 应用能力
- 企业微信JS-SDK。开发者通过使用企业微信JS-SDK,可借助企业微信高效地使用拍照、选图、语音、位置等手机系统的能力,同时可以直接使用企业微信分享、扫一扫等企业微信特有的能力,为企业微信用户提供更优质的网页体验。
- 应用消息推送。开发者可以使用企业微信丰富的消息推送能力,让应用与企业更好的互动。应用支持推送文本、图片、视频、文件、图文、模板等类型,其中模板消息包含文本通知、图文展示、按钮交互、投票选择、多项选择等丰富形态。
2.2.3 使用配置填写
填写项 | 填写标准 |
---|
应用主页 | 用户从企业微信工作台进入应用时将直接跳转到对应的主页URL |
可信域名 | 填写不带http:// 或https:// 头,可信域名必须通过ICP备案验证 设置可信域名后支持应用的OAuth2授权、JSSDK调用等 |
安装完成回调域名 | 填写不带http:// 或https: //头的有效域名地址 应用安装成功后会302跳转到该域名下的url,返回临时auth_code,再用此code换取永久授权码 |
业务设置URL | 填写带https:// 头的有效URL链接 授权企业的管理员可从企业微信后台的应用详情页免登录直接跳转该链接进行应用配置 |
2.2.4 回调配置填写
填写项 | 填写标准 |
---|
数据回调URL | 填写带https:// 头的有效URL链接,填写URL时需要正确响应企业微信验证URL的请求 用于接收托管企业微信应用的用户消息、进入应用事件、通讯录变更事件 |
指令回调URL | 填写带https:// 头的有效URL链接,填写URL时需要正确响应企业微信验证URL的请求 用于接收应用授权变更事件(应用添加、删除、修改)以及ticket参数,ticket说明详API接口说明 |
2.2.5 其他信息填写
填写项 | 填写标准 |
---|
自定义菜单 | 不可使用特殊字符及特殊词汇 (如:“微信”、“特卖”、“企业微信”、“抽奖”、“免费”等) |
手机应用截图 | 必须为IOS版的企业微信界面截图,五张,像素1242*2208,无水印的jpg、png格式,2M以内,可进行一定的设计来清晰直观呈现应用功能和特点 |
桌面应用截图 | 应用在企业微信桌面端工作台打开的应用界面截图。建议上传5张能体现完整应用功能的截图,像素1080*832,2M以内无水印的jpg、png图片 |
开发者隐私政策 | 开发者需跟进应用的实际情况,填写并上传隐私政策 |
2.2.6 填写ip白名单
开发者需前往开发者中心“工具 - 开发配置 - IP白名单” 中配置调用接口的IP地址,仅白名单内的IP地址可调用企业微信接口。
3. 测试应用
3.1 应用安装测试
开发者可对已创建的应用进行安装测试,开发者个人主体应用仅支持成员授权安装。
3.2 应用测试说明
- 用于安装测试的企业微信账号需开发者自行注册,每个应用支持同时添加10个测试企业微信账号。
- 安装测试的企业微信账号使用的是当前的应用配置信息,后续的修改不会进行同步;如需更新应用信息请重新授权安装。
- 同一企业微信账号,不支持同时安装测试应用和正式发布的应用。
- 建议对应用进行可用性测试,确保在多个终端能正常使用,包含企业微信移动端(iOS、Android)、企业微信PC端(Windows、Mac)。
4. 上线应用
4.1 应用上线流程
应用上线步骤:
- 提交上线:可进入工具—应用上线—点击提交上线—勾选应用—提交上线(由企业微信团队对应用信息进行审核)。
- 上线应用:审核通过—点击“已通过”状态—提交上线—上线成功。
4.2 应用上线说明
- 应用信息审核需1-2个工作日,为提高效率,建议在本地安装测试确认信息无误后再提交上线申请。
- 审核结果将由“企业微信团队”向系统管理员推送,请系统管理员及时查看企业微信消息提醒。
- 修改应用:在本地应用中修改信息并重新提交审核,发布后,所修改的应用信息才会覆盖到所有已授权的企业。
- 应用logo、应用介绍、应用名称,这三项信息修改并重新发布后,将不会覆盖所有已授权的企业。
- 下线应用:在“查看已上线应用”列表,进入应用详情页,可以下线应用。应用下线后将不再提供给新的企业授权使用,但不影响所有已授权的企业使用。
- 删除应用:在应用详情页可以删除应用。但曾经上线,且已被企业授权使用的应用不允许删除。
- 开发者个人主体的第三方应用暂不支持被用户在市场中搜索和查看,开发者可使用应用二维码进行应用的推广。
5. 应用二维码
应用上线后,可前往开发者中心-工具-应用二维码,获取应用的二维码,以此进行应用推广。用户使用企业微信扫码后,可安装该应用。开发者个人主体的第三方应用 -安装说明:
- 仅支持成员授权添加,且只能为当前用户个人添加
- 每个应用最多被10个不同的企业安装
- 每个应用最多被100个不同的用户安装