iOS客户端接入

搭建开发环境

1. 登录号码认证产品控制台，在控制台右侧API&SDK标签，单击立即使用，进入API&SDK页面，根据页面提示下载并解压iOS SDK（含Demo工程）。
2. 下载并安装Xcode 11。
3. 添加主库。添加主库的两种方法如下：
   • 选择并单击Xcode 11中Targets > Build Phases > Link Binary With Libraries，添加主库YTXMonitor.framework、SmsAuthSDK.framework，并将其Status设置为Required。
   • 选择并单击Xcode 11中Targets > General > Frameworks, Libraries, and Embedded Content，SmsAuthSDK.framework、YTXMonitor.framework两个依赖库都属于静态库，将Embed设置为Do Not Embed。

SDK方法说明

• 主类SmsVerifyCodeManager
  • 获取实例

    /**
     *  初始化SDK实例
     *  @param  sceneCode方案号，必传字段
     *  @return SDK操作实例
     */
    - (instancetype)initWithSceneCode:(NSString *)sceneCode;

  • 获取SDK版本号

    /**
     *  获取SDK版本号
     *  @return SDK版本号
     */
    - (NSString *)getVersion;

  • 设置SmsTokens更新代理对象（id<SmsTokenUpadterDelegate>）

    /**
     *  设置Token更新代理对象
     *  @param  tokenUpdateDelegate Token更新代理对象，注：SDK内部对该对象是弱引用，需要外部来维护其生命
     */
    - (void)setTokenUpdateDelegate:(id<SmsTokenUpadterDelegate>)tokenUpdateDelegate;

  • 发送短信验证码

    /**
     *  发送短信验证码
     *  @param  timeout接口超时时间（单位：s）
     *  @param  countryCode国际电话区号，目前仅作为保留字段，当前版本只支持86（即中国大陆的电话号码）
     *  @param  phoneNumber手机号
     *  @param  complete接口调用结果回调
     */
    - (void)sendVerifyCodeWithTimeout:(NSTimeInterval)timeout
                          countryCode:(int)countryCode
                          phoneNumber:(NSString *)phoneNumber
                             complete:(void(^)(SmsSendCodeResult *result))complete;

  • 清空本地SmsTokens缓存

    /**
     *  清空本地SmsTokens缓存
     */
    - (void)clearTokenCache;

• 实体类SmsTokens

  /// stsToken
  @property (nonatomic, copy) NSString *stsToken;
  /// bizToken
  @property (nonatomic, copy) NSString *bizToken;
  /// Token过期时间（单位：ms）
  @property (nonatomic, assign) long long expiredTimeMills;
  /// 临时accessKeyId
  @property (nonatomic, copy) NSString *accessKeyId;
  /// 临时accessKeySecret
  @property (nonatomic, copy)SmsSendCodeResult NSString *accessKeySecret;

• 实体类SmsSendCodeResult

  /// 请求对应的requestId，记录下来方便后面问题的全链路排查
  @property (nonatomic, copy) NSString *requestId;
  /// 请求返回的code，具体请参见SmsReturnCode.h
  @property (nonatomic, copy) NSString *code;
  /// 请求返回的msg
  @property (nonatomic, copy) NSString *msg;
  /// 发送验证码请求返回的Token
  @property (nonatomic, copy) NSString *smsVerifyToken;
  /// 接口请求失败返回的详细内容
  @property (nonatomic, strong) NSDictionary *failedResponseData;

• SmsTokens更新代理
  SDK发送短信验证码时需要用到BizToken、StsToken（包含AccessKey信息）两个Token。调用方法详情请参见GetSmsAuthTokens。

  @protocol SmsTokenUpadterDelegate <NSObject>
  @required
  /**
   *  返回最新的SmsTokens对象
   */
  - (SmsTokens *)updateTokenWithVerifyCodeManager:(SmsVerifyCodeManager *)verifyCodeManager;
  @end

  SDK在检测到本地缓存中没有有效SmsTokens（不存在或者已过期）时，则会调用updateTokenWithVerifyCodeManager方法，开发者需要实现该代理方法，并且获取到Token后，封装成SmsTokens返回给SDK。

  重要 使用该方法时需要发送网络请求获取相关参数，同时也会同步返回结果。在此过程中需要使用信号量做同步且属于私有线程，不会卡顿主线程，请放心同步。具体可以参见Demo工程。

SDK返回码