ArtikCloudSwift

此 SDK 帮助您将您的 iOS、tvOS、watchOS 和 macOS 应用程序连接到 ARTIK 云服务。它公开了许多方法，以便轻松执行对 ARTIK 云服务的 REST 和 WebSocket 调用。

规格说明

连接到 ARTIK 云服务并异步处理其响应。

DevicesAPI.get(id: "example-id").done { device in
    if device.isSharable() {
        device.share(email: "[email protected]").catch { error in
            print(error)
        }
    } else {
        device.removeFromArtik().done {
            print("We couldn't share the device, so it was removed.")
        }.catch { error in
            print(error)
        }
    }
}.catch { error in
    print(error)
}

先决条件

Alamofire >= 4.7.1
PromiseKit >= 6.2.3
ObjectMapper >= 3.1.0
CryptoSwift >= 0.9.0
Starscream >= 3.0.5

安装

CocoaPods

CocoaPods 1.1 或更高版本是必需的。

使用以下任一方法在您的 PodFile 中指定 ArtikCloudSwift

source 'https://github.com/CocoaPods/Specs.git'
pod 'ArtikCloudSwift'

然后运行以下命令

pod install

手动安装

将 ArtikCloudSwift.xcodeproj 拖入您的项目中，并将 ArtikCloudSwift.framework 添加到您的应用程序嵌入式框架中。

入门

import ArtikCloudSwift

应用程序设置

在开始发送请求之前，提供您的应用程序的客户端 ID 和重定向 URI。

ArtikCloudSwiftSettings.clientID = "my-clientid"
ArtikCloudSwiftSettings.redirectURI = "my-uri://"

有关在 ARTIK 云服务创建应用程序及其客户端 ID（应用程序 ID）和重定向 URI 的说明，请参阅我们的文档。

身份验证

API 调用需要身份验证，您必须通过任何可用的身份验证流程获取一个 Token。这些流程在 AuthenticationAPI 中实现。这个指南描述了如何为您的用例选择最佳的认证流程。

一旦您获取了一个 Token，可以使用以下方法之一设置它

ArtikCloudSwiftSettings.setUserToken(_ token: UserToken)
ArtikCloudSwiftSettings.setApplicationToken(_ token: ApplicationToken)
ArtikCloudSwiftSettings.setDeviceToken(_ token: DeviceToken)

每次使用 Token 时，都会在本地（如果可能）验证其有效性。对于已经过期的 UserToken，框架将尝试在执行请求之前使用 ARTIK 云服务刷新它。这可以通过将 ArtikCloudSwiftSettings.attemptToRefreshToken = false 来禁用。

使用多种令牌类型

如果您打算针对不同的请求使用多种 Token 类型，可以将 preferredTokenForRequests 设置为一个特定的 Token.Type。框架将首先尝试使用此令牌类型，如果不可用，则回退到其他类型。例如，优先考虑当前的 ApplicationToken

ArtikCloudSwiftSettings.preferredTokenForRequests = ApplicationToken.self

处理回调

当使用某些 API 时，ARTIK 云服务将尝试回掉到您的应用程序，例如在使用授权代码流或升级设备类型进行货币化时。为了做到这一点，请确保您的应用程序的重定向 URI（服务器端）、您的 URL 方案（客户端）和 ArtikCloudSwiftSettings.redirectURI 设置为相同的值。

一旦您的应用程序收到一个回调，通过将 URL 传递给 ArtikCloudSwiftSettings.identifyRedirectEndpoint(_ callback: URL) 来识别它正在针对的流程。使用返回的 RedirectEndpoint 值来确定如何处理它。

// iOS Example
func application(_ application: UIApplication, open url: URL, sourceApplication: String?, annotation: Any) -> Bool {
    if let endpoint = ArtikCloudSwiftSettings.identifyRedirectEndpoint(url) {
        switch endpoint {
        case .cloudAuthorization:
            // User was authorizing a Cloud Connector
        case .monetization:
        	// User has attempted to upgrade a device
            do {
                if try MonetizationAPI.processUpgradeCallback(url) == .accepted {
                	// Device was upgraded!
                }
            } catch {
                // Unable to determine upgrade result
            }
        case .logout:
            // User has logged out
        default:
            // Default Callback, used for Authentication flows
            
            // Using Authorization Code + PKCE for example...
            AuthenticationAPI.processAuthorizationCodeCallback(url, usingPKCE: true).done { token in
                // We got a Token!
            }.catch { error -> Void in
                // Something went wrong...
            }
        }
    }
    return true
}