Invitation Message
×
You have new activity to register, click Details button to get more information. You can also click the Ignore button to ignore the reminder of this activity.
Device Open Capabilities
Hikvision opens various capabilities of AIoT device interfaces to ecosystem partners. Ecosystem partners can independently develop protocols to integrate with AIoT devices through device integration APIs or integrate with AIoT devices through device integration SDK libraries. Third-party partners can use the open interfaces to call device functions, meeting various business application requirements.
ISAPI
Device SDK
Device Gateway
  • Overview
  • General Function
  • Access Control
  • Traffic
  • Entrance & Exit Management
Overview

The HTTP protocol in RESTful-style, ISAPI is not bound by operating systems or programming languages and is suitable for network environments where "hardware and clients are in the same LAN or private network with fixed IP addresses" or "hardware or routers connected to hardware have fixed public IP addresses or domain names". It supports a variety of network hardware devices including general/intelligent cameras and NVRs, access control products, traffic products, intercom products, alarm products, thermal products, control products, and more.

3rd-Party Software/Platform
ISAPI
Device with fixed/accessible IP
General Function
General Function
Device Activation
Video, Audio, Picture Capture and Recording
Device Maingence
PTZ Control
User Management
Alarm/Event
Storage Management
Device Parameter Configuration
Access Control
Access Control
Person Management
Biometric Identification Management
Access Control Permission Management
Alarm/Event
Remote Door Control
Attendance Status and Schedule
Authentication Mode Configuration
Anti-Passing Configuration
Traffic
Traffic
Capture Trigger Mode Configuration
Traffic Data and Statistic
Blacklist/Whitelist Management
Alarm/Event
Entrance & Exit Management
E&E (ANPR)
Barrier Control
Passing Vehicle Data
Blacklist/Whitelist Management
Alarm/Event
  • OTAP SDK
  • USB SDK
  • Web SDK
OTAP SDK

The OTAP (Open Things Access Protocol) SDK is provided in the form of dynamic link libraries, including versions for Win32, Win64, Linux32, and Linux64. It is suitable for network environments where "hardware devices do not have fixed IP addresses." It will gradually support various network hardware devices, including general/intelligent camera and NVR products, access control products, traffic products, intercom products, alarm products, thermal products, transmission & display products, control products, and more. Its functional features include support for device registration, preview, playback, voice intercom, event reception, OTA upgrades, gateway and sub-device management, parameter configuration, etc.

USB SDK

The USB SDK developed based on the UVC protocol or HID protocol is provided in the form of dynamic link libraries, including versions for Win32, Win64, Linux64, and Android mobile systems. It supports Hikvision-related USB hardware devices.

Web SDK

The Web SDK provides the basic video-related functionalities such as preview, playback, and PTZ control on web pages by JavaScript. It is suitable for network environments where "hardware and clients are in the same LAN or private network with fixed IP addresses" or "hardware or routers connected to hardware have fixed public IP addresses or domain names."

For Web SDK Version 3.2 supports Google Chrome and Mozilla Firefox browsers but requires hardware device support for the WebSocket streaming protocol. Version 3.3 requires installation of the HCWebSDKPlugin control and supports Google Chrome version 57+ and Mozilla Firefox version 52+. It is recommended to use IE browser for integration with WEB3.2 development package, and for non-IE browsers, use the WEB3.3 development package.

The Device Gateway connects access control devices and encoding devices with third-party platforms for data transmission over LAN or WAN. You can add and manage ISUP-enabled encoding devices and ISUP5.0/ISAPI-enabled access control devices for integration with third-party platforms.

  • Overview
  • Application Management
  • Permission Management
  • Open Capabilities
  • Container Management
Overview
Application Management

Provides methods for installing, deploying, starting, stopping, and uninstalling third-party applications, monitors the running status of applications, and promptly restores applications in abnormal states. It also offers functions such as log export and resource management for applications.

Permission Management

Effectively controls the permissions required by third-party applications, allowing users to have a clear understanding of the resources used by applications to protect user privacy and device security.

Open Capabilities
System Services
Provides functions such as obtaining the unique hardware identifier of devices, obtaining the service capabilities supported by devices etc.
Hardware Capabilities
Provides APIs to operate the RS485 node, PTZ motion functions of devices, and other open hardware nodes.
Network Services
Provides third-party applications with externally open ports, NAT traversal, and other functions.
AI Inference Services
Opens the computing capabilities of devices to run algorithm packages generated by deep learning models.
Media Services
Provides APIs to support obtaining the pre-encoded YUV data of devices, the RTP stream of post-encoded data, JPEG images, etc.
Intelligent Analysis Services with Hikvision Applications
Provides APIs for third-party applications to access data generated by existing intelligent algorithms of Hikvision, implement more meaningful functions based on the data, and assist in packaging intelligent data generated by third-party applications, pushing it to upper-layer platforms via Hikvision protocols, ONVIF standard protocols, etc., reducing the workload of third-party developers.
Container Management

Resource isolation between all installed applications. To ensure the expected performance of third-party apps through installation-state and running-state resource verification.

  • What is OTAP
  • Why OTAP
  • OTAP Pull Mode
  • OTAP Push Mode
What is OTAP
Question:
Is there a protocol that can define standards for accessing Hikvision’s 2000+ types of IoT devices, and standardize and regulate the interfaces and message formats for communication?
What we expect:
A protocol able to define:
The IoT Data Standards: To categorize device capabilities and describe their functionalities using "events, attributes, and operations," including metadata definitions for functional interfaces and the organization of data formats.
The IoT Access Standards: To provide secure and open communication standards like MQTT(S)/HTTP(S) for bidirectional interfacing between devices and platforms, specifying the message formats and access processes for various IoT devices.
What is Open Things Access Protocol (OTAP)?
OTAP is the Open IoT protocol standard of Hikvision.
Core: Data standards + Access standards (Currently supported access standards: MQTT, HTTP(S), CoAP, Modbus, LoRa)
Main Concepts:
Data Standards Definition
Abstract Standard Model
Open Capbilities
IoT Standards: Define by Functionality
Cover
Device Category
Function Category
Function-nality
Device Model: Modeling By Standards
Device Model
Attribute
PTZ Parameter
Temperature from Sensor
Operation
Live View
PTZ Control
...
Event
Alarm
Exception
...
Vairous Product Lines Support
Integration: Decoupied Development
Application
Device Model
Device
Software Platform
UP: Standard OTAP Protocol
Down: Device SDK
Why OTAP
Why OTAP?
Pain Points:
IoT device integration is constrained by factors such as transmission distance, rate, power consumption, resources, and cost.
The absence of a unified transmission protocol standard limits comprehensive coverage of application scenarios in heterogeneous networks.
Effects:
Data standards for the same functionality vary across different transmission protocols in different product lines.
Customers are required to develop additional compatibility code when integrating different product lines.
How to Solve?
A unified protocol with unified data standards for the same functions across product lines.
Adaptable to various network transmission scenarios to meet diverse application needs.
Unified protocol, reducing maintenance costs
Provide only one standardized protocol for third-party integration
Provide extensibility for access protocols to support the connection of multiple devices or gateways, especially low-power or wireless products
ISUP
ISAPI
EZVIZ
OTAP
Security
Low coupling
Transmission Efficiency
Richness
Openness
Easy Development
Mutual authentication
Full data encryption
Adapt the same data standard with different access modes
Compressing data by more than 70%, reducing data usage and lowering device memory usage
Rapid development of new devices based on the existing 7000+ function definitions
Supports user-defined IoT data standards for devices
Offers a variety of development packages based on APIs or open-source SDKs
OTAP Pull Mode
OTAP Pull Mode
Similar as ISAPI
RESTFul Style API over HTTP(s):
5.3.1.1 Get Video Wall Parameters
Operation Name
Operation ID
Function Field
Get Video Wall Parameters
GetVideoWallPara
Video Wall Management (VideoWall)
Function URL
Request URL: POST
/iot/global/0-global/model/service/operate/VideoWall/GetVideoWallPara
Request Data
Example Message with Annotations:
{
"data":{
/*req, object, wall ID, range:[,], desc:*/
      "wallID": 1
      /*req, integer, wall ID, const:, enum:[], range:[1,6], multipleof:1, unit:,
desc:*/
      }
}
Differences with ISAPI
Key upgrade: OTAP supports the unification of the object model definition and the transmission framework.
Object model categorizes product functionality into three types: attributes, operations, and events. It can standardize the description of the functions supported by the device.
OTAP Push Mode
OTAP Push Mode
OTAP Push SDK (Software Development Kit for the PUSH communication protocol)
Push SDK is a protocol integration solution, connecting to device directly.
It doesn’t require any integration components or install any services.
The third-party server must have a static IP address and port.
Third-party Time & Attendance / Payroll
Hikvision Access Control Hardware
Push SDK (LAN/WAN)
DS-K1T341CMF
What Does OTAP PUSH Provide?
For Authentication Token or Events: MQTT+JSON
For Media Capabilities: webSocket
For Configuration: Over HTTP
Advantage:
Fewer mapping ports
Easier and more flexible for integration
Complies with protocol standards, supporting the integration of more third-party devices
Cross-platform support, more secure and transparent. Clients do not need to put (or only need to put a few) Hikvision private lib files on the server.
Application Open Capabilities
Hikvision adheres to the principle of using technology products as the foundation and customer empowerment as the core. With digital intelligence, Hikvision aims to enhance enterprise digital transformation and smart city construction. Hikvision offers intelligent application open platforms for edge node applications, edge domain applications, and cloud applications. These platforms support a wide range of intelligent application scenarios, empower industries, and facilitate application integration.
HikCentral Professional OpenAPI
Hik-Partner Pro OpenAPI
Hik-Connect Team OpenAPI
  • Common Application
  • Resource Management
  • Event and Alarm
  • Video Application
  • ANPR
  • Parking Lot Application
  • On-Board Monitoring
  • Digital Signage
  • Intelligent Analysis
Common Application

Get general information or general applications (e.g., platform service information), which might be related to multiple service applications.

Resource Management

Resource management includes APIs for full synchronization and search by condition of devices and servers (encoding device, access control device, recording server, Intelligent Analysis Server, streaming server, and on-board device), sites, areas, cameras, alarm inputs/outputs, access points, person information, and license plate information.

Event and Alarm

Event is a signal that resource (e.g., camera, device, server) sends when something occurs.
Capabilities provided:
1. Event subscription: You can subscribe to events by event type or cancel the subscription as needed.
2. Real-time event push: Callback addresses in both HTTP and HTTPS format are supported.
3. Event and alarm search / picture download: You can search for event and alarm records, and download relevant pictures.
4. Generic event rule and alarm configuration.

Video Application

The video application and development includes video monitoring, video analysis, and other
extension applications based on videos.
Capabilities provided:
1. Video streaming: Live view, playback, two-way audio, and video download.
2. PTZ Control: 3D operations (rotate camera, move focus, adjust focal length (zoom in/out),
enlarge/reduce iris), jumping to preset, and starting patrol.
3. Intelligent Recognition: Search for matched faces / human bodies.
4. Picture capture by camera.
5. Person/Vehicle Tag Search: Get the tags of the person/vehicle-detected videos recorded by cameras.

ANPR

The ANPR application provides the capability of vehicle recognition, including ANPR event upload, ANPR record search, and vehicle picture download.

Parking Lot Application

The parking lot application includes searching for vehicle passing records, searching for vehicle parking records, getting the real-time occupancy of parking spaces, getting the parking fee information, etc.

On-Board Monitoring

The on-board monitoring capability is about managing on-board monitoring devices, getting detailed information of GPS statistics, searching for event information of an on-board device, and searching for event records of on-board monitoring.

Digital Signage

You can upload dynamic materials of third-party data source, link them to a program, and push data by updating the data source. The digital signage capability is about searching for the data source, updating the data source, and batch updating data sources.

Intelligent Analysis

The intelligent analysis provides video application based intelligent analysis data including people counting and heat map statistics.

  • Overview
  • Site Management
  • Device Management
  • Events and Alarms
  • ARC Service
  • VSaaS Service
Overview

Hik-Partner Pro (HPP) provides partners with efficient device management/ARC services with OpenAPI.

Site Management

Site Management and Site Sharing Management.

Device Management

Device Management: Add, delete, edit and search devices, as well as configuring and operating devices.

Events and Alarms

Events refer to device online/offline events, reported events and alarms by devices, and inspected events from Hik-Partner Pro.

ARC Service

Get the list of devices with ARC service enabled, Disable the ARC service of devices, or get the site information of devices with ARC service enabled

VSaaS Service

VSaaS integration is mainly video-related functions, including live view, playback, video download, and two-way audio.

  • Overview
  • Resource Management
  • Subscribe to and Get Alarms
  • Live View / Playback
  • Person Management
  • Access Control
  • Video Intercom
  • On-Board Monitoring Management
Overview
Resource Management

Resource capabilities are about services concerning getting device information including area information, camera information, alarm information, etc.

Subscribe to and Get Alarms

Alarm capabilities are about services such as getting alarm rules, editing alarm rules, subscribing events, and getting alarm messages.

Live View / Playback

Video capabilities are about services including getting recording schedule templates and getting playback addresses.

Person Management

Person management capabilities include getting department list, adding/deleting persons, updating basic information of persons, viewing information of single person, searching for person list, collecting/updating fingerprints, collecting/updating cards, updating PIN code, updating face pictures, and fast adding persons.

Access Control

Access control capabilities include opening door remotely, getting Bluetooth encryption information, searching for card swiping records, and applying person's access level.

Video Intercom

Video intercom capabilities are about services including building/room management, resident management, temporary pass management, and call management.

On-Board Monitoring Management

On-board monitoring capabilities are about services including managing on-board devices and vehicles linked to on-board device, subscribe to and get alarms and messages, etc.

![](~/Content/Images/ui-loader-white-16x16.gif)