Java SDK使用说明
1)搭建Java开发环境
您可以从Java官方网站下载对应的java开发工具包JDK进行安装,安装完成后可以对环境变量进行相应的配置;
2)安装Java SDK
i. 您可以从Apache Maven官网下载对应的Maven安装包,安装完成后可以对环境行相应的配置。
ii. 在选择服务和相应的开发语言后点击“SDK下载”按钮来下载SDK工具包。将下载的Java的SDK工具包进行解压,解压后如图所示。
此工具包集成了应用开发相关接口,核心是lib目录下的两个jar包,和demo目录下的调用示例。接口文档在“doc”目录下的md文件中,其中对各api接口的请求参数进行了详细的说明。
iii. 引入jar包至项目中
进入“lib“目录下,可以看到如图所示的两个jar包。使用sdk时,使用者需要将它们引入至开发项目的lib目录下。
安装开发工具后,如下所示,添加Maven依赖坐标至开发项目pom文件中。
<dependency>
<groupId>com.ctg.ag.sdk.biz</groupId>
<artifactId>sdkpackage</artifactId>
<scope>system</scope>
<version>1.0</version>
<systemPath>${pom.basedir}/lib/ag-sdk-biz-38430.tar.gz-20221202.181549-SNAPSHOT.jar</systemPath>
</dependency>
<dependency>
<groupId>com.ctg.ag.sdk.core</groupId>
<artifactId>sdkcore</artifactId>
<scope>system</scope>
<version>1.0</version>
<systemPath>${pom.basedir}/lib/ctg-ag-sdk-core-2.5.2-20221130.090742-4.jar</systemPath>
</dependency>
注:以上坐标供参考,具体以“lib”目录下jar包名称为准
3)调用SDK
根据您的需求(如HTTPS调用、异步调用、数据签名等),可以参考demo目录下的java调用示例,调用示例中给出了不同功能调用各个接口的代码示范,供使用者参考,或者直接引入自身的开发代码中。
以数据签名为例,appKey即您的App Key,appSecret为对应的App Secret,Appkey和AppSecret的获取请查看相关应用的详情界面。对于具体的请求参数,可以参考doc目录下的md文件。
应用接入域名地址:*.api.ctwing.cn客户级域名只支持https调用(*为租户id),TLS版本只支持1.2
public void testApiWithSignature() throws Exception {
AepDeviceCommandClient client = AepDeviceCommandClient.newClient().appKey("Your app key here").appSecret("Your app secret here").build();
{
QueryCommandListRequest request = new QueryCommandListRequest();
// request.setParam.. // set your request params here
request.setParamMasterKey("MasterKey");
request.setParamProductId("ProductId");
request.setParamDeviceId("DeviceId");
System.out.println(client.QueryCommandList(request));
}
client.shutdown();
}
如果您是专网用户,则需要您在调用的时候添加server地址,具体示例如下所示。其中,server为55.255.46.9:10000。
public void testApiWithSignature() throws Exception {
AepDeviceCommandClient client = AepDeviceCommandClient.newClient().appKey("Your app key here").appSecret("Your app secret here").server("55.255.46.9:10000").build();
{
QueryCommandListRequest request = new QueryCommandListRequest();
// request.setParam.. // set your request params here
request.setParamMasterKey("MasterKey");
request.setParamProductId("ProductId");
request.setParamDeviceId("DeviceId");
System.out.println(client.QueryCommandList(request));
}
client.shutdown();
}
注:如果调用SDK时出现报错,建议您参考在线文档中的API异常排查进行在线调试。