HikConnect API Reference

const response = await fetch('https://ius.hikcentralconnect.com/api/hccgw/platform/v1/token/get', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    appKey: 'your_app_key',
    secretKey: 'your_secret_key',
  }),
})

const data = await response.json()

if (data.errorCode === '0') {
  const accessToken = data.data.accessToken
  const expireTime = data.data.expireTime
  console.log('Token obtained:', accessToken)
} else {
  console.error('Error:', data.message)
}

const response = await fetch('https://ius.hikcentralconnect.com/api/hccgw/platform/v1/token/refresh', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Token': accessToken,
  },
  body: JSON.stringify({
    accessToken: currentToken,
  }),
})

const data = await response.json()
const newToken = data.data.accessToken

const response = await fetch('https://ius.hikcentralconnect.com/api/hccgw/platform/v1/systemproperties', {
  method: 'GET',
  headers: {
    'Token': accessToken,
  },
})

const data = await response.json()
console.log('System version:', data.data.version)
console.log('Timezone:', data.data.timezone)

const response = await fetch('https://ius.hikcentralconnect.com/api/hccgw/platform/v1/servicepackage', {
  method: 'GET',
  headers: {
    'Token': accessToken,
  },
})

const data = await response.json()
console.log('Package:', data.data.packageName)
console.log('Max devices:', data.data.maxDevices)

const response = await fetch('https://ius.hikcentralconnect.com/api/hccgw/platform/v1/streamtoken/get', {
  method: 'GET',
  headers: {
    'Token': accessToken,
  },
})

const data = await response.json()
const { appKey, appToken, streamAreaDomain } = data.data
// appToken is used as the accessToken for EZUIKit player
// streamAreaDomain is the regional video server domain
console.log('Stream domain:', streamAreaDomain)

const response = await fetch('https://ius.hikcentralconnect.com/api/hccgw/platform/v1/users/get', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Token': accessToken,
  },
  body: JSON.stringify({
    pageNo: 1,
    pageSize: 20,
  }),
})

const data = await response.json()
console.log('Total users:', data.data.total)
data.data.list.forEach(user => {
  console.log(user.userName)
})

const response = await fetch('https://ius.hikcentralconnect.com/api/hccgw/resource/v1/devices/add', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Token': accessToken,
  },
  body: JSON.stringify({
    deviceName: 'Front Door Camera',
    deviceSerial: 'DS-2CD2143G2-I-ABC123',
    validateCode: 'ABCDEF',
    areaId: 'area_001',
  }),
})

const data = await response.json()
const deviceId = data.data.deviceId
console.log('Device added:', deviceId)

const response = await fetch('https://ius.hikcentralconnect.com/api/hccgw/resource/v1/devices/update', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Token': accessToken,
  },
  body: JSON.stringify({
    deviceId: 'device_001',
    deviceName: 'Updated Camera Name',
    areaId: 'area_002',
  }),
})

const data = await response.json()
console.log('Device updated:', data.errorCode === '0')

const response = await fetch('https://ius.hikcentralconnect.com/api/hccgw/resource/v1/devices/get', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Token': accessToken,
  },
  body: JSON.stringify({
    pageNo: 1,
    pageSize: 20,
    areaId: 'area_001',
  }),
})

const data = await response.json()
console.log('Total devices:', data.data.total)
data.data.list.forEach(device => {
  console.log(`${device.deviceName}: ${device.status}`)
})

const response = await fetch('https://ius.hikcentralconnect.com/api/hccgw/resource/v1/devices/delete', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Token': accessToken,
  },
  body: JSON.stringify({
    deviceIds: ['device_001', 'device_002'],
  }),
})

const data = await response.json()
console.log('Devices deleted:', data.errorCode === '0')

const response = await fetch('https://ius.hikcentralconnect.com/api/hccgw/resource/v1/areas/add', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Token': accessToken,
  },
  body: JSON.stringify({
    areaName: 'Building A - Floor 1',
    parentAreaId: 'root_area',
  }),
})

const data = await response.json()
const areaId = data.data.areaId

const response = await fetch('https://ius.hikcentralconnect.com/api/hccgw/resource/v1/areas/get', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Token': accessToken,
  },
  body: JSON.stringify({}),
})

const data = await response.json()
data.data.list.forEach(area => {
  console.log(`${area.areaName} (ID: ${area.areaId})`)
})

const response = await fetch('https://ius.hikcentralconnect.com/api/hccgw/resource/v1/areas/cameras/get', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Token': accessToken,
  },
  body: JSON.stringify({
    areaId: 'area_001',
    pageNo: 1,
    pageSize: 20,
  }),
})

const data = await response.json()
data.data.list.forEach(camera => {
  console.log(`Camera: ${camera.cameraName}, Status: ${camera.status}`)
})

const response = await fetch('https://ius.hikcentralconnect.com/api/hccgw/alarm/v1/mq/subscribe', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Token': accessToken,
  },
  body: JSON.stringify({
    eventTypes: ['motion', 'intrusion', 'faceDetection'],
  }),
})

const data = await response.json()
const subscriptionId = data.data.subscriptionId
const mqUrl = data.data.mqUrl
console.log('Subscribed to MQ:', subscriptionId)

const response = await fetch('https://ius.hikcentralconnect.com/api/hccgw/alarm/v1/mq/messages', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Token': accessToken,
  },
  body: JSON.stringify({
    subscriptionId: 'sub_001',
    maxMessages: 100,
  }),
})

const data = await response.json()
data.data.messages.forEach(msg => {
  console.log(`Event: ${msg.eventType}, Time: ${msg.timestamp}`)
})

const response = await fetch('https://ius.hikcentralconnect.com/api/hccgw/alarm/v1/alarmrules/add', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Token': accessToken,
  },
  body: JSON.stringify({
    ruleName: 'Motion Detection Rule',
    deviceIds: ['device_001', 'device_002'],
    eventType: 'motion',
    schedule: {
      startTime: '08:00',
      endTime: '18:00',
      weekDays: [1, 2, 3, 4, 5],
    },
  }),
})

const data = await response.json()
const ruleId = data.data.ruleId

const response = await fetch('https://ius.hikcentralconnect.com/api/hccgw/alarm/v1/alarmlogs/get', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Token': accessToken,
  },
  body: JSON.stringify({
    startTime: '2024-01-01T00:00:00Z',
    endTime: '2024-01-31T23:59:59Z',
    eventTypes: ['motion', 'intrusion'],
    pageNo: 1,
    pageSize: 50,
  }),
})

const data = await response.json()
console.log('Total alarms:', data.data.total)

const response = await fetch('https://ius.hikcentralconnect.com/api/hccgw/message/v1/rawmessage/get', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Token': accessToken,
  },
  body: JSON.stringify({
    queueId: 'queue_001',
    maxCount: 100,
  }),
})

const data = await response.json()
const messages = data.data.messages

const response = await fetch('https://ius.hikcentralconnect.com/api/hccgw/message/v1/rawmessage/ack', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Token': accessToken,
  },
  body: JSON.stringify({
    queueId: 'queue_001',
    messageIds: ['msg_001', 'msg_002', 'msg_003'],
  }),
})

const data = await response.json()

// Get live EZOPEN URL for a camera
const response = await fetch('https://ius.hikcentralconnect.com/api/hccgw/video/v1/live/address/get', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Token': accessToken,
  },
  body: JSON.stringify({
    resourceId: 'camera_resource_id',  // From camera list
    deviceSerial: 'DS-2CD2143G2-I-ABC123',
    type: '1',       // 1=live, 2=cloud playback, 3=local playback
    code: '0',       // Channel code (usually "0")
    protocol: '1',   // 1=EZOPEN (required for encrypted streams)
    quality: '1',    // 1=HD, 2=SD
  }),
})

const data = await response.json()
// Returns an EZOPEN URL like: ezopen://open.ezviz.com/<token>/live
const ezopenUrl = data.data.url
console.log('EZOPEN URL:', ezopenUrl)
// Use this URL with EZUIKit player (see EZUIKit Integration section)

// Get playback URL - same endpoint, different type parameter
const response = await fetch('https://ius.hikcentralconnect.com/api/hccgw/video/v1/live/address/get', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Token': accessToken,
  },
  body: JSON.stringify({
    resourceId: 'camera_resource_id',
    deviceSerial: 'DS-2CD2143G2-I-ABC123',
    type: '2',       // 2=cloud playback, 3=local playback
    code: '0',
    protocol: '1',   // 1=EZOPEN
    quality: '1',
    startTime: '2024-01-15 10:00:00',  // Format: YYYY-MM-DD HH:MM:SS
    stopTime: '2024-01-15 11:00:00',
  }),
})

const data = await response.json()
const playbackUrl = data.data.url
// Use with EZUIKit player using template: 'pcRec' for playback

// Search recording segments for a camera
const response = await fetch('https://ius.hikcentralconnect.com/api/hccgw/video/v1/record/element/search', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Token': accessToken,
  },
  body: JSON.stringify({
    resourceId: 'camera_resource_id',
    filter: {
      beginTime: '2024-01-15T00:00:00.000+00:00',  // ISO 8601
      endTime: '2024-01-15T23:59:59.000+00:00',
      targetType: '0',  // 0=cloud, 1=local device
    },
  }),
})

const data = await response.json()
data.data.list.forEach(segment => {
  console.log(`Recording: ${segment.beginTime} - ${segment.endTime}`)
})

// Capture a snapshot from a device camera
const response = await fetch('https://ius.hikcentralconnect.com/api/hccgw/resource/v1/device/capturePic', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Token': accessToken,
  },
  body: JSON.stringify({
    deviceSerial: 'DS-2CD2143G2-I-ABC123',
    channelNo: 1,
  }),
})

const data = await response.json()
const captureUrl = data.data.captureUrl
console.log('Snapshot URL:', captureUrl)

// Get recording schedule settings for a camera
const response = await fetch('https://ius.hikcentralconnect.com/api/hccgw/video/v1/recordsettings/get', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Token': accessToken,
  },
  body: JSON.stringify({
    resourceId: 'camera_resource_id',
  }),
})

const data = await response.json()
console.log('Recording settings:', data.data)

const response = await fetch('https://ius.hikcentralconnect.com/api/hccgw/visp/v1/buildings/add', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Token': accessToken,
  },
  body: JSON.stringify({
    buildingName: 'Main Building',
    buildingNo: 'A1',
    address: '123 Main Street',
  }),
})

const data = await response.json()
const buildingId = data.data.buildingId

const response = await fetch('https://ius.hikcentralconnect.com/api/hccgw/visp/v1/buildings/get', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Token': accessToken,
  },
  body: JSON.stringify({
    pageNo: 1,
    pageSize: 20,
  }),
})

const data = await response.json()
data.data.list.forEach(building => {
  console.log(building.buildingName)
})

const response = await fetch('https://ius.hikcentralconnect.com/api/hccgw/visp/v1/residents/add', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Token': accessToken,
  },
  body: JSON.stringify({
    residentName: 'John Doe',
    phoneNo: '+1234567890',
    buildingId: 'building_001',
    roomNo: '101',
  }),
})

const data = await response.json()
const residentId = data.data.residentId

const response = await fetch('https://ius.hikcentralconnect.com/api/hccgw/visp/v1/passes/issue', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Token': accessToken,
  },
  body: JSON.stringify({
    residentId: 'resident_001',
    visitorName: 'Jane Smith',
    validFrom: '2024-01-20T09:00:00Z',
    validTo: '2024-01-20T18:00:00Z',
  }),
})

const data = await response.json()
const passCode = data.data.passCode
const qrCode = data.data.qrCode

const response = await fetch('https://ius.hikcentralconnect.com/api/hccgw/acs/v1/remote/control', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Token': accessToken,
  },
  body: JSON.stringify({
    doorId: 'door_001',
    controlType: 'open',
  }),
})

const data = await response.json()
if (data.errorCode === '0') {
  console.log('Door opened successfully')
}

const response = await fetch('https://ius.hikcentralconnect.com/api/hccgw/acs/v1/encryptinfo/get', {
  method: 'GET',
  headers: {
    'Token': accessToken,
  },
})

const data = await response.json()
const publicKey = data.data.publicKey
const algorithm = data.data.algorithm

const response = await fetch('https://ius.hikcentralconnect.com/api/hccgw/acspm/v1/accesslevel/list', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Token': accessToken,
  },
  body: JSON.stringify({
    pageNo: 1,
    pageSize: 20,
  }),
})

const data = await response.json()
data.data.list.forEach(level => {
  console.log(`Access Level: ${level.name}`)
})

const response = await fetch('https://ius.hikcentralconnect.com/api/hccgw/acspm/v1/personaccess/assign', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Token': accessToken,
  },
  body: JSON.stringify({
    personId: 'person_001',
    accessLevelIds: ['level_001', 'level_002'],
  }),
})

const data = await response.json()

const response = await fetch('https://ius.hikcentralconnect.com/api/hccgw/person/v1/groups/search', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Token': accessToken,
  },
  body: JSON.stringify({
    keyword: 'Engineering',
    pageNo: 1,
    pageSize: 20,
  }),
})

const data = await response.json()
data.data.list.forEach(group => {
  console.log(`Group: ${group.groupName}`)
})

const response = await fetch('https://ius.hikcentralconnect.com/api/hccgw/person/v1/persons/add', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Token': accessToken,
  },
  body: JSON.stringify({
    personName: 'John Smith',
    groupId: 'group_001',
    phoneNo: '+1234567890',
    email: 'john.smith@example.com',
    cardNo: 'CARD123456',
  }),
})

const data = await response.json()
const personId = data.data.personId

// First, convert image to base64
const imageFile = await fetch('/path/to/photo.jpg')
const imageBlob = await imageFile.blob()
const base64 = await blobToBase64(imageBlob)

const response = await fetch('https://ius.hikcentralconnect.com/api/hccgw/person/v1/persons/photo', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Token': accessToken,
  },
  body: JSON.stringify({
    personId: 'person_001',
    photoBase64: base64,
  }),
})

const data = await response.json()

const response = await fetch('https://ius.hikcentralconnect.com/api/hccgw/person/v1/persons/quick/add', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Token': accessToken,
  },
  body: JSON.stringify({
    personName: 'Jane Doe',
    groupId: 'group_001',
    photoBase64: photoBase64String,
    cardNo: 'CARD789012',
    accessLevelIds: ['level_001'],
  }),
})

const data = await response.json()
const personId = data.data.personId

const response = await fetch('https://ius.hikcentralconnect.com/api/hccgw/person/v1/persons/search', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Token': accessToken,
  },
  body: JSON.stringify({
    keyword: 'John',
    groupId: 'group_001',
    pageNo: 1,
    pageSize: 20,
  }),
})

const data = await response.json()
console.log('Found:', data.data.total, 'persons')

const response = await fetch('https://ius.hikcentralconnect.com/api/hccgw/obd/v1/vehicles/add', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Token': accessToken,
  },
  body: JSON.stringify({
    plateNo: 'ABC-1234',
    vehicleName: 'Delivery Truck 1',
    deviceId: 'device_001',
  }),
})

const data = await response.json()
const vehicleId = data.data.vehicleId

const response = await fetch('https://ius.hikcentralconnect.com/api/hccgw/obd/v1/vehicles/get', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Token': accessToken,
  },
  body: JSON.stringify({
    pageNo: 1,
    pageSize: 20,
  }),
})

const data = await response.json()
data.data.list.forEach(vehicle => {
  console.log(`${vehicle.plateNo}: ${vehicle.vehicleName}`)
})

const response = await fetch('https://ius.hikcentralconnect.com/api/hccgw/obd/v1/drivers/add', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Token': accessToken,
  },
  body: JSON.stringify({
    driverName: 'Mike Johnson',
    licenseNo: 'DL123456789',
    phoneNo: '+1234567890',
  }),
})

const data = await response.json()
const driverId = data.data.driverId

const response = await fetch('https://ius.hikcentralconnect.com/api/hccgw/obd/v1/vehicles/location', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Token': accessToken,
  },
  body: JSON.stringify({
    vehicleId: 'vehicle_001',
  }),
})

const data = await response.json()
const { latitude, longitude, speed, timestamp } = data.data
console.log(`Location: ${latitude}, ${longitude} - Speed: ${speed} km/h`)

const response = await fetch('https://ius.hikcentralconnect.com/api/hccgw/attendance/v1/records/get', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Token': accessToken,
  },
  body: JSON.stringify({
    startTime: '2024-01-01T00:00:00Z',
    endTime: '2024-01-31T23:59:59Z',
    groupId: 'group_001',
    pageNo: 1,
    pageSize: 50,
  }),
})

const data = await response.json()
console.log('Total records:', data.data.total)

const response = await fetch('https://ius.hikcentralconnect.com/api/hccgw/attendance/v1/timecard/report', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Token': accessToken,
  },
  body: JSON.stringify({
    startDate: '2024-01-01',
    endDate: '2024-01-31',
    groupId: 'group_001',
  }),
})

const data = await response.json()
data.data.report.forEach(entry => {
  console.log(`${entry.personName}: ${entry.totalHours} hours`)
})

const response = await fetch('https://ius.hikcentralconnect.com/api/hccgw/attendance/v1/summary/get', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Token': accessToken,
  },
  body: JSON.stringify({
    date: '2024-01-15',
    groupId: 'group_001',
  }),
})

const data = await response.json()
const { totalPersons, checkedIn, absent, late } = data.data
console.log(`Checked in: ${checkedIn}/${totalPersons}, Late: ${late}, Absent: ${absent}`)