每日钉钉API探索:requestAuthCode网页应用(H5微应用)免登授权
在企业级应用开发中,提供无缝的用户体验对于提高用户满意度至关重要。今天我们要介绍的是钉钉提供的 requestAuthCode
API,它允许开发者为网页应用(原H5微应用)获取免登授权码(authCode),从而实现用户无需输入用户名和密码即可自动登录的功能。
📌 功能概述
requestAuthCode
API主要用于获取网页应用(H5微应用)的免登授权码,这是实现用户免登录流程的重要步骤之一。通过调用此API,应用程序可以自动获取当前用户的登录凭证,并用于后续操作如获取用户详情等。
💻 支持平台
平台 | 版本要求 |
---|---|
Android | 不适用 |
iOS | 不适用 |
Harmony | 7.0.0+ |
Mac | 7.0.50+ |
Windows | 7.0.50+ |
注意:该API主要针对网页应用(H5微应用),且需要满足特定版本要求。
📲 应用类型支持
- 企业内部应用:支持
- 第三方企业应用:支持
- 第三方个人应用:不支持
这意味着该功能特别适合企业内部应用及与企业合作的第三方应用使用,以增强应用的安全性和用户体验。
🔒 鉴权规则
- 无需鉴权即可直接调用,简化了开发者的使用流程。
⚙️ 参数说明
继承通用输入对象,并扩展以下关键参数:
参数名 | 类型 | 必填 | 示例值 | 描述 |
---|---|---|---|---|
corpId | String | 是 | “企业的CorpId” | 企业CorpID,用于标识不同的企业组织。 |
clientId | String | 是 | “clientid” | 应用的Client ID。 - 原企业内部应用的 AppKey。 - 原第三方企业应用的 SuiteKey。 |
📤 返回结果
成功调用后,将返回包含授权码的对象,具体字段如下:
字段名 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | String | “hYLK98jkf0m” | 授权码,有效期为5分钟且只能使用一次,使用后会失效。 |
🛠 使用示例代码
以下是调用requestAuthCode
的一个简单示例:
dd.requestAuthCode({corpId: 'corpid', // 必须填写的企业CorpIDclientId: 'clientid', // 应用的Client IDonSuccess: function(result) {console.log('获取的授权码:', result.code);// 输出格式:// { "code": "hYLK98jkf0m" }// 接下来可以使用获取到的 authCode 调用其他接口获取用户信息},onFail: function(err) {console.error('调用失败:', err);}
});
🎯 免登流程概览
- 调用
requestAuthCode
获取免登授权码。 - 调用获取应用的 Access Token接口,以获取访问凭证。
- 调用通过免登码获取用户信息接口,以获得用户的userId。
- 调用查询用户详情接口,最终获取完整的用户信息。
这种免登机制极大地提升了用户体验,同时也保证了安全性。
希望今天的介绍能帮助你更好地理解和使用requestAuthCode
API。未来我们将继续探讨更多实用的钉钉API,敬请期待!