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

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

Firmware update

Getting Started FAQ

syncDeviceCommands

syncProperties

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) ​

Securing webhooks

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

<h2 class="slate-h2 " >Yonomi Platform Getting Started Guide</h2><p class="slate-p " >The Yonomi Platform Getting Started documentation will help a PACS software developer learn the Yonomi Platform purpose, concepts and implementation.</p><p class="slate-p " >It serves as a complete training guide to onboard PACS that are adding support for Yonomi Platform-enabled devices including the <a href="673c94b0fed1b3a01e7cdcb1/669eab147dd27b229f12fa1c/66a251591ed299338e81ff89/66a26b72d755e5b10f48ab09" target="">XE360 WiFi</a> and other next generation Allegion-brand devices.</p><p class="slate-p " >The Getting Started documentation, along with supplemental materials including the YP Quick Start Claiming Training App and Postman collection, drive the self-paced training.  Upon completion, partners should have the knowledge necessary to complete their own YP implementation project.</p><p class="slate-p " ></p>

The Yonomi Platform Getting Started documentation will help a PACS software developer learn the Yonomi Platform purpose, concepts and implementation.

It serves as a complete training guide to onboard PACS that are adding support for Yonomi Platform-enabled devices including the 

 and other next generation Allegion-brand devices.

The Getting Started documentation, along with supplemental materials including the YP Quick Start Claiming Training App and Postman collection, drive the self-paced training.  Upon completion, partners should have the knowledge necessary to complete their own YP implementation project.

<p class="slate-p " >The diagram below shows the recommended implementation of the workflow for updating firmware via BLE Proxy, i.e. when the device is not connected to WiFi.</p><div style="text-align:center"><figure ><div style="display:inline-block"><img src="https://d24lr4zqs1tgqh.cloudfront.net/696a911c-93cf-4f75-a490-119d023133a8-669eab147dd27b229f12fa13.jpg" alt="Firmware update workflow over BLE Proxy" style="
              width:664px;
	            height:907px;
	            aspect-ratio:664 / 907"
         /><figcaption class="published_caption">Firmware update workflow over BLE Proxy</figcaption></div></figure></div><p class="slate-p " ></p>

The diagram below shows the recommended implementation of the workflow for updating firmware via BLE Proxy, i.e. when the device is not connected to WiFi.

Sections

Firmware update

What made this section helpful for you?

What made this section unhelpful for you?

On this page