NG-Key
NG-Key
Developer APIs

Tenant API v1 — the contract automation teams actually read

Published OpenAPI specs, Postman collections, and permission scopes (`tenant.devices.write`, `tenant.integrations.m365.read`, `tenant.edge_devices.commands`, …) separate read telemetry from mutating operations — partners ship CI/CD‑safe integrations instead of screen‑scraping your tenant UI.

The tenant API spans context discovery, managed devices (provision, claim, reprovision, remote commands), locations and areas, reader presets, edge appliances, and explicit Microsoft 365 visit integration endpoints — everything namespaced per tenant header.

Personal API tokens inherit RBAC semantics — humans and service accounts stay distinguishable in audit evidence.

Edge gateways expose their own REST surfaces for appliance lifecycle; pairing cloud tenant APIs with edge automation covers full campus deployment pipelines.

Rate limits and error semantics mirror serious SaaS expectations — scripts recover predictably instead of hammering operators.

Interactive Scalar docs, OpenAPI YAML, and Postman artefacts ship alongside authenticated workspaces — procurement pilots review contracts beside live tenant references.

Spotlight

What API consumers get today

  • OpenAPI YAML + Postman JSON maintained with releases — consumed via authenticated Scalar docs inside your tenant workspace.
  • Granular ability scopes — separate read vs write vs command privileges for devices, edge hardware, locations, and integrations.
  • Provisioning pipelines — create managed devices, issue claims, push remote commands, and audit outcomes programmatically.
  • M365 visit automation — integration status and sync endpoints align visitor posture with calendar reality.
  • Edge orchestration — manage edge devices and remote commands where LAN gateways participate in rollout.
  • Tenant isolation by construction — ambiguous headers fail closed instead of leaking neighbouring estates.
Abstract API gateway beams and MQTT paths — NG-Key integrations marketing tile

Depth

Endpoints teams wire into CI/CD

Integration surfaces

Microsoft 365 visits status & sync — keep visitor programmes aligned without manual refresh jobs.

Managed devices

List, create, claim, reprovision, and issue remote commands — automate commissioning at scale.

Edge appliances

Provision gateways, patch metadata, and issue remote commands with the same scoped tokens.

Locations & areas

Structure automation around facility hierarchy — align orchestration jobs with physical truth.

Reader presets

Codify safe defaults and propagate configuration consistently across fleets.

Tokens & rotation

Tenant API tokens with explicit abilities — rotate and revoke without hunting shared secrets.

Motion

How platform teams ship safely

01

Read the contract

Import OpenAPI into your gateway — agree error semantics before writing glue.

02

Scope tokens

Grant least privilege per workload — readers vs integrations vs edge commands.

03

Automate

Wire provisioning pipelines with retries, backoff, and structured logging.

04

Prove audit

Demonstrate lineage for security reviews — tokens map cleanly to automation identities.

Outcomes teams feel in production

Fewer bespoke scripts and VPN‑dependent hacks holding integrations together.

Clear accountability when automation touches readers, gateways, or visitor records.

Partners onboard faster — references share OpenAPI artefacts instead of tribal knowledge.

Security reviews shorten because scopes encode intent explicitly.

Product preview

Chapter walkthrough

Short cinematic clip for this integrations chapter — muted, looped in-page players follow your motion preferences elsewhere on the site.

Continue exploring

Open workspace identity, facility topology, or ledger exports — or return to the platform core.