文档首页 > > API签名指南> 签名SDK与demo> C#

C#

分享
更新时间: 2019/09/07 GMT+08:00

本节以Visual Studio工具为例,介绍如何在C#环境中集成API请求签名的SDK。您可以直接导入示例工程体验,然后参考调用说明部分将签名SDK集成到您的应用中。

准备环境

获取并安装Visual Studio,可至Visual Studio官方网站下载。

获取SDK

请访问https://obs.cn-north-1.myhuaweicloud.com/apig-sdk/APIGW-csharp-sdk.zip下载SDK。

下载“APIGW-csharp-sdk.zip”压缩包,解压后目录结构如下:

名称

说明

apigateway-signature\Signer.cs

SDK代码

apigateway-signature\HttpEncoder.cs

sdk-request\Program.cs

签名请求示例代码

csharp.sln

工程文件

licenses\license-referencesource

第三方库license文件

打开工程

双击SDK包中的“csharp.sln”文件,打开工程。其中,apigateway-signature项目为实现签名算法的共享库,可用于.Net Framework与.Net Core项目。“sdk-request”项目为调用示例。

请求签名与API调用

  1. 在工程中引入sdk。

    1
    using APIGATEWAY_SDK;
    

  2. 生成一个新的Signer, 填入AK和SK。

    1
    2
    3
    Signer signer = new Signer();
    signer.Key = "QTWAOYT**********VKYUC";
    signer.Secret = "MFyfvK41ba2giqM7**********KGpownRZlmVmHc";
    

  3. 生成一个新的Request,指定域名、方法名、请求uri和body。

    1
    2
    3
    4
    //The following example shows how to set the request URL and parameters to query a VPC list.
    HttpRequest r = new HttpRequest("GET", new Uri("https://service.region.example.com/v1/77b6a44cba5**********9a8ff44fd/vpcs?limit=1"));
    //Add a body if you have specified the PUT or POST method. Special characters, such as the double quotation mark ("), contained in the body must be escaped.
    r.body = "";
    

  4. 添加需要签名的其他头域,或者其他用途的头域,如多项目场景中添加X-Project-Id,或者全局服务场景中添加X-Domain-Id。

    1
    2
    //Add header parameters, for example, X-Domain-Id for invoking a global service and X-Project-Id for invoking a project-level service.
    r.headers.Add("Content-Type", "application/json");
    

  5. 进行签名,执行此函数会生成一个新的HttpWebRequest,并在请求参数中添加用于签名的X-Sdk-Date头和Authorization头。

    如果您使用HTTP Client,可以从请求中获取头部信息使用。关于头部信息,请参考 AK/SK签名认证算法详解
    1
    HttpWebRequest req = signer.Sign(r);
    

  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());
    

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

跳转到云社区