身份认证SDK

初始化

初始化前需确保已正确集成安全图片，具体操作，请参见SDK初始化和集成安全图片。

使用方式

发送带身份认证的API请求

// 引入头文件
#import <IMSAuthentication/IMSIoTAuthentication.h>
#import <IMSApiClient/IMSApiClient.h>

// 构建请求
NSString *path = @"/uc/listByAccount";
NSString *apiVer = @"1.0.0";
NSDictionary *params = @{};
IMSIoTRequestBuilder *builder = [[IMSIoTRequestBuilder alloc] initWithPath:path apiVersion:apiVer params:params];

// 指定身份认证类型
[builder setAuthenticationType:IMSAuthenticationTypeIoT];

//通过 IMSRequestClient 发送请求
[IMSRequestClient asyncSendRequest:builder.build responseHandler:^(NSError * _Nullable error, IMSResponse * _Nullable response) {
    if (error) {
        //处理Error，非服务端返回的错误都通过该Error回调
    } else {
        if (response.code == 200) {
            //成功，处理response.data
        }
        else {
            //处理服务端错误
        }
    }
}];
					

API请求的认证错误处理

如果您创建自有App时配置为不支持多端登录（详细介绍，请参见创建自有App），当一个账号在多个设备登录时，只有最后登录的终端可以正常访问IoT服务。

• 如果是其他账号在发送API通道请求时，会返回认证错误（错误码为401）。

• 如果账号未登录或登录信息过期（或长时间未登录）时，在发送API通道请求时，也会返回认证错误。

出现以上两种认证错误时，您只需处理API请求的错误，并提示终端用户重新登录。

[IMSRequestClient asyncSendRequest:builder.build responseHandler:^(NSError * _Nullable error, IMSResponse * _Nullable response) {
 if (error) {
     //...
 } else {
     if (response.code == 200) {
         //...
     }
     else if (response.code == 401) {
         //处理认证错误
     }
     else {
         //...
     }
 }
}];

如果您希望统一处理这种类型的认证错误，可根据以下流程来实现。

1. 继承IMSIoTAuthentication来实现自定义的身份认证功能。

   @interface XXCustomAuthentication : IMSIoTAuthentication
   @end
   @implementation XXCustomAuthentication
   
   - (void)handleRequestBeforeSend:(IMSRequest * _Nonnull)request
                           payload:(IMSRequestPayload * _Nonnull)payload
                        completion:(void (^ _Nonnull)(NSError * _Nullable error,
                                                      IMSResponse *_Nullable mockResponse,
                                                      IMSRequestPayload * _Nullable newPayload))completionHandler {
       [super handleRequestBeforeSend:request payload:payload completion:^(NSError * _Nullable error, IMSResponse * _Nullable mockResponse, IMSRequestPayload * _Nullable newPayload) {
           completionHandler(error, mockResponse, newPayload);
   
           if (mockResponse && mockResponse.code == 401) {
               //自定义处理 401, 比如 toast
               NSLog(@"before: 401");
           }
       }];
   }
   
   - (void)handleResponse:(IMSResponse * _Nonnull)response
               completion:(void (^ _Nonnull)(NSError * _Nullable error, IMSResponse * _Nullable response))completionHandler {
       [super handleResponse:response
                  completion:^(NSError * _Nullable error, IMSResponse * _Nullable response) {
                      completionHandler(error, response);
   
                      if (response && response.code == 401) {
                          //自定义处理 401, 比如 toast
                          NSLog(@"after: 401");
                      }
                  }];
   }
   @end

2. 注册自定义的身份认证。

   XXCustomAuthentication *iotAuthDelegate = [[XXCustomAuthentication alloc] initWithCredentialManager:IMSCredentialManager.sharedManager];
   [IMSRequestClient registerDelegate:iotAuthDelegate forAuthenticationType:IMSAuthenticationTypeIoT];

3. 获取用户身份凭证。

   在账号登录成功后，可通过下面的方法同步获取用户身份凭证信息。

   #import <IMSAuthentication/IMSCredentialManager.h>
   
   IMSCredential *credential = [IMSCredentialManager sharedManager].credential;
   NSString *identityId = credential.identityId;
   NSString *iotToken = credential.iotToken;

4. 刷新用户身份凭证。

   当同步方法获取到的用户身份凭证为空时，可以通过下面的方法强制异步刷新一个新的用户身份凭证信息。

   #import <IMSAuthentication/IMSCredentialManager.h>
   
   [[IMSCredentialManager sharedManager] asyncRefreshCredential:^(NSError * _Nullable error, IMSCredential * _Nullable credential) {
       if (error) {
           //刷新出错，参考错误码 IMSCredentialManagerErrorCode 处理
       } else {
           NSString *identityId = credential.identityId;
           NSString *iotToken = credential.iotToken;
       }
   }];