¶ 快速开始
更新时间: 2024-10-10 07:28:40
¶ 基本信息
条目 | 说明 |
---|---|
支持版本 | Android 7.0 + |
仓库地址 | https://github.com/Authing/guard-android (opens new window) |
SDK 名称 | Guard Android SDK |
开发者 | 北京蒸汽记忆科技有限公司 |
版本 | 2.0.0 |
主要功能 | 包含基本登录组件的封装,如账密登录、手机号验证码登录,以及对 Authing 登录认证 API 的封装 |
个人信息收集 | 本 SDK 不收集个人隐私信息 |
合规使用说明 | 参考合规使用指南 |
¶ 第一步:新建 Android 工程
注意:Minimum SDK 版本 Android 7.0
¶ 第二步:添加 Guard 依赖
在工程根目录的 build.gradle (4.2+以后的版本 AndroidStudio 创建的新工程在 setting.gradle) 文件里面需包含 mavenCentral
buildscript {
repositories {
mavenCentral()
// other repositories
}
}
在主工程的 build.gradle 文件里面添加依赖
implementation 'cn.authing:guard:+'
¶ 第三步:初始化
在应用启动时调用:
// context is application or initial activity
// ”AUTHING_APP_ID“ is obtained from the Authing console
Authing.init(context, "AUTHING_APP_ID");
注意:AUTHING_APP_ID 是应用 ID,不是用户池 ID,请先前往控制台获取 (opens new window)
注意:如果需要登录成功后获取到 accessToken,请先参考登录成功获取到 accessToken (opens new window) 配置
¶ 第四步:常用操作
¶ 1. 注册/登录并获取用户信息
我们提供了三种方式来帮助开发者实现认证流程:
- 如果想独立构建自己的登录注册等 UI 界面,只调用认证相关接口,推荐使用 SDK API。
- 如果想两行代码实现包括 UI 的整个认证流程,推荐使用 SDK 托管页。
- 如果想通过语义化编程模型 (opens new window)快速构建自定义风格的认证流程,推荐使用 SDK 超组件。