NG-Key
NG-Key
Developer APIs

Tenant API v1 – the contract automation teams are actually reading.

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

The tenant API spans context discovery, managed readers (provision, claim, redeploy, remote commands), locations and areas, reader presets, Edge devices, and explicit Microsoft 365 visitor integration endpoints – all namespaced per tenant header.

Personal API tokens inherit RBAC semantics — people and service accounts remain distinguishable in audit trails.

Edge Gateways Expose Their Own REST Surfaces for Device Lifecycle; Combining Cloud Tenant APIs with Edge Automation Covers Full Campus Deployment Pipelines.

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

Interactive scalar documents, OpenAPI YAML, and Postman artifacts are provided alongside authenticated workspaces – procurement projects review contracts alongside live tenant references.

Spotlight

What API consumers get today

  • OpenAPI YAML + Postman JSON maintained with releases — consumed via authenticated Scalar documents in your tenant workspace.
  • Granular ability scopes — separate read vs write vs command rights for readers, edge hardware, locations, and integrations.
  • Provisioning pipelines — create managed readers, issue claims, send remote commands, and programmatically audit results.
  • M365 Visit Automation – Integration status and sync endpoints align visitor posture with calendar reality.
  • Edge Orchestration – Manage Edge Devices and Remote Commands, with LAN Gateways Participating in the Rollout.
  • Tenant isolation by construction – ambiguous headers fail closed instead of leaking adjacent areas.
Abstract API gateway beams and MQTT paths — NG-Key integrations marketing item

Depth

Endpoints Teams Wire into CI/CD

Integration surfaces

Microsoft 365 visits status & sync — keep visitor programs in sync without manual update jobs.

Managed Readers

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

Edge Appliances

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

Locations & Areas

Structure automation around facility hierarchy — aligning orchestration tasks with physical reality.

Reader presets

Codify safe defaults and propagate configuration consistently across fleets.

Tokens & Rotation

Tenant API tokens with explicit permissions – rotate and revoke without searching for shared secrets.

Motion

How platform teams ship safely

01

Read the contract

Import OpenAPI into your gateway – agree on error semantics before connecting.

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 Clearly to Automation Identities.

Outcomes that teams feel

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 artifacts instead of tribal knowledge.

Security reviews shorten because scopes explicitly encode intent.

Product Preview

Chapter Walkthrough

Short Cinematic Clip for This Chapter About Integrations – Silent, Repeated in the Page, Players Follow Your Motion Settings Elsewhere on the Page.

Continue Exploring

Open Workspace Identity, Facility Topology, or Ledger Exports – or Return to the Platform Core.