综合安防管理平台提供了OpenAPI安全认证库(Java)快速实现接口调用。
-
Java实现接口调用步骤如下:
-
新建Java工程,从Hikvision AI
Cloud开放平台网站(海康开放平台)上下载“OpenAPI安全认证库(Java)”,获取artemis-http-client.jar,导入到Java工程中。 -
设置认证信息,设置ArtemisConfig的host,appKey,appSecret。
-
设置接口URL。
-
设置接口入参。
-
接口调用,调用doPostStringArtemis方法(该方法内部实现了登入认证逻辑),传入接口URL,接口入参,数据提交类型等信息,完成接口调用。
OpenAPI 安全认证库 (JAVA)
下载路径:Hikvision AI Cloud开放平台网站(海康开放平台)
OpenAPI 安全认证库 (JAVA) V1.1.4 jar包下载地址:https://download.csdn.net/download/Lyq2017901206/87188700
源码如下:
package ddm.action;import java.io.InputStream;
import java.util.HashMap;
import java.util.Map;import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
import com.hikvision.artemis.sdk.ArtemisHttpUtil;
import com.hikvision.artemis.sdk.config.ArtemisConfig;public class ArtemisPostTest {/*** 请根据技术支持提供的实际的平台IP/端口和API网关中的合作方信息更换static静态块中的三个参数.* [1 host]* host格式为IP:Port,如10.0.0.1:443* 当使用https协议调用接口时,IP是平台(nginx)IP,Port是https协议的端口;* 当使用http协议调用接口时,IP是artemis服务的IP,Port是artemis服务的端口(默认9016)。* [2 appKey和appSecret]* 请按照技术支持提供的合作方Key和合作方Secret修改* appKey:合作方Key* appSecret:合作方Secret* 调用前请确认接口传入什么类型入参,是传入json就用doPostStringArtemis方法,是表单提交就用doPostFromArtemis方法**//*** API网关的后端服务上下文为:/artemis*/private static final String ARTEMIS_PATH = "/artemis";/*** 调用POST请求类型接口,这里以获取组织列表为例* 接口实际url:https://ip:port/artemis/api/resource/v1/org/orgList* @return*/public static String callPostStringApi() {/*** https://ip:port/artemis/api/resource/v1/org/advance/orgList* 通过查阅AI Cloud开放平台文档或网关门户的文档可以看到获取组织列表的接口定义,该接口为POST请求的Rest接口, 入参为JSON字符串,接口协议为https。* ArtemisHttpUtil工具类提供了doPostStringArtemis调用POST请求的方法,入参可传JSON字符串, 请阅读开发指南了解方法入参,没有的参数可传null*/ArtemisConfig config = new ArtemisConfig();config.setHost("192.25.10.58:443"); // 代理API网关nginx服务器ip端口config.setAppKey("254685412"); // 密钥appkeyconfig.setAppSecret("IOVFWC66OEREnw25KWRF7");// 密钥appSecretfinal String getCamsApi = ARTEMIS_PATH + "/api/visitor/v1/privilege/group";JSONObject paramMap = new JSONObject();// post请求参数paramMap.put("name", "123");paramMap.put("pageNo", 1);paramMap.put("pageSize", 10);String body = JSON.toJSON(paramMap).toString();Map<String, String> path = new HashMap<String, String>(2) {{put("https://", getCamsApi);}};String result = null;try {result = ArtemisHttpUtil.doPostStringArtemis(config, path, body, null, null, "application/json", null);} catch (Exception e) {e.printStackTrace();}return result;}public static void main(String[] args) throws Exception {String result = callPostStringApi();System.out.println(result);}}
1.调用申明
在提供的 artemis-http-client.jar 中,请调用 ArtemisHttpUtil.class 提供的函数来调用接口。
对应的 SDKjar 包是在 JDK1.8.0_66-b17 版本中编译 , 使用时请注意这一点 !
2.如何调用
在调用之前,首先要设置您的 appKey 、 appSecret 、 host 。
在您的代码要做如下设置:
ArtemisConfig.host ="10.33.59.196:443"; //artemis 网关服务器 ip 端口
ArtemisConfig.appKey ="24341259"; // 秘钥 appkey
ArtemisConfig.appSecret ="M5llsRpDovRZcB3WkhTk";// 秘钥 appSecret
在调用的过程中要注意调用接口的类型 , 按照对应的方法进行调用。
3.doGetArtemis(无 header 参数)
GET 接口请求 , 继承之前 doGetArtemis 方法 , 没有 header 参数 ;
4.参数介绍
① Path : artemis 配置的 get 请求的路径是一个数组长度为 1 的 Hashmap 集合,只存一组数据,key 为 http 的请求方式, value 为 host 后面的 path 路径。
② querys : map 类型 get 请求的 url 查询参数( url 中的 query 参数 , 没有就是为空)
形 如
"?aa=1&&bb=2"
形 式 参 数 变 成
map
键值对
query.put("aa","1");query.put("bb","2")
③ accept: 指定客户端能够接收的内容类型,该参数传空时的默认全部类型接受 ④ contentType: 请求的与实体对应的 MIME 信息,该参数传空时的取默认值。
访客功能接口
参数返回举例
测试接口返回举例
注意事项
在调用 application/json 类型的 post 的请求时 , 需要指定 cotentType 的类型 为”application/json”, 这个需要特别注意。
端口:默认443,可以询问技术人员端口号是多少,端口不对会报SSL解析错误 。
OpenAPI 安全认证库 (JAVA) V1.1.4 jar包下载地址:https://download.csdn.net/download/Lyq2017901206/87188700