API / SDK Tutorial

Author: John Honovich, Published on Dec 18, 2016

While Application Programming Interfaces (APIs) are key to 'open' platforms, they are frequently misunderstood and over-hyped in physical security. While APIs can provide great benefits, using them is much more complex than often mentioned in sales calls and magazines.

The goal of APIs in physical security is to allow different systems to work together. Examples include:

  • *********** **** ** ******* ** ********* **** **** ***
  • *********** **** ***/*** **** **** ****** ******* ******
  • *********** **** ***** ****** **** * ******* ********** ******
  • ******** * **** ****** **** ********** **** *** **** ******** systems

*** ***** **** **** ********* ** ***-***** ********** ***** * customer ** ********** **** * ******: "**** **** ****** **** with '*'?" ***** * ***** ** *** ****** ** ******** systems ** *** ****** ** *************.

*** ******* ****** ** *** ***** ****** **:

"****, ** **** ** ***."

**** ** *** ** *** ******** *** ********** ********* ** all ******** ********. ******* ** ** ** ******, ** ** a ***** ***** ** ***** ********* ****.

Lesson #*: ** **** ***** ** '**' ***

***** ** ** **** ***** ** '**' ***. ******** **** exist. ** ****** *******, ******** ** **** *****. *********, ***** is ** *** *** **** ******** ** * ******. **** to ***** **** *****, *** *** **** ***** ***. **** to ****** *** ****, *** *** **** ****** ***. **** to ******** *** ***** **** *** *********, *** *** ********* frame **** ***, ***.

Lesson #*: *** *** ********* **** ** ***

****'* *** ***** *****. *** *** ********* **** ** *** available. *** *** **** * **** ** *** ****** ********** alerts **** ******* ***********. **** *********** *** **** '** ***' but *** * ******** *** *** ******* ****** ******. ** you *** ******* ******* **** ******* ***** **** ******** ** functions, ** ** ****** **** ****** ** ***** ********* *** not ********** *** ** ***.

**** ******* ********** **** *********** ******* *** *****. * ******'* API ***** **** ******* ******** ************* ********* (**** ******* *** shutter *****, **** *******, ***, ***/*****, ***.). **** ** *** integrate *** *** *******, *** *** **** ******* ***********. **** sure ** ***** **** ******** *** **** ********** ** ****** that ** *** ** ****.

Lesson #*: ****** ** *** **** *** **** ** **** **** **** **** ******

***'* *** *** **** ** ********* * ******* *** *** access ******* ******. **** *** **** **** *** ***** ** no ********* **** ***** *** ******** **** **** ********. **** companies ****** **** ** * ***-********* *** *********** *** ** is *** **********.

********* *** ***** ** **** ** ********* ** ********* **** competitors. **** ** ********* *********'* ******** *** ****** ******* ******** Center? **** **** **** **** *** ***** ** **** ************** **** *** ****** ******** ** ***** ****, ** **** control *** *** ****** ***** ****. *** ****, *** *** post *** ********** ** "*********** ********* **** ***** *********."

***** **** *** ********* **** *** *** ******** ** ****** a *** *** *** ***, **** ******** ************* ***** ****** thousands ** ******* ** **** ****** ******. **** ** ********** likely ** ** ** * ***** *****, ****** ** ***** system.

**** ** *** **** ********** ** *** ******* *******'* ***, it ** *** ********** ** ****. ****** *** *** ********, like ****** ** ******, **** * ***** ****** ** ********* use ***** ****, ***** ***** **** ***** ** ******** ** have ************ ******. **** ***** ** ** *** **** *****.

Lesson #*: ***** *** *********** ***** ****

******* ***** ***** * *** ***** *** ***********. **** *** happen *** ***** ******** *** ********* ******* **** ** ** worked *** **** *** **** ************* ******.

******, ****** **** *** *** ********, *** ****** *** *** the *** *** *** ********. ** ***** ******** * ****** application *** ****** ** *** *********** *********** *******. ****, **** integrating **** * ******** ****** ***, *** ****** ****** ****** or ****************** ***** ********. *** **** ****** *** ****** *** ******* any ********* ************ *** ****** *** ******** ************ **********.

** ****, ** ******* ** *** **** *** ****** ****** you ****** *** **** ********. **** ** *** **** ** risk **** ** ***** ******* *** ********** ***** *** *** into *** ********* ******* ***** *** **** ****** ********** ***** APIs. *********, ***** ******** *** ********** **********, *** *** **** and **** *** ****.

Lesson #*: *** ******* *** ***** ***

**** **** * *******, **** ****, **** ******. *** ********** is **** ****, ***** ****** *** ***** **** ******. ******* for ****** ******* *********** ****, ********* ***********, ****** ** *** functionalities.

*******, ***** ******* ****** ** ***** ****. ***'* *** **** system ***** **** "****** *" ******* *.*. *** ***'* *** "Vendor *" ***** *** **** *.* *** **** ******* "****** the ***". ** ***** *****, *** *** ******* ** *** backwards ********** **** *** *** *******. **** ****** ***** ******** stop ******* **** "****** *" ** *** ******* ****** * to ******* *.*. *** ****** ** **** ******** ******* ****** no ****** ******** ***** ** ****** ** ******** *** ****** that **** *** *** *******.

**** ******* ********** **** *******. **** *** ******* * ****** and ** **** *** ****, ***** ******* **** ***, "** you **** *** *** ********" **** ** ***** *** ************* have **** ********** *** *****. **** ** ******* ******* ******* were **** ** *** *** **** '*****' *** ******** **********.

Lesson #*: *** *** ***** **** **** *** *** ****

****** *** *** * **** ***** ********, *** *** ***** with ******** *** *** **** ** ******** *** ** **** it. *****, *** **** *** ****, **** ***** *** ****. However, ** *** **** **** ****** *** **** ******** *** case, **** *** ** **** ** **********. **** **** ******* on **** ********* **** ***** ************ **** *** *** *** and ****** ** ** *** *** ********** *** ********* ******** up *****. ** * ****** ***** ** ** ****, *** change **** ******* **** * *** ** **** *** ******* because *** ****** **** ****** **** **** ** *** ***** the ***** ** ***** ******** ************* ***** **** ***. ****, if **** ******* **** *** ****** ***** ****, ** **** be ********** *** ******** ****** *** *** ******** * ******* deal ** *** ***** ** * ********* ****** **** ****.

Examples ** ****

*** **** **** ***** *** **** **** *** ** ***** surveillance ** ****'* *****. *** ******* ******* ********* **** **+ ********* ************ ******** ********* ****** ****. *** ********, ****'* ******* **** *** *** ********. ** ** **** **, ******* *.*.* ** *** *** to ******* *** *** ********* **** ********** *** ****** *** need ** ***, ****, **** *** ****.

** ***** ******* ** **** ** ****** *** ******* ******** of ********* ********** *** ************** ** ******** ***************.

** *** ***, ***** *** ********* ********* ** ********* **** available. *** ************* ** **,***+ ****. * *** ******** ************** ****,***** ****,******* ****, ***., ***.  

APIs ** ****

*****, *** ***** *** *** *** *** **** ** *********** when ********** ******** ***********.

  • *** - *********** *********** ********* - *** ****** **** ***** specification, ********* *** **** **** ** ********* *** *******
  • *** - ******** *********** *** - *** ************* *** *********** tools **** ******* *** **** *** ******* ** *** *** API

*** **** **** **** ****** ** ****.

*** ******** *** ************ *******, *** ********* **** *** **** an *** ***** **** *** *** ** **** *** ********** how ** *** **. ****, ****** *** **** **** *** fairly ***** ****** *** **** ** **** **** ********* *********/**********, security ******* ***** ******* (** ** ***** *****) ***** * specific ********* (***** .*** ** ****) *** ******* ***** ** make ** ****** ** *** ***** **********.

APIs *** *********

*** *** ******** ** *** ** **** **** **** *********** ones, ********* *** ********** ** ******** *********. **** *** ** typically (** ***** ********) ********* **** ****** **** ** **** are ***** *** **** ****** (********** * **** ***** ****, getting ** *****, ***.). ******* ** ****, ** ** **** time ********* ** ********* **** ******** ******* ** *** **** needs ** ** **** **** *** **** ***** *** **** new ******, ***, ********, ***.

**** '*********' *** ********* ** ************, *********, ***** *** **** **** * ***** ***** ******* ** manufacturers *** ***. ** **** *********** *** ** *** *** 'language', ** ******** **** ***** ** ***** ** ** * universal ********. ** **** ************ ****** **** ******** (***), **** they *** *** *********** ******* ****** ** ***** ***** ****** language ** *** *****. ********* *** ***** ****, **** *** that, *********, *** ******* **** *** ** '***********' *** ******* communicate. ****, *** ******** ********.

[**** *** ********** ******* ** **** *** ******** / ******* in ****.]

Comments (17)

It would be somewhat helpful to have a quantifiable ranking of what manufacturers will make availalbe in their API/SDK and if access is restricted.

We purchased 100 cameras from one manufacturer who claimed there was an API, then they decilined to release the API to anyone.

Which companies have none/good/great API and VMS support?

Michael, it's very rare to have an IP camera manufacturer 'decline to release the API to anyone.' The only exception would be for those who manufacturer cameras and enterprise VMSes. That said, I don't understand why you would ever buy IP cameras from those companies unless you wanted a 'full package solution.'

We could do some research into support but, like I said, camera companies are typically pretty open, as they want more partners.

Restricted API's bother the crap out of me. All things being equal, I lean towards companies that offer open or low-barrier API's (even though those options are woefully lacking). I don't understand the tendency to restrict access. What is the rational?

They figure they can sell more by forcing you to use their own complimentary products rather than a rival's.

Why has Twitter and Instragram been in an API restriction battle over the last year? Same thing :)

Very good/cool breakdown of a very misunderstood part of our industry.

I can say with considerable expierence in this area that dev in our industry can be a nightmare and is always very expensive, someone put it to me once that its not SDK its $DK!

The biggest issue is the lowest common denominator, say you have three video systems that you want to integrate into another thrid party VMS or PSIM every feature available to the front end has to be available on every connected system so you end up not using lots of features on some system because of weakness/lack of API functions in others.

The backwards compatability is the next biggest issue, you can end up stuck on a version because you know if its upgraded it will break the thrid party connectivity. My advice would be go in with your eyes open, and generally software companies like Genetec, Milestone, Onssi etc will have better and more accessable SDK packages than combined soft & hardware vendors like say Avigilon, Honeywell, Tyco etc as their core offering is a combined solution versus just software which the more open guys base their whole existance on.

I find that about 70% of the time when an end user thinks they need dev it turns out they dont, somtimes ripping out kit/changing software can be cheaper and give you a better and more future prof solution, of course sometimes dev is required and when carried out correctly with good underlaying products can yield very impressive results but it always costs, if not in dev hours and specification then in integrator hours and I guareente nothing ever works properly first time, by version 3 or 4 and sometimes 100's of hours later you have something useable.

Phil, great feedback!

"Its not SDK its $DK!" - Classic!

Good point about lowest common denominator. People are sometimes surprised why PSIM video management capabilities are so rudimentary but that is certainly a key barrier.

Interesting point about ripping out old systems. For sure, if you only have a few old DVRs, it is better to rip and replace, unless the integration is bulletproof and available off the shelf. However, if any custom work needs to be done, for sure, it's better to just upgrade. The trickier issue is what happens when you have dozens or hundreds of old units. To replace those could cost hundreds of thousands or millions of dollars/pounds/euros.

I immediately stop listening when someone even mentions API or SDK. If something does not do what I need right now, I have zero faith that "someone somewhere" will write the particular functionality I am looking for. I am also not going to pay for it to be written when there are other products that are out there already that do what I need.

The only thing that turns me off more than the whole API and SDK pitch is when sales folks say something like, "Everyone includes our cameras in their software and they always write them in."

Ross, good feedback and good advice for other end users.

The only caveat I would add is that sometimes vendors know they have you trapped. For instance, if the vendor is an incumbent at your site, he knows how much of their product you already have and can reasonably calculate that you don't have any other realistic option. It's too expensive and complex to switch so he can force you to either pay up or go without any integration.

You MUST be talking about $iemens and their $INVR :-)

Funny you should mention that John because that is exactly the boat we are in now with our #1 in the world integrator with the fancy old/new name. They have had us over a barrel for years and the only thing we could control was the video option. Now that we have moved away from them with video it is on to access control and then, eventually, BA/FA…

Great atricle it very useful

Got it. But I am still looking forward to hearing the class. Sounds like anyone can claim almost anything to sell you a camera. Even though a lot of really amazing stuff is out there it still seems like buyer beware. It sounds like...Sure our stuff will work with yours, as far as you know. When in reality it may be way more trouble than you expect.

Great breakdown of this often misunderstood topic. I find a lot of people not only do not understand API, but often think SDK is the same thing. Whenever I am working with another manufacturer on an integration of products, hearing them describe API or SDK tells me whether I am actually dealing with the technical expert I need to do the work. The scary part is when the most technical person on their team does not know either.

Any tutorials on how to actually get started using these APIs?

I have an EDI installed on my pc... just need some basic direction...

For example... what language are these in? Some practical examples etc...

Thanks

Kenny try, getting into API programming for SPLUNK. There are some ACAM and VMS integrations you might find interesting.

There is much support in the SPLUNK environment for tying business intelligence together in the security world. You will find a lot more robust software hooks to simulate with.

Good Luck.

There is much support in the SPLUNK environment for tying business intelligence together in the security world

What security / surveillance products / APIs are supported by SPLUNK?

Login to read this IPVM report.
Why do I need to log in?
IPVM conducts unique testing and research funded by member's payments enabling us to offer the most independent, accurate and in-depth information.

Related Reports

VMS Server Sizing on May 25, 2018
Specifying the right sized PC/server for VMS software is one of the most important yet difficult decisions in IP video surveillance. In the past...
Hanwha Wisenet X Analytics and VMD Test on May 24, 2018
Continuing our updated testing of camera analytics, we tested Hanwha's Wisenet X analytics for over two weeks in multiple scenes, indoors and out,...
Software Only VMS vs NVR Appliances on May 23, 2018
Should you buy your own PC/server and load VMS software on it or get a turnkey appliance (both hardware and software, e.g., NVR, Hybrid DVR) from a...
Buy Arecont: Top Bid $10 Million Cash on May 22, 2018
Last year, Arecont had a deal for a purchase price of $170 million (see Failed Arecont China Acquisition). This year, Arecont has a deal for a...
Installing Box Cameras Indoors Tutorial on May 22, 2018
This tutorial starts our physical installation for video surveillance series, starting with Box Cameras, one of the oldest and most basic types....
Dahua Intrusion Analytics And VMD Tested (Poorly) on May 21, 2018
Dahua ships basic analytics on practically all their cameras, ranging from low cost to high end. To see how these analytics work in real world...
Best Manufacturer Technical Support 2018 on May 21, 2018
While 5 manufacturers made the worst technical support 2018 list, only 3 stood out as providing the best technical support to 190+ integrators in...
Stealth / UCIT - Remote Video Monitoring Provider Profile on May 18, 2018
Can 2 remote video monitoring companies, Stealth Monitoring from the US and UCIT from Canada combine to impact the market and compete in a changing...
Cybersecurity for IP Video Surveillance Guide on May 18, 2018
Keeping surveillance networks secure can be a daunting task, but there are several methods that can greatly reduce risk, especially when used in...
Dahua 12MP Fisheye Camera Tested (NK8BR4) on May 16, 2018
Continuing our coverage of 12MP sensor fisheye cameras, we bought and tested the Dahua NK8BR4, examining: Default vs. Optimized...

Most Recent Industry Reports

VMS Server Sizing on May 25, 2018
Specifying the right sized PC/server for VMS software is one of the most important yet difficult decisions in IP video surveillance. In the past...
China: Foreign Video Surveillance Is Security Risk on May 25, 2018
The Chinese government has long acknowledged that foreign video surveillance is a 'risk to national security' and has increasingly and almost...
US House Passes Bill Banning Gov Use of Dahua and Hikvision on May 24, 2018
Today, the US House of Representatives passed H.R. 5515, a bill that includes a ban on the US government's use of Dahua and Hikvision. This follows...
Hanwha Wisenet X Analytics and VMD Test on May 24, 2018
Continuing our updated testing of camera analytics, we tested Hanwha's Wisenet X analytics for over two weeks in multiple scenes, indoors and out,...
Ambitious Mobile Access Startup: Openpath on May 24, 2018
This team sold their last startup for hundreds of millions of dollars, now they have started Openpath to become a rare access control small...
Amazon's "Dangerous New Face Recognition Technology" Says ACLU on May 23, 2018
The ACLU has caused a stir, with a new report Amazon Teams Up With Law Enforcement to Deploy Dangerous New Face Recognition Technology,...
Software Only VMS vs NVR Appliances on May 23, 2018
Should you buy your own PC/server and load VMS software on it or get a turnkey appliance (both hardware and software, e.g., NVR, Hybrid DVR) from a...
Buy Arecont: Top Bid $10 Million Cash on May 22, 2018
Last year, Arecont had a deal for a purchase price of $170 million (see Failed Arecont China Acquisition). This year, Arecont has a deal for a...
Installing Box Cameras Indoors Tutorial on May 22, 2018
This tutorial starts our physical installation for video surveillance series, starting with Box Cameras, one of the oldest and most basic types....
The Hikvision Smart Classroom Behavior Management System on May 22, 2018
Hikvision's rapidly growing offering of analytics, which we most recently examined with Hikvision's ethnic minority analytics, is now going into...

The world's leading video surveillance information source, IPVM provides the best reporting, testing and training for 10,000+ members globally. Dedicated to independent and objective information, we uniquely refuse any and all advertisements, sponsorship and consulting from manufacturers.

About | FAQ | Contact