Vendor APIs and SDKs
Find the supported API for the exact product and version. These pages cover public documentation, access requirements, licensing and integration checks.
On this page
Overview#
This catalogue answers the first integration question: which vendor owned surface is authoritative for the product and job in front of you? It separates public APIs from login gated references, partner SDKs, licensed server interfaces, on device application frameworks, and open standard interfaces. It doesn't turn a marketing claim such as “open API” into an endpoint, entitlement, or compatibility claim.
Start here#
- Selection and capability matrix, compare deployment, access tier, capabilities, and evidence quality.
- Device and edge video, camera, intercom, edge application, device management, and native SDK surfaces.
- VMS and cloud video, server, client, plugin, media, cloud, and event integrations.
- Access and identity, PACS, mobile credentials, cloud access, identity lifecycle, door, and biometric surfaces.
How to use a vendor page#
- Match the exact product family, deployment model, and integration direction.
- Confirm whether the normative material is public, account gated, partner only, licensed, or delivered with an installed product.
- Pin product, firmware/server, API/SDK, operating system/runtime, region, tenant, and licence assumptions.
- Obtain the current vendor compatibility and lifecycle statement before designing against a surface.
- Separate read, event, configuration, credential, media, and physical command privileges.
- Build recovery for duplicate, delayed, missing, reordered, and partially applied operations.
- Validate integrations in an owner approved non production environment before any live deployment.
Evidence grades in this section#
| Grade | Meaning here |
|---|---|
V2 |
Multiple official sources were cross checked, including a reference plus release, lifecycle, product, or access source where available. |
V1 |
An official public landing page or product artefact establishes the surface, but the normative guide, package, entitlement, compatibility matrix, or current details are gated or incomplete. |
V0 |
Reserved for an unverified inventory claim; confirm the vendor documentation before relying on an unverified claim. |
The grade describes source quality, not vendor certification or deployment compatibility. Environment evidence must identify the exact account, entitlement, product build, configuration, and controlled test scope. See verification and safety and the verification policy.
Integration boundaries#
- A vendor API isn't automatically enabled on every model or edition.
- A public reference doesn't grant a tenant, licence, developer account, export right, media entitlement, or command privilege.
- An SDK package version and the product it targets can have independent release lifecycles.
- Cloud regions, sovereign environments, and government editions can use different identities, hosts, features, and data residency terms.
- ONVIF, SIP, BACnet, OSDP, and other standards based support must be confirmed through the exact product declaration or conformance record; it is distinct from a vendor native API.
- “Unlock”, “override”, “arm/disarm”, “output”, “firmware”, “credential”, “biometric”, “audio”, and evidence export operations are high impact even when the transport is ordinary HTTPS.
Shared engineering guidance#
Use these pages with:
- Physical security system architecture
- Identity, authentication, and authorisation
- Events, state, commands, and time
- Interoperability, conformance, and profiles
- Development and integration patterns
- API and event security
- Privacy and sensitive data
- Asset and configuration inventory
Maintenance rule#
Vendor claims in this section expire quickly. Recheck public versus gated access, release status, identity flow, licences, regions, limits, deprecations, and compatibility at least every 90 days and before procurement or implementation. A dated version on a page is an observed documentation fact, not a claim that the version remains latest.