C# SDK使用说明
操作场景
使用C#语言调用APP认证的API时,您需要先获取SDK,然后打开SDK包中的工程文件,最后参考API调用示例调用API。
获取SDK
旧版界面:登录ROMA Connect实例控制台,在“服务集成 APIC > API调用”的“SDK”页签中下载SDK。
新版界面:登录ROMA Connect实例控制台,在“服务集成 APIC > 凭据管理”的“SDKs”页签中下载SDK。
解压后目录结构如下:
名称 |
说明 |
---|---|
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示例
- 在工程中引入sdk。
using APIGATEWAY_SDK;
- 生成一个新的Signer, 输入API所授权凭据的Key和Secret,可参考获取API的调用信息获取。
Signer signer = new Signer(); // Directly writing AK/SK in code is risky. For security, encrypt your AK/SK and store them in the configuration file or environment variables. // In this example, the AK/SK are stored in environment variables for identity authentication. Before running this example, set environment variables HUAWEICLOUD_SDK_AK and HUAWEICLOUD_SDK_SK. signer.Key = Environment.GetEnvironmentVariable("HUAWEICLOUD_SDK_AK"); signer.Secret = Environment.GetEnvironmentVariable("HUAWEICLOUD_SDK_SK");
- 生成一个Request对象,指定方法名、请求url和body,可参考获取API的调用信息获取。
HttpRequest r = new HttpRequest("POST", new Uri("https://c967a237-cd6c-470e-906f-a8655461897e.apigw.exampleRegion.com/app1?query=value")); r.body = "{\"a\":1}";
- 给请求添加x-stage头,内容为环境名。如有需要,添加需要签名的其他头域。
r.headers.Add("x-stage", "RELEASE");
- 进行签名,执行此函数会生成一个新的HttpWebRequest,并在请求参数中添加用于签名的X-Sdk-Date头和Authorization头。
1
HttpWebRequest req = signer.Sign(r);
- 若使用系统分配的子域名访问https请求的API,需要忽略证书校验,否则跳过此步。
System.Net.ServicePointManager.ServerCertificateValidationCallback = new System.Net.Security.RemoteCertificateValidationCallback(delegate { return true; });
- 访问API,查看访问结果。
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());