ParkingPandaSDK 为访问 Parking Panda API 提供方便。

• 特性
• 要求
• 安装
• 使用
• 即将推出
• 通信
• 许可

特性

• [x] 可以方便地访问 Parking Panda API 中的几乎所有调用。
• [x] 验证用户凭据并可选项缓存后续调用。
• [x] 通过共享静态实例或初始化自己的实例来使用客户端。
• [x] 响应内置事件订阅，了解 API 调用何时返回。
• [x] 为在我们系统中处理的每个推荐交易获得保证归因。
• [x] 无需担忧，因为我们使用与面向消费者的和企业的应用相同的逻辑。

要求

• iOS 9.0+
• Xcode 8.0+
• Swift 3.0+
• 来自 Parking Panda 的 API 密钥。联系我们 获取更多信息。

依赖

目前，ParkingPandaSDK 有三个依赖项，在包含此 Pod 时将 自动安装。

• ObjectMapper，用于 JSON 反序列化。
• Alamofire，用于所有网络请求。
• AlamofireObjectMapper，是一个组件库，提供方便的方法来连接这两个库。

安装

Swift Package Manager

Swift Package Manager 是一种用于管理 Swift 代码分布的工具。它与 Swift 构建系统集成，以自动化下载、编译和链接依赖项的过程。

目前我们不支持 Swift Package Manager。如果您需要 Swift Package Manager 支持请 联系我们。

手动

有关如何手动安装 SDK 的说明，请联系我们。

用法

客户端初始化

有两种方式开始使用。

1) 使用 shared 实例的 PPAPIClient 类。

PPAPIClient.shared.apiKey = "MY-API-KEY"
PPAPIClient.shared.test()

2) 创建自己的 PPAPIClient 类实例。

let client = PPAPIClient(apiKey: "MY-API-KEY")
client.test()

在 PPAPIClient 中每次调用都需要一个API密钥，该密钥可以在初始化期间或之后设置。

test() 方法将检查您的客户端是否有访问API的权限。

认证和缓存

认证非常简单。

func login(username: String?, password: String?, authType: PPAuthType = .default, includeCreditCards: Bool = true, callback: ((PPUserModel) -> Void)? = nil)

username通常是用户的电子邮件地址。
password是用户的明文密码或API令牌。
authType（可选）是认证类型。默认值为.default。
includeCreditCards（可选）确定是否返回用户的存储信用卡列表。
callback（可选）在认证成功时触发。

示例

PPAPIClient.shared.login(username: "USERNAME", password: "PASSWORD") { (user) in
    print(user.email)
}

默认情况下，如果用户认证成功，shared 实例的 PPAPIClient 会将用户凭据存储在设备上。这些凭据包括用户的id、电子邮件和api令牌。您可以通过将 cacheKey 属性设为 nil 来覆盖此行为。

同样，您可以在任何 PPAPIClient 实例上设置 cacheKey 属性，以保持每个客户端凭据的独特缓存。这可以在初始化期间或之后设置。

示例

let client = PPAPIClient(apiKey: "MY-API-KEY", cacheKey: "CLIENT-A")

let client = PPAPIClient()
client.apiKey = "MY-API-KEY"
client.cacheKey = "CLIENT-B"

即将推出

• 实现用于易联接的UI按钮。
• 移除 ObjectMapper 依赖。
• 移除 Alamofire 依赖。

沟通

• 如果您发现了**错误**，请提交问题。
• 如果您**没有API密钥**，请联系我们。
• 如果您**有功能需求**，请联系我们。

许可

ParkingPandaSDK采用Apache 2.0许可发布。有关详细信息，请参阅LICENSE文件。