APIとWebhookの活用例

メール通知・Webhook・APIの使い分け|知らせを受けるだけか、チャットや台帳に流すか、カギの発行まで自動にするかで選ぶ方法

RemoteLOCKからの知らせの受け取りや、カギの発行の自動化には、メール通知・Webhook・APIの3つの方法があります。
やりたいことに合わせて、手間と手続きの少ない方法からお選びいただけるよう、使い分けをまとめました。
こんなとき

やりたいことに合わせて3つから選べます

電池残量の低下や通信の切断を担当者が知るだけなら、お知らせ機能のメール通知で足ります(お知らせ機能)。開発は要りません。メールでは埋もれる、チャットや台帳に自動で流したいというときはWebhookを、予約に合わせてカギを出したいときはAPIを使います。
使い分け

上から順に見て、足りる方法をお選びいただけます

使い分けの決め方の図。1 はじめに:やりたいことを決める。知らせを受けたいか、カギを出したいか。2 メール通知:知らせを人が読めば足りる。お知らせ機能で通知先とイベントを選びます。3 Webhook:知らせをチャットや台帳に流す。受け口を作ります。NDAは要りません。4 API:カギの発行や予約を自動にする。連携を作ります。NDAが要ります。5 API+Webhook:発行も入室の記録も自動にする。APIで発行し、Webhookで記録を受けます。メール通知とWebhookは、お知らせ機能で登録しますNDA(機密保持契約)が要るのはAPIだけです
お知らせ機能で選んだイベントは、メールでもWebhookでも受け取れます。Webhookには扉やカギのIDなどが入るので、プログラムで扱えます。Webhookの通知先は、クラウド管理画面のお知らせ機能で登録でき、APIからも登録できます。カギの発行や予約の作成・変更を自動にするときはAPIが要り、APIで発行したカギの入室の記録はWebhookで受けます。
方法 向いている使い方 準備と手続き
メール通知 電池残量の低下、通信の切断と再接続、番号の同期の失敗、解錠・施錠などを、担当者がメールで受け取る お知らせ機能で通知先とイベントを選ぶだけです。開発もNDAも要りません
Webhook お知らせ機能のイベントを貴社のサーバーで受けて、チャット・台帳・表などに流す 受け口のプログラムを作ります(Webhookの受け口の条件)。NDAは要りません
API 予約に合わせたカギの発行・変更・無効化、アクセスユーザーの登録、デバイスの一覧の取得など 連携のプログラムを作ります。ビジネス スタンダード以上のプランでお支払いが有効なことと、NDAが要ります(ご利用までの手続き)
APIで予約に合わせてカギを出す例は、予約に合わせた暗証番号の自動発行 にあります。
気をつける点

作る前にお確かめいただきたいこと

  • 受け口は、HTTPSで受け、3秒以内に200番台を返す作りにしてください。失敗が続くとWebhookは無効になり、メールでお知らせします(Webhookの受け口の条件)
  • 機種によって受け取れるイベントが違います。すべての扉を対象にするときは、お知らせ機能の情報元を「アカウント」にしてください(お知らせ機能)
  • APIを呼べる回数には上限があります。予約をまとめて作るときは、間隔をあけて送ってください
  • イベントの一覧をAPIで取り出す方法は、2025年12月末で廃止されました(廃止のお知らせ)。これからの記録はWebhookで受け、過去の分はクラウド管理画面のレポートのCSVで取り出します(イベント情報をCSV出力した時の内容)
始め方

まずはお知らせ機能で通知先をご登録ください

Webhookの通知先は、クラウド管理画面の「高度な機能」→「お知らせ機能」→「通知先」で登録し、受け取るイベントを選びます(お知らせ機能)。届く内容の例は Webhookでのイベント情報の取得 にあります。カギの発行などをAPIで自動にしたいときは、API資料のお申し込み からご請求ください。
関連する記事

最終更新

この記事は役に立ちましたか?

0人中0人がこの記事が役に立ったと言っています

記事で解決しないときは

問い合わせフォーム(24時間受付)か、お電話でご相談ください。