APIを使った開発のTIPs

予約APIでのigloohomeへのカギの発行|algorithm_pinの仕様と注意点

予約APIからigloohomeデバイス用アクセスキー algorithm_pin を発行する際、以下のポイントに留意してください。

  • デバイス名とIDの取得

    • デバイス一覧からdevice_idを取得してください。typeによるフィルタはかけない事を推奨していますが、絞り込みをしている場合はタイプ"igloo_lock"が除外されないようにしてください。
  • algorithm_pin 仕様(2024-08-22時点)

    1. 暗証番号の指定・編集は不可。予約APIから自動発行のみ
    2. 9桁のランダムな暗証番号が発行 例:968941311
    3. 有効な最大期間:365日まで
    4. APIのvalidationパラメータと開始終了時刻の制限
      falseの指定した場合、開始・終了時刻を、有効な時刻に自動補正します。
      trueまたは指定なしの場合は、以下の制限通りに指定する必要があります。
      • デバイスの制限に開始・終了日時は時間単位でしか設定できない(分は00)
      • 28日間以上有効なalgorithm_pin:開始・終了の時刻を合わせる必要がある
    •  
  • ユニバーサルアクセスキーとalgorithm_pin

    1. ユニバーサルアクセスキー画面には、発行されたalgorithm_pinの番号が表示されます。
    2. 予約の変更(期間やデバイスID)があった場合、algorithm_pinの番号は変更されますが、ユニバーサルアクセスキーのURLに変更はありません。
    3. ユニバーサルアクセスキー画面には、予約作成の際に指定した期間 "starts_at"と"ends_at" が表示されます。時刻が自動補正またはマージンが設定されている場合に実際に解錠できる時間帯は、APIで返却される"available_starts_at"と"available_ends_at"を確認してください。 

予約APIで発行したユニバーサルアクセスキーの画面(利用日時と暗証番号)

  • マージン設定とalgorithm_pin

    1. RemoteLOCKアカウントで解錠可能時間のマージンが設定されている場合、マージンを考慮した上で、igloohomeデバイスで設定可能な1時間単位になった時間が解錠可能が設定されます。

例1:

設定した予約期間(マージン10分込み)→ 開始:"2024-09-25T14:10:00", 終了:"2024-09-27T11:10:00"

予約APIシステム上保存される期間→ 開始:"2024-09-25T14:00:00", 終了:"2024-09-27T11:00:00"

※時刻が00分になる

例2:利用期間 28日間以上

設定した予約期間→ 開始: "2024-09-25T08:10:00", 終了: "2024-10-25T16:02:00"

予約APIシステム上保存される期間→ 開始: "2024-09-25T08:00:00", 終了: "2024-10-26T08:00:00"

※時刻が00分になり、開始と終了の時刻を合わせるため → 終了: "2024-10-25T08:00:00"。この場合は元の利用したい時刻までカーバするため、2024-10-25 + 1day 遅くして保存される

  • 予約API経由で発行したalgorithm_pinのRemoteLOCKクラウド画面の表示

    RemoteLOCKクラウドの「アクセス」メニュー、アルゴリズムPINとして、以下の通り表示されます。 
    • ゲストの名前は、予約発行に指定した name 
    • ゲストのemailは、予約発行に指定した email

    • ゲストの期間は、algorithm_pinが有効な期間(予約APIシステム上保存された時刻) 

  • 同一開始終了時刻への発行

    igloohomeデバイスは、1つのデバイスに対して同じ開始終了時刻で発行できる件数に制限があります。ただし、APIでは同じデバイスに同一期間の予約を複数作成した場合、新たなigloohomeゲストが発行されず、既に発行済みのalgorithm_pinを再利用する形で回数の制限を受けません。RemoteLOCKクラウドの画面上では初回作成時の内容(ゲスト名など)として表示されます。

最終更新

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

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

記事で解決しないときは

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