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 (18)

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?

Good article on API.

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

Axis ~$100 Camera Tested on Jul 17, 2018
Axis has released their lowest cost camera ever, the Companion Eye Mini L, setting their sights on a market dominated by Hikvision and Dahua. Can...
Installing Dome Cameras Indoors Guide on Jul 16, 2018
IPVM is producing the definitive series on installing surveillance cameras. This entry covers one of the most common scenarios - installing dome...
Security Sales Course Summer 2018 on Jul 13, 2018
Based on member's interest, IPVM is offering a security sales course this summer. Register Now - IPVM Security Sales Course Summer 2018 This...
Axis Perimeter Defender Video Analytics Tested on Jul 12, 2018
Axis 'high security' video analytics offering is Perimeter Defender, OEMed / developed with Digital Barriers. But how good is Perimeter Defender?...
Eastern and SavvyTech Merge, Form ENS, Targets ADI on Jul 09, 2018
ADI, ENS is coming for you. Or, at least, they hope. Two US distributors, NY based EasternCCTV and California based SavvyTech have merged, to...
Arlo IPO Filing Reveals Key Financial and Competitive Details on Jul 09, 2018
Arlo is going to IPO at a projected valuation greater than Axis. Now, Arlo has released their 175-page Form S1 Registration Statement for its...
Drops Dahua, Fenner Becomes ISS CMO on Jul 09, 2018
Hired to improve Dahua's miserable marketing just last year, Janet Fenner has quit Dahua, joining VMS manufacturer ISS as Chief Marketing...
UK VSaaS Startup Ocucon on Jul 03, 2018
Decreasing exposure to fraudulent slip-and-fall insurance claims and lawsuits is one of the oldest selling points of video surveillance for retail....
Digital Watchdog Low Cost 4MP Camera Tested on Jul 02, 2018
Based on member 4MP testing requests, we bought and tested Digital Watchdog's low-cost 4MP DWC-MTT4Wi to see how it performs in real world scenes,...
Replacing / Switching Access Control Systems Guide on Jun 28, 2018
Ripping out and replacing access control systems is hard for important reasons. Because users typically hold on to access control systems for as...

Most Recent Industry Reports

Axis ~$100 Camera Tested on Jul 17, 2018
Axis has released their lowest cost camera ever, the Companion Eye Mini L, setting their sights on a market dominated by Hikvision and Dahua. Can...
Amazon Ring Alarm System Tested on Jul 16, 2018
Amazon Ring is going to hurt traditional dealers, and especially ADT, new IPVM test results of Ring's Alarm system underscore. IPVM found that...
Hikvision Wins Chinese Government Forced Facial Recognition Project Across 967 Mosques on Jul 16, 2018
Hikvision has won a Chinese government tender which requires that facial recognition cameras be set up at the entrance of every single mosque...
Installing Dome Cameras Indoors Guide on Jul 16, 2018
IPVM is producing the definitive series on installing surveillance cameras. This entry covers one of the most common scenarios - installing dome...
Security Sales Course Summer 2018 on Jul 13, 2018
Based on member's interest, IPVM is offering a security sales course this summer. Register Now - IPVM Security Sales Course Summer 2018 This...
US Tariffs Hit China Video Surveillance on Jul 13, 2018
Chinese video surveillance products avoided tariffs for the first two rounds. Now, in the third round, many video surveillance products will be...
Last Chance - July 2018 IP Networking Course on Jul 12, 2018
Registration ends today, Thursday. Register now. This is the only networking course designed specifically for video surveillance...
4 Most Difficult Camera Installs (Statistics) on Jul 12, 2018
Heavy housings, cumbersome brackets, heavy ladders required, and tricky field of view requirements will cause difficulties no matter the camera...
Axis Perimeter Defender Video Analytics Tested on Jul 12, 2018
Axis 'high security' video analytics offering is Perimeter Defender, OEMed / developed with Digital Barriers. But how good is Perimeter Defender?...

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