OpenAPI安全认证库（C#）V1.0.1开发指南（海康威视Infovision IoT）.pdfVIP

OpenAPI 安全认证库（C# ）开发指南 1. 简介 1.1 前言 非常感谢您使用我们公司的产品，我们将竭诚为您提供最好的服务。 本手册可能包含技术上不准确的地方或文字错误。 本手册的内容将做定期的更新，恕不另行通知,更新的内容将会在本手册的新版本中加入。 我们随时会改进或更新本手册中描述的产品或程序。 当您阅读该开发手册时，同时应该拿到以下内容： 1.HttpUtillib （以下简称OpenAPI 安全认证库（C# ））开发包，包含导出库HttpUtillib.dll 以及使用说明文档。 2. 基于Visual Studio 2015 的HttpUtillib 源代码及其测试源代码。 1.2 OpenAPI 安全认证库 （C# ）简介 OpenAPI 安全认证库封装了HTTP/HTTPS 的POST 与GET 方法，提供C#调OpenAPI HTTP 接口统一 的入口。OpenAPI 安全认证库屏蔽了OpenAPI HTTP 接口签名细节，降低C#对接OpenAPI 的复杂度，使用 方只需引入OpenAPI 安全认证库（C# ）即可方便快速的实现HTTP 通信。 提供源代码，已使用Visual Studio 2015 以及.Net4.5.2 基于Any CPU 平台编译出HttpUtillib.dll ，位于bin 目录中，兼容32/64 位程序对接。 1.3 运行环境  支持Win7 、Win8 、Win10 32/64 位操作系统 1.4 更新说明 V1.0.1 1、修复无法适配.net core 问题。 2 、修复获取二进制数据且数据量较大时数据丢失问题。 V1.0.0 1、根据OpenAPI 安全认证协议，封装C#版本的HTTP/HTTPS 请求安全认证过程。 2. 接口定义 2.1 设置平台信息接口 接口名称： void SetPlatformInfo(string appkey, string secret, string ip, int port = 443, bool isHttps = true) 接口描述： 统一设置HTTP/HTTPS 请求的平台参数信息。 1 / 9 OpenAPI 安全认证库（C# ）开发指南 参数说明： [in] appkey：合作方APPKey [in] secret：合作方APPSecret [in] ip ：平台IP 地址 [in] port：平台端口，视现场环境、平台实际端口指定。如果是HTTP 协议，一般端口为80；如果是HTTPS 协议，一般端口为443，是使用HTTP 还是使用HTTPS 协议由isHttps 参数控制 [in] isHttps ：是否启用HTTPS 协议，true-使用HTTPS 协议 false-使用HTTP 协议，使用HTTP 还是HTTPS 协议需视现场环境以及平台配置决定 返回值： 无。 备注： 使用其它接口之前需要通过此接口设置平台信息。 示例 （使用HTTPS 协议）： 详见基于OpenAPI 安全认证库（C# ）接口的使用示例。 2.2 POST 请求接口 接口名称： byte[] HttpPost(string uri, string body, int timeout) 接口描述： 封装HTTP/HTTPS POST 请求，提供POST 请求统一入口。 参数说明： [in] uri ：POST 请求的URI，如/artemis/api/vms/v1/videoParam [in] body：POST 请求体 [in] timeout ：请求超时时间，单位：秒 返回值： 返回字节数组的响应。 备注： 返回值是byte[]数组，OpenAPI 接口的实际返回值有两种情况： 1、请求返回json 字符串，此时将字节数组转换成json 字符串即可，详细方法可参考示例代码。 2 、请求返回字节流，根据OpenAPI 接口的实际业务逻辑进行处理，如果是图片流，可直接将byte[]数组存 成图片文件。 如何判断返回值是以上两种情况中的哪种： 建议先将byte[]直接转换成json 字符串，如果抛出异常，则认为返回的是字节流，详细方法可参考示例代码。 uri 标识的接口是否可能返回字节流，请前往/docs 软件产品选择具体使用的产品， 在API 列表找到具体的接口，查看接口说明。 2 / 9 OpenAPI 安全认证库（C#