文档首页/ 数据治理中心 DataArts Studio/ SDK参考/ 数据服务SDK参考/ 使用APP认证调用API/ C#
更新时间：2024-08-19 GMT+08:00
查看PDF
分享

C#

操作场景

使用C#语言调用APP认证的API时，您需要先获取SDK，然后打开SDK包中的工程文件，最后参考API调用示例调用API。

准备环境

  • 已获取API的域名、请求url、请求方法、AppKey和AppSecret等信息，具体参见认证前准备。
  • 获取并安装Visual Studio，如果未安装，请至Visual Studio官方网站下载。

获取SDK

  1. 登录DataArts Studio控制台。
  2. 单击“数据服务”模块。
  3. 单击左侧菜单“共享版> SDK”或“专享版 > SDK”。
  4. 单击SDK使用引导区域里对应语言的SDK，下载SDK包到本地。
  5. 进行SDK包完整性校验。Windows操作系统下，打开本地命令提示符框，输入如下命令，在本地生成已下载SDK包的SHA256值，其中，“D:\java-sdk.zip”为SDK包的本地存放路径和SDK包名，请根据实际情况修改。 

    certutil -hashfile D:\java-sdk.zip SHA256

    命令执行结果示例，如下所示：

    SHA256 的 D:\java-sdk.zip 哈希:
77e033cfb4ea3a8bfdc773d44b9db0ce886eee16fa97bbac536a3174f9d4e029
CertUtil: -hashfile 命令成功完成。

    对比所下载SDK包的SHA256值和下表中对应语言SDK包的SHA256值。如果一致，则表示下载过程不存在篡改和丢包。

    表1 SDK包及对应的SHA256值

    不同语言SDK包

    SHA256值

    Java

    77e033cfb4ea3a8bfdc773d44b9db0ce886eee16fa97bbac536a3174f9d4e029

    Go

    f448645da65b4f765d9569fc97ca45dc3e8f1ce4f79d70c5c43934318521d767

    Python

    54b4984d91db641d2b1b0e77064c162850cb2511a587f95e2f8b8340e7afa128

    C#

    970782e67540efbbf4fc2ccb5e96ca3b1a2f352233a4bbc52b9210b2382831f7

    JavaScript

    43da0b54d6b04d1f5ed7f278c2918c2a63a1ddb8048e2d1c5db60baafb17663c

    PHP

    394c068420a3817f32d5d88b6c1632978f573f2a685e4a1d10c2f698e0f6786e

    C++

    abae5473d47594f88dcd5eaa0902dc12cd6f1e3bd63c0b82d9d1fab8b4351f54

    C

    a376573fe8aa3a636a6d123926ddc3dca11748b289b8c2c16a5056830a095acb

    Android

    c19175d736f05b1945dab4675df19311834ede0d9b1978b11b50c86687baf85c

获取“ApiGateway-csharp-sdk.zip”压缩包，解压后目录结构如下：

名称

说明

apigateway-signature\Signer.cs

SDK代码

apigateway-signature\HttpEncoder.cs

sdk-request\Program.cs

签名请求示例代码

backend-signature\

后端签名示例工程

csharp.sln

工程文件

licenses\license-referencesource

第三方库license文件

打开工程

双击SDK包中的“csharp.sln”文件，打开工程。工程中包含如下3个项目：

  • apigateway-signature：实现签名算法的共享库，可用于.Net Framework与.Net Core项目。
  • backend-signature：后端服务签名示例。
  • sdk-request：签名算法的调用示例，请根据实际情况修改参数后使用。具体代码说明请参考调用API示例。

调用API示例

  1. 在工程中引入sdk。 

    1
    		 
    using APIGATEWAY_SDK;

  2. 生成一个新的Signer， 填入AppKey和AppSecret。 

    1
2
3
4
5
6
7
8
    		 
    // 认证用的ak和sk编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；
// 本示例以ak和sk保存在环境变量中来实现身份验证为例，运行本示例前请先在本地环境中设置环境变量SDK_AK和SDK_SK。
string ak = System.Environment.GetEnvironmentVariable("SDK_AK");
string sk = System.Environment.GetEnvironmentVariable("SDK_SK");

Signer signer = new Signer();
signer.Key = ak;
signer.Secret = sk;

  3. 生成一个HttpRequest对象，指定域方法名、请求url和body。 

    1
2
3
    		 
    HttpRequest r = new HttpRequest("POST",    
                    new Uri("https://c967a237-cd6c-470e-906f-a8655461897e.apigw.cn-north-1.huaweicloud.com/app1?query=value"));
r.body = "{\"a\":1}";

  4. 给请求添加header头，内容为具体参数数据。如有需要，添加需要签名的其他头域。 

    1
2
    		 
    r.headers.Add("x-stage", "RELEASE");
r.headers.Add("name","value");

  5. 进行签名，执行此函数会生成一个新的HttpWebRequest，并在请求参数中添加用于签名的X-Sdk-Date头和Authorization头。然后为请求添加x-Authorization头，值与Authorization头相同。 

    1
2
    		 
    HttpWebRequest req = signer.Sign(r);
req.Headers.Add("x-Authorization", string.Join(", ", req.Headers.GetValues("x-Authorization")));

  6. 访问API，查看访问结果。 

    1
2
3
4
5
6
    		 
    var writer = new StreamWriter(req.GetRequestStream());
writer.Write(r.body);
writer.Flush();
HttpWebResponse resp = (HttpWebResponse)req.GetResponse();
var reader = newStreamReader(resp.GetResponseStream());
Console.WriteLine(reader.ReadToEnd());

相关文档