概述
注意:passage-ios目前处于测试版。
Passage iOS框架提供了一个易于使用的SDK接口,用于在Swift原生应用程序中实现Passkey中心化的身份验证体验。
在设置工作之前想看看最终效果吗?
要查看代码级别的实现,请检查并运行我们的Swift示例应用程序
要观看快速演示,请联系我们在Discord的团队,并索要我们的TestFlight应用程序的链接。
注意:此包目前处于测试版 - 可能会发生破坏性更改。请创建GitHub问题或在Discord上与我们团队联系以报告错误。
要求
Xcode
兼容Xcode版本14+。
iOS版本
Passage-iOS SDK支持iOS版本14+。然而,Passkeys仅支持iOS v16+。
iOS版本 | Passkey登录 | 密码与魔法链接登录 |
---|---|---|
v16.x | ||
v15.x | ✅ | |
v14.x |
安装
通过SwiftPackage Manager或Cocoapods将passage-ios包添加到您的应用中
Swift Package Manager
- 在Xcode中打开您的项目
- 点击“文件” -> “添加包”
- 粘贴以下URL:https://github.com/passageidentity/passage-ios
- 点击“下一步” -> “下一步” -> “完成”
或者:
- 将此URL粘贴到Xcode中Swift Package Manager的搜索栏中
https://github.com/passageidentity/passage-ios
CocoaPods
将以下行添加到您的Podfile中
pod 'Passage', '~> 1.1'
然后,运行pod install。
有关CocoaPods的进一步信息,请参阅他们的官方文档。
- 运行
pod install
安装指南
查看文档目录或下载文档目录,在Xcode文档查看器中查看。按照以下步骤进行操作:入门指南
- 设置您的Passage应用
- 将您的域与应用程序相关联
- 在Xcode中配置您的应用程序
- 启用后端验证JWT
- 在API请求中发送身份验证令牌
初始化和用法
将Passage软件包导入任何将使用iOS SDK的源文件。
import Passage
查看文档目录或下载文档目录,在Xcode文档查看器中查看,并导航到入门指南
以获得详细的分步指南。
SDK方法
本包提供了类型方法和实例方法。这些方法提供了您用于在应用程序上注册、登录和管理用户所需的一切。以下SDK方法提供了可用操作的概述。要查看可用方法及其签名的完整列表,请查看文档目录或下载文档目录,在Xcode文档查看器中查看,并导航到类
。
PassageAuth
PassageAuth 是您将主要使用的类。它提供以下功能
- 注册
- 登录
- 登出(如果您使用Passage Token Store)
- 用户管理
- 应用详情
- 等等
示例
注册
请参考文档目录中的用户注册
指南或下载文档目录,在Xcode文档查看器中查看。
登录
请参考文档目录中的登录
指南或下载文档目录,在Xcode文档查看器中查看。
资源
在线文档
文档目录
本软件包包含一个文档目录,可以在 Xcode 开发者文档浏览器中查看。
要生成文档目录,在 Xcode 中点击“产品” -> “构建文档”,应打开文档查看器,如果没有则选择“窗口” -> “开发者文档”
下载 DocC 存档