HCP Platform OpenAPI Deployment & Online Debug

This document provides instructions for deploying and debugging the HCP platform OpenAPI. It covers installing the OpenAPI package, enabling the API in the HCP platform, creating a partner and getting credentials, and using the online debugger. It also points to demo projects that can be used for development.

Uploaded by

dma1

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

0% found this document useful (0 votes)

113 views7 pages

HCP Platform OpenAPI Deployment & Online Debug

Uploaded by

dma1

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

You are on page 1/ 7

HCP Platform OpenAPI Deployment & Online Debug

1、Installation
1.1 Get OpenAPI installation package
Because the HCP platform installation package is not the same as the OpenAPI installation
package, you need to get the OpenAPI installation package. First, the customer should
register a TPP account, https://tpp.hikvision.com/ After approval, please download the
OpenAPI installation package consistent with the HCP platform version. The download link is
https://tpp.hikvision.com/tpp/Resource

1.2 Install OpenAPI

After getting the installation package, install it on a Windows server or computer with one
click. OpenAPI and HCP platform can be installed on the same server or on different servers.
We recommend installing on the same server.
2、Online Debug
2.1 License
Please confirm HCP platform contains Third-Party Integration license. If not, please apply for
a license first.

2.2 Enable Open API

System Configuration - Third-Party Integration, enable Open API, and save.
Note: You can edit the IP and port only when you log in to the server where HCP is installed.

2.3. Login API web page

https://ip/artemis-web/ ,the ip is the address where OpenAPI is installed.
If you login to this page locally on the HCP server, you can use https://127.0.0.1/artemis-
web/ .
If you login to this page on another computer, please use the correct IP address.
You can see that there are 2 ways: (1) Debug (2) Login
Both methods can debug APIs, but you need to create partner first, then get APPkey and
APPsecret.
Therefore, please log in first. The user name is admin, and the default password is
admin@123 , you need to change password after first login.

2.4 Create Partner

Create a Partner

Set Partner Name and Description

Configure Authorization

Save

2.5 Get APPkey and APPsecret

2.6 Online Debug

After the partner is created, you can start online debugging.
Find the API you want to call from the API list, and then click "Online Debugging", such as Get
person information.
You can check the Request Body in the document.
3、Demo
We provide demo, which you can refer to when developing.
Demo Path：\HikCentral\VSM Servers\OpenAPI\HCVideoSDK

Please check the development documents of each demo.

If you want to use C # demo, please do first :

1、Copy all files in the path of “OpenAPI\HCVideoSDK\C++SDK\bin\win64” to
“OpenAPI\HCVideoSDK\C#SDK\bin\win64”
2、Copy all files in the path of “OpenAPI\HCVideoSDK\C++SDK\bin\win32” to
“OpenAPI\HCVideoSDK\C#SDK\bin\win32”
then , you can open C# demo.
You can use C # demo to test calling API、Live view、Playback、Two-way Audio、Event
Receiving.

C++ demo