文档首页/ API全生命周期管理 ROMA API/ 开发指南/ 使用APP认证调用API/ C#
更新时间：2024-12-20 GMT+08:00
查看PDF
分享

C#

操作场景

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

准备环境

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

获取SDK

下载SDK的最新版本，获取“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
    		 
    Signer signer = new Signer();
signer.Key = "4f5f626b-073f-402f-a1e0-e52171c6100c";
signer.Secret = "******";

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

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

  4. 给请求添加x-stage头，内容为环境名。如有需要，添加需要签名的其他头域。 

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

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

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

相关文档