iOS应用
iOS接入指南
接入说明:
任何需要调用企业微信API的应用,都需要先在企业微信管理后台创建一个应用,设置完成后,即可使用对应的功能。
不允许跨企业使用,即仅支持企业自己的app使用。
创建应用
- 管理员登录企业微信管理后台,选择企业应用
- 选择已有应用或添加应用,进入应用详情页面。
- 选择“企业微信授权登录”,在设置界面填写iOS App的BundleId,设置完成后系统自动生成应用程序scheme。
下载企业微信终端SDK文件
SDK文件包括 libWXWorkApi.a,WWKApi.h,WWKApiObject.h 三个。
请前往 资源下载 下载最新SDK包sdk.zip
SDK名称:企业微信登录/分享SDK
主要功能:通过企业微信登录/分享SDK,企业可在自建的app引入sdk,从而可使用企业微信账号登录app,并且在app中分享消息到企业微信。
使用说明:详见本接入指南
开发者:深圳市腾讯计算机系统有限公司
隐私政策:请接入企业微信登录/分享 SDK的开发者,认真阅读《企业微信登录/分享SDK个人信息保护规则》,并确保对企业微信登录/分享SDK的接入使用情况符合上述规则的相关要求。
下载包包含4个文件,其名称和含义分别是:
WWKApi.h 定义SDK接口的头文件
WWKApiObject.h 定义SDK接口用来进行参数传递的对象
libWXWorkApi.a 第三方工程需要引用的SDK静态库文件
demo.tar.gz 一个供参考的企业微信iOS端SDK使用的示例工程,这个工程介绍了当前版本SDK提供的所有接口的使用方法
搭建开发环境
- 在XCode中建立你的工程。
- 将SDK文件中包含的 libWXWorkApi.a,WWKApi.h,WWKApiObject.h 三个文件添加到你所建的工程中。具体实现可参考 资源下载 页面中提供的SDK Sample Demo工程(下载sdk.zip压缩包后,解压其中的demo.tar.gz即为一个供参考的企业微信iOS端SDK使用的示例工程,这个工程介绍了当前版本SDK提供的所有接口的使用方法)。
- 在你的工程文件中选中Search Paths,并添加 libWXWorkApi.a ,WWKApi.h,WWKApiObject.h,文件所在位置。
- 在XCode中,选择你的工程设置项,选中“TARGETS”一栏,在“Info”标签栏的“URL Types”添加“URL Schemes”,其内容为你所注册的应用程序将获得应用程序ID和scheme。
- 在你需要使用企业微信终端API的文件中 import WWKApi.h 并增加 WWKApiDelegate 协议。
在代码中使用SDK进行初始化注册
- 要使你的程序启动后企业微信终端能响应你的程序,必须在代码中向企业微信终端注册你的scheme。(如下面代码所示,在 AppDelegate 的 didFinishLaunchingWithOptions 函数中向企业微信注册id)。
参数说明
registerApp : 必填字段 用户填写第三方应用Bundleid完成上述注册流程后,系统根据corpId(企业ID 见下描述)与agentId(应用ID 见下描述)计算得到的一个scheme字符串。用于企业微信完成SSO登录流程后回调返回用户的第三方应用
corpId: 必填字段 用户登录企业管理页面的时候在 “我的企业” 页面会得到一个corpId,这个corpid即为需要填在这里的企业ID
agentId: 必填字段 当用户为自己企业新加一个第三方iOS应用的时候,系统会为每个iOS应用分配不同的企业内部唯一的应用ID
2.重写AppDelegate的handleOpenURL和openURL方法,第三方iOS App需要在这两个方法中调用SDK的handleOpenURL接口方法,让SDK有机会在第三方App内部处理SSO结果返回给第三方iOS App后的后续处理工作
3.现在,你的程序要实现和企业微信终端交互的具体请求与回应,因此需要实现WWKApiDelegate协议的两个方法。第三方iOS App可以根据自身需求实现这两个方法
具体在此两方法中所要完成的内容由你定义,具体可参考企业微信开发工具包中的SDK Sample Demo源码。
接入企业微信登录
使用SDK中的企业微信登录功能,获取企业微信用户信息。
注意,如果使用Xcode16及以上版本构建应用,需要使用异步接口。
需要特别指出的是,使用了SSO接口进行登录的程序需要在 handleOpenURL 函数中处理来自企业微信的回调,企业微信返回的是获取用户信息的一次性code,第三方app需要继续使用此code通过后端服务器换取用户的信息。
通过code获取用户信息
请求方式:GET(HTTPS)
请求地址:https://qyapi.weixin.qq.com/cgi-bin/user/getuserinfo?access_token=ACCESS_TOKEN&code=CODE
参数说明:
| 参数 | 必须 | 说明 |
|---|---|---|
| access_token | 是 | 调用接口凭证 |
| code | 是 | 通过成员授权获取到的code,每次成员授权带上的code将不一样,code只能使用一次,5分钟未被使用自动过期 |
权限说明:
跳转的域名须完全匹配企业内任一应用的可信域名。
返回结果:
| 参数 | 说明 |
|---|---|
| UserId | 成员UserID |
出错返回示例:

