合作伙伴工作台
注册

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包,使用者需使用mvn install 命令加它们加入到本地maven仓库,由于ag-sdk依赖于ctg-ag-sdk-core,所以您需要先安装ctg-ag-sdk,具体操作如下:

在jar包所在目录中打开命令行,输入如下命令,命令中的“${SDK版本}”需替换为具体的jar包版本。例如,上图 jar包,其版本号为 “2.5.0-20200724.080449-26”,替换完成后执行,若执行结果出现”Build Success“字样,说明jar包注入成功。

mvn install:install-file -Dfile=ctg-ag-sdk-core-${SDK版本}.jar -DpomFile=ctg-ag-sdk-core-${SDK版本}.pom.xml


完成ctg-ag-sdk-core安装后,在相同目录下可以通过以下命令完成ag-sdk开发包的安装,命令中的“${SDK版本}”需替换为具体的jar包版本(如:44137.tar.gz-20201027.162343)。

若执行结果出现”Build Success“字样,说明jar包注入成功。

mvn org.apache.maven.plugins:maven-install-plugin:2.5.1:install-file -Dfile=ag-sdk-biz-${SDK版本}-SNAPSHOT.jar -DpomFile=ag-sdk-biz-${SDK版本}-SNAPSHOT.pom.xml


安装开发工具后,需要添加Maven依赖坐标至开发项目pom文件中。

<groupId>com.ctg.ag</groupId>
<artifactId>ctg-ag-sdk-core</artifactId>
<version>2.5.0-SNAPSHOT</version>
<groupId>com.ctg.ag</groupId>
<artifactId>ag-sdk-biz-44137.tar.gz</artifactId>
<version>20201027.162343-SNAPSHOT</version>


注:以上坐标供参考,具体以“lib”目录下的两个pom文件为准。

3)调用SDK

根据您的需求(如HTTPS调用、异步调用、数据签名等),可以参考demo目录下的java调用示例,调用示例中给出了不同功能调用各个接口的代码示范,供使用者参考,或者直接引入自身的开发代码中。

以数据签名为例,appKey即您的App Key,appSecret为对应的App Secret,Appkey和AppSecret的获取请查看相关应用的详情界面。对于具体的请求参数,可以参考doc目录下的md文件。

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异常排查进行在线调试。


这篇文档是否帮助您解决了问题?
如果您愿意进一步帮助我们改进文档 ,请留下您的联系方式。