hikopenapi-node/README.md

hikvision openapi for ifar/isee artemis rest service

# HIKOPENAPI-NODE
iSee/iFar Artemis Http Client Nodejs SDK


接口获取:[海康威视开放平台](https://open.hikvision.com)

GITHUB:https://github.com/qoddi/hikopenapi-node.git

适配ISC/PVIA等基于iSee/iFar架构的平台，基于OpenAPI 安全认证库封装了 HTTP/HTTPS 的 POST/GET 方法，提供nodejs下调 OpenAPI HTTP 接口统一的入口。OpenAPI 安全认证库屏蔽了 OpenAPI HTTP 接口签名细节以及重定向处理过程，降低对接OpenAPI 的复杂度，使用方只需引入即可方便快速的实现 HTTP 通信。 

## Support
适配windows x64环境与linux x64环境,已经测试通过的环境包括

1. 【windows 10 + nodejs v10.16.0】 
2. 【windows server 2016 + nodejs v10.16.0】 
3. 【CentOS-7.4-hik-r4 + nodejs v10.16.0】

平台需部署openapi网关后即可调用相关接口，appKey appSecret请联系海康工作人员获取，请求请使用https://portal_ip:443/artemis/

## Author
qoddi

email:moranran8023@gmail.com


## Installation

```bash
$ npm install hikopenapi-node
```

## Usage
### Windows
windows下安装部署即可直接使用，无需特殊配置，基于cpp认证库，提供post get put delete四种方法支持,返回data需要使用Base64解密
Example:
```js
const Hikopenapi=require('hikopenapi-node');

let requestUrl='https://123.123.123.123:443/artemis/api/video/v1/cameras/previewURLs';
let headers={"content-type":"application/json","accept":"application/json"};
let body=JSON.stringify({
    "cameraIndexCode":  "fsjdfkj2hkjsdhfkajhskdjahksdjahksjfhsf" ,
    "streamType":0,
    "protocol":"rtsp",
    "transmode":0,
    "expand":"transcode=0"});
let timeout=15;
let appKey='12345';
let appSecret='skjfhakjshdakjh12312jkhk';
//封装认证库POST方法
let httpRes=await Hikopenapi.httpPost(requestUrl,headers,body,appKey,appSecret,timeout);
console.log(httpRes); 　//{"status":true,error:0,data:""}

//封装认证库GET方法
let httpRes=await Hikopenapi.httpGet(requestUrl,headers,appKey,appSecret,timeout);
console.log(httpRes);　//{"status":true,error:0,data:""}

//封装认证库DELETE方法
let httpRes=await Hikopenapi.httpDelete(requestUrl,headers,appKey,appSecret,timeout);
console.log(httpRes);　//{"status":true,error:0,data:""}

//封装认证库PUT方法
let httpRes=await Hikopenapi.httpPut(requestUrl,headers,body,appKey,appSecret,timeout);
console.log(httpRes);　//{"status":true,error:0,data:""}
```


### Linux
linux下需要配置动态库的环境变量，基于c认证库，提供post get两种方法支持，返回data需要使用Base64解密，配置方法如下
1. 查找本模块的安装位置，拷贝目录下lib/linux/x64下全部文件到/root/openapilib文件夹(自行创建)
2. 编辑/etc/ld.so.conf,在最下面新增一行/root/openapiilib并保存退出
3. 执行ldconfig指令,使配置文件生效，然后就和windows一样使用了

Example:
```js
const Hikopenapi=require('hikopenapi-node');

let requestUrl='https://123.123.123.123:443/artemis/api/video/v1/cameras/previewURLs';
let headers={"content-type":"application/json","accept":"application/json"};
let body=JSON.stringify({
    "cameraIndexCode":  "fsjdfkj2hkjsdhfkajhskdjahksdjahksjfhsf" ,
    "streamType":0,
    "protocol":"rtsp",
    "transmode":0,
    "expand":"transcode=0"});
let timeout=15;
let appKey='12345';
let appSecret='skjfhakjshdakjh12312jkhk';
//封装认证库POST方法
let httpRes=await Hikopenapi.httpPost(requestUrl,headers,body,appKey,appSecret,timeout);
console.log(httpRes);　//{"status":true,error:0,data:""}

//封装认证库GET方法
let httpRes=await Hikopenapi.httpGet(requestUrl,headers,appKey,appSecret,timeout);
console.log(httpRes);　//{"status":true,error:0,data:""}
```

## Error Code
| 码值 | 信息 |
| :--------: | :---------------:|
| 0 | 无错误 | 
| 10000以下 | http状态 |
| 10001 | 参数错误 |
| 10002 | 分配session失败 |
| 10003 | 设置头域失败 |
| 10004 | 发起网络请求失败 |
| 10005 | 分配内存失败 |
| 10006 | 获取重定向Url失败 |
| 20000 | 其他错误 |
| 30000 | 加载动态库失败 |
| 30001 | 加载函数指针失败 |




## License

(The MIT License)