ID Verification:iOS 統合

1. 初期化 (initFG)

SDK を内部で初期化するには、アプリケーションの起動時にできるだけ早くこの関数を呼び出す必要があります。詳細については、「統合フロー」をご参照ください。[ タイミング 1 ] で initFG インターフェイスを呼び出します。

• 関数プロトタイプ

  @interface FaceGuardDevice : NSObject
  
  /**
   *  FACE_GUARD 初期化関数
   */
  - (void)initFG:(NSString *)userProductKey 
          withOptions:(NSMutableDictionary *)options
          callback:(void (^)(int))initCallback;
  // ...
  @end

• パラメーター

  • userProductKey: ユーザーを識別します。これは Alibaba Cloud によって割り当てられた ProductKey であり、AccessKey (AK) とは異なります。ProductKey を入手するには、ビジネス担当者にお問い合わせください。

    重要

    FACE_GUARD を統合するアプリケーションには、成熟した顔認識アルゴリズムと脅威ポリシーを管理するためのシステムが必要です。まず、ビジネス担当者に相談して、これがビジネスシナリオに適しているかどうかを評価することをお勧めします。

  • options: データ収集のためのオプションのパラメーター。デフォルト値は nil です。次のパラメーターが使用可能です。

    説明

    • ID Verification クライアントには、Device Guard セキュリティモジュールが組み込まれています。さまざまなリージョンでのデータ収集コンプライアンス要件を満たすために、さまざまなデータレポートサイトを提供します。ユーザー属性に基づいてレポートサイトを指定するために、CustomUrl と CustomHost を設定できます。

      注: 1 つのアプリケーションセッションのライフサイクル内で指定できるレポートサイトは 1 つだけです。サーバーのクエリリージョンは、レポートサイトと一致する必要があります。

    • レポートサイトの指定:

      • シンガポールサイト (デフォルト): https://cloudauth-device.ap-southeast-1.aliyuncs.com

      • インドネシアサイト: https://cloudauth-device.ap-southeast-5.aliyuncs.com

      • 米国西部 (シリコンバレー): https://cloudauth-device.us-west-1.aliyuncs.com

      • ドイツ (フランクフルト): https://cloudauth-device.eu-central-1.aliyuncs.com

      • 中国 (香港): https://cloudauth-device.cn-hongkong.aliyuncs.com

    • プロダクトサーバーでサポートされているリージョンの詳細については、「サポートされているリージョン」をご参照ください。

    フィールド名	説明	例
    IPv6	デバイス情報をレポートするために IPv6 ドメイン名を使用するかどうかを指定します。 0 (デフォルト): いいえ (IPv4 ドメイン名を使用) 1: はい (IPv6 ドメイン名を使用)	"1"
    DataSwitch	デバイス情報をレポートするタイミング。 0 (デフォルト): 初期化時 1: トークン取得時 説明 デフォルトの構成を使用することをお勧めします。	"1"
    CustomUrl	データレポートサーバーのドメイン名を設定します。	"https://cloudauth-device.ap-southeast-1.aliyuncs.com"
    CustomHost	データレポートサーバーのホストを設定します。	"cloudauth-device.ap-southeast-1.aliyuncs.com

  • initCallback: 初期化コールバックのリスナー。このコールバックを使用して、初期化が成功したかどうかを判断できます。デフォルト値は nil です。code フィールドの値の範囲については、「コードの戻り値」をご参照ください。

• 呼び出し例

  NSMutableDictionary *options = [[NSMutableDictionary alloc] init];
  [options setValue:@"0" forKey:@"IPv6"];       // IPv4 に設定
  [options setValue:@"0" forKey:@"DataSwitch"]; // データ収集を初期化フェーズに設定
  // カスタムデータレポートリージョンを設定
  // [options setValue:@"xxx" forKey:@"CustomUrl"];  // レポートサイトの URL を設定
  // [options setValue:@"xxx" forKey:@"CustomHost"]; // レポートサイトのホストを設定
  
  // 標準呼び出し (推奨)
  [[FaceGuardDevice sharedInstance] initFG:@"******" withOptions:options callback:nil];
  
  // コールバック呼び出し
  [[FaceGuardDevice sharedInstance] initFG:@"******" withOptions:options callback:^(int code) {
      NSString * initResult = [NSString stringWithFormat: @ "デバイスアシスタントの初期化結果: %d", code];
      NSLog(@ "%@", initResult);
  
      if (SC_SUCCESS != code) {
          NSLog(@ "初期化に失敗しました");
      } else {
          NSLog(@ "初期化に成功しました");
      }
  }];

2. クライアント token の取得 (getDeviceToken)

クライアントトークンを取得するには、「統合フロー」をご参照ください。[ タイミング 2 ] で呼び出しを行い、トークンをビジネスサーバーにレポートします。次に、サーバーから FACE_GUARD の FaceGuardRisk インターフェイスをクエリして、クライアントデバイスの不正検出情報を取得します。

• 関数プロトタイプ

  @interface FaceGuardDevice : NSObject
  - (FaceGuardToken *) getDeviceToken;
    // bizId を渡すことをお勧めします。
  - (FaceGuardToken *) getDeviceToken:(NSString *)bizId;
  @end

• パラメーター

  bizId: 顧客のビジネス ID。このパラメーターは、ビジネス ID をトークンに関連付けます。デフォルトでは、このパラメーターを空のままにすることができます。

• 戻り値

  • `FaceGuardToken` 型。定義は次のとおりです:

    @interface FaceGuardToken: NSObject
    
    /**
     * get token 操作の結果
     */
    @property(atomic) int code;
    
    /**
     * トークンの結果を含む文字列
     */
    @property(copy, atomic) NSString * token;
    @end

  • code: API 呼び出しの状態コード。これを使用して、呼び出しが成功したかどうかを判断できます。

    コードの戻り値

    FaceSecCode	コード	注釈
    SC_SUCCESS	10000	SDK は正常に初期化されました。
    SC_NOT_INIT	10001	SDK は初期化されていません。
    SC_NOT_PERMISSION	10002	SDK に必要な基本権限が完全に付与されていません。
    SC_UNKNOWN_ERROR	10003	不明なシステムエラー。
    SC_NETWORK_ERROR	10004	ネットワークエラー。
    SC_NETWORK_ERROR_EMPTY	10005	ネットワークエラー。返されたコンテンツは空の文字列です。
    SC_NETWORK_ERROR_INVALID	10006	ネットワーク応答のフォーマットが無効です。
    SC_PARSE_SRV_CFG_ERROR	10007	サーバー構成の解析に失敗しました。
    SC_NETWORK_RET_CODE_ERROR	10008	ゲートウェイが失敗を返しました。
    SC_APPKEY_EMPTY	10009	AppKey が指定されていません。
    SC_PARAMS_ERROR	10010	その他のパラメーターエラー。
    SC_FGKEY_ERROR	10011	キー計算エラー。
    SC_APPKEY_ERROR	10012	ProductKey が無効です。

  • token: トークン文字列。後続のビジネスコールで Alibaba Cloud FACE_GUARD API 操作に使用できます。

    重要

    token 文字列は、良好なネットワーク環境では約 600 バイト、劣悪なネットワーク環境では約 2.5 KB の長さです。また、特別な識別子があります:

    • 良好なネットワーク: "U0dfTkxxxx"

    • 劣悪なネットワーク: "U0dfUFxxxx"

    ビジネスで多数の長いトークンが発生した場合:

    • まず、クライアントが安定したネットワーク接続を持っていることを確認してください。

    • 次に、「アクセスフロー」の指示に従ってください。initFG インターフェイスを[ タイミング 1 ] で、getDeviceToken インターフェイスを[ タイミング 2 ] で呼び出します。または、SDK の initFG と getDeviceToken インターフェイスの呼び出しの間隔が 3 秒以上であることを確認してください。

• 呼び出し例

  // deviceToken の改ざんを防ぐために bizId を渡します。これは推奨されます。
  NSString *bizId = @"1234567890abcdef******";
  FaceGuardToken *deviceToken = [[FaceGuardDevice sharedInstance] getDeviceToken:bizId];
  
  if (deviceToken == nil || SC_SUCCESS != deviceToken.code) {
      NSLog(@"トークンの取得に失敗しました。呼び出し結果を使用してリスクタグをクエリすることはできません。");
  } else {
      NSLog(@"トークンを正常に取得しました。これでリスクタグをクエリできます。トークン: %@", deviceToken.token);
  }

3. トークンを使用してサーバーにリクエストを送信

deviceToken (FaceGuardDevice.token) を正常に取得した後、このパラメーターをサーバーへのリクエストに含めることができます。その後、サーバーは結果をクエリして検証します。詳細については、「サーバー側の API 操作」をご参照ください。