C# SDK使用说明
1)搭建C#开发环境
i. 安装.NET Framework 4.0及以上版本(如果您已安装,请忽略此步骤),另外,您也可以通过访问.NET官网进行下载安装;
ii. 安装Visual Studio 2010 及以上版本(如果您已安装,请忽略此步骤),另外,您也可以通过访问 Microsoft Visual Studio 官网进行下载安装;
2)调用C# SDK
i. 在选择服务和相应的开发语言后点击“SDK下载”按钮来下载SDK工具包。将下载的C#的SDK工具包进总解压,解压后如图所示。
此工具包集成了应用开发相关接口,核心是Apis目录下的.cs文件,和Demo目录下的调用示例。接口文档在“doc”目录下的md文件中,文档中对各api接口的请求参数进行了详细的说明;
ii. 将apis文件添加至项目中,然后根据您的需求,可以参考demo目录下的调用示例,调用示例中给出了不同功能调用各个接口的代码示范,供使用者参考,或者直接引入自身的开发代码中。
以查询设备列表为例,其所需的参数如下所示,其中appKey即您的App Key,appSecret为对应的App Secret,Appkey和AppSecret的获取请查看相关应用的详情界面。MasterKey和productId分别对应Master-APIkey和产品ID,可以从产品中心中的产品详情界面获取。其余的参数可以按照具体需求进行赋值。
public static string QueryDeviceList(string appKey, string appSecret, string MasterKey, string productId, string searchValue = "", string pageNow = "", string pageSize = "")
{
string path = "/aep_device_management/devices";
Dictionary<string, string> headers = new Dictionary<string, string>();
headers.Add("MasterKey", MasterKey);
Dictionary<string, string> param = new Dictionary<string, string>();
param.Add("productId", productId);
param.Add("searchValue", searchValue);
param.Add("pageNow", pageNow);
param.Add("pageSize", pageSize);
string version = "20190507012134";
string application = appKey;
string key = appSecret;
string response = AepHttpRequest.SendAepHttpRequest(path, headers, param, null, version, application, key, "GET");
if (response != null)
return response;
return null;
}
调用示例如下所示,供使用者参考,或者直接引入自身的开发代码中。
using AepSdk.Apis;
using System;
namespace AepSdk.Demo
{
class Aep_device_management_Demo
{
public static void Demo()
{
string result = null;
result = Aep_device_management.QueryDeviceList('appKey', 'appSecret', 'MasterKey', productId, searchValue, pageNow, pageSize);
Console.WriteLine("result = " + result);
}
}
}
注:如果调用SDK时出现报错,建议您参考在线文档中的API异常排查进行在线调试。
iii. 专网用户调用
如果您是专网用户,则需要您在调用时,修改baseUrl、timeUrl两处地址,位置为apis-core-AepSdkRequestSend.py文件,若专网地址为:55.255.46.9:10000,示例代码如下:
#!/usr/bin/python
# encoding=utf-8
import time
import datetime
import binascii
import base64
import json
#import urllib2
import urllib
import hmac
#import urlparse
from hashlib import sha1
import sys
offset = 0
lastGetOffsetTime = 0
baseUrl = 'http://55.255.46.9:10000'
timeUrl = 'http://55.255.46.9:10000/echo'
sdk = 'GIT: a4fb7fca'
Accept = 'gzip,deflate'
Content_Type = 'application/json; charset=UTF-8'
User_Agent = 'Telecom API Gateway Java SDK'