更新时间:2023-11-21 GMT+08:00

C#

操作场景

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

准备环境

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

获取SDK

  1. 登录DataArts Studio控制台。
  2. 单击“数据服务”模块。
  3. 单击左侧菜单“专享版 > 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 哈希:
    becff4310645f3734344897ffdcabb1853d4b7d93b59a6ea187c5ae40543b36b
    CertUtil: -hashfile 命令成功完成。
    becff4310645f3734344897ffdcabb1853d4b7d93b59a6ea187c5ae40543b36b

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

    不同语言SDK包

    SHA256

    Java

    becff4310645f3734344897ffdcabb1853d4b7d93b59a6ea187c5ae40543b36b

    Go

    bcf8cf19a21226e247195f2e584c8414da39b8d05840fb02948e1375d9bbb7e6

    Python

    c3da3b5814f828d6217963e856563d558d938b3da28993a8a13c8a7ebff5b95d

    C#

    a880b47e63ab35bfe216592e340a8135b866aef8f756ef7738fff3287885f33a

    JavaScript

    53261387f5fcf46e61d0bef5e890bea97952717f327c356412c3128389e848d6

    PHP

    29bf711144e77a4adaea1257cd6dedd2220e57b729a8fd000c51e68ccb42ad4b

    C++

    f604c6386c62cccb7c358007778037d5b15480987dc2860eef1b7bad37cb21d7

    C

    7086012c2d0569d5938830926b19fbea0d46682a983e04e52924978e8720c2f8

    Android

    89962b186707828b06b0c9f50c010b2f4cefd6a8e7ca9bdefb616bbbf6e739c8

获取“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://{apig-endpoint}/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());