ARTIK Cloud Objective-C SDK
此SDK帮助您将iOS或OS X应用程序连接到ARTIK Cloud。它公开了许多执行REST API调用到ARTIK Cloud的简单方法。
要求
SDK要求在Xcode项目中开启ARC（自动引用计数）。
安装与使用
使用CocoaPods从GitHub进行安装
将以下内容添加到Podfile中
pod 'ArtikCloud', :git => 'https://github.com/artikcloud/artikcloud-objc.git'为了指定特定的分支，添加, :branch => 'branch-name-here'
为了指定特定的提交，添加, :commit => '11aa22'
使用 CocoaPods 从本地路径安装
将 SDK 放置在您的项目文件夹下（例如：/path/to/objc_project/Vendor/ArtikCloud），然后在 Podfile 中添加以下内容
pod 'ArtikCloud', :path => 'Vendor/ArtikCloud'使用方法
导入以下内容
#import <ArtikCloud/ACApiClient.h>
#import <ArtikCloud/ACDefaultConfiguration.h>
// load models
#import <ArtikCloud/ACAcceptanceStatusResponse.h>
#import <ArtikCloud/ACAckEnvelope.h>
#import <ArtikCloud/ACAcknowledgement.h>
#import <ArtikCloud/ACAction.h>
#import <ArtikCloud/ACActionArray.h>
#import <ArtikCloud/ACActionDetails.h>
#import <ArtikCloud/ACActionDetailsArray.h>
#import <ArtikCloud/ACActionIn.h>
#import <ArtikCloud/ACActionOut.h>
#import <ArtikCloud/ACActions.h>
#import <ArtikCloud/ACAggregateData.h>
#import <ArtikCloud/ACAggregatesHistogramData.h>
#import <ArtikCloud/ACAggregatesHistogramResponse.h>
#import <ArtikCloud/ACAggregatesResponse.h>
#import <ArtikCloud/ACAppProperties.h>
#import <ArtikCloud/ACCertificateData.h>
#import <ArtikCloud/ACCertificateEnvelope.h>
#import <ArtikCloud/ACCertificateFields.h>
#import <ArtikCloud/ACCertificateId.h>
#import <ArtikCloud/ACCheckTokenMessage.h>
#import <ArtikCloud/ACCheckTokenResponse.h>
#import <ArtikCloud/ACContactInfo.h>
#import <ArtikCloud/ACCreateModelBody.h>
#import <ArtikCloud/ACCreateModelData.h>
#import <ArtikCloud/ACDevice.h>
#import <ArtikCloud/ACDeviceArray.h>
#import <ArtikCloud/ACDeviceEnvelope.h>
#import <ArtikCloud/ACDevicePricingTier.h>
#import <ArtikCloud/ACDevicePricingTierEnvelope.h>
#import <ArtikCloud/ACDevicePricingTierRequest.h>
#import <ArtikCloud/ACDevicePricingTiers.h>
#import <ArtikCloud/ACDevicePricingTiersEnvelope.h>
#import <ArtikCloud/ACDeviceRegCompleteRequest.h>
#import <ArtikCloud/ACDeviceRegConfirmUserRequest.h>
#import <ArtikCloud/ACDeviceRegConfirmUserResponse.h>
#import <ArtikCloud/ACDeviceRegConfirmUserResponseEnvelope.h>
#import <ArtikCloud/ACDeviceRegStatusResponse.h>
#import <ArtikCloud/ACDeviceRegStatusResponseEnvelope.h>
#import <ArtikCloud/ACDeviceShareInfo.h>
#import <ArtikCloud/ACDeviceSharing.h>
#import <ArtikCloud/ACDeviceSharingArray.h>
#import <ArtikCloud/ACDeviceSharingDataResponseBody.h>
#import <ArtikCloud/ACDeviceSharingEnvelope.h>
#import <ArtikCloud/ACDeviceSharingId.h>
#import <ArtikCloud/ACDeviceSharingIdResponseBody.h>
#import <ArtikCloud/ACDeviceStatus.h>
#import <ArtikCloud/ACDeviceStatusBatch.h>
#import <ArtikCloud/ACDeviceStatusData.h>
#import <ArtikCloud/ACDeviceStatusPut.h>
#import <ArtikCloud/ACDeviceStatusPutData.h>
#import <ArtikCloud/ACDeviceTask.h>
#import <ArtikCloud/ACDeviceTaskUpdateRequest.h>
#import <ArtikCloud/ACDeviceTaskUpdateResponse.h>
#import <ArtikCloud/ACDeviceToken.h>
#import <ArtikCloud/ACDeviceTokenEnvelope.h>
#import <ArtikCloud/ACDeviceType.h>
#import <ArtikCloud/ACDeviceTypeArray.h>
#import <ArtikCloud/ACDeviceTypeEnvelope.h>
#import <ArtikCloud/ACDeviceTypeInfo.h>
#import <ArtikCloud/ACDeviceTypeInfoEnvelope.h>
#import <ArtikCloud/ACDeviceTypePricingList.h>
#import <ArtikCloud/ACDeviceTypePricingTier.h>
#import <ArtikCloud/ACDeviceTypePricingTiersEnvelope.h>
#import <ArtikCloud/ACDeviceTypeUpdateInput.h>
#import <ArtikCloud/ACDeviceTypesEnvelope.h>
#import <ArtikCloud/ACDeviceTypesInfo.h>
#import <ArtikCloud/ACDeviceTypesInfoEnvelope.h>
#import <ArtikCloud/ACDevicesEnvelope.h>
#import <ArtikCloud/ACErrorEnvelope.h>
#import <ArtikCloud/ACEventFeedData.h>
#import <ArtikCloud/ACExportData.h>
#import <ArtikCloud/ACExportDataArray.h>
#import <ArtikCloud/ACExportHistoryResponse.h>
#import <ArtikCloud/ACExportNormalizedMessagesResponse.h>
#import <ArtikCloud/ACExportRequest.h>
#import <ArtikCloud/ACExportRequestData.h>
#import <ArtikCloud/ACExportRequestInfo.h>
#import <ArtikCloud/ACExportRequestResponse.h>
#import <ArtikCloud/ACExportResponse.h>
#import <ArtikCloud/ACExportStatusResponse.h>
#import <ArtikCloud/ACField.h>
#import <ArtikCloud/ACFieldPath.h>
#import <ArtikCloud/ACFieldPresence.h>
#import <ArtikCloud/ACFieldPresenceEnvelope.h>
#import <ArtikCloud/ACFieldsActions.h>
#import <ArtikCloud/ACGetModelsResponseBody.h>
#import <ArtikCloud/ACManifestField.h>
#import <ArtikCloud/ACManifestProperties.h>
#import <ArtikCloud/ACManifestPropertiesEnvelope.h>
#import <ArtikCloud/ACManifestVersions.h>
#import <ArtikCloud/ACManifestVersionsEnvelope.h>
#import <ArtikCloud/ACMessage.h>
#import <ArtikCloud/ACMessageAction.h>
#import <ArtikCloud/ACMessageID.h>
#import <ArtikCloud/ACMessageIDEnvelope.h>
#import <ArtikCloud/ACMessageIn.h>
#import <ArtikCloud/ACMessageOut.h>
#import <ArtikCloud/ACMetadataEnvelope.h>
#import <ArtikCloud/ACMetadataPropertiesEnvelope.h>
#import <ArtikCloud/ACMetadataQueryEnvelope.h>
#import <ArtikCloud/ACModelResponseBody.h>
#import <ArtikCloud/ACModelResponseData.h>
#import <ArtikCloud/ACNonEmptyString.h>
#import <ArtikCloud/ACNormalizedAction.h>
#import <ArtikCloud/ACNormalizedActionsEnvelope.h>
#import <ArtikCloud/ACNormalizedMessage.h>
#import <ArtikCloud/ACNormalizedMessagesEnvelope.h>
#import <ArtikCloud/ACNotifMessage.h>
#import <ArtikCloud/ACNotifMessageArray.h>
#import <ArtikCloud/ACNotifMessagesResponse.h>
#import <ArtikCloud/ACOutputRule.h>
#import <ArtikCloud/ACOutputScene.h>
#import <ArtikCloud/ACParameters.h>
#import <ArtikCloud/ACPendingTasksList.h>
#import <ArtikCloud/ACPredictBody.h>
#import <ArtikCloud/ACPredictResponseBody.h>
#import <ArtikCloud/ACPredictResponseData.h>
#import <ArtikCloud/ACPresenceEnvelope.h>
#import <ArtikCloud/ACPresenceModel.h>
#import <ArtikCloud/ACPropertiesEnvelope.h>
#import <ArtikCloud/ACRefreshTokenResponse.h>
#import <ArtikCloud/ACRegisterMessage.h>
#import <ArtikCloud/ACRejectedCSVRow.h>
#import <ArtikCloud/ACRejectedCSVRowsEnvelope.h>
#import <ArtikCloud/ACRuleArray.h>
#import <ArtikCloud/ACRuleCreationInfo.h>
#import <ArtikCloud/ACRuleEnvelope.h>
#import <ArtikCloud/ACRuleError.h>
#import <ArtikCloud/ACRuleUpdateInfo.h>
#import <ArtikCloud/ACRuleWarningOutput.h>
#import <ArtikCloud/ACRulesEnvelope.h>
#import <ArtikCloud/ACSceneCreationInfo.h>
#import <ArtikCloud/ACSceneEnvelope.h>
#import <ArtikCloud/ACScenesEnvelope.h>
#import <ArtikCloud/ACSnapshotResponse.h>
#import <ArtikCloud/ACSnapshotResponses.h>
#import <ArtikCloud/ACSnapshotsResponseEnvelope.h>
#import <ArtikCloud/ACSubscription.h>
#import <ArtikCloud/ACSubscriptionArray.h>
#import <ArtikCloud/ACSubscriptionEnvelope.h>
#import <ArtikCloud/ACSubscriptionInfo.h>
#import <ArtikCloud/ACSubscriptionsEnvelope.h>
#import <ArtikCloud/ACTag.h>
#import <ArtikCloud/ACTagArray.h>
#import <ArtikCloud/ACTagsEnvelope.h>
#import <ArtikCloud/ACTask.h>
#import <ArtikCloud/ACTaskByDid.h>
#import <ArtikCloud/ACTaskByDidList.h>
#import <ArtikCloud/ACTaskByDidListEnvelope.h>
#import <ArtikCloud/ACTaskEnvelope.h>
#import <ArtikCloud/ACTaskHistory.h>
#import <ArtikCloud/ACTaskHistoryList.h>
#import <ArtikCloud/ACTaskList.h>
#import <ArtikCloud/ACTaskListEnvelope.h>
#import <ArtikCloud/ACTaskParameters.h>
#import <ArtikCloud/ACTaskRequest.h>
#import <ArtikCloud/ACTaskStatus.h>
#import <ArtikCloud/ACTaskStatusCounts.h>
#import <ArtikCloud/ACTaskStatuses.h>
#import <ArtikCloud/ACTaskStatusesEnvelope.h>
#import <ArtikCloud/ACTaskStatusesHistoryEnvelope.h>
#import <ArtikCloud/ACTaskUpdateRequest.h>
#import <ArtikCloud/ACTaskUpdateResponse.h>
#import <ArtikCloud/ACTasksStatusCounts.h>
#import <ArtikCloud/ACTier.h>
#import <ArtikCloud/ACToken.h>
#import <ArtikCloud/ACTokenInfo.h>
#import <ArtikCloud/ACTokenInfoSuccessResponse.h>
#import <ArtikCloud/ACTokenRequest.h>
#import <ArtikCloud/ACTokenResponse.h>
#import <ArtikCloud/ACUnregisterDeviceResponse.h>
#import <ArtikCloud/ACUnregisterDeviceResponseEnvelope.h>
#import <ArtikCloud/ACUpdateParameters.h>
#import <ArtikCloud/ACUpgradePath.h>
#import <ArtikCloud/ACUpgradePathEnvelope.h>
#import <ArtikCloud/ACUpgradePathUserToken.h>
#import <ArtikCloud/ACUpgradePathUserTokenEnvelope.h>
#import <ArtikCloud/ACUploadIdEnvelope.h>
#import <ArtikCloud/ACUploadStatusEnvelope.h>
#import <ArtikCloud/ACUser.h>
#import <ArtikCloud/ACUserEnvelope.h>
#import <ArtikCloud/ACValidationCallbackInfo.h>
#import <ArtikCloud/ACValidityPeriod.h>
#import <ArtikCloud/ACWebSocketError.h>
#import <ArtikCloud/ACWhitelist.h>
#import <ArtikCloud/ACWhitelistEnvelope.h>
#import <ArtikCloud/ACWhitelistResultEnvelope.h>
// load API classes for accessing endpoints
#import <ArtikCloud/ACDefaultApi.h>
#import <ArtikCloud/ACDeviceTypesApi.h>
#import <ArtikCloud/ACDevicesApi.h>
#import <ArtikCloud/ACDevicesManagementApi.h>
#import <ArtikCloud/ACDevicesSharesApi.h>
#import <ArtikCloud/ACDevicesStatusApi.h>
#import <ArtikCloud/ACExportApi.h>
#import <ArtikCloud/ACMessagesApi.h>
#import <ArtikCloud/ACMlApi.h>
#import <ArtikCloud/ACMonetizationApi.h>
#import <ArtikCloud/ACRegistrationsApi.h>
#import <ArtikCloud/ACRulesApi.h>
#import <ArtikCloud/ACScenesApi.h>
#import <ArtikCloud/ACSubscriptionsApi.h>
#import <ArtikCloud/ACTagsApi.h>
#import <ArtikCloud/ACTokensApi.h>
#import <ArtikCloud/ACUsersApi.h>
#import <ArtikCloud/ACWhitelistingApi.h>
建议
在多线程环境中，建议每个线程创建一个 ApiClient 实例，以避免潜在问题。
入门
请遵循安装程序，然后运行以下操作
ACDefaultConfiguration *apiConfig = [ACDefaultConfiguration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: artikcloud_oauth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
NSString* *deviceTypeId = @"deviceTypeId_example"; // deviceTypeId
NSString* *count = @"count_example"; // count (optional)
NSString* *offset = @"offset_example"; // offset (optional)
ACDeviceTypesApi *apiInstance = [[ACDeviceTypesApi alloc] init];
// Get Available Manifest Versions
[apiInstance getAvailableManifestVersionsWithDeviceTypeId:deviceTypeId
count:count
offset:offset
completionHandler: ^(ACManifestVersionsEnvelope* output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
API 端点文档
所有 URI 都是相对于 https://api.artik.cloud/v1.1
| 类 | 方法 | HTTP 请求 | 描述 |
|---|---|---|---|
| ACDefaultApi | getUserScenes | GET /users/{uid}/scenes | 获取所有用户场景 |
| ACDeviceTypesApi | getAvailableManifestVersions | GET /devicetypes/{deviceTypeId}/availablemanifestversions | 获取可用的 Manifest 版本 |
| ACDeviceTypesApi | getDeviceType | GET /devicetypes/{deviceTypeId} | 获取设备类型 |
| ACDeviceTypesApi | getDeviceTypes | GET /devicetypes | 获取设备类型列表 |
| ACDeviceTypesApi | getDeviceTypesByApplication | GET /applications/{appId}/devicetypes | 按应用程序获取设备类型 |
| ACDeviceTypesApi | getLatestManifestProperties | GET /devicetypes/{deviceTypeId}/manifests/latest/properties | 获取最新的 Manifest 属性 |
| ACDeviceTypesApi | getManifestProperties | GET /devicetypes/{deviceTypeId}/manifests/{version}/properties | 获取 Manifest 属性 |
| ACDevicesApi | addDevice | POST /devices | 添加设备 |
| ACDevicesApi | deleteDevice | DELETE /devices/{deviceId} | 删除设备 |
| ACDevicesApi | deleteDeviceToken | 删除 /devices/{deviceId}/tokens | 删除设备令牌 |
| ACDevicesApi | getDevice | GET /devices/{deviceId} | 获取设备 |
| ACDevicesApi | getDevicePresence | GET /devices/{deviceId}/presence | 获取设备存在信息 |
| ACDevicesApi | getDeviceToken | GET /devices/{deviceId}/tokens | 获取设备令牌 |
| ACDevicesApi | updateDevice | PUT /devices/{deviceId} | 更新设备 |
| ACDevicesApi | updateDeviceToken | PUT /devices/{deviceId}/tokens | 更新设备令牌 |
| ACDevicesManagementApi | createTasks | POST /devicemgmt/tasks | 为多个设备创建新的任务 |
| ACDevicesManagementApi | deleteServerProperties | DELETE /devicemgmt/devices/{did}/serverproperties | 删除设备属性。 |
| ACDevicesManagementApi | getAllByDid | GET /devicemgmt/devices/{did}/tasks | 返回特定设备ID的任务列表，可选状态过滤器。 |
| ACDevicesManagementApi | getAllPendingTasksByDid | GET /devicemgmt/devices/{did}/pendingtasks | 返回特定设备ID的待处理任务列表。 |
| ACDevicesManagementApi | getDeviceTypesInfo | GET /devicemgmt/devicetypes/{dtid} | 读取设备类型的设备管理信息。 |
| ACDevicesManagementApi | getManifestProperties | GET /devicemgmt/devicetypes/{dtid}/manifest/properties | 获取设备类型的设备管理清单属性 |
| ACDevicesManagementApi | getProperties | GET /devicemgmt/devices/{did}/properties | 读取设备的属性。 |
| ACDevicesManagementApi | getStatuses | GET /devicemgmt/tasks/{tid}/statuses | 返回任务ID的详细信息、状态以及列表中每个设备ID的个体状态。 |
| ACDevicesManagementApi | getStatusesHistory | GET /devicemgmt/tasks/{tid}/statuses/history | 返回特定任务ID或任务中的特定设备ID的状态变化历史。 |
| ACDevicesManagementApi | getTaskByID | GET /devicemgmt/tasks/{tid} | 返回特定任务ID的详细信息及全局状态。 |
| ACDevicesManagementApi | getTasks | GET /devicemgmt/tasks | 返回设备类型的所有任务。 |
| ACDevicesManagementApi | notifyAboutAcceptance | POST /devicemgmt/tasks/{tid}/devices/{did}/acceptance | 通知/告知任务接受状态 |
| ACDevicesManagementApi | queryProperties | GET /devicemgmt/devices/properties | 跨设备查询设备属性。 |
| ACDevicesManagementApi | updateDeviceTypesInfo | PUT /devicemgmt/devicetypes/{dtid} | 更新设备类型信息 |
| ACDevicesManagementApi | updateServerProperties | POST /devicemgmt/devices/{did}/serverproperties | 更新设备的服务器属性。 |
| ACDevicesManagementApi | updateTask | PUT /devicemgmt/tasks/{tid} | 更新所有设备的任务 - 目前仅允许更改状态为取消。 |
| ACDevicesManagementApi | updateTaskForDevice | PUT /devicemgmt/tasks/{tid}/devices/{did} | 更新特定设备的任务 - 目前仅允许更改状态为取消。 |
| ACDevicesSharesApi | createShareForDevice | POST /devices/{deviceId}/shares | 分享设备 |
| ACDevicesSharesApi | deleteSharingForDevice | DELETE /devices/{deviceId}/shares/{shareId} | 删除指定设备ID的特定共享 |
| ACDevicesSharesApi | getAllSharesForDevice | GET /devices/{deviceId}/shares | 列出指定设备ID的所有共享 |
| ACDevicesSharesApi | getSharingForDevice | GET /devices/{deviceId}/shares/{shareId} | 获取指定设备ID的特定共享 |
| ACDevicesStatusApi | getDeviceStatus | GET /devices/{deviceId}/status | 获取设备状态 |
| ACDevicesStatusApi | getDevicesStatus | GET /devices/status | 获取设备状态 |
| ACDevicesStatusApi | putDeviceStatus | PUT /devices/{deviceId}/status | 更新设备状态 |
| ACExportApi | exportRequest | POST /messages/export | 创建导出请求 |
| ACExportApi | getExportHistory | GET /messages/export/history | 获取导出历史 |
| ACExportApi | getExportResult | GET /messages/export/{exportId}/result | 获取导出结果 |
| ACExportApi | getExportStatus | GET /messages/export/{exportId}/status | 检查导出状态 |
| ACMessagesApi | getAggregatesHistogram | GET /messages/analytics/histogram | 获取标准化消息直方图 |
| ACMessagesApi | getFieldPresence | GET /messages/presence | 获取标准化消息存在度 |
| ACMessagesApi | getLastNormalizedMessages | GET /messages/last | 获取最后标准化消息 |
| ACMessagesApi | getMessageAggregates | GET /messages/analytics/aggregates | 获取标准化消息聚合 |
| ACMessagesApi | getMessageSnapshots | GET /messages/snapshots | 获取消息快照 |
| ACMessagesApi | getNormalizedActions | GET /actions | 获取标准化操作 |
| ACMessagesApi | getNormalizedMessages | GET /messages | 获取标准化消息 |
| ACMessagesApi | sendActions | POST /actions | 发送操作 |
| ACMessagesApi | sendMessage | POST /messages | 发送消息 |
| ACMlApi | createModel | POST /ml/models | 创建模型 |
| ACMlApi | deleteModel | DELETE /ml/models/{modelId} | 删除模型 |
| ACMlApi | getModel | GET /ml/models/{modelId} | 获取模型 |
| ACMlApi | getModels | GET /ml/models | 获取模型列表 |
| ACMlApi | predict | POST /ml/models/{modelId}/predict | 预测 |
| ACMonetizationApi | createPricingTiers | POST /pricing/devicetypes/{dtid}/pricingtiers | 定义设备类型的定价等级 |
| ACMonetizationApi | getPricingTiers | GET /pricing/devices/{did}/pricingtiers | 获取设备的定价等级 |
| ACMonetizationApi | getThePricingTiers | GET /pricing/devicetypes/{dtid}/pricingtiers | 获取设备类型的定价等级 |
| ACMonetizationApi | getUpgradePath | GET /pricing/devices/{did}/revenueshare/upgradepath | 获取升级路径 |
| ACMonetizationApi | setPricingTier | PUT /pricing/devices/{did}/pricingtiers | 设置设备的定价等级 |
| ACRegistrationsApi | confirmUser | PUT /devices/registrations/pin | 确认用户 |
| ACRegistrationsApi | getRequestStatusForUser | GET /devices/registrations/{requestId}/status | 获取用户请求的状态 |
| ACRegistrationsApi | unregisterDevice | DELETE /devices/{deviceId}/registrations | 注销设备 |
| ACRulesApi | createRule | POST /rules | 创建规则 |
| ACRulesApi | deleteRule | DELETE /rules/{ruleId} | 删除规则 |
| ACRulesApi | getRule | GET /rules/{ruleId} | 获取规则 |
| ACRulesApi | updateRule | PUT /rules/{ruleId} | 更新规则 |
| ACScenesApi | createScene | POST /scenes | 创建新场景 |
| ACScenesApi | getScene | GET /scenes/{sceneId} | 获取场景 |
| ACScenesApi | getScenes | GET /scenes | 获取所有用户场景 |
| ACScenesApi | scenesSceneIdDelete | DELETE /scenes/{sceneId} | 删除场景 |
| ACScenesApi | triggerScene | POST /scenes/{sceneId} | 触发场景 |
| ACScenesApi | updateScene | PUT /scenes/{sceneId} | 更新场景 |
| ACSubscriptionsApi | createSubscription | POST /subscriptions | 创建订阅 |
| ACSubscriptionsApi | deleteSubscription | DELETE /subscriptions/{subId} | 删除订阅 |
| ACSubscriptionsApi | getAllSubscriptions | GET /subscriptions | 获取所有订阅 |
| ACSubscriptionsApi | getMessages | GET /notifications/{notifId}/messages | 获取消息 |
| ACSubscriptionsApi | getSubscription | GET /subscriptions/{subId} | 获取订阅 |
| ACSubscriptionsApi | validateSubscription | POST /subscriptions/{subId}/validate | 验证订阅 |
| ACTagsApi | getTagCategories | GET /tags/categories | 获取所有分类 |
| ACTagsApi | getTagSuggestions | GET /tags/suggestions | 获取标签建议 |
| ACTagsApi | getTagsByCategories | GET /tags | 获取所有分类的标签 |
| ACTokensApi | checkToken | POST /accounts/checkToken | 检查令牌 |
| ACTokensApi | refreshToken | POST /accounts/token | 刷新令牌 |
| ACTokensApi | tokenInfo | GET /accounts/tokenInfo | 令牌信息 |
| ACUsersApi | createUserProperties | POST /users/{userId}/properties | 创建用户应用程序属性 |
| ACUsersApi | deleteUserProperties | DELETE /users/{userId}/properties | 删除用户应用程序属性 |
| ACUsersApi | getSelf | GET /users/self | 获取当前用户档案 |
| ACUsersApi | getUserDeviceTypes | GET /users/{userId}/devicetypes | 获取用户设备类型 |
| ACUsersApi | getUserDevices | GET /users/{userId}/devices | 获取用户设备 |
| ACUsersApi | getUserProperties | GET /users/{userId}/properties | 获取用户应用程序属性 |
| ACUsersApi | getUserRules | GET /users/{userId}/rules | 获取用户规则 |
| ACUsersApi | listAllSharesForUser | GET /users/{userId}/shares | 获取用户共享 |
| ACUsersApi | updateUserProperties | PUT /users/{userId}/properties | 更新用户应用程序属性 |
| ACWhitelistingApi | deleteVdid | DELETE /devicetypes/{dtid}/whitelist/{vdid} | 从设备类型白名单中删除一个 vdid。 |
| ACWhitelistingApi | deleteWhitelistCertificate | DELETE /devicetypes/{dtid}/whitelist/certificates/{cid} | 删除与设备类型关联的白名单证书。 |
| ACWhitelistingApi | enableWhitelist | PUT /devicetypes/:dtid/whitelist/enable | 启用或禁用设备类型白名单功能 |
| ACWhitelistingApi | getRejectedRowList | GET /devicetypes/{dtid}/whitelist/{uploadId}/rejectedRows | 获取上传 CSV 文件拒绝行的列表。 |
| ACWhitelistingApi | getUploadStatus | GET /devicetypes/{dtid}/whitelist/{uploadId}/status | 获取上传 CSV 文件的状态。 |
| ACWhitelistingApi | getWhitelist | GET /devicetypes/{dtid}/whitelist | 获取设备类型的白名单 vdid。 |
| ACWhitelistingApi | getWhitelistCertificate | GET /devicetypes/{dtid}/whitelist/certificates | 获取设备类型的白名单证书。 |
| ACWhitelistingApi | getWhitelistStatus | GET /devicetypes/{dtid}/whitelist/status | 获取设备类型白名单功能状态（启用/禁用）。 |
| ACWhitelistingApi | uploadCSV | POST /devicetypes/{dtid}/whitelist | 上传与设备类型相关的 CSV 文件。 |
模型文档
- ACAcceptanceStatusResponse
- ACAckEnvelope
- ACAcknowledgement
- ACAction
- ACActionArray
- ACActionDetails
- ACActionDetailsArray
- ACActionIn
- ACActionOut
- ACActions
- ACAggregateData
- ACAggregatesHistogramData
- ACAggregatesHistogramResponse
- ACAggregatesResponse
- ACAppProperties
- ACCertificateData
- ACCertificateEnvelope
- ACCertificateFields
- ACCertificateId
- ACCheckTokenMessage
- ACCheckTokenResponse
- ACContactInfo
- ACCreateModelBody
- ACCreateModelData
- ACDevice
- ACDeviceArray
- ACDeviceEnvelope
- ACDevicePricingTier
- ACDevicePricingTierEnvelope
- ACDevicePricingTierRequest
- ACDevicePricingTiers
- ACDevicePricingTiersEnvelope
- ACDeviceRegCompleteRequest
- ACDeviceRegConfirmUserRequest
- ACDeviceRegConfirmUserResponse
- ACDeviceRegConfirmUserResponseEnvelope
- ACDeviceRegStatusResponse
- ACDeviceRegStatusResponseEnvelope
- ACDeviceShareInfo
- ACDeviceSharing
- ACDeviceSharingArray
- ACDeviceSharingDataResponseBody
- ACDeviceSharingEnvelope
- ACDeviceSharingId
- ACDeviceSharingIdResponseBody
- ACDeviceStatus
- ACDeviceStatusBatch
- ACDeviceStatusData
- ACDeviceStatusPut
- ACDeviceStatusPutData
- ACDeviceTask
- ACDeviceTaskUpdateRequest
- ACDeviceTaskUpdateResponse
- ACDeviceToken
- ACDeviceTokenEnvelope
- ACDeviceType
- ACDeviceTypeArray
- ACDeviceTypeEnvelope
- ACDeviceTypeInfo
- ACDeviceTypeInfoEnvelope
- ACDeviceTypePricingList
- ACDeviceTypePricingTier
- ACDeviceTypePricingTiersEnvelope
- ACDeviceTypeUpdateInput
- ACDeviceTypesEnvelope
- ACDeviceTypesInfo
- ACDeviceTypesInfoEnvelope
- ACDevicesEnvelope
- ACErrorEnvelope
- ACEventFeedData
- ACExportData
- ACExportDataArray
- ACExportHistoryResponse
- ACExportNormalizedMessagesResponse
- ACExportRequest
- ACExportRequestData
- ACExportRequestInfo
- ACExportRequestResponse
- ACExportResponse
- ACExportStatusResponse
- ACField
- ACFieldPath
- ACFieldPresence
- ACFieldPresenceEnvelope
- ACFieldsActions
- ACGetModelsResponseBody
- ACManifestField
- ACManifestProperties
- ACManifestPropertiesEnvelope
- ACManifestVersions
- ACManifestVersionsEnvelope
- ACMessage
- ACMessageAction
- ACMessageID
- ACMessageIDEnvelope
- ACMessageIn
- ACMessageOut
- ACMetadataEnvelope
- ACMetadataPropertiesEnvelope
- ACMetadataQueryEnvelope
- ACModelResponseBody
- ACModelResponseData
- ACNonEmptyString
- ACNormalizedAction
- ACNormalizedActionsEnvelope
- ACNormalizedMessage
- ACNormalizedMessagesEnvelope
- ACNotifMessage
- ACNotifMessageArray
- ACNotifMessagesResponse
- ACOutputRule
- ACOutputScene
- ACParameters
- ACPendingTasksList
- ACPredictBody
- ACPredictResponseBody
- ACPredictResponseData
- ACPresenceEnvelope
- ACPresenceModel
- ACPropertiesEnvelope
- ACRefreshTokenResponse
- ACRegisterMessage
- ACRejectedCSVRow
- ACRejectedCSVRowsEnvelope
- ACRuleArray
- ACRuleCreationInfo
- ACRuleEnvelope
- ACRuleError
- ACRuleUpdateInfo
- ACRuleWarningOutput
- ACRulesEnvelope
- ACSceneCreationInfo
- ACSceneEnvelope
- ACScenesEnvelope
- ACSnapshotResponse
- ACSnapshotResponses
- ACSnapshotsResponseEnvelope
- ACSubscription
- ACSubscriptionArray
- ACSubscriptionEnvelope
- ACSubscriptionInfo
- ACSubscriptionsEnvelope
- ACTag
- ACTagArray
- ACTagsEnvelope
- ACTask
- ACTaskByDid
- ACTaskByDidList
- ACTaskByDidListEnvelope
- ACTaskEnvelope
- ACTaskHistory
- ACTaskHistoryList
- ACTaskList
- ACTaskListEnvelope
- ACTaskParameters
- ACTaskRequest
- ACTaskStatus
- ACTaskStatusCounts
- ACTaskStatuses
- ACTaskStatusesEnvelope
- ACTaskStatusesHistoryEnvelope
- ACTaskUpdateRequest
- ACTaskUpdateResponse
- ACTasksStatusCounts
- ACTier
- ACToken
- ACTokenInfo
- ACTokenInfoSuccessResponse
- ACTokenRequest
- ACTokenResponse
- ACUnregisterDeviceResponse
- ACUnregisterDeviceResponseEnvelope
- ACUpdateParameters
- ACUpgradePath
- ACUpgradePathEnvelope
- ACUpgradePathUserToken
- ACUpgradePathUserTokenEnvelope
- ACUploadIdEnvelope
- ACUploadStatusEnvelope
- ACUser
- ACUserEnvelope
- ACValidationCallbackInfo
- ACValidityPeriod
- ACWebSocketError
- ACWhitelist
- ACWhitelistEnvelope
- ACWhitelistResultEnvelope
授权文档
artikcloud_oauth
- 类型: OAuth
- 流程: 隐式
- 授权URL: https://accounts.artik.cloud/authorize
- 作用域:
- read:artikcloud: 从ARTIK Cloud读取
- write:artikcloud: 从ARTIK Cloud写入
使用说明
作者
您可以查看我们的教程和示例应用程序。这些会提供一个关于您能做什么以及如何做的良好概述。
关于ARTIK Cloud的更多信息
如果您不熟悉ARTIK Cloud，我们提供了大量的文档，请访问 https://developer.artik.cloud/documentation。
完整的ARTIK Cloud API规范可在以下位置找到：https://developer.artik.cloud/documentation/api-reference/
在以下位置查看高级示例应用：https://developer.artik.cloud/documentation/samples/
要在ARTIK Cloud上创建和管理您的服务和设备，请在前述网址 https://developer.artik.cloud 注册一个账户。
还可以查看ARTIK Cloud博客，其中包含教程、更新等信息：http://artik.io/blog/cloud
许可和版权
依据Apache License授权。请参阅 LICENSE。
版权所有 (c) 2018 三星电子株式会社。