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

<p class="slate-p " >With Yonomi Platform concepts complete, the remainder of this training will focus on a hands-on project exercising all aspects of the topics you’ve reviewed.   This training will focus on a multifamily project. ​</p><p class="slate-p " >Your role and objective: Fictitious Allegion PACS partner <strong class="slate-bold">Romanworks</strong> would like to add XE360s to their portfolio of supported devices on the Romanworks Access Control Platform, their ACS. They would then like to onboard <strong class="slate-bold">Acme Living LLC</strong> as a customer. Acme Living’s first installation site for devices will be <strong class="slate-bold">125 Ocean Ave in Miami</strong>.</p><p class="slate-p " >We will operate under the following personas for this project:​</p><div class="published-table"><div class="table-container" style="padding-left: 0px;"><table class="slate-table" style="min-width:100%;"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:100px;">Title</div><div style="width:100px;">Description</div></div><colgroup ><col style="width:initial"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p><div style="text-align:left"><figure ><div style="display:inline-block"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/5e5dc4e9-cbdc-4716-a08d-d41c903dad22.jpg" alt="" style="
              width:100px;
	            height:100px;
	            aspect-ratio:100 / 100"
         /></div></figure></div></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >“<strong class="slate-bold">Darryl</strong>“ will be referenced as the name of developer at Romanworks who will be doing development</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p><div style="text-align:left"><figure ><div style="display:inline-block"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/5e85199f-335d-4bcd-988b-348835cf6127.jpg" alt="" style="
              width:100px;
	            height:100px;
	            aspect-ratio:100 / 100"
         /></div></figure></div></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >“<strong class="slate-bold">Anna</strong>” will be the property manager at Acme Living who owns the locks and building at 125 Ocean Ave</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p><div style="text-align:left"><figure ><div style="display:inline-block"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/df46134d-244f-4571-8923-53f231d0f6ea.jpg" alt="" style="
              width:100px;
	            height:100px;
	            aspect-ratio:100 / 100"
         /></div></figure></div></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >“<strong class="slate-bold">Ivonne</strong>” will be the integrator responsible for installing and setting up hardware</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p><div style="text-align:left"><figure ><div style="display:inline-block"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/9309b0d6-7653-488d-84b3-d9ee4118ecdb.jpg" alt="" style="
              width:100px;
	            height:99px;
	            aspect-ratio:100 / 99"
         /></div></figure></div></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >”<strong class="slate-bold">Paully</strong>” will be the patron of Anna’s building at 125 Ocean Ave</p></td></div></tr></tbody></table></div></div><p class="slate-p " ></p>

With Yonomi Platform concepts complete, the remainder of this training will focus on a hands-on project exercising all aspects of the topics you’ve reviewed.   This training will focus on a multifamily project. ​

Your role and objective: Fictitious Allegion PACS partner 

 would like to add XE360s to their portfolio of supported devices on the Romanworks Access Control Platform, their ACS. They would then like to onboard 

 as a customer. Acme Living’s first installation site for devices will be 

We will operate under the following personas for this project:​

Title

Description

<div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:100px;">Title</div><div style="width:100px;">Description</div></div><colgroup ><col style="width:initial"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/23594227-e804-477e-b5de-5e85efaf4851.jpg" style="width:auto;height:auto" /></div></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">All trait-defined actions that manipulate a device&apos;s state after it has been claimed fall under this flow except bulk data uploads.​</strong></p><p class="slate-p " ></p><p class="slate-p " >When invoking a single API call with asynchronous resolution, the mutation name and the necessary arguments should be provided. The selection set should include the <code class="slate-code"><strong class="slate-bold">Action ID </strong></code>to track the action&apos;s lifecycle effectively.​</p><p class="slate-p " ></p><p class="slate-p " >There are two relevant events are associated with this flow: <code class="slate-code"><strong class="slate-bold">DEVICE_ACTION_CREATE</strong></code> and <code class="slate-code"><strong class="slate-bold">DEVICE_ACTION_UPDATED</strong></code>​</p></td></div></tr></tbody></table></div><p class="slate-p " ></p><p class="slate-p " ></p>

Sections

Single API Call with Asynchrounous Resolution

What made this section unhelpful for you?

On this page