Products & Services

API / SDK / XML


Hirsch Identive’s Interoperability Development Kit (IDK) is a professional-grade software development kit (SDK). The IDK is made up of the Velocity application programming interface (API), a Velocity eXtensible markup language (XML) kit, and supporting sample code and documentation to enable experienced coders to develop secure interfaces for two-way data transmission with Velocity.

Authorized third-party applications can perform the following from outside Velocity:

  • Add, modify and delete Velocity people and credentials
  • Receive Velocity alarms, events and transactions
  • Acknowledge and clear Velocity alarms
  • Execute Velocity commands (e.g., lockdown) 
 

With the Hirsch API and Velocity, qualified programmers have everything they need to create high-value, customized functionality, features and interoperability. Some of the most popular applications include:

  • Send alarm notifications to trigger specific video/CCTV system actions
  • Insert new employees into the Velocity database from a third-party human resources system (PeopleSoft, etc.) or from the IT system (Active Directory, etc.). The new employee's building and network access privileges can be enabled automatically and immediately without duplicating data entry
  • Disable access privileges for an employee whose HR system record status was changed to "terminated," automatically and immediately
  • Acknowledge and clear alarms from an external third-party monitoring system or from a handheld device
  • Receive alarm notifications on cell phones or other remote systems
  • Execute Velocity commands (e.g., unlock front door, trigger command set B, lockdown facility) from an external system or handheld device
  • Insert visitors into Velocity from a reception web interface or visitor management system
  • Retrieve data to write custom reports 

The possibilities are endless. Interoperability unlocks the key to real return-on-investment. Interoperability enables you to automate manual processes, enable new capabilities, serve new users, and solve big challenges.

If your target system is "open," meaning it has a robust, mature, documented API and the ability to transmit and receive the necessary information, then you can likely create interoperability between it and your Hirsch security system.

Velocity can interact with nearly any open, external system including:

  • Video (video management systems, DVRs, NVRs, VVRs)
  • Alarm panels, central station receivers
  • People management systems (HR, etc.)
  • Directory services, logical access (Active Directory, etc.)
  • Network access control (NAC)
  • Physical security information management (PSIM) systems
  • Network security information and event management (SIEM) systems
  • Identity management systems (IDMS)
  • Card/credential management systems (CMS)
  • Provisioning systems
  • Visitor management systems
  • Building automation (BACnet, lighting, HVAC, elevator, parking, other)
  • Paging systems
  • Time and attendance (T&A)
  • Handheld devices
 

If you don't want to create the integration programming yourself, consider having Hirsch build it for you. See some of the integration and interfaces available from Hirsch Professional Services Group.   

The Hirsch Interoperability Development Kit includes everything an experienced programmer needs to develop secure interfaces for two-way data transmission with Velocity.

API for People and Credential Records
Technically, the Velocity API is a DLL (Dynamic Link Library), HirschVMO.DLL, based on a programmable COM (Component Object Model) interface. Using HirschVMO.DLL, third parties can programmatically maintain persons and their credentials in Velocity with full logging and without concern for database complexities.

API Sample Code
Eight practical programs and their source code are provided. These programs include an API wrapper (HirschAPIWrap.exe) which is a COM executable program encapsulating API functionality and windows events -- a requirement for web programs. There are two programs designed to demonstrate Velocity XML interoperability (see “XML Kit” below). Additionally, there are two Windows programs with source code in classic Visual Basic and .Net. One is for the API and the other for the Wrapper. Finally, there is a simple VB Script program to demonstrate the use of the Wrapper in a scripting context.

XML Kit

  • Instructions on how to utilize Velocity's web server and XML interface. Set up Velocity to broadcast select information to authorized outside listeners. Execute Velocity commands externally by sending XML remote procedure calls (RPC)
  • XML Listener: XMLEar.exe is a program designed to listen at the designated port for XML code sent from Velocity’s XML Writer and display the XML in a text box
  • XML code generator: TestXML.exe is a program that builds sample Velocity XML RPC commands
 

Documentation
You may view a portion of the IDK Reference Guide.

Support
Eight hours of telephone support is included with the first-year's license fee. Additional phone or in-person support is available.  

 
Send Hirsch A Message

© Hirsch Electronics. All Rights Reserved. Presentation is designed to communicate concepts, thus actual solutions may differ in implementation from that shown and are subject to change without notice. Other company or product names therein may be trademarks or registered trademarks of their respective owners and are respectfully acknowledged.