WDF Open Api
    • ‌Interface Specification
    • 1.Login Authentication
      • Authorization Code Authentication (Recommended)
        • Authorization Code Authentication (Recommended)
        • ‌Authorization Code Heartbeat API (Recommended)
      • ‌Login Authentication
        • ‌Interface Encryption Usage Instructions
        • ‌Login API
        • ‌Verification Code API
      • ‌Logout API
        POST
    • ‌2.Real-time Perception
      • ‌WebSocket Get Location
      • ‌Device Message Downlink API
        POST
      • ‌Rapid Evacuation Notification API
        POST
      • ‌Device Statistics API
        GET
      • ‌Device Details API
        GET
    • 3.Alarm Management
      • WebSocket push alarm interface
      • Business alarm modification interface
        PUT
      • New interface for business alarms
        POST
      • Business alarm deletion interface
        DELETE
      • Service alarm start/stop setting interface
        POST
      • Business alarm details interface
        GET
      • Business alarm list interface
        GET
      • Hardware alarm modification interface
        PUT
      • New interface for hardware alarms
        POST
      • Hardware alarm deletion interface
        DELETE
      • Hardware alarm on/off setting interface
        POST
      • Hardware alarm details interface
        GET
      • Hardware alarm list interface
        GET
      • Alarm list interface
        GET
      • One-click alarm processing interface
        POST
      • Alarm processing interface
        POST
      • Alarm details interface
        GET
    • 4. Map information
      • Map modification interface
      • New map interface
      • Map details interface
      • Map deletion API
      • Map list interface
      • Map pagination list interface
      • Map details interface
      • Map tree list interface
      • Default map setting interface
      • Default map query interface
    • 5. Electronic fence
      • Add new interface to the fence
      • Fence modification interface
      • Fence deletion interface
      • Fence details interface
      • Fence list interface
      • Fence paging list interface
      • Fence GeoJson list interface
      • Fence GeoJson details interface
    • 6. Historical trajectory
      • Display historical trajectories of multiple people
      • Statistics of personnel stay duration
      • Statistics of regional stay duration
      • Obtain the final location
      • Historical location information query interface
      • Trajectory efficiency analysis query interface
      • Historical layer list query interface
      • Historical layer details query interface
    • 7. Visitor Information
      • Visitor modification interface
      • Add new visitor information
      • Visitor deletion interface
      • Visitor details interface
      • Visitor list interface
      • Visitor exit interface
      • Visitor registration modification interface
      • New interface for visitor registration
      • Visitor registration deletion interface
      • Visitor registration details interface
      • Visitor registration list interface
    • 8. Tag binding management
      • Vehicle modification interface
      • Newly added interfaces for vehicles
      • Vehicle deletion interface
      • Vehicle details interface
      • Vehicle list interface
      • Employee modification interface
      • Employee addition interface
      • Employee deletion interface
      • Employee details interface
      • Employee list interface
      • Interface for all staff list
      • Material modification interface
      • Material addition interface
      • Material deletion interface
      • Material details interface
      • Material list interface
    • 9. Smart Devices
      • Product list interface
      • Product paging list interface
      • Product details interface
      • Product attribute list interface
      • Product attribute paging list interface
      • Device list interface
      • Device details interface
    • 10. Anti-collision interface
      • Interface for collision avoidance alarm list
      • Detailed interface of collision avoidance alarm
    • 11. Paperless interface
      • New interface for template parameters
      • Template parameter modification interface
      • Template parameter deletion interface
      • Template parameter list interface
      • Template parameter details interface
      • Template new interface
      • Template modification interface
      • Template deletion interface
      • Template start-stop setting interface
      • Template list interface
      • Template details interface
      • Template message push interface
      • Template message list interface
      • Template image details API
    • Schemas
      • Example data model
        • Pet
        • Category
        • Tag
      • Schemas
        • TableDataInfoWzhTemplateVo
        • WzhTemplateMsgVo
        • TableDataInfoWzhTemplateMsgVo
        • WzhTemplateMsgItemVo
        • TableDataInfoWzhTemplateMsgItemVo
        • WzhTemplateMsgItemBo
        • WzhTemplateVo
        • RWzhTemplateVo
        • TableDataInfoWzhTemplateParamVo
        • WzhTemplateParamVo
        • RWzhTemplateParamVo
        • WzhTemplateMsgBo
        • WzhTemplateBo
        • WzhTemplateParamBo
        • TableDataInfoFzAlarmEventVo
        • RFzAlarmEventVo
        • FzAlarmEventVo
        • RMapObjectObject
        • RListMapObjectObject
        • FzAlarmEventBo
        • RCacheListInfoVo
        • CacheListInfoVo
        • TableDataInfoSysLogininforVo
        • SysLogininforVo
        • TableDataInfoSysUserOnline
        • SysUserOnline
        • TableDataInfoSysOperLogVo
        • SysOperLogVo
        • SysLogininforBo
        • SysOperLogBo
        • TableDataInfoSysOssConfigVo
        • SysOssConfigVo
        • RSysOssConfigVo
        • RListSysOssVo
        • TableDataInfoSysOssVo
        • SysOssVo
        • SysOssBo
        • TableDataInfoSysChannelConfigVo
        • SysChannelConfigVo
        • RSysChannelConfigVo
        • TableDataInfoSysChannelTemplateVo
        • SysChannelTemplateVo
        • RSysChannelTemplateVo
        • TableDataInfoSysChannelTypeVo
        • SysChannelTypeVo
        • RSysChannelTypeVo
        • TableDataInfoSysClientVo
        • SysClientVo
        • RSysClientVo
        • TableDataInfoSysConfigVo
        • SysConfigVo
        • RSysConfigVo
        • RListSysDeptVo
        • RSysDeptVo
        • TableDataInfoSysDeviceAttributeMsgVo
        • SysDeviceAttributeMsgVo
        • SysDeviceAttributeLogVo
        • SysDeviceAttributeLogBo
        • TableDataInfoSysDictDataVo
        • RListSysDictDataVo
        • SysDictDataVo
        • RSysDictDataVo
        • TableDataInfoSysDictTypeVo
        • RListSysDictTypeVo
        • SysDictTypeVo
        • RSysDictTypeVo
        • TableDataInfoSysJobTypeVo
        • SysJobTypeVo
        • RSysJobTypeVo
        • TableDataInfoLanguageCollectDo
        • LanguageCollectDo
        • SysLanguageCollectBo
        • TableDataInfoSysLanguageVo
        • SysLanguageVo
        • RSysLanguageVo
        • RListSysLanguageGroupVo
        • TableDataInfoSysLanguageGroupVo
        • SysLanguageGroupVo
        • RSysLanguageGroupVo
        • RListSysLanguageTypeVo
        • TableDataInfoSysLanguageTypeVo
        • SysLanguageTypeVo
        • RSysLanguageTypeVo
        • RouterVo
        • RListRouterVo
        • MetaVo
        • RListSysMenuVo
        • RMenuTreeSelectVo
        • MenuTreeSelectVo
        • SysMenuVo
        • RSysMenuVo
        • TableDataInfoSysNoticeVo
        • SysNoticeVo
        • RSysNoticeVo
        • TableDataInfoSysPostVo
        • RListSysPostVo
        • RSysPostVo
        • RDeptTreeSelectVo
        • DeptTreeSelectVo
        • TableDataInfoSysRoleVo
        • RListSysRoleVo
        • RSysRoleVo
        • TableDataInfoSysSiteConfigVo
        • SysSiteConfigVo
        • RSysSiteConfigVo
        • SysSocialVo
        • RListSysSocialVo
        • TableDataInfoSysTenantVo
        • TableDataInfoSysTenantPackageVo
        • RListSysTenantPackageVo
        • SysTenantPackageVo
        • RSysTenantPackageVo
        • SysTenantVo
        • RSysTenantVo
        • SysUserInfoVo
        • SysPostVo
        • RSysUserInfoVo
        • UserInfoVo
        • RUserInfoVo
        • RListSysUserVo
        • TableDataInfoSysUserVo
        • SysUserVo
        • SysRoleVo
        • SysDeptVo
        • RProfileVo
        • ProfileVo
        • DeptResourceVo
        • SysOssUploadVo
        • RSysOssUploadVo
        • ResourceTree
        • RListResourceTree
        • DeptResourceBo
        • RListLanguageIndexBo
        • RMapStringString
        • LanguageIndexBo
        • SysOssConfigBo
        • SysChannelConfigBo
        • SysChannelTemplateBo
        • SysChannelTypeBo
        • SysClientBo
        • SysConfigBo
        • SysDeptBo
        • SysDictDataBo
        • SysDictTypeBo
        • SysJobTypeBo
        • SysLanguageGroupBo
        • SysLanguageTypeBo
        • SysLanguageBo
        • SysMenuBo
        • SysNoticeBo
        • SysPostBo
        • SysUserRole
        • SysRoleBo
        • SysSiteConfigBo
        • SysTenantPackageBo
        • SysTenantBo
        • SysUserPasswordBo
        • SysUserProfileBo
        • SysUserBo
        • RCaptchaVo
        • CaptchaVo
        • TenantListVo
        • RLoginTenantVo
        • LoginTenantVo
        • RLoginVo
        • LoginVo
        • RegisterBody
        • SocialLoginBody
        • RMapImagesVo
        • MapImagesVo
      • DevicePositionBo
      • WdfLampSceneEventBo
      • WdfLampEventBo
      • RListString
      • WdfInspectReportBo
      • WdfInspectRecordBo
      • LocalTime
      • WdfInspectConfigBo
      • TableDataInfoWdfAlarmEventVo
      • RWdfAlarmEventVo
      • WdfAlarmTemplateVo
      • RWdfAlarmTemplateVo
      • AttendanceStaffRecordBo
      • TableDataInfoWdfBusinessAlarmConfigVo
      • AttendanceShiftsBo
      • WdfBusinessAlarmConfigVo
      • AttendanceShiftsBreakTimesBo
      • RWdfBusinessAlarmConfigVo
      • AttendanceShiftRecordBo
      • TableDataInfoCameraInfoVo
      • AttendanceScheduleSetting
      • RCameraInfoVo
      • JSONConfig
      • CameraInfoVo
      • JSONObject
      • TableDataInfoCameraSourceInfoVo
      • RJSONObject
      • RCameraSourceInfoVo
      • WorkingAreaDto
      • CameraSourceInfoVo
      • TableDataInfoSysCarVo
      • WdfAlarmConfigBo
      • SysCarVo
      • WdfLampSceneBo
      • RSysCarVo
      • WdfLampExceptionBo
      • TableDataInfoSysCarModelVo
      • WdfLampConfigBo
      • SysCarModelVo
      • RSysCarModelVo
      • TableDataInfoEngineInfoVo
      • REngineInfoVo
      • EngineInfoVo
      • RFeature
      • RListFeature
      • Geometry
      • Feature
      • LampStatisticsParamsBo
      • TableDataInfoFenceInfoVo
      • KeyValueFloatVo
      • RListFenceInfoVo
      • RListKeyValueFloatVo
      • RFenceInfoVo
      • KeyValueDoubleVo
      • FenceInfoVo
      • RListKeyValueDoubleVo
      • TableDataInfoWdfHardAlarmConfigVo
      • RListWdfLampEventVo
      • WdfHardAlarmConfigVo
      • WdfLampEventVo
      • RWdfHardAlarmConfigVo
      • ReSetInfo
      • TableDataInfoHistoryNodeVo
      • ReBootInfo
      • TableDataInfoHistoryMapListVo
      • WdfUpgradeScriptBo
      • HistoryMapListVo
      • UnBindBo
      • RHistoryProcessVo
      • StaffExportAndPrintQuery
      • PieChartVo
      • HistoryProcessVo
      • HistoryProcessNode
      • HistoryProcessEdge
      • HistoryNodeVo
      • ReportRollcallBo
      • BarChartVo
      • ReportRollcallDetailBo
      • TableDataInfoMapInfoVo
      • RMapInfoVo
      • MaterialExportAndPrintQuery
      • MapInfoVo
      • TableDataInfoMaterialInfoVo
      • Respond to the information subject
      • RMaterialInfoVo
      • MaterialInfoVo
      • TableDataInfoDeviceResourceTypeVo
      • RDeviceResourceTypeVo
      • DeviceResourceTypeVo
      • RListHistoryPositionVo
      • RListSysProductVo
      • FenceRecordVo
      • RListSysProductAttributeVo
      • TableDataInfoSysProductAttributeVo
      • HeatmapFenceByTypeStatistics
      • SysProductAttributeVo
      • HeatmapFenceStatistics
      • TableDataInfoSysProductVo
      • HeatmapStatistics
      • SysProductVo
      • RHeatmapStatistics
      • RSysProductVo
      • HeatmapAggResult
      • TableDataInfoVisitRegisterRecordVo
      • RListHeatmapAggResult
      • VisitRegisterRecordVo
      • TimeDo
      • RVisitRegisterRecordVo
      • GatheringInfo
      • RDevicePositionDetails
      • RListGatheringInfo
      • DevicePositionDetails
      • WarnInfo
      • DeviceBinding
      • ExerciseReportBo
      • RListSysStaffVo
      • ExerciseConfigBo
      • TableDataInfoSysStaffVo
      • ForbiddenStatus
      • SysStaffVo
      • DeviceExportAndPrintQuery
      • RSysStaffVo
      • TableDataInfoSysVisitorVo
      • SysVisitorVo
      • RSysVisitorVo
      • GatewayParamBo
      • WdfAlarmEvent
      • DeviceBasicInfoVo
      • RHistoryPositionVo
      • DeviceBasicModel
      • PositionNode
      • ConfigRollcall
      • HistoryPositionVo
      • ConfigRollcallBo
      • HistoryInfoBo
      • CarExportAndPrintQuery
      • SysProductAttributeBo
      • RListSysCarVo
      • RapidEvacuationBo
      • EngineMessageDispatchBo
      • RListObject
      • RListAlarmStatisticsVo
      • AlarmStatisticsVo
      • AttendanceScheduleStaff
      • RListKeyValueVo
      • R
      • KeyValueVo
      • AttendanceScheduleSettingBo
      • WdfAlarmEventVo
      • StaffShift
      • RListWdfAlarmEventVo
      • AttendanceWorkingAreaBo
      • StatisticsParamsBo
      • AlarmEventExportAndPrintQuery
      • WdfAlarmEventBo
      • GatherAlarmVo
      • WdfBusinessAlarmConfigBo
      • RListGatherAlarmVo
      • CameraInfoBo
      • CameraSourceInfoBo
      • LampPositionConfig
      • SysCarModelBo
      • LampGearConfig
      • SysCarBo
      • SectionInfo
      • EngineInfoBo
      • NetworkDeviceInfo
      • FenceInfoBo
      • RListNetworkDeviceInfo
      • WdfHardAlarmConfigBo
      • MapInfoBo
      • DeviceResourceTypeBo
      • MaterialInfoBo
      • SysProductBo
      • VisitRegisterRecordBo
      • SysStaffBo
      • SysVisitorBo
      • DeviceBindingLatestInfo
      • DeviceDisplayIconInfo
      • RListDeviceBindingLatestInfo
      • TagPositionInfo
      • DeviceBasicInfo
      • DeviceStatusStatisticsVo
      • RMapStringListDeviceStatusStatisticsVo
      • RListDeviceStatusStatisticsVo
      • RListJSONObject
      • FeatureCollection
      • RFeatureCollection
      • GatewayRtlsInfo
      • RListGatewayRtlsInfo
      • DeviceInfoInFence
      • TableDataInfoDeviceInfoInFence
      • BusinessAlarmConfigSingle
      • FenceBusinessStatistics
      • RFenceBusinessStatistics
      • FenceBusinessStatisticsInfo
      • RFenceBusinessStatisticsInfo
      • DeviceRtlsInfo
      • RListDeviceRtlsInfo
      • DeviceBloodOxygenSensor
      • DeviceHeartRateSensor
      • DeviceSensorInfo
      • DeviceStepCountSensor
      • TableDataInfoSysDeviceVo
      • SysDeviceVo
      • RSysDeviceVo
      • WdfRebootLogVo
      • AttributeInfo
      • WdfUpgradeScriptLogVo
      • RMapStringObject
      • AnchorRtlsInfo
      • RListAnchorRtlsInfo
      • ReportRollcallVo
      • TableDataInfoReportRollcallVo
      • ReportRollcallDetailVo
      • TableDataInfoReportRollcallDetailVo
      • RMapIntegerListSysProductVo
      • ProductTypeGroupVo
      • RListProductTypeGroupVo
      • SysProductSimpleVo
      • RBoolean
      • DevicePositionVo
      • RDevicePositionVo
      • TableDataInfoDevicePositionVo
      • RWdfLampSceneEventVo
      • WdfLampSceneEventVo
      • TableDataInfoWdfLampSceneEventVo
      • RWdfLampEventVo
      • TableDataInfoWdfLampEventVo
      • RWdfInspectReportVo
      • WdfInspectDetailVo
      • WdfInspectFenceVo
      • WdfInspectReportVo
      • TableDataInfoWdfInspectReportVo
      • RWdfInspectRecordVo
      • WdfInspectRecordVo
      • TableDataInfoWdfInspectRecordVo
      • FenceDetailInfo
      • MapInfoDetail
      • RWdfInspectConfigVo
      • WdfInspectConfigVo
      • TableDataInfoWdfInspectConfigVo
      • MapEventMergeVo
      • RListMapEventMergeVo
      • HistoryMapQueryBo
      • FinalPosition
      • TreeNodeConfig
      • RListFinalPosition
      • TreeLong
      • StaffFinalPositionVo
      • RListTreeLong
      • RStaffFinalPositionByMapIdVo
      • StaffFinalPositionByMapIdVo
      • FenceEventMergeVo
      • FenceStatisticVo
      • RListFenceStatisticVo
      • PageQuery
      • ExerciseReportVo
      • TableDataInfoExerciseReportVo
      • ExerciseConfigVo
      • SysDeviceAttribute2Bo
      • TableDataInfoExerciseConfigVo
      • SysDeviceAttributeItemBo
      • SysDeviceAttribute1Bo
      • RListDeviceBasicInfoVo
      • RListDeviceBinding
      • TableDataInfoMapStringObject
      • SysDeviceBo
      • FenceCamerasInfo
      • RListFenceCamerasInfo
      • AttendanceStaffEventVo
      • AttendanceStaffRecordVo
      • RAttendanceStaffEventVo
      • TableDataInfoAttendanceStaffRecordVo
      • AttendanceShiftsBreakTimesVo
      • AttendanceShiftsVo
      • RString
      • RAttendanceShiftsVo
      • TableDataInfoAttendanceShiftsVo
      • AttendanceShiftRecordVo
      • RAttendanceShiftRecordVo
      • TableDataInfoAttendanceShiftRecordVo
      • AttendanceScheduleSettingVo
      • TableDataInfoAttendanceScheduleSettingVo
      • RWorkingAreaDto
      • TableDataInfoWorkingAreaDto
      • RVoid
      • RSilenceVo
      • RObject
      • SilenceVo
      • RWdfAlarmConfigVo
      • WdfAlarmConfigVo
      • TableDataInfoWdfAlarmConfigVo
      • RListWdfAlarmConfigVo
      • RMapStringListWdfAlarmConfigVo
      • RWdfLampSceneVo
      • WdfLampSceneVo
      • TableDataInfoWdfLampSceneVo
      • RListWdfLampSceneVo
      • RWdfLampExceptionVo
      • WdfLampExceptionVo
      • TableDataInfoWdfLampExceptionVo
      • RWdfLampConfigVo
      • WdfLampConfigVo
      • TableDataInfoWdfLampConfigVo
      • RListWdfLampConfigVo
      • RListWdfLampLightEffectVo
      • WdfLampLightEffectVo
      • RListMapStringObject
      • RInteger
      • ExerciseReportDetailBo
      • TableDataInfo

    ‌Interface Specification

    WDF Platform Integration Instructions#

    Key Notes#

    The value of clientid corresponds to the method of obtaining the token, and they are different in the current version. Please pay close attention when calling the interface!!!
    The login interface involves interface data encryption. For third-party integration, it is recommended to use authorization code authentication to obtain the token.
    image.png

    1.1 Interface Reading Instructions#

    1.
    All interfaces must use the HTTP protocol, JSON data format, and UTF-8 encoding. For POST requests, please set Content-Type:application/json in the HTTP Header.
    2.
    Return parameter description:
    code: Response code, 1200 indicates success, 1401 indicates unauthorized, 1417 indicates other exceptions
    msg: Response text
    data: Specific response content
    tran: Internationalization related, whether to translate
    {
        "code": 1401,
        "msg": "Session invalid, unable to access system resources, please log in again and try!",
        "data": null,
        "tran": true
    }

    1.2 Obtaining Integration Information#

    All integrated APIs require a token to be obtained. The WDF system provides two acquisition methods, choose one to use. The clientId corresponding to the two methods is different, please distinguish carefully.
    The account with the system's built-in authorization code is admin. If you need other accounts, please contact us to generate the client secret. The authorization code is maintained in Service Support -> Terminal Management.
    The WDF system needs to decrypt and verify the client secret data. Unauthorized and self-added clients cannot obtain the token through the authorization code method.

    1.2.1 Authorization Code Acquisition (Recommended)#

    image.png
    Interface reference: Authorization Code Authentication

    1.2.2 Login Acquisition#

    image.png
    Interface reference: Get Verification Code, Encryption Instructions, Login Interface

    Constructing HTTP Request Headers#

    Authorization Header#

    The format of the Authorization value is Bearer {{token}}. Please replace {{token}} with the actually obtained Token.

    Client ID Header#

    Clientid is an identifier to distinguish clients, a custom value, which can be a 32-character lowercase MD5 string.
    Set the HTTP Header.

    1.3 Example of Sending HTTP Requests with Axios in Vue 3#

    1. Install Axios#

    Ensure that axios is installed in your Vue 3 project. If not installed, use the following command to install:

    2. Create a Vue 3 Component#

    Create a new component in your Vue 3 project and use the Composition API to send HTTP requests.
    <template>
      <div>
        <button @click="fetchData">Call Interface</button>
        <div v-if="apiResponse">
          <p>Interface Return Data: {{ apiResponse }}</p>
        </div>
        <div v-if="error">
          <p>Error Message: {{ error }}</p>
        </div>
      </div>
    </template>
    
    <script>
    import axios from 'axios';
    import { ref } from 'vue';
    
    export default {
      setup() {
        // Simulate Token and Client ID
        const token = 'YOUR_ACTUAL_TOKEN';
        const clientId = 'YOUR_CLIENT_ID';
    
        // Reactive references for storing API responses and error messages
        const apiResponse = ref(null);
        const error = ref(null);
    
        // Define the async function fetchData to send HTTP requests
        const fetchData = async () => {
          try {
            // Create an axios instance and set request headers
            const instance = axios.create({
              baseURL: 'https://api.example.com',
              headers: {
                'Authorization': `Bearer ${token}`,
                'Clientid': clientId
              }
            });
    
            // Send a GET request to the specified API endpoint
            const response = await instance.get('/endpoint');
    
            // Store the response data in the reactive reference apiResponse
            apiResponse.value = response.data;
          } catch (err) {
            // Catch and store error messages in the reactive reference error
            error.value = err.message;
          }
        };
    
        // Expose reactive references and functions to the template
        return {
          apiResponse,
          error,
          fetchData
        };
      }
    };
    </script>

    3. Use the Component#

    Add the above component to your Vue 3 application, and make sure to replace YOUR_ACTUAL_TOKEN and YOUR_CLIENT_ID with the actual Token and Client ID.

    4. Notes#

    Ensure that a valid Token and Client ID have been obtained before sending the request.
    Adjust the request method (GET, POST, etc.), URL, and request headers according to the API documentation.

    Modified at 2026-04-13 01:14:50
    Next
    Authorization Code Authentication (Recommended)
    Built with