La API de HikConnect Teams es una interfaz de programación que permite a desarrolladores e integradores interactuar con la plataforma de video vigilancia y control de acceso de Hikvision.
Esta API brinda acceso a una amplia gama de funcionalidades, desde la gestión de dispositivos y áreas hasta el control de alarmas, video en vivo, intercomunicación y control de acceso.
Características principales:
Gestión de dispositivos: Agregar, actualizar, obtener y eliminar dispositivos de la plataforma.
Gestión de áreas: Crear, obtener y gestionar áreas lógicas para organizar dispositivos y recursos.
Gestión de alarmas: Configurar reglas de alarma, obtener logs y suscribirse a eventos de alarma en tiempo real.
Transmisión de video: Obtener URLs para reproducir video en vivo o grabado desde cámaras.
Intercomunicación: Gestionar edificios, habitaciones, residentes y llamadas de intercomunicación.
Control de acceso: Abrir puertas remotamente, gestionar tarjetas, niveles de acceso y eventos.
Gestión de personas: Administrar información de personas, huellas digitales, tarjetas y fotos.
Monitoreo a bordo: Agregar y gestionar vehículos y dispositivos móviles.
Tiempo y asistencia: Obtener reportes de tiempo total registrado por tarjetas.
Para utilizar la API, primero es necesario obtener las claves appKey y secretKey llenando la siguiente solicitud:
Una vez obtenidas las claves, se puede autenticar y obtener un token de acceso para consumir los diversos endpoints.
Para mayor información, consulte el documento completo dando clic aquí:
1 Servicios relacionados con el sistema.
1.1 Obtener token
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/platform/v1/token/get' \
--header 'Content-Type: application/json' \
--data '{
"appKey": "APPKEY",
"secretKey": "SECRETKEY"
}'
1.2 Operación del sistema
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/platform/v1/systemproperties' \
--header 'Token: ACCESSTOKEN' \
--data ''
1.3 Paquete de servicios
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/platform/v1/servicepackage' \
--header 'Token: ACCESSTOKEN' \
--data ''
1.4 Obtener token de streaming
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/platform/v1/streamtoken/get' \
--header 'Token: ACCESSTOKEN' \
--data ''
1.5 Obtener usuarios del sistema
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/platform/v1/users/get' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"pageIndex": 1,
"pageSize": 50
}'
2 Servicios relacionados con recursos
2.1 Recursos físicos
2.1.1 Información del dispositivo
2.1.1.1 Agregar
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/resource/v1/devices/add' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"deviceCategory": "encodingDevice",
"deviceInfo": {
"name": "ceshi",
"ezvizSerialNo": "G81652987",
"ezvizVerifyCode": "hcc12345",
"userName": "",
"password": "",
"streamSecretKey": ""
},
"importToArea": {
"areaID": "",
"enable": "0"
},
"timeZone": {
"id": "26",
"applyToDevice": "1"
}
}'
2.1.1.2 Actualizar
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/resource/v1/devices/update' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"deviceInfo": {
"id": "4606458718594636bb0487029f759684",
"name": "NVR_test221",
"userName": "admin",
"password": "Abc12345"
},
"timeZone": {
"id": "19",
"applyToDevice": "1"
}
}'
2.1.1.3 Obtener lista
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/resource/v1/devices/get' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"pageIndex": 1,
"pageSize": 500
}'
2.1.1.4 Obtener detalle
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/resource/v1/devicedetail/get' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"deviceSerialNo": "F74021782"
}'
2.1.1.5 Eliminar
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/resource/v1/devices/delete' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"deviceID": [
"4ab20c2f3ba54daea4e0f569b622c362"
],
"deviceCategory": "encodingDevice"
}'
2.1.1.6 Tomar captura de canal de video
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/resource/v1/device/capturePic' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"deviceSerial": "F68147103",
"channelNo": 1
}'
2.1.1.7 Sincronizar estatus
curl --location --request POST 'https://ius.hikcentralconnect.com/api/hccgw/resource/v1/device/DEVICEID/refresh' \
--header 'Token: ACCESSTOKEN' \
--data ''
2.1.2 Recursos lógicos
2.1.2.1 Áreas
2.1.2.1.1 Agregar
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/resource/v1/areas/add' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"parentAreaID": "-1",
"areaName": "Area de prueba"
}'
2.1.2.1.2 Obtener
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/resource/v1/areas/get' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"pageIndex": "1",
"pageSize": "10",
"filter": {
"parentAreaID": "-1",
"includeSubArea": 1
}
}'
2.1.2.1.3 Obtener detalles
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/resource/v1/areadetail/get' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"areaID":[
"0bc6b13de8e24fb3a131fe8eb42613a5",
"97d8f5a7905e46a78916ea63057020b9"
]
}'
2.1.2.2 Cámaras y entradas/salidas de alarma
2.1.2.2.1 Agregar
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/resource/v1/areadetail/get' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"areaID":[
"0bc6b13de8e24fb3a131fe8eb42613a5",
"97d8f5a7905e46a78916ea63057020b9"
]
}'
2.1.2.2.2 Eliminar
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/resource/v1/areas/resources/delete' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"ids": [
"1d3797d6f5c84b4c9720f2d1453b3516"
]
}'
2.1.2.2.3 Obtener lista de cámaras
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/resource/v1/areas/cameras/get' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"pageIndex": "1",
"pageSize": "10",
"filter": {
"areaID": "-1",
"includeSubArea": "1",
"deviceID": "",
"deviceSerialNo": "",
"cameraID": [
"ba1e16a1f1084a93a7dc72b21609c380",
"b6ddbebb36584a51858edbba30c7283c"
]
}
}'
2.1.2.2.4 Obtener lista de salidas de alarma
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/resource/v1/areas/alarmoutputs/get' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"pageIndex": "1",
"pageSize": "10",
"filter": {
"areaID": "-1",
"includeSubArea": "1",
"deviceID": "",
"deviceSerialNo": ""
}
}'
2.1.2.2.5 Obtener lista de entradas de alarma
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/resource/v1/areas/alarminputs/get' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"pageIndex": "1",
"pageSize": "10",
"filter": {
"areaID": "-1",
"includeSubArea": "1",
"deviceID": "",
"deviceSerialNo": ""
}
}'
2.1.2.2.6 Obtener estatus de entradas de alarma
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/resource/v1/areas/alarminputs/status/get' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"alarmInputID": [
"2c0a4ab9a2504de4842d95435f3a8620",
"b35b8e9a9326418ca2198ed45709b5bd"
]
}'
2.1.2.2.7 Controlar salida alarma
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/resource/v1/areas/alarmoutputs/control' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"alarmOutputOperation": [
{
"alarmOutputID": "b58a0172ab504c9f98060456a3c7069f",
"operation": 1
}
]
}'
2.1.2.2.8 Obtener estatus de salidas de alarma
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/resource/v1/areas/alarmoutputs/status/get' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"alarmOutputID": [
"b58a0172ab504c9f98060456a3c7069f"
]
}'
2.1.2.2.9 Obtener miniatura de cámara
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/resource/v1/areas/cameras/thumbnail/get' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"cameraID": "ba1e16a1f1084a93a7dc72b21609c380",
"refresh": 1
}'
2.1.2.3 Puertas
2.1.2.3.1 Obtener lista de puertas
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/resource/v1/areas/doors/get' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"pageIndex": 1,
"pageSize": 10,
"filter": {
"areaID": "-1",
"includeSubArea": "1",
"deviceID": "",
"deviceSerialNo": ""
}
}'
2.1.2.4 Zona horaria
2.1.2.4.1 Obtener lista de zonas horarias
curl --location --request POST 'https://ius.hikcentralconnect.com/api/hccgw/resource/v1/timezone/get' \
--header 'Token: ACCESSTOKEN'
3 Servicios relacionados con alarmas
3.1 Suscripción de alarmas
3.1.1 Suscribir a alarma
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/alarm/v1/mq/suscribe' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"subscribeType": 1,
"subscribeMode": 1,
"eventType": [
0,
1
]
}'
3.1.2 Obtener información de alarma
curl --location --request POST 'https://ius.hikcentralconnect.com/api/hccgw/alarm/v1/mq/messages' \
--header 'Token: ACCESSTOKEN' \
--data ''
3.1.3 Confirmar alarma
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/alarm/v1/mq/messages/complete' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"batchId": "5a32fddc6f5c01e067f7abdfe5348a6c98f64d1fe196b9d54c45b01b50a3a7b5946dbcd91f0a6eca6ec6cddf4511a78f"
}'
3.2 Regla de alarmas
3.2.1 Configurar reglas
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/alarm/v1/' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"alarmRule": [
{
"name": "fjx-test",
"color": "#ff0000",
"alarmMainCategory": "alarmCategoryVideo",
"alarmSubCategory": "alarmSubCategoryCamera",
"description": "fjx-test",
"enable": 1,
"priority": {
"id": "2f87acf0985e431d852bbaed10aba040"
},
"notification": {
"enable": 1,
"recipients": [
{
"userID": "0985e4310985e431d852bbad852bba",
"userName": "hccdd2 uat6"
}
]
},
"schedule": {
"type": "1",
"timeSchedule": {
"id": "161a03299fd94914b89accdf0844b0e6"
}
},
"ignoreRecurring": {
"enable": "1",
"timeValue": "15"
},
"eventSource": {
"sourceType": "camera",
"eventType": 10102,
"sourceID": "6a95b98ae34e4eac88f3af8a286bf47c",
"sourceName": "5546G0_191 Camera 01"
}
}
]
}'
3.2.2 Obtener lista de reglas
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/alarm/v1/alarmrules/get' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"pageIndex": "1",
"pageSize": "10",
"filter": {}
}'
3.2.3 Editar alarmas
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/alarm/v1/alarmrules/update' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"alarmRule": [
{
"id": "1542072136028524544",
"name": "Camera 01-Motion Detection",
"color": "#ff0000",
"enable": 1,
"state": "0",
"alarmMainCategory": "alarmCategoryVideo",
"alarmSubCategory": "alarmSubCategoryCamera",
"notification": {
"enable": 1,
"recipients": [
{
"userID": "8a7489d68161eaf9018161f84bb70004",
"userName": "abc abc"
},
{
"userID": "8a748b3181a510aa0181a53fef2e1210",
"userName": "lmk lmk"
}
]
},
"schedule": {
"timeSchedule": {
"id": "8a748e7681618fea018161f847d70000",
"name": ""
},
"type": "1"
},
"priority": {
"id": "0db8cd1c85324e27a1f36c4f5a66e18",
"level": "1",
"levelName": "",
"color": "#F40B0B"
},
"ignoreRecurring": {
"enable": 0,
"timeValue": 15
},
"eventSource": {
"eventType": 10002,
"sourceID": "a1afc31e55af4960900fa6498d67399d",
"sourceType": "camera",
"sourceName": "Camera 01"
}
}
]
}'
3.2.4 Obtener lista de prioridad de alarmas
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/alarm/v1/alarmpriorities/get' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"pageIndex": "1",
"pageSize": "10"
}'
3.2.5 Obtener lista de plantillas de programación de armado de alarmas
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/alarm/v1/receivingschedules/get' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"pageIndex": "1",
"pageSize": "10"
}'
3.2.6 Configurar enlaces de alarma
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/alarm/v1/alarmlinkage/add' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"alarmLinkage": [
{
"alarmRuleID": "30a3f5b30a3f5b6975fa6975fa",
"linkageItem": [
{
"linkageType": "LinkCamera",
"linkageConfig": {
"linkCamera": {
"preRecordTime": 3,
"postRecordTime": 15,
"camera": [
{
"id": "21f84da3f9604a30a3f5b6975fa0f38a",
"name": "5546G0_191 Camera 01",
"areaID": "450ac442bf4e4daf9f04e1af1bc90be7",
"areaName": "_2022-05-07T201804_0"
}
]
}
}
},
{
"linkageType": "LinkCapturePicture",
"linkageConfig": {
"linkCapturePicture": {
"captureInterval": 3,
"captureMode": 2,
"camera": [
{
"resourceType": "1001",
"id": "21f84da3f9604a30a3f5b6975fa0f38a",
"name": "5546G0_191 Camera 01",
"areaID": "450ac442bf4e4daf9f04e1af1bc90be7",
"areaName": "_2022-05-07T201804_0"
}
]
}
}
},
{
"linkageType": "LinkAlarmOutput",
"linkageConfig": {
"linkAlarmOutput": {
"autoClose": 0,
"autoCloseTime": 15,
"alarmOutput": [
{
"id": "d5418485784b44f79b52e24a64bf2574",
"name": "A 2",
"areaID": "1b65a68be27d41be9f2ed7ddc7045276",
"areaName": "111"
}
]
}
}
},
{
"linkageType": "LinkEMail",
"linkageConfig": {
"linkEmail": {
"emailTemplateId": "8a748675809d8e3901809d9c57370000",
"emailTemplateName": "test22"
}
}
}
]
}
]
}'
3.2.7 Obtener logs de alarma
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/alarm/v1/alarmlog' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"pageIndex": 1,
"pageSize": 5,
"timeRange": {
"beginTime": "2023-04-23 00:00:00",
"endTime": "2023-04-24 00:00:00"
},
"areaID": "565623256767",
"eventTypeList": [
"10061",
"10657"
]
}'
4 Servicios relacionados con mensajes
4.1 Suscripción y recepción de mensajes
4.1.1 Suscribirse a mensajes
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/rawmsg/v1/mq/subscribe' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"subscribeType": 1,
"msgType": [
"Msg330001",
"Msg330002"
]
}'
4.1.2 Obtener mensajes manualmente
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/rawmsg/v1/mq/messages/complete' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"batchId": "4075e8d16a4b4ce63dabebcdba3cd37e83b65a13edd5b4d34343ef595ab6b5a7946a86e61d086cc86cc4cfdd4713a58d"
}'
4.1.3 Confirmar mensaje
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/rawmsg/v1/mq/messages/complete' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"batchId": "4075e8d16a4b4ce63dabebcdba3cd37e83b65a13edd5b4d34343ef595ab6b5a7946a86e61d086cc86cc4cfdd4713a58d"
}'
5 Servicios relacionados con video
5.1 Calendarios de grabación y reproducción
5.1.1 Obtener calendarios de grabación
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/video/v1/recordsettings/get' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"cameraId": [
"2aeec98c14a4427f9ace6c48e91ab4cc"
]
}'
5.1.2 Obtener url para video en vivo/grabacion
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/video/v1/live/address/get' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"type": "1",
"code": "1111qqqq",
"deviceSerial": "G99131454",
"resourceId": "b2f3f6ce0a954045ba77a6acfe8dd89e"
}'
6 Servicios relacionados con video intercom
6.1 Edificios y habitaciones
6.1.1 Buscar edificio
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/vims/v1/build/search' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"pageNum": 1,
"pageSize": 64,
"searchCriteria": {
"areaId": "-1",
"isContainSubArea": 1,
"filterName": ""
}
}'
6.1.2 Buscar habitación
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/vims/v1/room/search' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"pageNum": 1,
"pageSize": 64,
"searchCriteria": {
"areaId": "-1",
"buildId": "",
"isContainSubArea": 1,
"filter": {
"roomNum": "",
"roomName": "",
"personAmount": "",
"email": "",
"mainAccount": ""
}
}
}'
6.2 Protocolo de transmisión ISAPI
6.2.1 Transmitir ISAPI transparentemente
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/video/v1/isapi/proxypass' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"method": "GET",
"url": "/ISAPI/PTZCtrl/channels/2/presets/1",
"id": "98234fc2334b0897fadd",
"contentType": "application/xml",
"body": ""
}'
6.3 Residentes
6.3.1 Buscar residentes
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/vims/v1/person/search' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"pageNum": 0,
"pageSize": 0,
"searchRequest": {
"areaId": "",
"buildId": "",
"isContainSubArea": 0,
"filter": {
"name": "",
"roomNum": 0,
"email": "",
"phone": "",
"type": 0,
"isExpired": 0
}
}
}'
6.3.2 Agregar residente
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/vims/v1/person/add' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"personBaseInfo": {
"id": "",
"personCode": "",
"groupId": "",
"firstName": "",
"lastName": "",
"gender": 0,
"phone": "",
"email": "",
"description": "",
"startDate": "",
"endDate": ""
},
"alIds": [
""
],
"roomList": [
{
"roomId": "",
"roomNum": 0,
"buildId": "",
"buildName": "",
"areaId": "",
"areaName": "",
"accountType": 0
}
],
"language": ""
}'
6.3.3 Actualizar residente
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/vims/v1/person/update' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"personBaseInfo": {
"id": "",
"personCode": "",
"groupId": "",
"firstName": "",
"lastName": "",
"gender": 0,
"phone": "",
"email": "",
"description": "",
"startDate": "",
"endDate": ""
},
"alIds": [
""
],
"roomList": [
{
"roomId": "",
"roomNum": 0,
"buildId": "",
"buildName": "",
"areaId": "",
"areaName": "",
"accountType": 0
}
],
"language": ""
}'
6.3.4 Eliminar residente
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/vims/v1/person/delete' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"deleteList": [
"string1"
]
}'
6.4 Pases temporales
6.4.1 Ver pases temporales
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/vims/v1/tempauth/get' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"id": "237160983473358848",
"clientLocalTime": "2022-10-28T11:08:23-06:00"
}'
6.4.2 Buscar pases temporales
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/vims/v1/tempauth/get' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"id": "237160983473358848",
"clientLocalTime": "2022-10-28T11:08:23-06:00"
}'
6.4.3 Crear pases temporales
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/vims/v1/tempauth/add' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"name": "",
"openCount": 0,
"startTime": "",
"endTime": "",
"clientLocalTime": "",
"alIds": [
""
]
}'
6.4.4 Actualizar pase temporal
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/vims/v1/tempauth/update' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"id": "",
"name": "",
"openCount": 0,
"startTime": "",
"endTime": "",
"clientLocalTime": "",
"alIds": [
""
]
}'
6.4.5 Eliminar pase temporal
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/vims/v1/tempauth/delete' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"deleteList": [
"string1"
]
}'
6.5 Llamadas video intercom
6.5.1 Responder llamadas
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/devcall/v1/call/receive' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"recordId": "",
"userId": "",
"status": "2"
}'
7 Servicios relacionados con control de acceso
7.1 Abrir puerta remotamente
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/acs/v1/remote/control' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"remoteControl": {
"actionType": 0,
"elementlist": [
""
],
"direction": 0,
"areaId": "",
"depthTraversal": 0
}
}'
7.2 Obtener llave de encriptación bluetooth
curl --location --request POST 'https://ius.hikcentralconnect.com/api/hccgw/acs/v1/encryptinfo/get' \
--header 'Token: ACCESSTOKEN'
7.3 Buscar registros de tarjetas
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/acs/v1/event/certificaterecords/search' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"pageIndex": 1,
"pageSize": 20
}'
7.4 Obtener niveles de acceso
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/acspm/v1/accesslevel/list' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"accessLevelSearchRequest": {
"pageIndex": 1,
"pageSize": 20,
"searchCriteria": {
"accessLevelName": "",
"associateResInfoList": []
}
}
}'
7.5 Obtener niveles de acceso de usuario
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/acspm/v1/maintain/overview/person/PERSONID/elementdetail' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"returnSuccess": false
}'
7.6 Agregar nivel de acceso a persona
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/acspm/v1/accesslevel/person/add' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"personList": [
{
"personId": "aaaa",
"accessLevelIdList": [
"222",
"333"
]
}
]
}'
7.7 Quitar nivel de acceso a persona
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/acspm/v1/accesslevel/person/delete' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"personList": [
{
"personId": "aaaa",
"deleteAll": false,
"accessLevelIdList": [
"222",
"333"
]
}
]
}'
7.8 Actualizar nivel de acceso a persona
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/acspm/v1/accesslevel/person/modify' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"personList": [
{
"personId": "aaaa",
"deleteAll": false,
"accessLevelIdList": [
"222",
"333"
]
}
]
}'
8 Servicios relacionados con personas
8.1 Obtener lista de departamentos
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/person/v1/groups/search' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"parentGroupId": "",
"groupName": "",
"depthTraversal": "",
"groupIdList": [
"111"
]
}'
8.2 Agregar persona
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/person/v1/persons/add' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
"groupId": "378117915440051200",
"firstName": "test",
"lastName": "",
"gender": 2,
"personCode": "odhdf888",
"phone": "110",
"email": "[email protected]",
"description": "",
"startDate": "2022-02-21T20:12:45+08:00",
"endDate": "2032-02-21T20:12:45+08:00"
}'
8.3 Actualizar persona
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/person/v1/persons/update' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
"groupId": "1",
"firstName": "test1",
"lastName": "test12",
"gender": 2,
"phone": "110",
"email": "[email protected]",
"startDate": "2022-02-21T20:12:45+08:00",
"endDate": "2032-02-21T20:12:45+08:00",
"personCode": "odhdf888",
"personId": "399996371484193792"
}'
8.4 Actualizar foto de persona
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/person/v1/persons/photo' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"personId": "381019761745728512",
"photoData": "ddd"
}'
8.5 Recolectar huellas
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/person/v1/persons/fingercollect' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"deviceSerial": "378117915440051200"
}'
8.6 Actualizar huella de persona
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/person/v1/persons/updatefingers' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"personId": "377140151211762688",
"fingerList": [
{
"data": "90030500A3B1564620B3A616A0A7246092E00000000000397",
"name": "ssssss"
}
]
}'
8.7 Recolectar número de tarjeta
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/person/v1/persons/cardcollect' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"deviceSerial": "378117915440051200"
}'
8.8 Actualizar número de tarjeta de persona
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/person/v1/persons/updatecards' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"personId": "378222739150076928",
"cardList": [
{
"cardNo": "892"
}
]
}'
8.9 Actualizar código PIN
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/person/v1/persons/updatepinecode' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"personId": "395611750566890496",
"pinCode": "3452"
}'
8.10 Obtener información de persona
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/person/v1/persons/get' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"personId": "376748042642236416"
}'
8.11 Eliminar persona
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/person/v1/persons/delete' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"personId": "376748042642236416"
}'
8.12 Agregar persona rápidamente
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/person/v1/persons/quick/add' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
"personInfo": {
"groupId": "381019761120777216",
"firstName": "Xavier",
"lastName": "",
"gender": 1,
"phone": "1124235678051",
"email": "[email protected]",
"startDate": "2023-02-21T20:12:45+08:00",
"endDate": "2033-02-21T20:12:45+08:00",
"personCode": "12114785901"
},
"pinCode": "33456",
"photoData": "",
"aceessLevelList": [
"395619513653140480"
]
}'
8.13 Buscar personas
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/person/v1/persons/list' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"pageIndex": 1,
"pageSize": 10,
"filter": {
"name": "zmh",
"email": "zmh",
"phone": "112"
}
}'
9 Servicios relacionados con monitoreo a bordo
9.1 Agregar vehículo
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/resource/v1/areas/vehicles/add' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"areaId": "2aeec98c14a4427f9ace6c48e91ab4cc",
"licensePlateNo": "ADDDEEE",
"driverFirstName": "san",
"driverLastName": "zhang",
"driverPhoneNo": "18611119999",
"pictureKey": "",
"deviceSerial": "J091122",
"vehicleType": 1,
"extend": "this is a demo car"
}'
9.2 Actualizar vehículo
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/resource/v1/areas/vehicles/VEHICLEID/update' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"licensePlateNo": "ADDDEEE",
"driverFirstName": "san",
"driverLastName": "zhang",
"driverPhoneNo": "18611119999",
"pictureKey": "",
"deviceSerial": "J091122",
"vehicleType": 1,
"extend": "this is a demo car"
}'
9.3 Buscar vehículos
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/resource/v1/areas/vehicles/get' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"pageIndex": 1,
"pageSize": 10,
"filter": {
"areaID": "-1",
"includeSubArea": "1",
"vehicleID": []
}
}'
9.4 Obtener parámetros de carga de imágenes
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/resource/v1/picture/uploadparam/get' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"format": "jpg"
}'
10 Servicios relacionados con tiempo y asistencia
10.1 Buscar tiempo total de una tarjeta
curl --location 'https://ius.hikcentralconnect.com/api/hccgw/attendance/v1/report/totaltimecard/list' \
--header 'Token: ACCESSTOKEN' \
--header 'Content-Type: application/json' \
--data '{
"pageIndex": 1,
"pageSize": 20,
"beginTime": "2024-01-01T00:00:00+08:00",
"endTime": "2024-01-31T23:59:59+08:00",
"personName": "abc",
"personCode": "123",
"personGroupIds": [],
"dateFormat": "yyyy/MM/dd",
"timeFormat": "HH:mm",
"durationFormat": "HH:MM"
}'