API / SDK Tutorial

By: 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:

  • *********** **** ** ******* or ********* **** **** VMS
  • *********** **** ***/*** **** your ****** ******* ******
  • *********** **** ***** ****** with * ******* ********** system
  • ******** *********** **** ********** **** all **** ******** *******

*** ***** **** **** discussed ** ***-***** ********** where * ******** ** integrator **** * ******: "Does **** ****** **** with '*'?" ***** * could ** *** ****** of ******** ******* ** any ****** ** *************.

*** ******* ****** ** the ***** ****** **:

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

**** ** *** ** the ******** *** ********** statement ** *** ******** security. ******* ** ** so ******, ** ** a ***** ***** ** start ********* ****.

Integration ******** ******** ****

***** ** ** **** thing ** '**' ***. Numerous **** *****. ** larger *******, ******** ** APIs *****. *********, ***** is ** *** *** each ******** ** * system. **** ** ***** live *****, *** *** live ***** ***. **** to ****** *** ****, use *** **** ****** API. **** ** ******** the ***** **** *** recording, *** *** ********* frame **** ***, ***.

Not *** ********* **** ** ***

*** *** ********* **** an *** *********. *** you **** * **** of *** ****** ********** alerts **** ******* ***********. This *********** *** **** 'an ***' *** *** a ******** *** *** sending ****** ******. ** you *** ******* ******* most ******* ***** **** hundreds ** *********, ** is ****** **** ****** of ***** ********* *** not ********** *** ** API.

**** ******* ********** **** integrating ******* *** *****. A ******'* *** ***** lack ******* ******** ************* functions (**** ******* ***** codec ********, *****, ***/*****/** status, ***.). **** ** you ********* *** *** devices, *** *** **** significant ***********. **** **** to ***** **** ******** you **** ********** ** ensure **** ** *** be ****.

Having ** *** **** *** ****** *************

** *** **** ** integrate * ******* *** and ****** ******* ******, both *** **** **** but ***** ** ** guarantee **** ***** *** products **** **** ********. Both ********* ****** **** is * ***-********* *** integration *** ** ** not **********.

********* *** ***** ** make ** ********* ** integrate **** ***********. **** to ********* *********'* ******** VMS ****** ******* ******** Center? **** **** **** APIs *** ***** ** this************** **** *** ****** unlikely ** ***** ****, as **** ******* *** can ****** ***** ****. For ****, *** *** post *** ********** ** "*********** ********* **** ***** Recorders."

***** **** *** ********* free *** *** ******** or ****** * *** fee *** ***, **** security ************* ***** ****** thousands ** ******* ** even ****** ******. **** is ********** ****** ** it ** * ***** video, ****** ** ***** system.

**** ** *** **** permission ** *** ******* company's ***, ** ** not ********** ** ****. Unlike *** *** ********, like ****** ** ******, only * ***** ****** of ********* *** ***** APIs, ***** ***** **** could ** ******** ** have ************ ******. **** leads ** ** *** next *****.

Integration ***** ****

******* ***** ***** * few ***** *** ***********. This *** ****** *** often ******** *** ********* details **** ** ** worked *** **** *** take ************* ******.

******, ****** **** *** web ********, *** ****** can *** *** *** off *** ********. ** often ******** * ****** application *** ****** ** the *********** *********** *******. Plus, **** *********** **** a ******** ****** ***, you ****** ****** ****** or ****************** ***** ********. *** only ****** *** ****** can ******* *** ********* difficulties *** ****** *** security ************ **********.

** ****, ** ******* of *** **** *** dollar ****** *** ****** for **** ********. **** is *** **** ** risk **** ** ***** unknown *** ********** ***** you *** **** *** technical ******* ***** *** each ****** ********** ***** APIs. *********, ***** ******** are ********** **********, *** the **** *** **** can ****.

API ******* *** ***** ***********

**** **** * *******, over ****, **** ******. The ********** ** **** APIs, ***** ****** *** break **** ******. ******* for ****** ******* *********** bugs, ********* ***********, ****** in *** ***************.

*******, ***** ******* ****** on ***** ****. ***'* say **** ****** ***** with "****** *" ******* 3.1. *** ***'* *** "Vendor *" ***** *** with *.* *** **** version "****** *** ***". In ***** *****, *** new ******* ** *** backwards ********** **** *** old *******. **** ****** could ******** **** ******* with "****** *" ** you ******* ****** * to ******* *.*. *** result ** **** ******** command ****** ** ****** displays ***** ** ****** or ******** *** ****** that **** *** *** upgrade.

**** ******* ********** **** cameras. **** *** ******* a ****** *** ** does *** ****, ***** vendors **** ***, "** you **** *** *** firmware" **** ** ***** two ************* **** **** integrated *** *****. **** is ******* ******* ******* were **** ** *** API **** '*****' *** existing **********.

Adding ********* ** **** ****

****** *** *** * very ***** ********, *** are ***** **** ******** the *** **** ** whatever *** ** **** it. *****, *** **** you ****, **** ***** out ****. *******, ** you **** **** ****** for **** ******** *** case, **** *** ** hard ** **********. **** sure ******* ** **** technical **** ***** ************ what *** *** *** and ****** ** ** you *** ********** *** potential ******** ** *****. If * ****** ***** to ** ****, *** change **** ******* **** a *** ** **** and ******* ******* *** vendor **** ****** **** they ** *** ***** the ***** ** ***** security ************* ***** **** API. ****, ** **** believe **** *** ****** needs ****, ** **** be ********** *** ******** unless *** *** ******** a ******* **** ** the ***** ** * briefcase ****** **** ****.

Examples ** ****

*** **** **** ***** and **** **** ************ API ** ***** ************ is ****'* *****. *** current ******* ********* **** **+ ********* sections**** ******** ********* ****** each. *** ********, ****'* their** **** *** *** document. ** ** **** 24, ******* *.*.* ** see *** ** ******* the *** ********* **** parameters *** ****** *** need ** ***, ****, zoom *** ****.

** ***** ******* ** Axis ** ****** *** require ******** ** ********* operations *** ************** ** numerous ***************.

** *** ***, ***** are ********* ********* ** different **** *********. *** this********* ** **,***+ ****. * *** ******** include ******* **** [**** no ****** *********],***** ****,******* ****, ***., ***.

APIs ** ****

*****, *** ***** *** and *** *** **** in *********** **** ********** software ***********.

  • *** - *********** *********** Interface - *** ****** code ***** *************, ********* you **** **** ** integrate *** *******
  • *** - ******** *********** Kit - *** ************* and *********** ***** **** support *** **** *** parties ** *** *** API

*** **** **** **** on**** ** ****.

*** ******** *** ************ systems, *** ********* **** and **** ** *** along **** *** *** to **** *** ********** how ** *** **. Plus, ****** *** **** that *** ****** ***** weight *** **** ** call **** ********* *********/**********, security ******* ***** ******* (or ** ***** *****) using * ******** ********* (often .*** ** ****) and ******* ***** ** make ** ****** ** use ***** **********.

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

*** *** ******** ** far ** **** **** been *********** ****, ********* and ********** ** ******** companies. **** *** ** typically (** ***** ********) different **** ****** **** if **** *** ***** the **** ****** (********** a **** ***** ****, getting ** *****, ***.). Because ** ****, ** is **** **** ********* to ********* **** ******** systems ** *** **** needs ** ** **** over *** **** ***** for **** *** ******, VMS, ********, ***.

**** '*********' *** ********* in ************, *********, ***** *** **** that * ***** ***** section ** ************* *** use. ** **** *********** API ** *** *** 'language', ** ******** **** ONVIF ** ***** ** be * ********* ********. If **** ************ ****** that ******** (***), **** they *** *** *********** without ****** ** ***** every ****** ******** ** the *****. ********* *** still ****, **** *** that, *********, *** ******* will *** ** '***********' how ******* ***********. ****, see ******** ********.

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

Comments (19)

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.

This tutorial helped me connect dots and understand further. Thank you much for a great job of presenting the content in a clear fashion.

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

ONVIF Video Surveillance Tutorial on Jan 29, 2019
ONVIF is well known within the surveillance industry as an interface to connect IP cameras and VMS systems. However, new users may find it...
Last Chance - Camera Course Winter 2020 on Jan 30, 2020
This is the only independent surveillance camera course, based on in-depth product and technology testing. Lots of manufacturer training exists...
2020 Camera Book Released on Jan 10, 2020
This is the best, most comprehensive security camera training in the world, based on our unprecedented testing. Now, all IPVM PRO Members can get...
Security Sales Course January 2020 - Last Chance on Jan 02, 2020
Notice: This is the last chance to register for the course. This sales course is customized for the current needs and challenges specific to...
2020 IP Networking Book Released on Jan 06, 2020
The new IP Networking Book 2020 is a 280 page in-depth guide that teaches you how IT and telecom technologies impact modern security systems,...
No Genetec Major Releases In Over A Year on Feb 06, 2019
Annual VMS licenses are a controversial practice in the video surveillance industry, with many questioning their need or value. However, enterprise...
Milestone Launches Marketplace Where Nothing Is For Sale on Feb 26, 2019
The central announcement at Milestone's annual conference MIPS is Marketplace, which Milestone compared to Uber and Match.com for its ability to...
Manufacturer Favorability Guide 2019 on Jun 12, 2019
The 259 page PDF guide may be downloaded inside by all IPVM members. It includes our manufacturer favorability rankings and individual...
Milestone "GDPR-ready" Certification Claim Critiqued on Aug 12, 2019
Milestone is touting that its latest XProtect VMS is "GDPR-ready" with a 'European Privacy Seal'. However, our investigation raises significant...
Video Surveillance 101 Course - Last Chance on Feb 20, 2020
This is the last chance to join IPVM's first Video Surveillance 101 course, designed to help those new to the industry to quickly understand the...

Most Recent Industry Reports

Every VMS Will Become a VSaaS on Feb 21, 2020
VMS is ending. Soon every VMS will be a VSaaS. Competitive dynamics will be redrawn. What does this mean? VMS Historically...
Video Surveillance 101 Course - Last Chance on Feb 20, 2020
This is the last chance to join IPVM's first Video Surveillance 101 course, designed to help those new to the industry to quickly understand the...
Vulnerability Directory For Access Credentials on Feb 20, 2020
Knowing which access credentials are insecure can be difficult to see, especially because most look and feel the same. Even insecure 125 kHz...
AI/Smart Camera Tutorial on Feb 20, 2020
Cameras with video analytics, sometimes called 'Smart' camera or 'AI' cameras, etc. are one of the most promising growth areas of video...
China Manufacturer Suffers Coronavirus Scare on Feb 20, 2020
Uniview suffered a significant health scare last week after one of its employees reported a fever and initially tested positive for coronavirus....
Cheap Camera Problems at Night on Feb 19, 2020
Cheap cameras generally have problems at night, despite the common perception that integrated IR makes cameras mostly the same, according to new...
Milestone Launches Multiple Cloud Solutions on Feb 18, 2020
Milestone is going to the cloud, becoming one of the last prominent VMSes to do so. Milestone is clearly late but how competitive do these new...
Video Surveillance Architecture 101 on Feb 18, 2020
Video surveillance can be designed and deployed in a number of ways. This 101 examines the most common options and architectures used in...
UK Stands Behind Hikvision But Controversy Continues on Feb 18, 2020
Hikvision is exhibiting at a UK government conference for law enforcement, provoking controversy from the press, politicians, and activists due to...
IronYun AI Analytics Tested on Feb 17, 2020
Taiwan startup IronYun has raised tens of millions for its "mission to be the leading Artificial Intelligence, big data video software as a service...