Allegion

Getting Started

Introduction

Overview

Yonomi Platform Concepts

General Terms: Roles

General Terms: Concepts

YP Developer Portal Account

Dev Resource Group

Installation

Organization

Integration

Application Clients

Webhook

Relationship between Integrations, Organizations and Installations

Identity Federation

Device Claiming

Common Device Workflows

Prerequisites

Determining if a Device is Claimable

Architecture

The Yonomi Platform Solution

Technology Stack overview

Core Components

Platform Interface

Traits

Queries

Training Project

Training Project Solution Goal

Training: YP Developer Portal

API Training Section 1: Working with th eYP GraphQL API

Training: Preparation for Claiming a Device

API Training Section 2: Claiming a Device

Training: Triggered Events

API Training Section 3: Working with Devices

Changelog

Blank

Production

Action-Lifecycle Events

Trait Actions and the Action Lifecycle

API Calls

Authorize the Romanworks Integration to manage the  Acme Org (Request #9) ​

BLE Proxy overview

Client Use Cases

Cloud-driven Device Management

Create the 125 Ocean Ave Installation (Request #5) ​

Dev Resource Groups Elements

Device Actions: Examples of 2-Step API Calls with Asynchronous Resolution​

Device Actions: Examples of Single API Calls with Asynchrounous Resolution

Device History Events

Device Queries

Training App

Events in Yonomi Platform

Features

Getting Started FAQ

Schlage XE360

Yonomi Platform Developer Portal

YP No Tour overview

List Authorized Integrations for Acme Living Org (Request #10)​

Login to YP Developer Portal

Sidequest: Observe the Scripts and Automatically Set Variables

YP Dev Portal: Organization ID

Query the Romanworks Integration ID (Request #8) ​

Set the Claim Token in Postman​

Sidequest: Device Time

Sidequest: How to FDR the XE360 WiFi Lock​

Single API Call with Asynchrounous Resolution

Single API Call with Synchrounous Resolution

Summary: YP Developer Portal

The first webook event:  A subscription confirmation request from YP​

Training: Claim a Device (Request #11)

Training: Confirming the Webhooks Subscription

Training: Create a Dev Resource Group

Training: Create a User Scope Application Client

Training Create a Webhook Configuration

Training: Create an Identity Federation Configuration

Training: Create an Integration

Training : Create an M2M Client

Training: Create the Acme Living Organization (Request #2)

Training: Generating Access Tokens using the Client Credential Client

Training: Generating Access Tokens using the M2M Client

Training: Using Postman for API Requests Part 2

Training: Using Postman for API Requests Part 1

Training: Set the Claim Token in Postman

Two-step Bulk Upload Process with Asynchrounous Resolution

Training: Working with Devices

Trait Action Resolution:​ Webhooks vs. Event Queries​

What's Not Covered

What We Will Build

Training: Raw Event Data

Training: The Message Field

YP Dev Portal: Integrations

YP Dev Portal: Application Clients

YP Dev Portal : Federation Configurations

YP Dev Portal: Webhooks

User Scope Clients vs. M2M Clients

This section covers basic Yonomi Platform concepts that a developer must understand to build a successful integration to Yonomi Platform. Concrete definitions of each concept will be provided as reference.Refer back to this section as necessary to understand the various Yonomi Platform objects and concepts and relationships between them.

This section covers basic Yonomi Platform concepts that a developer must understand to build a successful integration to Yonomi Platform.  Concrete definitions of each concept will be provided as reference.

Refer back to this section as necessary to understand the various Yonomi Platform objects and concepts and relationships between them.

 is a deployment of Allegion hardware owned by an Owner.  ​

Installations are created using the YP GraphQL API.​

An owner may manage one or multiple physical sites using a single installation:  ​

Alternatively, an owner may associate each physical site with its own installation: ​

Which organizational approach is used is up to the PACS and how they’ve structured their integration with Yonomi Platform to manage installations.  

An installation for YP is different than an installation than a “site” in Engage. ​

Sections

Installation

An owner may manage one or multiple physical sites using a single installation:

Alternatively, an owner may associate each physical site with its own installation:

What made this section unhelpful for you?

On this page

Sections

Installation

An owner may manage one or multiple physical sites using a single installation: ​

Alternatively, an owner may associate each physical site with its own installation: ​

What made this section unhelpful for you?

On this page

An owner may manage one or multiple physical sites using a single installation:

Alternatively, an owner may associate each physical site with its own installation: