API仕様書と一緒にお送りするサンプルのアカウントとデバイスで、最初に確かめていただきたい操作を順にまとめました。
これからRemoteLOCK APIとの連携を作る、貴社や開発会社の担当の方向けの例です。
こんなとき
本番の前に、つまずきやすいところを確かめられます
機密保持契約（NDA）の締結後に、API仕様書と、動作を確かめるためのサンプルのアカウントとデバイスの情報をお送りします（API仕様書を受け取ったあと）。いきなり業務の流れ全体を作るより、認証、デバイスの確認、予約の作成から無効化までを順に試しておくと、トークンの期限やデバイスIDの取り違えなど、本番でつまずきやすいところを先に確かめられます。
しくみ
認証から予約の無効化までを順に試します
最初に、仕様書の手順で認証し、アクセストークンを受け取ります。アクセストークンには有効期限があり、リフレッシュトークンで更新します。リフレッシュトークンにも期限があるため、定期的に更新する処理を初めに作っておきます（APIの認証エラーとタイムアウト）。次にデバイスの一覧を取得してデバイスIDを確かめ、扉ごとに使えるカギの種類も見ておきます。
そのうえで予約を1件作り、返ってきたユニバーサルアクセスキーのURLを開いて、番号やQRコードが出ることを確かめます。続けて終了の日時を変え、同じURLのまま表示が変わることを確かめます（ユニバーサルアクセスキー）。最後に予約を無効にします。削除すると記録ごと消えるため、取り消しには無効にする操作を使うのがおすすめです。
必要なもの
始める前に4つがそろっているかお確かめください
| 必要なもの | 中身 |
| 料金プラン | ビジネス スタンダード以上で、お支払いが有効なこと（ご利用までの手続き） |
| アカウントとデバイス | 有効なRemoteLOCKのアカウントに、扉のデバイスが登録されていること |
| 契約 | 機密保持契約（NDA）。APIのご利用に必要です。API利用料はかかりません |
| 連携のプログラム | 貴社か、ご依頼先の開発会社で作っていただきます。弊社は開発の受託や技術支援を行っておりません |
気をつける点
作る前にお確かめいただきたいこと
- APIを呼べる回数には上限があります。予約をまとめて作るときは、間隔をあけて送ってください
- サンプルのアカウントは、ほかの会社様も使う共有のものです。テストにだけお使いいただき、個人情報は登録しないでください。お客様のデバイスを追加することもできません
- クライアントシークレットやトークンは、チャットや共有の表に貼らないでください
- デモ用の実機の貸し出しはしていません。実機で確かめたいときは、製品をご購入いただけます
- 運用に使うOAuthアプリは、貴社かご利用になるお客様のアカウントに登録します（システム連携とOAuthアプリの登録申請）。運用を始める前のご連絡は、API仕様書を受け取ったあと にあるフォームからお送りください
始め方
まずはAPI資料をお申し込みください
API資料のお申し込み からご請求いただくと、概要資料と、機密保持契約（NDA）の手続きのご案内をお送りします。NDAの締結後に、API仕様書と、動作を確かめるためのサンプルのアカウントとデバイスの情報をお送りします。手続きの流れは RemoteLOCK APIのご利用までの手続き に、そのほかの使い方は RemoteLOCK APIでできること にまとめています。
関連する記事