# .NET SDK
本章节介绍.NET SDK，您可以参考本章节进行快速集成开发。
 #### 准备工作
- [注册华为账号并开通华为云](https://support.huaweicloud.com/usermanual-account/account_id_001.html)，并完成实名认证，账号不能处于欠费或冻结状态。
- 已具备开发环境，.NET SDK 适用于.NET Standard 2.0 及其以上版本；C# 4.0 及其以上版本。
- 登录"[我的凭证](https://console.huaweicloud.com/iam/#/myCredential) \> 访问密钥"页面，获取Access Key（AK）和Secret Access Key（SK）。
  图1获取AK、SK   
  ![](https://support.huaweicloud.com/sdkreference-ivs/zh-cn_image_0000001731583632.png "点击放大") 
- 登录"[我的凭证](https://console.huaweicloud.com/iam/#/myCredential)"页面，获取"IAM用户名""、账号名"以及待使用区域的"项目ID"。调用服务时会用到这些信息，请提前保存。
  本样例以"华北-北京四"区域为例，获取对应的项目ID（project_id）。
  图2我的凭证   
  ![](https://support.huaweicloud.com/sdkreference-ivs/zh-cn_image_0000001732203174.png "点击放大") 
 
#### 安装SDK
使用SDK前，需要安装"HuaweiCloud.SDK.Core"和"HuaweiCloud.SDK.Ivs"，有两种安装方式，分别如下。
- 使用 .NET CLI 工具
  ```
  dotnet add package HuaweiCloud.SDK.Core
  dotnet add package HuaweiCloud.SDK.Ivs
  ```
  
- 使用 Package Manager
  ```
  Install-Package HuaweiCloud.SDK.Core
  Install-Package HuaweiCloud.SDK.Ivs
  ```
  
 
#### 开始使用SDK
1. 导入依赖模块
   ```
   using System;
   using System.Collections.Generic;
   using HuaweiCloud.SDK.Core;
   using HuaweiCloud.SDK.Core.Auth;
   using HuaweiCloud.SDK.Ivs;
   using HuaweiCloud.SDK.Ivs.V2;
   using HuaweiCloud.SDK.Ivs.V2.Model;
   ```
   
2. 配置客户端连接参数
   - 默认配置
     ```
     // 使用默认配置
     var config = HttpConfig.GetDefaultConfig();
     ```
     
   
   - 网络代理（可选）
     ```
     // 根据需要配置网络代理
     config.ProxyHost = "proxy.huaweicloud.com";
     config.ProxyPort = 8080;
     config.ProxyUsername = "test";
     config.ProxyPassword = "test";
     ```
     
   
   - 超时配置（可选）
     ```
     // 默认超时时间为120秒，可根据需要调整
     config.Timeout = 120;
     ```
     
   
   - SSL配置（可选）
     ```
     // 根据需要配置是否跳过SSL证书验证
     config.IgnoreSslVerification = true;
     ```
     
    
3. 配置认证信息 配置AK、SK信息。华为云通过AK识别用户的身份，通过SK对请求数据进行签名验证，用于确保请求的机密性、完整性和请求者身份的正确性。AK、SK获取方法请参见[准备工作]。
   ```
   const string ak = Environment.GetEnvironmentVariable("HUAWEICLOUD_SDK_AK");
   const string sk = Environment.GetEnvironmentVariable("HUAWEICLOUD_SDK_SK");
   var auth = new BasicCredentials(ak, sk);
   ```
   ![](https://support.huaweicloud.com/sdkreference-ivs/public_sys-resources/caution_3.0-zh-cn.png)
   - 认证用的 ak 和sk 硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全。
   
   - 本示例以 ak 和 sk 保存在环境变量中来实现身份验证为例，运行本示例前请先在本地环境中设置环境变量HUAWEICLOUD_SDK_AK和HUAWEICLOUD_SDK_SK。
    
   图3Windows环境新建环境变量   
   ![](https://support.huaweicloud.com/sdkreference-ivs/zh-cn_image_0000001778663081.png "点击放大") 
4. 初始化客户端
   - 指定云服务region方式（推荐）
     ```
     // 初始化指定云服务的客户端 {Service}Client ，以初始化IVS服务的 IvsClient 为例
     var client = IvsClient.NewBuilder()
              .WithCredential(auth)
              .WithRegion(IvsRegion.ValueOf("cn-north-4"))
              .WithHttpConfig(config)
              .Build();
     ```
     
   
   - 指定云服务endpoint方式
     ```
     // 指定终端节点，以IVS服务北京四的 endpoint 为例
     String endpoint = "https://ivs.cn-north-4.myhuaweicloud.com";
     // 初始化客户端认证信息，需要填写相应 projectId，以初始化 BasicCredentials 为例
     var auth = new BasicCredentials(ak, sk, projectId);
     // 初始化指定云服务的客户端 {Service}Client，以初始化IVS服务的 IvsClient 为例
     var client = IvsClient.NewBuilder()
         .WithCredential(auth)
         .WithEndPoint(endpoint)
         .WithHttpConfig(config)
         .Build();
     ```
     endpoint是华为云各服务应用区域和各服务的终端节点，详情请查看 [地区和终端节点](https://support.huaweicloud.com/api-ivs/ivs_02_0004.html) 。
     
    
5. 发送请求并查看响应
   ```
   // 以调用人证核身标准版（三要素）接口 DetectStandardByIdCardImage 为例
   var req = new DetectStandardByIdCardImageRequest
   {
   };
   List<ReqDataByIdCardImage> listReqDataByIdCardImageReqData = new List<ReqDataByIdCardImage>();
   listReqDataByIdCardImageReqData.Add(new ReqDataByIdCardImage()
   {
       IdcardImage1 = "身份证人像面图像数据,使用base64编码",
       IdcardImage2 = "身份证国徽面图像数据,使用base64编码",
       FaceImage = "现场人像图像数据,使用base64编码"
   });
   IvsStandardByIdCardImageRequestBodyData databody = new IvsStandardByIdCardImageRequestBodyData()
   {
       ReqData = listReqDataByIdCardImageReqData
   };
   Meta metabody = new Meta()
   {
       Uuid = "唯一标识此次请求的ID,用户自定义,不超过64位。"
   };
   req.Body = new IvsStandardByIdCardImageRequestBody()
   {
       Data = databody,
       Meta = metabody
   };
   try
   {
       var resp = client.DetectStandardByIdCardImage(req);
       var respStatusCode = resp.HttpStatusCode;
       Console.WriteLine(respStatusCode);
   }
   ```
   
6. 异常处理
   表1异常处理 
   | 一级分类                     | 一级分类说明  | 二级分类                     | 二级分类说明                      |
   |:---|:---|:---|:---|
   | ConnectionException      | 连接类异常   | HostUnreachableException | 网络不可达、被拒绝。                  |
   | ConnectionException      | 连接类异常   | SslHandShakeException    | SSL认证异常。                    |
   | RequestTimeoutException  | 响应超时异常  | CallTimeoutException     | 单次请求，服务器处理超时未返回。            |
   | RequestTimeoutException  | 响应超时异常  | RetryOutageException     | 在重试策略消耗完成后，仍无有效的响应。         |
   | ServiceResponseException | 服务器响应异常 | ServerResponseException  | 服务端内部错误，Http响应码：\[500,\]。   |
   | ServiceResponseException | 服务器响应异常 | ClientRequestException   | 请求参数不合法，Http响应码：\[400, 500) |
      
   ```
   // 捕获和处理不同类型的异常
   try
               {
   var resp = client.DetectStandardByIdCardImage(req);
   var respStatusCode = resp.HttpStatusCode;
                   Console.WriteLine(respStatusCode);
               }
   catch (RequestTimeoutException requestTimeoutException)
               {
                   Console.WriteLine(requestTimeoutException.ErrorMessage);
               }
   catch (ServiceResponseException clientRequestException)
               {
                   Console.WriteLine(clientRequestException.HttpStatusCode);
                   Console.WriteLine(clientRequestException.ErrorCode);
                   Console.WriteLine(clientRequestException.ErrorMsg);
               }
   catch (ConnectionException connectionException)
               {
                   Console.WriteLine(connectionException.ErrorMessage);
               }
   ```
   
 
![](https://support.huaweicloud.com/sdkreference-ivs/public_sys-resources/note_3.0-zh-cn.png)
使用异步客户端，配置日志等操作请参见[SDK中心](https://sdkcenter.developer.huaweicloud.com/)、[.NET SDK使用指导](https://github.com/huaweicloud/huaweicloud-sdk-net-v3/blob/master/README_CN.md)、[.NET SDK视频指导](https://res-static.hc-cdn.cn/cloudbu-site/china/zh-cn/support/sdk-video/huaweicloud_.net_sdk.mp4)。
#### SDK demo 代码解析
**人证核身标准版（三要素）**
- 方式一：使用身份证图片、人像图片进行校验
  ```
  var req = new DetectStandardByIdCardImageRequest
  {
  };
  List<ReqDataByIdCardImage> listReqDataByIdCardImageReqData = new List<ReqDataByIdCardImage>();
  listReqDataByIdCardImageReqData.Add(new ReqDataByIdCardImage()
  {
      IdcardImage1 = "身份证人像面图像数据,使用base64编码",
      IdcardImage2 = "身份证国徽面图像数据,使用base64编码",
      FaceImage = "现场人像图像数据,使用base64编码,"
  });
  IvsStandardByIdCardImageRequestBodyData databody = new IvsStandardByIdCardImageRequestBodyData()
  {
      ReqData = listReqDataByIdCardImageReqData
  };
  Meta metabody = new Meta()
  {
      Uuid = "唯一标识此次请求的ID,用户自定义,不超过64位。例如10eb0091-887f-4839-9929-cbc884f1e20e"
  };
  req.Body = new IvsStandardByIdCardImageRequestBody()
  {
      Data = databody,
      Meta = metabody
  };
  try
  {
      var resp = client.DetectStandardByIdCardImage(req);
      var respStatusCode = resp.HttpStatusCode;
      Console.WriteLine(respStatusCode);
  }
  catch (RequestTimeoutException requestTimeoutException)
  {
      Console.WriteLine(requestTimeoutException.ErrorMessage);
  }
  catch (ServiceResponseException clientRequestException)
  {
      Console.WriteLine(clientRequestException.HttpStatusCode);
      Console.WriteLine(clientRequestException.ErrorCode);
      Console.WriteLine(clientRequestException.ErrorMsg);
  }
  catch (ConnectionException connectionException)
  {
      Console.WriteLine(connectionException.ErrorMessage);
  }
  ```
  
- 方式二：使用身份证姓名、身份证号码文本，人像图片进行校验
  ```
  var req = new DetectStandardByNameAndIdRequest
  {
  };
  List<StandardReqDataByNameAndId> listStandardReqDataByNameAndIdReqData = new List<StandardReqDataByNameAndId>();
  listStandardReqDataByNameAndIdReqData.Add(new StandardReqDataByNameAndId()
  {
      VerificationName = "被验证人的姓名",
      VerificationId = "被验证人的身份证号码",
      FaceImage = "现场人像图像数据,使用base64编码"
  });
  IvsStandardByNameAndIdRequestBodyData databody = new IvsStandardByNameAndIdRequestBodyData()
  {
      ReqData = listStandardReqDataByNameAndIdReqData
  };
  Meta metabody = new Meta()
  {
      Uuid = "唯一标识此次请求的ID,用户自定义,不超过64位。例如10eb0091-887f-4839-9929-cbc884f1e20e"
  };
  req.Body = new IvsStandardByNameAndIdRequestBody()
  {
      Data = databody,
      Meta = metabody
  };
  try
  {
      var resp = client.DetectStandardByNameAndId(req);
      var respStatusCode = resp.HttpStatusCode;
      Console.WriteLine(respStatusCode);
  }
  catch (RequestTimeoutException requestTimeoutException)
  {
      Console.WriteLine(requestTimeoutException.ErrorMessage);
  }
  catch (ServiceResponseException clientRequestException)
  {
      Console.WriteLine(clientRequestException.HttpStatusCode);
      Console.WriteLine(clientRequestException.ErrorCode);
      Console.WriteLine(clientRequestException.ErrorMsg);
  }
  catch (ConnectionException connectionException)
  {
      Console.WriteLine(connectionException.ErrorMessage);
  }
  ```
  
- 方式三：使用现场拍摄的人像视频数据，实现活体人证核身
  ```
  var req = new DetectStandardByVideoAndIdCardImageRequest
  {
  };
  List<ReqDataByVideoAndIdCardImage> listReqDataData = new List<ReqDataByVideoAndIdCardImage>();
  listReqDataData.Add(new ReqDataByVideoAndIdCardImage()
  {
      IdcardImage1 = "身份证人像面图像数据,使用base64编码",
      IdcardImage2 = "身份证国徽面图像数据,使用base64编码",
      Video = "现场拍摄人像视频数据,使用base64编码",
      Actions = "动作代码顺序列表"
  });
  IvsStandardByVideoAndIdCardImageRequestBodyData databody = new IvsStandardByVideoAndIdCardImageRequestBodyData()
  {
      ReqData = listReqDataData
  };
  Meta metabody = new Meta()
  {
      Uuid = "唯一标识此次请求的ID,用户自定义,不超过64位。例如10eb0091-887f-4839-9929-cbc884f1e20e"
  };
  req.Body = new IvsStandardByVideoAndIdCardImageRequestBody()
  {
      Data = databody,
      Meta = metabody
  };
  try
  {
      var resp = client.DetectStandardByVideoAndIdCardImage(req);
      var respStatusCode = resp.HttpStatusCode;
      Console.WriteLine(respStatusCode);
  }
  catch (RequestTimeoutException requestTimeoutException)
  {
      Console.WriteLine(requestTimeoutException.ErrorMessage);
  }
  catch (ServiceResponseException clientRequestException)
  {
      Console.WriteLine(clientRequestException.HttpStatusCode);
      Console.WriteLine(clientRequestException.RequestId);
      Console.WriteLine(clientRequestException.ErrorCode);
      Console.WriteLine(clientRequestException.ErrorMsg);
  }
  catch (ConnectionException connectionException)
  {
      Console.WriteLine(connectionException.ErrorMessage);
  }
  ```
  
- 方式四：使用身份证姓名、身份证号码文本和现场拍摄的人像视频数据，实现活体人证核身
  ```
  var req = new DetectStandardByVideoAndNameAndIdRequest
  {
  };
  List<StandardReqDataByVideoAndNameAndId> listReqDataData = new List<StandardReqDataByVideoAndNameAndId>();
  listReqDataData.Add(new StandardReqDataByVideoAndNameAndId()
  {
  VerificationName = "被验证人的姓名",
  VerificationId = "被验证人的身份证号码",
  Video = "现场拍摄人像视频数据,使用base64编码",
  Actions = "动作代码顺序列表"
  });
  IvsStandardByVideoAndNameAndIdRequestBodyData databody = new IvsStandardByVideoAndNameAndIdRequestBodyData()
  {
  ReqData = listReqDataData
  };
  Meta metabody = new Meta()
  {
  Uuid = "唯一标识此次请求的ID,用户自定义,不超过64位。例如10eb0091-887f-4839-9929-cbc884f1e20e"
  };
  req.Body = new IvsStandardByVideoAndNameAndIdRequestBody()
  {
  Data = databody,
  Meta = metabody
  };
  try
  {
  var resp = client.DetectStandardByVideoAndNameAndId(req);
  var respStatusCode = resp.HttpStatusCode;
  Console.WriteLine(respStatusCode);
  }
  catch (RequestTimeoutException requestTimeoutException)
  {
  Console.WriteLine(requestTimeoutException.ErrorMessage);
  }
  catch (ServiceResponseException clientRequestException)
  {
  Console.WriteLine(clientRequestException.HttpStatusCode);
  Console.WriteLine(clientRequestException.RequestId);
  Console.WriteLine(clientRequestException.ErrorCode);
  Console.WriteLine(clientRequestException.ErrorMsg);
  }
  catch (ConnectionException connectionException)
  {
  Console.WriteLine(connectionException.ErrorMessage);
  }
  ```
  
**人证核身证件版（二要素）**
- 方式一：使用身份证图片进行校验
  ```
  var req = new DetectExtentionByIdCardImageRequest
  {
  };
  List<ExtentionReqDataByIdCardImage> listExtentionReqDataByIdCardImageReqData = new List<ExtentionReqDataByIdCardImage>();
  listExtentionReqDataByIdCardImageReqData.Add(new ExtentionReqDataByIdCardImage()
  {
      IdcardImage1 = "身份证人像面图像数据,使用base64编码",
      IdcardImage2 = "身份证国徽面图像数据,使用base64编码"
  });
  IvsExtentionByIdCardImageRequestBodyData databody = new IvsExtentionByIdCardImageRequestBodyData()
  {
      ReqData = listExtentionReqDataByIdCardImageReqData
  };
  Meta metabody = new Meta()
  {
      Uuid = "唯一标识此次请求的ID,用户自定义,不超过64位。例如10eb0091-887f-4839-9929-cbc884f1e20e"
  };
  req.Body = new IvsExtentionByIdCardImageRequestBody()
  {
      Data = databody,
      Meta = metabody
  };
  try
  {
      var resp = client.DetectExtentionByIdCardImage(req);
      var respStatusCode = resp.HttpStatusCode;
      Console.WriteLine(respStatusCode);
  }
  catch (RequestTimeoutException requestTimeoutException)
  {
      Console.WriteLine(requestTimeoutException.ErrorMessage);
  }
  catch (ServiceResponseException clientRequestException)
  {
      Console.WriteLine(clientRequestException.HttpStatusCode);
      Console.WriteLine(clientRequestException.ErrorCode);
      Console.WriteLine(clientRequestException.ErrorMsg);
  }
  catch (ConnectionException connectionException)
  {
      Console.WriteLine(connectionException.ErrorMessage);
  }
  ```
  
- 方式二：使用身份证姓名、身份证号码文本进行校验
  ```
  var req = new DetectExtentionByNameAndIdRequest
  {
  };
  List<ExtentionReqDataByNameAndId> listExtentionReqDataByNameAndIdReqData = new List<ExtentionReqDataByNameAndId>();
  listExtentionReqDataByNameAndIdReqData.Add(new ExtentionReqDataByNameAndId()
  {
      VerificationName = "被验证人的姓名",
      VerificationId = "被验证人的身份证号码"
  });
  IvsExtentionByNameAndIdRequestBodyData databody = new IvsExtentionByNameAndIdRequestBodyData()
  {
      ReqData = listExtentionReqDataByNameAndIdReqData
  };
  Meta metabody = new Meta()
  {
      Uuid = "唯一标识此次请求的ID,用户自定义,不超过64位。例如10eb0091-887f-4839-9929-cbc884f1e20e"
  };
  req.Body = new IvsExtentionByNameAndIdRequestBody()
  {
      Data = databody,
      Meta = metabody
  };
  try
  {
      var resp = client.DetectExtentionByNameAndId(req);
      var respStatusCode = resp.HttpStatusCode;
      Console.WriteLine(respStatusCode);
  }
  catch (RequestTimeoutException requestTimeoutException)
  {
      Console.WriteLine(requestTimeoutException.ErrorMessage);
  }
  catch (ServiceResponseException clientRequestException)
  {
      Console.WriteLine(clientRequestException.HttpStatusCode);
      Console.WriteLine(clientRequestException.ErrorCode);
      Console.WriteLine(clientRequestException.ErrorMsg);
  }
  catch (ConnectionException connectionException)
  {
      Console.WriteLine(connectionException.ErrorMessage);
  }
  ```
  
 
#### 代码示例自动生成
[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/sdk?product=IVS&api=DetectStandardByIdCardImage)提供API检索及平台调试，支持全量快速检索、可视化调试、帮助文档查看和在线咨询。
您只需要在API Explorer中修改接口参数，即可自动生成对应的代码示例。同时，可在集成开发环境CloudIDE中完成代码的构建、调试和运行等操作。
图4API Explorer   
![](https://support.huaweicloud.com/sdkreference-ivs/zh-cn_image_0000001207507570.png "点击放大")