鍵を、御社のサービスの機能に。

公開している操作

170以上

カテゴリ

15

API 利用料

¥0

レートリミット

なし

1. WatchKey に無料登録する

   メールアドレスだけで登録できます。登録ページへ

2. 管理画面から仕様書を開く

   ログイン後、管理画面から API 仕様書を閲覧できます。あわせて API トークンも発行できます。

3. 仕様書と連携ガイドを見ながら実装する

   実装に必要な情報は、仕様書とこのサイトの連携ガイド・Webhook にまとめています。

1. WatchKey に登録する

   登録ページからメールアドレスで登録し、機器をつないでドアを作ります。

2. API トークンを発行する

   管理画面の「クラウドアカウント → API トークン → 新規発行」から発行します。トークンの値は発行したときにしか表示されないので、安全な場所に保存してください。

3. ドアの状態を取得する

   # ドアの状態を取得する
   curl https://backend.watchkey.net/api/doors/{door_id} \
     -H "Authorization: Bearer $WATCHKEY_TOKEN"

   {
     "id": "…",
     "name": "1F エントランス",
     "status": "CONNECTED",
     "lock": "LOCKED",
     "battery": 80,
     "door_state": "CLOSED"
   }

   レスポンスは主な項目のみ抜粋しています。

POST /api/epic/{device_id}/guest_keys
Authorization: Bearer <API_TOKEN>
Content-Type: application/json

{
  "name": "Guest 1205",
  "password": "482915",
  "date_from": "2026-12-05 15:00:00",
  "date_to": "2026-12-07 11:00:00"
}

GET /api/histories
    ?from=2026-10-01 00:00:00
    &to=2026-10-31 23:59:59
    &limit=100&sort=DESC
Authorization: Bearer <API_TOKEN>

PATCH /api/auth/api_tokens/{token_id}/permissions

{
  "permission": {
    "name": "front-desk",
    "actions": ["GetDoor", "Unlock", "GetHistory"],
    "resources": ["door:<DOOR_ID>"]
  }
}

エラーの本文は {"message": "…"} の形で返ります。機器と通信する API は、ネットワークの状態によって数秒かかることがあります。