Open Capabilities

Openness Overview

Hik-Connect OpenAPI

The Hik-Connect OpenAPI is an API platform that comes with the Hik-Connect service. Partners will find abundant functionality when they want to design and integrate their own application with welcome flexibility. Hikvision designed OpenAPI with ease of use (RESTful API) and security in mind, and will help users build an integrated solution with Hikvision hardware easily and securely.

Developer Tools (OpenAPI)：

OpenAPI Developer Guide Document

WASM (JSDecoder) Develop Kit

Develop Progress:

Sign up for a Hik-Connect account on the Hik-Connect website.

Provide registered Hik-Connect email address to Hikvision for API Key application.

Register at tpp.hikvision.com, and upon approval, go to Download/Hik-Connect to download the OpenAPI developer tools.

Ready to develop!

01

Sign up for a Hik-Connect account on the Hik-Connect website.

02

Provide registered Hik-Connect email address to Hikvision for API Key application

03

Register at tpp.hikvision.com, and upon approval, go to Download/Hik-Connect to download the OpenAPI developer tools.

04

Ready to develop!

Device Management:

CURD CCTV Devices & Areas

Get specified device detail information

Get Alarms & Events:

Such as field detection, line crossing, motion detection, device online/offline, etc.

Streaming:

WAMS (JSDecoder) for partners to get streaming (live view, playback) in web browser easily.

* Playback from Local Storage or Cloud Storage.

Alarms and Video Rules:

Get and modify Alarm & Video related information from Hik-Connect.

1. Quick and Easy Integration

Easy-to-use REST API

WASM (JSDecoder) Develop Kit for Web non-plugin solution

2. Plug-and-Play Connectivity

Thanks to P2P Technology, Hikvision devices can connect to your cloud in seconds. No need for port mapping or configuring static IP address for devices

3. Cost-Effective Solution

No need to deploy streaming media server, video storage server, or expanded bandwidth on your cloud; Hik-Connect provides all services

No additional fees for OpenAPI license

4. Hik-Connect as a powerful tool

End Users/SIs can use Hik-Connect to configure alarm rules, manage devices, maintain system, etc.

5. Go to Market via Hikvision Channel

Release a joint-value solution on the Hikvision Technology Partner Portal: tpp.hikvision.com, Hikvision customers will see your solution

Hik-Connect Team Business Open Capabilities

Struggling with security management at one, or across multiple locations? Fed up with limited on-premises access control?

If so, give Hik-Connect for Teams a try. Designed for more demanding business settings, it caters to various multi-user management scenarios from offices to chain stores and communities.

Learn more about Hik-Connect for Teams

Integration Architecture

Hik-Connect Portal & App

Enterprise Customer

Boss/Manager

Operator

Using Hik-Connect portal or app:

Device management, role & user management, area management, etc.

Live view, playback, alarm, recording backup, recording download and maintenance, etc.

Alarm, Event, etc.

Partners

Partner app

Systems from SIs or Enterprise Customers mainly, who want to manage alarm/event in an unified system and needs cloud-based video monitoring.

What partners can do via OpenAPI:

Video verification for alarms/events

P2P Connection with Hikvision CCTV

Continuous live view or playback in partner’s web application (non-plugin)

...

Integration Architecture

Step 1:

1.

Register at tpp.hikvision.com.

2.

Download OpenAPI Doc/Demo from tpp.hikvision.com -> Download.

3.

Register Hik-Connect account, create Team Mode, and apply for AK/SK from Hikvision.

Step 2 (Hik-Connect Team Portal, manually):

1.

Activate, add devices to Hik-Connect Team manually, configure vehicle information.

2.

Configure Fence, Deviation, Over Speed, Panic Alarm, Driver Behavior Alarm… in Hik-Connect Team.

3.

Configure alarm recording linkage actions in Hik-Connect Team.

Step 3 (OpenAPI):

1.

Subscribe alarm/event including panic alarm, GPS data, overspeed alarm, DBA… from Hik-Connect Team.

2.

Get area and linkage rule information.

3.

Possible to do snapshot via OpenAPI.

4.

Possible to control IO via OpenAPI.

Partner's Application

Step 4:

1.

Partner dispatch alarm to different clients by themselves

Step 5 (OpenAPI):

1.

Follow JSDecoder (Web non-plugin solution for live view and playback) development.

2.

Start two-way audio.

3.

Show alarm/event/GPS data here.

4.

Download standard MP4.

Step 5 (OpenAPI):

1.

Receive and check the alarm.

2.

See GPS data tracking in real time.

Integration Architecture

License:

Hik-Connect Team will license number of rooms added in Hik-Connect Team.

Property Manager / Hik Installer

Hik-Connect Portal

Step 1:

Add community, building, room, device, access level to Hik-Connect Team manually.

Step 2 (Partner):

1.

Apply for AK/SK from Hikvision using Hik-Connect Team account for property managers.

2.

Get community, building, room, device, access level list and CRUD residents (including cellphone device ID) to certain devices via OpenAPI. This step configures residents permission.

3.

Subscribe intercom events, like calling events. We will transfer these calling events to end user app via VoIP (Apple/Google).

Step 3 (Partner):

1.

Via OpenAPI and Hikvision UIKit (WASM) to answer the intercom call, live view, two-way audio, remote open, etc.

2.

Use QR code to open the door for visitors.

3.

Get Bluetooth from Hik-Connect Team via OpenAPI, using Bluetooth SDK in cellphone to generate Bluetooth key to open door on-site.

3rd-Party Intercom/Property Management System

Integration Architecture

Application Layer

T&A and ACS

Cloud Layer

Device Layer

HRMS

3rd-Party Payroll

3rd-Party T&A and ACS System

Access Control

Export TXT, CSV file on Hik-Connect Platform

Hik-Connect Team OpenAPI for Integration

OpenAPI Integration:

Person and biometric identification management

Get real-time events or search for historical events

Remote door control

Search for time attendance data

Configuration on Portal:

Add/set devices

Attendance rule management

Alarm configuration

Preparations:

Register on Hik-Connect Portal and apply for the Team Mode

Purchase a General License

Provide your registered Hik-Connect email address to Hikvision for Appkey application

Register on tpp.Hikvision.com and check the Hik-Connect Team OpenAPI Developer Guide

Capabilities

Reliable Services

Hik-Connect brings reliable services from data security to professional support

Data encryption

HTTPS/TLS AES /RSA P2P technology

HTTPS / TLSAES / RSAP2P technology
Certifications

Multiple industry-leading standards and protocols
High-level cloud services

World-class AWS cloud service, reliable and stable
No server failures

Cloud-based deployment removes friction involved in setting up and maintaining on-site VMS systems
Professional support

Professional Hikvision teams provide customers with real-time technical consultation

What Is Hik-Connect?

Main Benefits

Open Capabilities

Openness Overview

Hik-Connect OpenAPI

Developer Tools (OpenAPI)：

Develop Progress:

Device Management:

Get Alarms & Events:

Streaming:

Alarms and Video Rules:

1. Quick and Easy Integration

2. Plug-and-Play Connectivity

3. Cost-Effective Solution

4. Hik-Connect as a powerful tool

5. Go to Market via Hikvision Channel

Hik-Connect Team Business Open Capabilities

Reliable Services

Hik-Connect brings reliable services from data security to professional support

Data encryption

Certifications

High-level cloud services

No server failures

Professional support