当前位置：首页 > news >正文

每日钉钉API探索：getAuthCode实现免登授权

news 2025/7/17 10:06:11

在企业级应用中，提供一个无缝的用户体验是至关重要的。今天我们要介绍的是钉钉提供的 getAuthCode API，它可以帮助开发者轻松实现用户免登录体验，让用户无需输入用户名和密码即可自动登录到应用。

📌 功能概述

getAuthCode API主要用于获取应用的免登授权码(authCode)，这是实现用户免登录流程的关键步骤之一。通过调用此API，应用程序能够自动获取当前用户的登录凭证，进而进行后续操作如获取用户详情等。

💻 支持平台

平台	版本要求
Android	不支持
iOS	不支持
Harmony	不支持
Mac	不支持
Windows	不支持

注意：该API主要适用于小程序环境，并从6.0.0版本开始支持Android、iOS以及Windows桌面端的小程序应用。

📲 应用类型支持

企业内部应用：支持
第三方企业应用：支持
第三方个人应用：支持

这意味着无论你是为企业内部定制的应用程序，还是面向外部市场的应用程序，都可以利用这个API来增强你的应用功能。

🔒 鉴权规则

无需鉴权即可直接调用，简化了开发者的使用流程。

⚙️ 参数说明

继承通用输入对象，并扩展以下关键参数：

参数名	类型	必填	示例值	描述
`corpId`	String	是	“ding12345xxx”	企业CorpID，用于标识不同的企业组织。

📤 返回结果

成功调用后，将返回包含授权码的对象，具体字段如下：

字段名	类型	示例值	描述
`authCode`	String	“hYLK98jkf0m”	授权码，有效期为5分钟且只能使用一次，使用后会失效。

🛠 使用示例代码

以下是调用getAuthCode的一个简单示例：

dd.getAuthCode({corpId: 'ding12345xxx', // 必须填写的企业CorpIDsuccess: function(res) {console.log('获取的授权码:', res.authCode);// 输出格式：// { "authCode": "hYLK98jkf0m" }// 接下来可以使用获取到的 authCode 调用其他接口获取用户信息},fail: function(err) {console.error('调用失败:', err);},complete: function() {console.log('操作完成');}
});