From 3ecdfe3db3296bf35684b05c3895d24290cbb173 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Louis=20Pr=C3=A9?= Date: Tue, 21 Apr 2026 15:39:26 -0700 Subject: [PATCH 1/7] Move brand guide files from device-guides/ to device-and-system-integration-guides/ Move 30 brand-related files so their file paths match their published URLs under device-and-system-integration-guides/. Update SUMMARY.md references accordingly. Co-Authored-By: Claude Opus 4.6 (1M context) --- docs/guides/SUMMARY.md | 60 +++++++++---------- .../2n-intercom-systems/README.md} | 0 .../get-started-with-2n-intercoms.md | 0 .../avigilon-alta-access-system.md | 0 .../dormakaba-oracode-locks/README.md} | 0 ...et-started-with-dormakaba-oracode-locks.md | 0 .../ecobee-thermostats.md | 0 .../get-started-with-august-locks.md | 0 .../get-started-with-controlbyweb-devices.md | 0 .../get-started-with-ecobee-thermostats.md | 0 .../get-started-with-kwikset-wifi-locks.md | 0 .../get-started-with-minut-sensors.md | 0 .../get-started-with-noiseaware-sensors.md | 0 .../get-started-with-nuki-locks.md | 0 .../get-started-with-salto-locks.md | 0 .../get-started-with-smartlocks-api.md | 0 .../get-started-with-ttlock-devices.md | 0 .../get-started-with-wyze-locks.md | 0 .../get-started-with-yale-locks.md | 0 .../google-nest-thermostats/README.md | 0 ...evice-access-and-commercial-development.md | 0 .../igloohome-locks/README.md} | 0 .../get-started-with-igloo-locks.md | 0 .../minut-sensors.md | 0 .../nuki-locks.md | 0 .../pti-storlogix-cloud.md | 0 .../get-started-with-schlage-locks.md | 0 ...ted-with-smartthings-hubs-+-smart-locks.md | 0 .../ttlock-locks.md | 0 .../wyze-locks.md | 0 .../yale-locks.md | 0 31 files changed, 30 insertions(+), 30 deletions(-) rename docs/guides/{device-guides/2n-intercom-systems.md => device-and-system-integration-guides/2n-intercom-systems/README.md} (100%) rename docs/guides/{device-guides => device-and-system-integration-guides/2n-intercom-systems}/get-started-with-2n-intercoms.md (100%) rename docs/guides/{device-guides => device-and-system-integration-guides}/avigilon-alta-access-system.md (100%) rename docs/guides/{device-guides/dormakaba-oracode-locks.md => device-and-system-integration-guides/dormakaba-oracode-locks/README.md} (100%) rename docs/guides/{device-guides => device-and-system-integration-guides/dormakaba-oracode-locks}/get-started-with-dormakaba-oracode-locks.md (100%) rename docs/guides/{device-guides => device-and-system-integration-guides}/ecobee-thermostats.md (100%) rename docs/guides/{device-guides => device-and-system-integration-guides}/get-started-with-august-locks.md (100%) rename docs/guides/{device-guides => device-and-system-integration-guides}/get-started-with-controlbyweb-devices.md (100%) rename docs/guides/{device-guides => device-and-system-integration-guides}/get-started-with-ecobee-thermostats.md (100%) rename docs/guides/{device-guides => device-and-system-integration-guides}/get-started-with-kwikset-wifi-locks.md (100%) rename docs/guides/{device-guides => device-and-system-integration-guides}/get-started-with-minut-sensors.md (100%) rename docs/guides/{device-guides => device-and-system-integration-guides}/get-started-with-noiseaware-sensors.md (100%) rename docs/guides/{device-guides => device-and-system-integration-guides}/get-started-with-nuki-locks.md (100%) rename docs/guides/{device-guides => device-and-system-integration-guides}/get-started-with-salto-locks.md (100%) rename docs/guides/{device-guides => device-and-system-integration-guides}/get-started-with-smartlocks-api.md (100%) rename docs/guides/{device-guides => device-and-system-integration-guides}/get-started-with-ttlock-devices.md (100%) rename docs/guides/{device-guides => device-and-system-integration-guides}/get-started-with-wyze-locks.md (100%) rename docs/guides/{device-guides => device-and-system-integration-guides}/get-started-with-yale-locks.md (100%) rename docs/guides/{device-guides => device-and-system-integration-guides}/google-nest-thermostats/README.md (100%) rename docs/guides/{device-guides => device-and-system-integration-guides}/google-nest-thermostats/obtain-google-nest-device-access-and-commercial-development.md (100%) rename docs/guides/{device-guides/igloohome-locks.md => device-and-system-integration-guides/igloohome-locks/README.md} (100%) rename docs/guides/{device-guides => device-and-system-integration-guides/igloohome-locks}/get-started-with-igloo-locks.md (100%) rename docs/guides/{device-guides => device-and-system-integration-guides}/minut-sensors.md (100%) rename docs/guides/{device-guides => device-and-system-integration-guides}/nuki-locks.md (100%) rename docs/guides/{device-guides => device-and-system-integration-guides}/pti-storlogix-cloud.md (100%) rename docs/guides/{device-guides => device-and-system-integration-guides/schlage-locks}/get-started-with-schlage-locks.md (100%) rename docs/guides/{device-guides => device-and-system-integration-guides/smartthings-hubs-+-devices}/get-started-with-smartthings-hubs-+-smart-locks.md (100%) rename docs/guides/{device-guides => device-and-system-integration-guides}/ttlock-locks.md (100%) rename docs/guides/{device-guides => device-and-system-integration-guides}/wyze-locks.md (100%) rename docs/guides/{device-guides => device-and-system-integration-guides}/yale-locks.md (100%) diff --git a/docs/guides/SUMMARY.md b/docs/guides/SUMMARY.md index d65096c67..f5e402151 100644 --- a/docs/guides/SUMMARY.md +++ b/docs/guides/SUMMARY.md @@ -226,9 +226,9 @@ ## Device and System Integration Guides * [Overview](device-and-system-integration-guides/overview.md) -* [2N Intercom Systems](device-guides/2n-intercom-systems.md) +* [2N Intercom Systems](device-and-system-integration-guides/2n-intercom-systems/README.md) * [2N System Set Up Instructions](device-and-system-integration-guides/2n-intercom-systems/2n-system-set-up-instructions.md) - * [Get started with 2N Intercoms](device-guides/get-started-with-2n-intercoms.md) + * [Get started with 2N Intercoms](device-and-system-integration-guides/2n-intercom-systems/get-started-with-2n-intercoms.md) * [33 Lock Devices](device-and-system-integration-guides/33-lock-devices/README.md) * [Get started with 33 Lock devices](device-and-system-integration-guides/33-lock-devices/get-started-with-33-lock-devices.md) * [4SUITES Locks](device-and-system-integration-guides/4suites-locks/README.md) @@ -296,35 +296,35 @@ * [Special Requirements for iOS Mobile Access SDK Development](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/special-requirements-for-ios-mobile-access-sdk-development.md) * [Creating Visionline Card-based Credentials](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/creating-visionline-card-based-credentials.md) * [August Locks](device-and-system-integration-guides/august-locks.md) - * [Get started with August locks](device-guides/get-started-with-august-locks.md) -* [Avigilon Alta Access System](device-guides/avigilon-alta-access-system.md) + * [Get started with August locks](device-and-system-integration-guides/get-started-with-august-locks.md) +* [Avigilon Alta Access System](device-and-system-integration-guides/avigilon-alta-access-system.md) * [Brivo Access](device-and-system-integration-guides/brivo-access/README.md) * [Brivo Access Setup Guide](device-and-system-integration-guides/brivo-access/brivo-access-setup-guide.md) -* [Get started with ControlByWeb Devices](device-guides/get-started-with-controlbyweb-devices.md) +* [Get started with ControlByWeb Devices](device-and-system-integration-guides/get-started-with-controlbyweb-devices.md) * [Dormakaba Ambiance Access Control System](device-and-system-integration-guides/dormakaba-ambiance-access-control-system/README.md) * [Dormakaba Ambiance Setup Guide](device-and-system-integration-guides/dormakaba-ambiance-access-control-system/dormakaba-ambiance-setup-guide.md) * [Dormakaba Community Access Control System](device-and-system-integration-guides/dormakaba-community-access-control-system/README.md) * [Dormakaba Community Setup Guide](device-and-system-integration-guides/dormakaba-community-access-control-system/dormakaba-community-setup-guide.md) -* [Dormakaba Oracode Locks](device-guides/dormakaba-oracode-locks.md) - * [Get started with dormakaba Oracode Locks](device-guides/get-started-with-dormakaba-oracode-locks.md) +* [Dormakaba Oracode Locks](device-and-system-integration-guides/dormakaba-oracode-locks/README.md) + * [Get started with dormakaba Oracode Locks](device-and-system-integration-guides/dormakaba-oracode-locks/get-started-with-dormakaba-oracode-locks.md) * [Creating dormakaba Oracode Offline Access Codes](device-and-system-integration-guides/dormakaba-oracode-locks/creating-dormakaba-oracode-offline-access-codes.md) * [Programming Offline Access Codes on Dormakaba Oracode Locks](device-and-system-integration-guides/dormakaba-oracode-locks/programming-offline-access-codes-on-dormakaba-oracode-locks.md) * [Dormakaba Oracode Setup Guide](device-and-system-integration-guides/dormakaba-oracode-locks/dormakaba-oracode-setup-guide.md) -* [ecobee Thermostats](device-guides/ecobee-thermostats.md) - * [Get Started with ecobee Thermostats](device-guides/get-started-with-ecobee-thermostats.md) -* [Google Nest Thermostats](device-guides/google-nest-thermostats/README.md) +* [ecobee Thermostats](device-and-system-integration-guides/ecobee-thermostats.md) + * [Get Started with ecobee Thermostats](device-and-system-integration-guides/get-started-with-ecobee-thermostats.md) +* [Google Nest Thermostats](device-and-system-integration-guides/google-nest-thermostats/README.md) * [Get Started with Nest Thermostats](device-and-system-integration-guides/google-nest-thermostats/get-started-with-nest-thermostats.md) - * [Obtain Google Nest Device Access and Commercial Development](device-guides/google-nest-thermostats/obtain-google-nest-device-access-and-commercial-development.md) + * [Obtain Google Nest Device Access and Commercial Development](device-and-system-integration-guides/google-nest-thermostats/obtain-google-nest-device-access-and-commercial-development.md) * [Honeywell Resideo Thermostats](device-and-system-integration-guides/honeywell-thermostats/README.md) * [Get Started with Honeywell Resideo Thermostats](device-and-system-integration-guides/honeywell-thermostats/get-started-with-honeywell-thermostats.md) -* [igloohome Locks](device-guides/igloohome-locks.md) +* [igloohome Locks](device-and-system-integration-guides/igloohome-locks/README.md) * [IglooHome Error and Warning Codes](device-and-system-integration-guides/igloohome-locks/igloohome-error-and-warning-codes.md) * [Creating igloohome Offline Access Codes](device-and-system-integration-guides/igloohome-locks/creating-igloohome-offline-access-codes.md) - * [Get started with igloohome Locks](device-guides/get-started-with-igloo-locks.md) + * [Get started with igloohome Locks](device-and-system-integration-guides/igloohome-locks/get-started-with-igloo-locks.md) * [Keynest Key Lockers](device-and-system-integration-guides/keynest-key-lockers/README.md) * [Keynest Setup Instructions](device-and-system-integration-guides/keynest-key-lockers/keynest-setup-instructions.md) * [Kwikset Locks](device-and-system-integration-guides/kwikset-locks.md) - * [Get started with Kwikset Wi-Fi Locks](device-guides/get-started-with-kwikset-wifi-locks.md) + * [Get started with Kwikset Wi-Fi Locks](device-and-system-integration-guides/get-started-with-kwikset-wifi-locks.md) * [Latch Access Control System](device-and-system-integration-guides/latch-access-control-system/README.md) * [Latch Setup Guide](device-and-system-integration-guides/latch-access-control-system/latch-setup-guide.md) * [Programming Code-Based Latch Credentials](device-and-system-integration-guides/latch-access-control-system/programming-code-based-latch-credentials.md) @@ -332,46 +332,46 @@ * [Lockly Locks](device-and-system-integration-guides/lockly-locks/README.md) * [Lockly Setup Guide](device-and-system-integration-guides/lockly-locks/lockly-setup-guide.md) * [Creating Lockly Offline Access Codes](device-and-system-integration-guides/lockly-locks/creating-lockly-offline-access-codes.md) -* [Minut Sensors](device-guides/minut-sensors.md) - * [Get started with Minut Sensors](device-guides/get-started-with-minut-sensors.md) +* [Minut Sensors](device-and-system-integration-guides/minut-sensors.md) + * [Get started with Minut Sensors](device-and-system-integration-guides/get-started-with-minut-sensors.md) * [NoiseAware Sensors](device-and-system-integration-guides/noiseaware-sensors.md) - * [Get started with NoiseAware Sensors](device-guides/get-started-with-noiseaware-sensors.md) -* [Nuki Locks](device-guides/nuki-locks.md) - * [Get Started with Nuki Locks](device-guides/get-started-with-nuki-locks.md) -* [PTI Storlogix Cloud](device-guides/pti-storlogix-cloud.md) + * [Get started with NoiseAware Sensors](device-and-system-integration-guides/get-started-with-noiseaware-sensors.md) +* [Nuki Locks](device-and-system-integration-guides/nuki-locks.md) + * [Get Started with Nuki Locks](device-and-system-integration-guides/get-started-with-nuki-locks.md) +* [PTI Storlogix Cloud](device-and-system-integration-guides/pti-storlogix-cloud.md) * [Salto KS Access Control System](device-and-system-integration-guides/salto-ks-access-control-system/README.md) * [Salto KS Setup Instructions](device-and-system-integration-guides/salto-ks-access-control-system/salto-ks-setup-instructions.md) * [Programming Salto KS PIN Code Credentials](device-and-system-integration-guides/salto-ks-access-control-system/programming-code-based-salto-ks-credentials.md) * [Programming Salto KS Mobile Credentials](device-and-system-integration-guides/salto-ks-access-control-system/programming-salto-ks-mobile-credentials.md) * [Special Requirements for Android Mobile Access SDK Development](device-and-system-integration-guides/salto-ks-access-control-system/special-requirements-for-android-mobile-access-sdk-development.md) * [Salto KS Locks](device-and-system-integration-guides/salto-locks.md) - * [Get started with Salto KS Locks](device-guides/get-started-with-salto-locks.md) + * [Get started with Salto KS Locks](device-and-system-integration-guides/get-started-with-salto-locks.md) * [Salto ProAccess Space Access System](device-and-system-integration-guides/salto-proaccess-space-access-system/README.md) * [Salto Space Setup Instructions](device-and-system-integration-guides/salto-proaccess-space-access-system/salto-space-setup-instructions.md) * [Programming Salto Space Card-based Credentials](device-and-system-integration-guides/salto-proaccess-space-access-system/programming-salto-space-card-based-credentials.md) * [Programming Salto Space Mobile Credentials](device-and-system-integration-guides/salto-proaccess-space-access-system/programming-salto-space-mobile-credentials.md) * [Schlage Locks](device-and-system-integration-guides/schlage-locks/README.md) * [Schlage Locks Setup Instructions](device-and-system-integration-guides/schlage-locks/schlage-locks-setup-instructions.md) - * [Get started with Schlage Locks](device-guides/get-started-with-schlage-locks.md) + * [Get started with Schlage Locks](device-and-system-integration-guides/schlage-locks/get-started-with-schlage-locks.md) * [Schlage Locks - Daylight Savings time adjustments](device-and-system-integration-guides/schlage-locks/schlage-locks-daylight-savings-time-adjustments.md) * [Sensi Thermostats](device-and-system-integration-guides/sensi-thermostats/README.md) * [Get Started with Sensi Thermostats](device-and-system-integration-guides/sensi-thermostats/get-started-with-sensi-thermostats.md) * [SmartThings Hubs + Devices](device-and-system-integration-guides/smartthings-hubs-+-devices/README.md) - * [Get Started with SmartThings Hubs + Smart Locks](device-guides/get-started-with-smartthings-hubs-+-smart-locks.md) + * [Get Started with SmartThings Hubs + Smart Locks](device-and-system-integration-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md) * [Get Started with SmartThings Hubs + Thermostats](device-and-system-integration-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-thermostats.md) * [Tedee Locks](device-and-system-integration-guides/tedee-locks/README.md) * [Get Started with Tedee Locks](device-and-system-integration-guides/tedee-locks/get-started-with-tedee-locks.md) -* [TTLock Locks](device-guides/ttlock-locks.md) - * [Get started with TTLock Locks](device-guides/get-started-with-ttlock-devices.md) +* [TTLock Locks](device-and-system-integration-guides/ttlock-locks.md) + * [Get started with TTLock Locks](device-and-system-integration-guides/get-started-with-ttlock-devices.md) * [Ultraloq Locks](device-and-system-integration-guides/ultraloq-locks/README.md) * [Ultraloq Setup Guide](device-and-system-integration-guides/ultraloq-locks/ultraloq-setup-guide.md) * [Configuring Ultraloq Device Timezones](device-and-system-integration-guides/ultraloq-locks/configuring-ultraloq-device-timezones.md) * [Creating Ultraloq Access Codes](device-and-system-integration-guides/ultraloq-locks/creating-ultraloq-access-codes.md) -* [Wyze Locks](device-guides/wyze-locks.md) - * [Get started with Wyze Locks](device-guides/get-started-with-wyze-locks.md) -* [Yale Locks](device-guides/yale-locks.md) - * [Get started with Yale Locks](device-guides/get-started-with-yale-locks.md) -* [Get started with Smart Locks](device-guides/get-started-with-smartlocks-api.md) +* [Wyze Locks](device-and-system-integration-guides/wyze-locks.md) + * [Get started with Wyze Locks](device-and-system-integration-guides/get-started-with-wyze-locks.md) +* [Yale Locks](device-and-system-integration-guides/yale-locks.md) + * [Get started with Yale Locks](device-and-system-integration-guides/get-started-with-yale-locks.md) +* [Get started with Smart Locks](device-and-system-integration-guides/get-started-with-smartlocks-api.md) ## Device Manufacturer Guidance diff --git a/docs/guides/device-guides/2n-intercom-systems.md b/docs/guides/device-and-system-integration-guides/2n-intercom-systems/README.md similarity index 100% rename from docs/guides/device-guides/2n-intercom-systems.md rename to docs/guides/device-and-system-integration-guides/2n-intercom-systems/README.md diff --git a/docs/guides/device-guides/get-started-with-2n-intercoms.md b/docs/guides/device-and-system-integration-guides/2n-intercom-systems/get-started-with-2n-intercoms.md similarity index 100% rename from docs/guides/device-guides/get-started-with-2n-intercoms.md rename to docs/guides/device-and-system-integration-guides/2n-intercom-systems/get-started-with-2n-intercoms.md diff --git a/docs/guides/device-guides/avigilon-alta-access-system.md b/docs/guides/device-and-system-integration-guides/avigilon-alta-access-system.md similarity index 100% rename from docs/guides/device-guides/avigilon-alta-access-system.md rename to docs/guides/device-and-system-integration-guides/avigilon-alta-access-system.md diff --git a/docs/guides/device-guides/dormakaba-oracode-locks.md b/docs/guides/device-and-system-integration-guides/dormakaba-oracode-locks/README.md similarity index 100% rename from docs/guides/device-guides/dormakaba-oracode-locks.md rename to docs/guides/device-and-system-integration-guides/dormakaba-oracode-locks/README.md diff --git a/docs/guides/device-guides/get-started-with-dormakaba-oracode-locks.md b/docs/guides/device-and-system-integration-guides/dormakaba-oracode-locks/get-started-with-dormakaba-oracode-locks.md similarity index 100% rename from docs/guides/device-guides/get-started-with-dormakaba-oracode-locks.md rename to docs/guides/device-and-system-integration-guides/dormakaba-oracode-locks/get-started-with-dormakaba-oracode-locks.md diff --git a/docs/guides/device-guides/ecobee-thermostats.md b/docs/guides/device-and-system-integration-guides/ecobee-thermostats.md similarity index 100% rename from docs/guides/device-guides/ecobee-thermostats.md rename to docs/guides/device-and-system-integration-guides/ecobee-thermostats.md diff --git a/docs/guides/device-guides/get-started-with-august-locks.md b/docs/guides/device-and-system-integration-guides/get-started-with-august-locks.md similarity index 100% rename from docs/guides/device-guides/get-started-with-august-locks.md rename to docs/guides/device-and-system-integration-guides/get-started-with-august-locks.md diff --git a/docs/guides/device-guides/get-started-with-controlbyweb-devices.md b/docs/guides/device-and-system-integration-guides/get-started-with-controlbyweb-devices.md similarity index 100% rename from docs/guides/device-guides/get-started-with-controlbyweb-devices.md rename to docs/guides/device-and-system-integration-guides/get-started-with-controlbyweb-devices.md diff --git a/docs/guides/device-guides/get-started-with-ecobee-thermostats.md b/docs/guides/device-and-system-integration-guides/get-started-with-ecobee-thermostats.md similarity index 100% rename from docs/guides/device-guides/get-started-with-ecobee-thermostats.md rename to docs/guides/device-and-system-integration-guides/get-started-with-ecobee-thermostats.md diff --git a/docs/guides/device-guides/get-started-with-kwikset-wifi-locks.md b/docs/guides/device-and-system-integration-guides/get-started-with-kwikset-wifi-locks.md similarity index 100% rename from docs/guides/device-guides/get-started-with-kwikset-wifi-locks.md rename to docs/guides/device-and-system-integration-guides/get-started-with-kwikset-wifi-locks.md diff --git a/docs/guides/device-guides/get-started-with-minut-sensors.md b/docs/guides/device-and-system-integration-guides/get-started-with-minut-sensors.md similarity index 100% rename from docs/guides/device-guides/get-started-with-minut-sensors.md rename to docs/guides/device-and-system-integration-guides/get-started-with-minut-sensors.md diff --git a/docs/guides/device-guides/get-started-with-noiseaware-sensors.md b/docs/guides/device-and-system-integration-guides/get-started-with-noiseaware-sensors.md similarity index 100% rename from docs/guides/device-guides/get-started-with-noiseaware-sensors.md rename to docs/guides/device-and-system-integration-guides/get-started-with-noiseaware-sensors.md diff --git a/docs/guides/device-guides/get-started-with-nuki-locks.md b/docs/guides/device-and-system-integration-guides/get-started-with-nuki-locks.md similarity index 100% rename from docs/guides/device-guides/get-started-with-nuki-locks.md rename to docs/guides/device-and-system-integration-guides/get-started-with-nuki-locks.md diff --git a/docs/guides/device-guides/get-started-with-salto-locks.md b/docs/guides/device-and-system-integration-guides/get-started-with-salto-locks.md similarity index 100% rename from docs/guides/device-guides/get-started-with-salto-locks.md rename to docs/guides/device-and-system-integration-guides/get-started-with-salto-locks.md diff --git a/docs/guides/device-guides/get-started-with-smartlocks-api.md b/docs/guides/device-and-system-integration-guides/get-started-with-smartlocks-api.md similarity index 100% rename from docs/guides/device-guides/get-started-with-smartlocks-api.md rename to docs/guides/device-and-system-integration-guides/get-started-with-smartlocks-api.md diff --git a/docs/guides/device-guides/get-started-with-ttlock-devices.md b/docs/guides/device-and-system-integration-guides/get-started-with-ttlock-devices.md similarity index 100% rename from docs/guides/device-guides/get-started-with-ttlock-devices.md rename to docs/guides/device-and-system-integration-guides/get-started-with-ttlock-devices.md diff --git a/docs/guides/device-guides/get-started-with-wyze-locks.md b/docs/guides/device-and-system-integration-guides/get-started-with-wyze-locks.md similarity index 100% rename from docs/guides/device-guides/get-started-with-wyze-locks.md rename to docs/guides/device-and-system-integration-guides/get-started-with-wyze-locks.md diff --git a/docs/guides/device-guides/get-started-with-yale-locks.md b/docs/guides/device-and-system-integration-guides/get-started-with-yale-locks.md similarity index 100% rename from docs/guides/device-guides/get-started-with-yale-locks.md rename to docs/guides/device-and-system-integration-guides/get-started-with-yale-locks.md diff --git a/docs/guides/device-guides/google-nest-thermostats/README.md b/docs/guides/device-and-system-integration-guides/google-nest-thermostats/README.md similarity index 100% rename from docs/guides/device-guides/google-nest-thermostats/README.md rename to docs/guides/device-and-system-integration-guides/google-nest-thermostats/README.md diff --git a/docs/guides/device-guides/google-nest-thermostats/obtain-google-nest-device-access-and-commercial-development.md b/docs/guides/device-and-system-integration-guides/google-nest-thermostats/obtain-google-nest-device-access-and-commercial-development.md similarity index 100% rename from docs/guides/device-guides/google-nest-thermostats/obtain-google-nest-device-access-and-commercial-development.md rename to docs/guides/device-and-system-integration-guides/google-nest-thermostats/obtain-google-nest-device-access-and-commercial-development.md diff --git a/docs/guides/device-guides/igloohome-locks.md b/docs/guides/device-and-system-integration-guides/igloohome-locks/README.md similarity index 100% rename from docs/guides/device-guides/igloohome-locks.md rename to docs/guides/device-and-system-integration-guides/igloohome-locks/README.md diff --git a/docs/guides/device-guides/get-started-with-igloo-locks.md b/docs/guides/device-and-system-integration-guides/igloohome-locks/get-started-with-igloo-locks.md similarity index 100% rename from docs/guides/device-guides/get-started-with-igloo-locks.md rename to docs/guides/device-and-system-integration-guides/igloohome-locks/get-started-with-igloo-locks.md diff --git a/docs/guides/device-guides/minut-sensors.md b/docs/guides/device-and-system-integration-guides/minut-sensors.md similarity index 100% rename from docs/guides/device-guides/minut-sensors.md rename to docs/guides/device-and-system-integration-guides/minut-sensors.md diff --git a/docs/guides/device-guides/nuki-locks.md b/docs/guides/device-and-system-integration-guides/nuki-locks.md similarity index 100% rename from docs/guides/device-guides/nuki-locks.md rename to docs/guides/device-and-system-integration-guides/nuki-locks.md diff --git a/docs/guides/device-guides/pti-storlogix-cloud.md b/docs/guides/device-and-system-integration-guides/pti-storlogix-cloud.md similarity index 100% rename from docs/guides/device-guides/pti-storlogix-cloud.md rename to docs/guides/device-and-system-integration-guides/pti-storlogix-cloud.md diff --git a/docs/guides/device-guides/get-started-with-schlage-locks.md b/docs/guides/device-and-system-integration-guides/schlage-locks/get-started-with-schlage-locks.md similarity index 100% rename from docs/guides/device-guides/get-started-with-schlage-locks.md rename to docs/guides/device-and-system-integration-guides/schlage-locks/get-started-with-schlage-locks.md diff --git a/docs/guides/device-guides/get-started-with-smartthings-hubs-+-smart-locks.md b/docs/guides/device-and-system-integration-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md similarity index 100% rename from docs/guides/device-guides/get-started-with-smartthings-hubs-+-smart-locks.md rename to docs/guides/device-and-system-integration-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md diff --git a/docs/guides/device-guides/ttlock-locks.md b/docs/guides/device-and-system-integration-guides/ttlock-locks.md similarity index 100% rename from docs/guides/device-guides/ttlock-locks.md rename to docs/guides/device-and-system-integration-guides/ttlock-locks.md diff --git a/docs/guides/device-guides/wyze-locks.md b/docs/guides/device-and-system-integration-guides/wyze-locks.md similarity index 100% rename from docs/guides/device-guides/wyze-locks.md rename to docs/guides/device-and-system-integration-guides/wyze-locks.md diff --git a/docs/guides/device-guides/yale-locks.md b/docs/guides/device-and-system-integration-guides/yale-locks.md similarity index 100% rename from docs/guides/device-guides/yale-locks.md rename to docs/guides/device-and-system-integration-guides/yale-locks.md From cde8b32fc4accf5727396e4ab51f6363abc03833 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Louis=20Pr=C3=A9?= Date: Tue, 21 Apr 2026 15:40:56 -0700 Subject: [PATCH 2/7] Move reconnecting-an-account.md to core-concepts/connected-accounts/ File was in device-guides/ but listed under Core Concepts > Connected Accounts in SUMMARY.md. Co-Authored-By: Claude Opus 4.6 (1M context) --- docs/guides/SUMMARY.md | 2 +- .../connected-accounts}/reconnecting-an-account.md | 0 2 files changed, 1 insertion(+), 1 deletion(-) rename docs/guides/{device-guides => core-concepts/connected-accounts}/reconnecting-an-account.md (100%) diff --git a/docs/guides/SUMMARY.md b/docs/guides/SUMMARY.md index f5e402151..4225e8bb5 100644 --- a/docs/guides/SUMMARY.md +++ b/docs/guides/SUMMARY.md @@ -36,7 +36,7 @@ * [Connected Accounts](core-concepts/connected-accounts/README.md) * [Adding Custom Metadata to a Connected Account](core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account.md) * [Filtering Connected Accounts by Custom Metadata](core-concepts/connected-accounts/filtering-connected-accounts-by-custom-metadata.md) - * [Reconnecting an Account](device-guides/reconnecting-an-account.md) + * [Reconnecting an Account](core-concepts/connected-accounts/reconnecting-an-account.md) * [Mapping Your Resources to Seam Resources](core-concepts/mapping-your-resources-to-seam-resources.md) * [Action Attempts](core-concepts/action-attempts.md) diff --git a/docs/guides/device-guides/reconnecting-an-account.md b/docs/guides/core-concepts/connected-accounts/reconnecting-an-account.md similarity index 100% rename from docs/guides/device-guides/reconnecting-an-account.md rename to docs/guides/core-concepts/connected-accounts/reconnecting-an-account.md From 501a1cdfd28b4373af28c96defcf2e0211408bf6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Louis=20Pr=C3=A9?= Date: Tue, 21 Apr 2026 15:41:49 -0700 Subject: [PATCH 3/7] Move rate-limits-and-guardrails.md to developer-tools/ File was in device-guides/ but listed under Developer Tools in SUMMARY.md. Co-Authored-By: Claude Opus 4.6 (1M context) --- docs/guides/SUMMARY.md | 2 +- .../rate-limits-and-guardrails.md | 0 2 files changed, 1 insertion(+), 1 deletion(-) rename docs/guides/{device-guides => developer-tools}/rate-limits-and-guardrails.md (100%) diff --git a/docs/guides/SUMMARY.md b/docs/guides/SUMMARY.md index 4225e8bb5..ad2bdfac5 100644 --- a/docs/guides/SUMMARY.md +++ b/docs/guides/SUMMARY.md @@ -207,7 +207,7 @@ * [Sandbox TTLock Locks](device-guides/sandbox-and-sample-data/ttlock-sample-data.md) * [Sandbox Wyze Locks](device-guides/sandbox-and-sample-data/wyze-sample-data.md) * [Sandbox Yale Locks](device-guides/sandbox-and-sample-data/yale-sample-data.md) -* [Rate Limits and Guardrails](device-guides/rate-limits-and-guardrails.md) +* [Rate Limits and Guardrails](developer-tools/rate-limits-and-guardrails.md) * [Mobile SDKs](developer-tools/mobile-sdks/README.md) * [Android SDK](developer-tools/mobile-sdks/android-sdk.md) * [iOS SDK](developer-tools/mobile-sdks/ios-sdk.md) diff --git a/docs/guides/device-guides/rate-limits-and-guardrails.md b/docs/guides/developer-tools/rate-limits-and-guardrails.md similarity index 100% rename from docs/guides/device-guides/rate-limits-and-guardrails.md rename to docs/guides/developer-tools/rate-limits-and-guardrails.md From b100c9ea5bcbbc90650621b77605ea403c01a556 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Louis=20Pr=C3=A9?= Date: Tue, 21 Apr 2026 15:42:53 -0700 Subject: [PATCH 4/7] Move sandbox-and-sample-data files from device-guides/ to developer-tools/ All sandbox data files were listed under Developer Tools in SUMMARY.md but split across device-guides/ and developer-tools/. Consolidate them all under developer-tools/sandbox-and-sample-data/. Co-Authored-By: Claude Opus 4.6 (1M context) --- docs/guides/SUMMARY.md | 54 +++++++++---------- .../2n-intercoms-sample-data.md | 0 .../4suites-locks-sample-data.md | 0 .../sandbox-and-sample-data/README.md | 0 ...ne-access-management-system-sample-data.md | 0 .../august-locks-sample-data.md | 0 ...avigilon-alta-access-system-sample-data.md | 0 .../brivo-access-sample-data.md | 0 .../controlbyweb-relays-sample-data.md | 0 .../doorking-sample-data.md | 0 .../dormakaba-oracode-sample-data.md | 0 .../ecobee-sample-data.md | 0 .../genie-sample-data.md | 0 .../google-nest-thermostats-sample-data.md | 0 .../hubitat-hub-sample-data.md | 0 .../igloohome-sample-data.md | 0 .../kwikset-locks-sample-data.md | 0 .../linear-sample-data.md | 0 .../lockly-lock-sample-data.md | 0 .../lockly-sample-data.md | 0 .../minut-noise-sensor-sample-data.md | 0 .../minut-sample-data.md | 0 .../noiseaware-sample-data.md | 0 .../nuki-sample-data.md | 0 .../pti-storlogix-cloud-sample-data.md | 0 .../schlage-encode-sample-data.md | 0 .../seam-bridge-sample-data.md | 0 .../smartthings-sample-data.md | 0 .../ttlock-sample-data.md | 0 .../wyze-sample-data.md | 0 .../yale-sample-data.md | 0 31 files changed, 27 insertions(+), 27 deletions(-) rename docs/guides/{device-guides => developer-tools}/sandbox-and-sample-data/2n-intercoms-sample-data.md (100%) rename docs/guides/{device-guides => developer-tools}/sandbox-and-sample-data/4suites-locks-sample-data.md (100%) rename docs/guides/{device-guides => developer-tools}/sandbox-and-sample-data/README.md (100%) rename docs/guides/{device-guides => developer-tools}/sandbox-and-sample-data/assa-abloy-visionline-access-management-system-sample-data.md (100%) rename docs/guides/{device-guides => developer-tools}/sandbox-and-sample-data/august-locks-sample-data.md (100%) rename docs/guides/{device-guides => developer-tools}/sandbox-and-sample-data/avigilon-alta-access-system-sample-data.md (100%) rename docs/guides/{device-guides => developer-tools}/sandbox-and-sample-data/brivo-access-sample-data.md (100%) rename docs/guides/{device-guides => developer-tools}/sandbox-and-sample-data/controlbyweb-relays-sample-data.md (100%) rename docs/guides/{device-guides => developer-tools}/sandbox-and-sample-data/doorking-sample-data.md (100%) rename docs/guides/{device-guides => developer-tools}/sandbox-and-sample-data/dormakaba-oracode-sample-data.md (100%) rename docs/guides/{device-guides => developer-tools}/sandbox-and-sample-data/ecobee-sample-data.md (100%) rename docs/guides/{device-guides => developer-tools}/sandbox-and-sample-data/genie-sample-data.md (100%) rename docs/guides/{device-guides => developer-tools}/sandbox-and-sample-data/google-nest-thermostats-sample-data.md (100%) rename docs/guides/{device-guides => developer-tools}/sandbox-and-sample-data/hubitat-hub-sample-data.md (100%) rename docs/guides/{device-guides => developer-tools}/sandbox-and-sample-data/igloohome-sample-data.md (100%) rename docs/guides/{device-guides => developer-tools}/sandbox-and-sample-data/kwikset-locks-sample-data.md (100%) rename docs/guides/{device-guides => developer-tools}/sandbox-and-sample-data/linear-sample-data.md (100%) rename docs/guides/{device-guides => developer-tools}/sandbox-and-sample-data/lockly-lock-sample-data.md (100%) rename docs/guides/{device-guides => developer-tools}/sandbox-and-sample-data/lockly-sample-data.md (100%) rename docs/guides/{device-guides => developer-tools}/sandbox-and-sample-data/minut-noise-sensor-sample-data.md (100%) rename docs/guides/{device-guides => developer-tools}/sandbox-and-sample-data/minut-sample-data.md (100%) rename docs/guides/{device-guides => developer-tools}/sandbox-and-sample-data/noiseaware-sample-data.md (100%) rename docs/guides/{device-guides => developer-tools}/sandbox-and-sample-data/nuki-sample-data.md (100%) rename docs/guides/{device-guides => developer-tools}/sandbox-and-sample-data/pti-storlogix-cloud-sample-data.md (100%) rename docs/guides/{device-guides => developer-tools}/sandbox-and-sample-data/schlage-encode-sample-data.md (100%) rename docs/guides/{device-guides => developer-tools}/sandbox-and-sample-data/seam-bridge-sample-data.md (100%) rename docs/guides/{device-guides => developer-tools}/sandbox-and-sample-data/smartthings-sample-data.md (100%) rename docs/guides/{device-guides => developer-tools}/sandbox-and-sample-data/ttlock-sample-data.md (100%) rename docs/guides/{device-guides => developer-tools}/sandbox-and-sample-data/wyze-sample-data.md (100%) rename docs/guides/{device-guides => developer-tools}/sandbox-and-sample-data/yale-sample-data.md (100%) diff --git a/docs/guides/SUMMARY.md b/docs/guides/SUMMARY.md index ad2bdfac5..7824a4424 100644 --- a/docs/guides/SUMMARY.md +++ b/docs/guides/SUMMARY.md @@ -166,47 +166,47 @@ * [Webhooks](developer-tools/webhooks.md) * [Seam CLI](developer-tools/seam-cli.md) * [Seam MCP Server](developer-tools/seam-mcp.md) -* [Sandbox Devices and Systems](device-guides/sandbox-and-sample-data/README.md) - * [Sandbox 2N Intercoms](device-guides/sandbox-and-sample-data/2n-intercoms-sample-data.md) - * [Sandbox 4SUITES Locks](device-guides/sandbox-and-sample-data/4suites-locks-sample-data.md) +* [Sandbox Devices and Systems](developer-tools/sandbox-and-sample-data/README.md) + * [Sandbox 2N Intercoms](developer-tools/sandbox-and-sample-data/2n-intercoms-sample-data.md) + * [Sandbox 4SUITES Locks](developer-tools/sandbox-and-sample-data/4suites-locks-sample-data.md) * [Sandbox Akiles Locks](developer-tools/sandbox-and-sample-data/sandbox-akiles-locks.md) * [Sandbox ASSA ABLOY Vingcard Credential Services](developer-tools/sandbox-and-sample-data/sandbox-assa-abloy-vingcard-credential-services.md) - * [Sandbox Assa Abloy Visionline Access Control System](device-guides/sandbox-and-sample-data/assa-abloy-visionline-access-management-system-sample-data.md) + * [Sandbox Assa Abloy Visionline Access Control System](developer-tools/sandbox-and-sample-data/assa-abloy-visionline-access-management-system-sample-data.md) * [Sandbox Assa Abloy Vostio Access Control System](developer-tools/sandbox-and-sample-data/sandbox-assa-abloy-vostio-access-control-system.md) - * [Sandbox August Locks](device-guides/sandbox-and-sample-data/august-locks-sample-data.md) - * [Sandbox Avigilon Alta Access System](device-guides/sandbox-and-sample-data/avigilon-alta-access-system-sample-data.md) - * [Sandbox Brivo Access](device-guides/sandbox-and-sample-data/brivo-access-sample-data.md) - * [Sandbox ControlByWeb Relays](device-guides/sandbox-and-sample-data/controlbyweb-relays-sample-data.md) - * [Sandbox Doorking Callboxes](device-guides/sandbox-and-sample-data/doorking-sample-data.md) + * [Sandbox August Locks](developer-tools/sandbox-and-sample-data/august-locks-sample-data.md) + * [Sandbox Avigilon Alta Access System](developer-tools/sandbox-and-sample-data/avigilon-alta-access-system-sample-data.md) + * [Sandbox Brivo Access](developer-tools/sandbox-and-sample-data/brivo-access-sample-data.md) + * [Sandbox ControlByWeb Relays](developer-tools/sandbox-and-sample-data/controlbyweb-relays-sample-data.md) + * [Sandbox Doorking Callboxes](developer-tools/sandbox-and-sample-data/doorking-sample-data.md) * [Sandbox Dormakaba Ambiance Access Control System](developer-tools/sandbox-and-sample-data/sandbox-dormakaba-ambiance-access-control-system.md) * [Sandbox Dormakaba Community Access Control System](developer-tools/sandbox-and-sample-data/sandbox-dormakaba-community-access-control-system.md) - * [Sandbox Dormakaba Oracode Locks](device-guides/sandbox-and-sample-data/dormakaba-oracode-sample-data.md) - * [Sandbox ecobee Thermostats](device-guides/sandbox-and-sample-data/ecobee-sample-data.md) - * [Sandbox Genie Garage Openers](device-guides/sandbox-and-sample-data/genie-sample-data.md) - * [Sandbox Google Nest Thermostats](device-guides/sandbox-and-sample-data/google-nest-thermostats-sample-data.md) + * [Sandbox Dormakaba Oracode Locks](developer-tools/sandbox-and-sample-data/dormakaba-oracode-sample-data.md) + * [Sandbox ecobee Thermostats](developer-tools/sandbox-and-sample-data/ecobee-sample-data.md) + * [Sandbox Genie Garage Openers](developer-tools/sandbox-and-sample-data/genie-sample-data.md) + * [Sandbox Google Nest Thermostats](developer-tools/sandbox-and-sample-data/google-nest-thermostats-sample-data.md) * [Sandbox Honeywell Resideo Thermostats](developer-tools/sandbox-and-sample-data/sandbox-honeywell-thermostats.md) * [Sandbox Hotek Access Control System](developer-tools/sandbox-and-sample-data/sandbox-hotek-access-control-system.md) - * [Sandbox igloohome Locks](device-guides/sandbox-and-sample-data/igloohome-sample-data.md) + * [Sandbox igloohome Locks](developer-tools/sandbox-and-sample-data/igloohome-sample-data.md) * [Sandbox Keynest Lockers](developer-tools/sandbox-and-sample-data/sandbox-keynest-lockers.md) - * [Sandbox Kwikset Locks](device-guides/sandbox-and-sample-data/kwikset-locks-sample-data.md) + * [Sandbox Kwikset Locks](developer-tools/sandbox-and-sample-data/kwikset-locks-sample-data.md) * [Sandbox Latch Access Control System](developer-tools/sandbox-and-sample-data/sandbox-latch-access-control-system.md) - * [Sandbox Linear Callboxes](device-guides/sandbox-and-sample-data/linear-sample-data.md) - * [Sandbox Lockly Locks](device-guides/sandbox-and-sample-data/lockly-lock-sample-data.md) - * [Sandbox Minut Sensors](device-guides/sandbox-and-sample-data/minut-noise-sensor-sample-data.md) - * [Sandbox NoiseAware Sensors](device-guides/sandbox-and-sample-data/noiseaware-sample-data.md) - * [Sandbox Nuki Locks](device-guides/sandbox-and-sample-data/nuki-sample-data.md) - * [Sandbox PTI Storlogix Cloud](device-guides/sandbox-and-sample-data/pti-storlogix-cloud-sample-data.md) + * [Sandbox Linear Callboxes](developer-tools/sandbox-and-sample-data/linear-sample-data.md) + * [Sandbox Lockly Locks](developer-tools/sandbox-and-sample-data/lockly-lock-sample-data.md) + * [Sandbox Minut Sensors](developer-tools/sandbox-and-sample-data/minut-noise-sensor-sample-data.md) + * [Sandbox NoiseAware Sensors](developer-tools/sandbox-and-sample-data/noiseaware-sample-data.md) + * [Sandbox Nuki Locks](developer-tools/sandbox-and-sample-data/nuki-sample-data.md) + * [Sandbox PTI Storlogix Cloud](developer-tools/sandbox-and-sample-data/pti-storlogix-cloud-sample-data.md) * [Sandbox Salto KS Access Control System](developer-tools/sandbox-and-sample-data/sandbox-salto-ks-access-control-system.md) * [Sandbox Salto KS Locks](developer-tools/sandbox-and-sample-data/sandbox-salto-ks-locks.md) * [Sandbox Salto Space Access System](developer-tools/sandbox-and-sample-data/sandbox-salto-space-access-control-system.md) - * [Sandbox Schlage Encode Locks](device-guides/sandbox-and-sample-data/schlage-encode-sample-data.md) - * [Sandbox Seam Bridge](device-guides/sandbox-and-sample-data/seam-bridge-sample-data.md) + * [Sandbox Schlage Encode Locks](developer-tools/sandbox-and-sample-data/schlage-encode-sample-data.md) + * [Sandbox Seam Bridge](developer-tools/sandbox-and-sample-data/seam-bridge-sample-data.md) * [Sandbox Sensi Thermostats](developer-tools/sandbox-and-sample-data/sandbox-sensi-thermostats.md) - * [Sandbox SmartThings Hub](device-guides/sandbox-and-sample-data/smartthings-sample-data.md) + * [Sandbox SmartThings Hub](developer-tools/sandbox-and-sample-data/smartthings-sample-data.md) * [Sandbox Tedee Locks](developer-tools/sandbox-and-sample-data/sandbox-tedee-locks.md) - * [Sandbox TTLock Locks](device-guides/sandbox-and-sample-data/ttlock-sample-data.md) - * [Sandbox Wyze Locks](device-guides/sandbox-and-sample-data/wyze-sample-data.md) - * [Sandbox Yale Locks](device-guides/sandbox-and-sample-data/yale-sample-data.md) + * [Sandbox TTLock Locks](developer-tools/sandbox-and-sample-data/ttlock-sample-data.md) + * [Sandbox Wyze Locks](developer-tools/sandbox-and-sample-data/wyze-sample-data.md) + * [Sandbox Yale Locks](developer-tools/sandbox-and-sample-data/yale-sample-data.md) * [Rate Limits and Guardrails](developer-tools/rate-limits-and-guardrails.md) * [Mobile SDKs](developer-tools/mobile-sdks/README.md) * [Android SDK](developer-tools/mobile-sdks/android-sdk.md) diff --git a/docs/guides/device-guides/sandbox-and-sample-data/2n-intercoms-sample-data.md b/docs/guides/developer-tools/sandbox-and-sample-data/2n-intercoms-sample-data.md similarity index 100% rename from docs/guides/device-guides/sandbox-and-sample-data/2n-intercoms-sample-data.md rename to docs/guides/developer-tools/sandbox-and-sample-data/2n-intercoms-sample-data.md diff --git a/docs/guides/device-guides/sandbox-and-sample-data/4suites-locks-sample-data.md b/docs/guides/developer-tools/sandbox-and-sample-data/4suites-locks-sample-data.md similarity index 100% rename from docs/guides/device-guides/sandbox-and-sample-data/4suites-locks-sample-data.md rename to docs/guides/developer-tools/sandbox-and-sample-data/4suites-locks-sample-data.md diff --git a/docs/guides/device-guides/sandbox-and-sample-data/README.md b/docs/guides/developer-tools/sandbox-and-sample-data/README.md similarity index 100% rename from docs/guides/device-guides/sandbox-and-sample-data/README.md rename to docs/guides/developer-tools/sandbox-and-sample-data/README.md diff --git a/docs/guides/device-guides/sandbox-and-sample-data/assa-abloy-visionline-access-management-system-sample-data.md b/docs/guides/developer-tools/sandbox-and-sample-data/assa-abloy-visionline-access-management-system-sample-data.md similarity index 100% rename from docs/guides/device-guides/sandbox-and-sample-data/assa-abloy-visionline-access-management-system-sample-data.md rename to docs/guides/developer-tools/sandbox-and-sample-data/assa-abloy-visionline-access-management-system-sample-data.md diff --git a/docs/guides/device-guides/sandbox-and-sample-data/august-locks-sample-data.md b/docs/guides/developer-tools/sandbox-and-sample-data/august-locks-sample-data.md similarity index 100% rename from docs/guides/device-guides/sandbox-and-sample-data/august-locks-sample-data.md rename to docs/guides/developer-tools/sandbox-and-sample-data/august-locks-sample-data.md diff --git a/docs/guides/device-guides/sandbox-and-sample-data/avigilon-alta-access-system-sample-data.md b/docs/guides/developer-tools/sandbox-and-sample-data/avigilon-alta-access-system-sample-data.md similarity index 100% rename from docs/guides/device-guides/sandbox-and-sample-data/avigilon-alta-access-system-sample-data.md rename to docs/guides/developer-tools/sandbox-and-sample-data/avigilon-alta-access-system-sample-data.md diff --git a/docs/guides/device-guides/sandbox-and-sample-data/brivo-access-sample-data.md b/docs/guides/developer-tools/sandbox-and-sample-data/brivo-access-sample-data.md similarity index 100% rename from docs/guides/device-guides/sandbox-and-sample-data/brivo-access-sample-data.md rename to docs/guides/developer-tools/sandbox-and-sample-data/brivo-access-sample-data.md diff --git a/docs/guides/device-guides/sandbox-and-sample-data/controlbyweb-relays-sample-data.md b/docs/guides/developer-tools/sandbox-and-sample-data/controlbyweb-relays-sample-data.md similarity index 100% rename from docs/guides/device-guides/sandbox-and-sample-data/controlbyweb-relays-sample-data.md rename to docs/guides/developer-tools/sandbox-and-sample-data/controlbyweb-relays-sample-data.md diff --git a/docs/guides/device-guides/sandbox-and-sample-data/doorking-sample-data.md b/docs/guides/developer-tools/sandbox-and-sample-data/doorking-sample-data.md similarity index 100% rename from docs/guides/device-guides/sandbox-and-sample-data/doorking-sample-data.md rename to docs/guides/developer-tools/sandbox-and-sample-data/doorking-sample-data.md diff --git a/docs/guides/device-guides/sandbox-and-sample-data/dormakaba-oracode-sample-data.md b/docs/guides/developer-tools/sandbox-and-sample-data/dormakaba-oracode-sample-data.md similarity index 100% rename from docs/guides/device-guides/sandbox-and-sample-data/dormakaba-oracode-sample-data.md rename to docs/guides/developer-tools/sandbox-and-sample-data/dormakaba-oracode-sample-data.md diff --git a/docs/guides/device-guides/sandbox-and-sample-data/ecobee-sample-data.md b/docs/guides/developer-tools/sandbox-and-sample-data/ecobee-sample-data.md similarity index 100% rename from docs/guides/device-guides/sandbox-and-sample-data/ecobee-sample-data.md rename to docs/guides/developer-tools/sandbox-and-sample-data/ecobee-sample-data.md diff --git a/docs/guides/device-guides/sandbox-and-sample-data/genie-sample-data.md b/docs/guides/developer-tools/sandbox-and-sample-data/genie-sample-data.md similarity index 100% rename from docs/guides/device-guides/sandbox-and-sample-data/genie-sample-data.md rename to docs/guides/developer-tools/sandbox-and-sample-data/genie-sample-data.md diff --git a/docs/guides/device-guides/sandbox-and-sample-data/google-nest-thermostats-sample-data.md b/docs/guides/developer-tools/sandbox-and-sample-data/google-nest-thermostats-sample-data.md similarity index 100% rename from docs/guides/device-guides/sandbox-and-sample-data/google-nest-thermostats-sample-data.md rename to docs/guides/developer-tools/sandbox-and-sample-data/google-nest-thermostats-sample-data.md diff --git a/docs/guides/device-guides/sandbox-and-sample-data/hubitat-hub-sample-data.md b/docs/guides/developer-tools/sandbox-and-sample-data/hubitat-hub-sample-data.md similarity index 100% rename from docs/guides/device-guides/sandbox-and-sample-data/hubitat-hub-sample-data.md rename to docs/guides/developer-tools/sandbox-and-sample-data/hubitat-hub-sample-data.md diff --git a/docs/guides/device-guides/sandbox-and-sample-data/igloohome-sample-data.md b/docs/guides/developer-tools/sandbox-and-sample-data/igloohome-sample-data.md similarity index 100% rename from docs/guides/device-guides/sandbox-and-sample-data/igloohome-sample-data.md rename to docs/guides/developer-tools/sandbox-and-sample-data/igloohome-sample-data.md diff --git a/docs/guides/device-guides/sandbox-and-sample-data/kwikset-locks-sample-data.md b/docs/guides/developer-tools/sandbox-and-sample-data/kwikset-locks-sample-data.md similarity index 100% rename from docs/guides/device-guides/sandbox-and-sample-data/kwikset-locks-sample-data.md rename to docs/guides/developer-tools/sandbox-and-sample-data/kwikset-locks-sample-data.md diff --git a/docs/guides/device-guides/sandbox-and-sample-data/linear-sample-data.md b/docs/guides/developer-tools/sandbox-and-sample-data/linear-sample-data.md similarity index 100% rename from docs/guides/device-guides/sandbox-and-sample-data/linear-sample-data.md rename to docs/guides/developer-tools/sandbox-and-sample-data/linear-sample-data.md diff --git a/docs/guides/device-guides/sandbox-and-sample-data/lockly-lock-sample-data.md b/docs/guides/developer-tools/sandbox-and-sample-data/lockly-lock-sample-data.md similarity index 100% rename from docs/guides/device-guides/sandbox-and-sample-data/lockly-lock-sample-data.md rename to docs/guides/developer-tools/sandbox-and-sample-data/lockly-lock-sample-data.md diff --git a/docs/guides/device-guides/sandbox-and-sample-data/lockly-sample-data.md b/docs/guides/developer-tools/sandbox-and-sample-data/lockly-sample-data.md similarity index 100% rename from docs/guides/device-guides/sandbox-and-sample-data/lockly-sample-data.md rename to docs/guides/developer-tools/sandbox-and-sample-data/lockly-sample-data.md diff --git a/docs/guides/device-guides/sandbox-and-sample-data/minut-noise-sensor-sample-data.md b/docs/guides/developer-tools/sandbox-and-sample-data/minut-noise-sensor-sample-data.md similarity index 100% rename from docs/guides/device-guides/sandbox-and-sample-data/minut-noise-sensor-sample-data.md rename to docs/guides/developer-tools/sandbox-and-sample-data/minut-noise-sensor-sample-data.md diff --git a/docs/guides/device-guides/sandbox-and-sample-data/minut-sample-data.md b/docs/guides/developer-tools/sandbox-and-sample-data/minut-sample-data.md similarity index 100% rename from docs/guides/device-guides/sandbox-and-sample-data/minut-sample-data.md rename to docs/guides/developer-tools/sandbox-and-sample-data/minut-sample-data.md diff --git a/docs/guides/device-guides/sandbox-and-sample-data/noiseaware-sample-data.md b/docs/guides/developer-tools/sandbox-and-sample-data/noiseaware-sample-data.md similarity index 100% rename from docs/guides/device-guides/sandbox-and-sample-data/noiseaware-sample-data.md rename to docs/guides/developer-tools/sandbox-and-sample-data/noiseaware-sample-data.md diff --git a/docs/guides/device-guides/sandbox-and-sample-data/nuki-sample-data.md b/docs/guides/developer-tools/sandbox-and-sample-data/nuki-sample-data.md similarity index 100% rename from docs/guides/device-guides/sandbox-and-sample-data/nuki-sample-data.md rename to docs/guides/developer-tools/sandbox-and-sample-data/nuki-sample-data.md diff --git a/docs/guides/device-guides/sandbox-and-sample-data/pti-storlogix-cloud-sample-data.md b/docs/guides/developer-tools/sandbox-and-sample-data/pti-storlogix-cloud-sample-data.md similarity index 100% rename from docs/guides/device-guides/sandbox-and-sample-data/pti-storlogix-cloud-sample-data.md rename to docs/guides/developer-tools/sandbox-and-sample-data/pti-storlogix-cloud-sample-data.md diff --git a/docs/guides/device-guides/sandbox-and-sample-data/schlage-encode-sample-data.md b/docs/guides/developer-tools/sandbox-and-sample-data/schlage-encode-sample-data.md similarity index 100% rename from docs/guides/device-guides/sandbox-and-sample-data/schlage-encode-sample-data.md rename to docs/guides/developer-tools/sandbox-and-sample-data/schlage-encode-sample-data.md diff --git a/docs/guides/device-guides/sandbox-and-sample-data/seam-bridge-sample-data.md b/docs/guides/developer-tools/sandbox-and-sample-data/seam-bridge-sample-data.md similarity index 100% rename from docs/guides/device-guides/sandbox-and-sample-data/seam-bridge-sample-data.md rename to docs/guides/developer-tools/sandbox-and-sample-data/seam-bridge-sample-data.md diff --git a/docs/guides/device-guides/sandbox-and-sample-data/smartthings-sample-data.md b/docs/guides/developer-tools/sandbox-and-sample-data/smartthings-sample-data.md similarity index 100% rename from docs/guides/device-guides/sandbox-and-sample-data/smartthings-sample-data.md rename to docs/guides/developer-tools/sandbox-and-sample-data/smartthings-sample-data.md diff --git a/docs/guides/device-guides/sandbox-and-sample-data/ttlock-sample-data.md b/docs/guides/developer-tools/sandbox-and-sample-data/ttlock-sample-data.md similarity index 100% rename from docs/guides/device-guides/sandbox-and-sample-data/ttlock-sample-data.md rename to docs/guides/developer-tools/sandbox-and-sample-data/ttlock-sample-data.md diff --git a/docs/guides/device-guides/sandbox-and-sample-data/wyze-sample-data.md b/docs/guides/developer-tools/sandbox-and-sample-data/wyze-sample-data.md similarity index 100% rename from docs/guides/device-guides/sandbox-and-sample-data/wyze-sample-data.md rename to docs/guides/developer-tools/sandbox-and-sample-data/wyze-sample-data.md diff --git a/docs/guides/device-guides/sandbox-and-sample-data/yale-sample-data.md b/docs/guides/developer-tools/sandbox-and-sample-data/yale-sample-data.md similarity index 100% rename from docs/guides/device-guides/sandbox-and-sample-data/yale-sample-data.md rename to docs/guides/developer-tools/sandbox-and-sample-data/yale-sample-data.md From 90daea908b8e4e1180e56fb9279d6e8020d9a24f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Louis=20Pr=C3=A9?= Date: Tue, 21 Apr 2026 16:01:46 -0700 Subject: [PATCH 5/7] Move for-device-manufacturers/ files to device-manufacturer-guidance/ 5 files under "## Device Manufacturer Guidance" in SUMMARY.md were in for-device-manufacturers/ instead of device-manufacturer-guidance/. Co-Authored-By: Claude Opus 4.6 (1M context) --- docs/guides/SUMMARY.md | 10 +++++----- .../creating-the-health-endpoint.md | 0 .../creating-a-seam-compatible-intercom-api/README.md | 0 .../creating-access-code-crud-endpoints.md | 0 .../creating-intercom-crud-endpoints.md | 0 .../creating-oauth-endpoints.md | 0 6 files changed, 5 insertions(+), 5 deletions(-) rename docs/guides/{for-device-manufacturers => device-manufacturer-guidance}/creating-a-seam-compatible-door-locks-api/creating-the-health-endpoint.md (100%) rename docs/guides/{for-device-manufacturers => device-manufacturer-guidance}/creating-a-seam-compatible-intercom-api/README.md (100%) rename docs/guides/{for-device-manufacturers => device-manufacturer-guidance}/creating-a-seam-compatible-intercom-api/creating-access-code-crud-endpoints.md (100%) rename docs/guides/{for-device-manufacturers => device-manufacturer-guidance}/creating-a-seam-compatible-intercom-api/creating-intercom-crud-endpoints.md (100%) rename docs/guides/{for-device-manufacturers => device-manufacturer-guidance}/creating-a-seam-compatible-intercom-api/creating-oauth-endpoints.md (100%) diff --git a/docs/guides/SUMMARY.md b/docs/guides/SUMMARY.md index 7824a4424..78ca7e622 100644 --- a/docs/guides/SUMMARY.md +++ b/docs/guides/SUMMARY.md @@ -381,8 +381,8 @@ * [Implementing Lock Actions](device-manufacturer-guidance/building-a-seam-compatible-smart-lock-api/implementing-lock-actions.md) * [Implementing Access Codes](device-manufacturer-guidance/building-a-seam-compatible-smart-lock-api/implementing-access-codes.md) * [Webhooks & Events](device-manufacturer-guidance/building-a-seam-compatible-smart-lock-api/webhooks-and-events.md) -* [Creating a Seam-Compatible Intercom API](for-device-manufacturers/creating-a-seam-compatible-intercom-api/README.md) - * [Creating OAuth Endpoints](for-device-manufacturers/creating-a-seam-compatible-intercom-api/creating-oauth-endpoints.md) - * [Creating Intercom CRUD Endpoints](for-device-manufacturers/creating-a-seam-compatible-intercom-api/creating-intercom-crud-endpoints.md) - * [Creating Access Code CRUD Endpoints](for-device-manufacturers/creating-a-seam-compatible-intercom-api/creating-access-code-crud-endpoints.md) - * [Creating the Health Endpoint](for-device-manufacturers/creating-a-seam-compatible-door-locks-api/creating-the-health-endpoint.md) +* [Creating a Seam-Compatible Intercom API](device-manufacturer-guidance/creating-a-seam-compatible-intercom-api/README.md) + * [Creating OAuth Endpoints](device-manufacturer-guidance/creating-a-seam-compatible-intercom-api/creating-oauth-endpoints.md) + * [Creating Intercom CRUD Endpoints](device-manufacturer-guidance/creating-a-seam-compatible-intercom-api/creating-intercom-crud-endpoints.md) + * [Creating Access Code CRUD Endpoints](device-manufacturer-guidance/creating-a-seam-compatible-intercom-api/creating-access-code-crud-endpoints.md) + * [Creating the Health Endpoint](device-manufacturer-guidance/creating-a-seam-compatible-door-locks-api/creating-the-health-endpoint.md) diff --git a/docs/guides/for-device-manufacturers/creating-a-seam-compatible-door-locks-api/creating-the-health-endpoint.md b/docs/guides/device-manufacturer-guidance/creating-a-seam-compatible-door-locks-api/creating-the-health-endpoint.md similarity index 100% rename from docs/guides/for-device-manufacturers/creating-a-seam-compatible-door-locks-api/creating-the-health-endpoint.md rename to docs/guides/device-manufacturer-guidance/creating-a-seam-compatible-door-locks-api/creating-the-health-endpoint.md diff --git a/docs/guides/for-device-manufacturers/creating-a-seam-compatible-intercom-api/README.md b/docs/guides/device-manufacturer-guidance/creating-a-seam-compatible-intercom-api/README.md similarity index 100% rename from docs/guides/for-device-manufacturers/creating-a-seam-compatible-intercom-api/README.md rename to docs/guides/device-manufacturer-guidance/creating-a-seam-compatible-intercom-api/README.md diff --git a/docs/guides/for-device-manufacturers/creating-a-seam-compatible-intercom-api/creating-access-code-crud-endpoints.md b/docs/guides/device-manufacturer-guidance/creating-a-seam-compatible-intercom-api/creating-access-code-crud-endpoints.md similarity index 100% rename from docs/guides/for-device-manufacturers/creating-a-seam-compatible-intercom-api/creating-access-code-crud-endpoints.md rename to docs/guides/device-manufacturer-guidance/creating-a-seam-compatible-intercom-api/creating-access-code-crud-endpoints.md diff --git a/docs/guides/for-device-manufacturers/creating-a-seam-compatible-intercom-api/creating-intercom-crud-endpoints.md b/docs/guides/device-manufacturer-guidance/creating-a-seam-compatible-intercom-api/creating-intercom-crud-endpoints.md similarity index 100% rename from docs/guides/for-device-manufacturers/creating-a-seam-compatible-intercom-api/creating-intercom-crud-endpoints.md rename to docs/guides/device-manufacturer-guidance/creating-a-seam-compatible-intercom-api/creating-intercom-crud-endpoints.md diff --git a/docs/guides/for-device-manufacturers/creating-a-seam-compatible-intercom-api/creating-oauth-endpoints.md b/docs/guides/device-manufacturer-guidance/creating-a-seam-compatible-intercom-api/creating-oauth-endpoints.md similarity index 100% rename from docs/guides/for-device-manufacturers/creating-a-seam-compatible-intercom-api/creating-oauth-endpoints.md rename to docs/guides/device-manufacturer-guidance/creating-a-seam-compatible-intercom-api/creating-oauth-endpoints.md From 9558fa2fea83d6eb9408b170f79a5f044413c0fa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Louis=20Pr=C3=A9?= Date: Tue, 21 Apr 2026 16:19:17 -0700 Subject: [PATCH 6/7] Fix broken relative and absolute links after file moves Update links in ~20 files that pointed to old device-guides/ paths. Fixes both relative links (../../device-guides/...) and absolute URLs (https://docs.seam.co/latest/device-guides/...). Co-Authored-By: Claude Opus 4.6 (1M context) --- .../connect-an-acs-to-seam/README.md | 4 +-- .../smart-locks/access-codes/README.md | 10 +++---- .../migrating-existing-access-codes.md | 4 +-- .../capability-guides/thermostats/README.md | 2 +- ...-thermostat-app-with-simulate-endpoints.md | 2 +- .../customizing-connect-webviews.md | 28 +++++++++---------- ...gainst-device-disconnection-and-removal.md | 4 +-- .../guides/core-concepts/workspaces/README.md | 2 +- ...assa-abloy-vingcard-credential-services.md | 2 +- .../33-lock-devices/README.md | 2 +- .../get-started-with-33-lock-devices.md | 4 +-- .../get-started-with-4suites-locks.md | 4 +-- .../get-started-with-akiles-locks.md | 2 +- ...-dormakaba-oracode-offline-access-codes.md | 6 ++-- .../get-started-with-controlbyweb-devices.md | 2 +- .../get-started-with-kwikset-wifi-locks.md | 2 +- .../get-started-with-minut-sensors.md | 2 +- .../get-started-with-noiseaware-sensors.md | 2 +- .../get-started-with-nuki-locks.md | 2 +- .../get-started-with-salto-locks.md | 2 +- .../get-started-with-wyze-locks.md | 2 +- .../get-started-with-yale-locks.md | 2 +- .../get-started-with-nest-thermostats.md | 6 ++-- .../get-started-with-honeywell-thermostats.md | 2 +- .../get-started-with-igloo-locks.md | 2 +- .../get-started-with-schlage-locks.md | 2 +- .../get-started-with-sensi-thermostats.md | 2 +- ...ted-with-smartthings-hubs-+-thermostats.md | 4 +-- .../get-started-with-tedee-locks.md | 6 ++-- 29 files changed, 58 insertions(+), 58 deletions(-) diff --git a/docs/guides/capability-guides/access-systems/connect-an-acs-to-seam/README.md b/docs/guides/capability-guides/access-systems/connect-an-acs-to-seam/README.md index e34e29917..50093c32b 100644 --- a/docs/guides/capability-guides/access-systems/connect-an-acs-to-seam/README.md +++ b/docs/guides/capability-guides/access-systems/connect-an-acs-to-seam/README.md @@ -11,7 +11,7 @@ You can use [Seam Console](../../../core-concepts/seam-console/) or the [Seam AP 1. Log in to [Seam Console](https://console.seam.co/). 2. In the upper-left corner, click the workspace switcher and select or create a [workspace](../../../core-concepts/workspaces/). - To connect a real access system to Seam, use a production workspace. To use one of Seam's [virtual access systems](../../../device-guides/sandbox-and-sample-data/), use a [sandbox workspace](../../../core-concepts/workspaces/#sandbox-workspaces). + To connect a real access system to Seam, use a production workspace. To use one of Seam's [virtual access systems](../../../developer-tools/sandbox-and-sample-data/), use a [sandbox workspace](../../../core-concepts/workspaces/#sandbox-workspaces). ![Use the Seam Console workspace switcher to switch between workspaces and create new workspaces.](../../../.gitbook/assets/workspace-switcher.png) 3. In the top navigation pane, click **ACS Systems**. @@ -22,7 +22,7 @@ You can use [Seam Console](../../../core-concepts/seam-console/) or the [Seam AP
Use a Connect Webview to connect your access system to Seam.

Use a Connect Webview to connect your access system to Seam.

- If you want to connect a virtual access system to a sandbox workspace, use the corresponding [sandbox access system credentials](../../../device-guides/sandbox-and-sample-data/). + If you want to connect a virtual access system to a sandbox workspace, use the corresponding [sandbox access system credentials](../../../developer-tools/sandbox-and-sample-data/). To connect a real access system, see the [system integration guide](../../../device-and-system-integration-guides/overview.md#access-control-systems) for your ACS to learn any brand- or system-specific prerequisites, requirements, and restrictions. diff --git a/docs/guides/capability-guides/smart-locks/access-codes/README.md b/docs/guides/capability-guides/smart-locks/access-codes/README.md index e530d65be..3573cafe0 100644 --- a/docs/guides/capability-guides/smart-locks/access-codes/README.md +++ b/docs/guides/capability-guides/smart-locks/access-codes/README.md @@ -30,7 +30,7 @@ Time-bound access codes are suitable for temporary access, like guest visits or ### Offline Access Codes -Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. Currently, Seam supports offline access codes for [igloohome locks](../../../device-guides/igloohome-locks.md), [dormakaba Oracode locks](../../../device-guides/dormakaba-oracode-locks.md), and [Lockly locks](../../../device-and-system-integration-guides/lockly-locks/). For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code. +Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. Currently, Seam supports offline access codes for [igloohome locks](../../../device-and-system-integration-guides/igloohome-locks/), [dormakaba Oracode locks](../../../device-and-system-integration-guides/dormakaba-oracode-locks/), and [Lockly locks](../../../device-and-system-integration-guides/lockly-locks/). For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code. {% hint style="info" %} You cannot modify a created offline access code. In addition, you cannot revoke a created offline access code before the configured expiration date for the code. To invalidate an offline access code before the expiration date, you must either perform a factory reset on the device or re-pair your smartphone with the device. @@ -38,13 +38,13 @@ You cannot modify a created offline access code. In addition, you cannot revoke Seam supports two types of offline access codes: [time-bound](./#time-bound-offline-access-codes) and [one-time-use](./#one-time-use-offline-access-codes). Note that this support varies based on the device manufacturer. Before creating an offline access code, it is imperative to understand any manufacturer- or device-specific constraints, such as the maximum number of access codes, any time slot or activation requirements, and so on. For details, see the corresponding device guide. -* [igloohome Locks device guide](../../../device-guides/igloohome-locks.md) -* [dormakaba Oracode Locks device guide](../../../device-guides/dormakaba-oracode-locks.md) +* [igloohome Locks device guide](../../../device-and-system-integration-guides/igloohome-locks/) +* [dormakaba Oracode Locks device guide](../../../device-and-system-integration-guides/dormakaba-oracode-locks/) * [Lockly Locks device guide](../../../device-and-system-integration-guides/lockly-locks/) #### Time-Bound Offline Access Codes -For [igloohome locks](../../../device-guides/igloohome-locks.md) and [dormakaba Oracode locks](../../../device-guides/dormakaba-oracode-locks.md), you can create time-bound offline access codes with validity durations at either the hour level or the day level. For [Lockly locks](../../../device-and-system-integration-guides/lockly-locks/), you can create generic time-bound offline access codes that do not differentiate between hourly-bound and daily-bound codes. +For [igloohome locks](../../../device-and-system-integration-guides/igloohome-locks/) and [dormakaba Oracode locks](../../../device-and-system-integration-guides/dormakaba-oracode-locks/), you can create time-bound offline access codes with validity durations at either the hour level or the day level. For [Lockly locks](../../../device-and-system-integration-guides/lockly-locks/), you can create generic time-bound offline access codes that do not differentiate between hourly-bound and daily-bound codes. Hourly-bound offline access codes are intended for shorter durations, while daily-bound offline codes are intended for longer durations. Device manufacturers set the bounds for these short- and long-term access codes, and some device manufacturers enforce a maximum duration for hourly-bound offline access codes. See the corresponding device guide for more information. @@ -52,7 +52,7 @@ To [create a time-bound offline access code](offline-access-codes.md#creating-ti #### One-Time-Use Offline Access Codes -For [igloohome locks](../../../device-guides/igloohome-locks.md) and [Lockly locks](../../../device-and-system-integration-guides/lockly-locks/), you can create [one-time-use offline access codes](offline-access-codes.md#creating-one-time-use-offline-access-codes). igloohome one-time-use offline access codes are valid for 24 hours from the `starts_at` timestamp that you configure. Lockly offline access codes are valid for the time period that you specify using the `starts_at` and `ends_at` timestamps. These codes expire after a single use. +For [igloohome locks](../../../device-and-system-integration-guides/igloohome-locks/) and [Lockly locks](../../../device-and-system-integration-guides/lockly-locks/), you can create [one-time-use offline access codes](offline-access-codes.md#creating-one-time-use-offline-access-codes). igloohome one-time-use offline access codes are valid for 24 hours from the `starts_at` timestamp that you configure. Lockly offline access codes are valid for the time period that you specify using the `starts_at` and `ends_at` timestamps. These codes expire after a single use. *** diff --git a/docs/guides/capability-guides/smart-locks/access-codes/migrating-existing-access-codes.md b/docs/guides/capability-guides/smart-locks/access-codes/migrating-existing-access-codes.md index 62d24f109..4fece4bf7 100644 --- a/docs/guides/capability-guides/smart-locks/access-codes/migrating-existing-access-codes.md +++ b/docs/guides/capability-guides/smart-locks/access-codes/migrating-existing-access-codes.md @@ -285,9 +285,9 @@ Once an unmanaged code is successfully converted to a managed code, all of the n Some third-party device providers strictly limit the information available about existing access codes on a device. Thus, for devices connected using these providers, we cannot convert unmanaged codes to managed ones. The following providers currently do not support conversion: -* [igloohome](../../../device-guides/igloohome-locks.md) +* [igloohome](../../../device-and-system-integration-guides/igloohome-locks/) * [Kwikset](../../../device-and-system-integration-guides/kwikset-locks.md) -* [SmartThings](../../../device-guides/get-started-with-smartthings-hubs-+-smart-locks.md) +* [SmartThings](../../../device-and-system-integration-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md) For SmartThings devices, you can still see a list of all unmanaged codes on the devices using the `GET /access_codes/unmanaged/list` endpoint, but you cannot see the actual PIN code for the access codes (the `code` property is not present). diff --git a/docs/guides/capability-guides/thermostats/README.md b/docs/guides/capability-guides/thermostats/README.md index c1ed30951..c9a81cdda 100644 --- a/docs/guides/capability-guides/thermostats/README.md +++ b/docs/guides/capability-guides/thermostats/README.md @@ -80,7 +80,7 @@ For detailed information about these capabilities, see [Device and System Capabi Seam supports integration with the following smart thermostat manufacturers: -
ecobee Thermostatsecobee-thermostats.mdecobee-logo.png
Google Nest Thermostatsgoogle-nest-thermostatsnest-logo.png
Honeywell Resideo Thermostatshoneywell-thermostatshoneywell_logo.png
Sensi Thermostatsbroken-referencesensi-logo.png
+
ecobee Thermostatsecobee-thermostats.mdecobee-logo.png
Google Nest Thermostatsgoogle-nest-thermostatsnest-logo.png
Honeywell Resideo Thermostatshoneywell-thermostatshoneywell_logo.png
Sensi Thermostatsbroken-referencesensi-logo.png
*** diff --git a/docs/guides/capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints.md b/docs/guides/capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints.md index 146da62a6..e1212b808 100644 --- a/docs/guides/capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints.md +++ b/docs/guides/capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints.md @@ -11,7 +11,7 @@ Seam's suite of `simulate` endpoints help you to test your thermostat app agains * [`/thermostats/simulate/hvac_mode_adjusted`](testing-your-thermostat-app-with-simulate-endpoints.md#simulate-adjusting-the-hvac-mode) * [`/thermostats/simulate/temperature_reached`](testing-your-thermostat-app-with-simulate-endpoints.md#simulate-reaching-a-desired-temperature) -Seam supports these endpoints for all thermostat [sandbox devices](../../device-guides/sandbox-and-sample-data/). +Seam supports these endpoints for all thermostat [sandbox devices](../../developer-tools/sandbox-and-sample-data/). {% hint style="info" %} Seam provides additional `simulate` endpoints to help you [test your app against device disconnection and removal](../../core-concepts/devices/testing-your-app-against-device-disconnection-and-removal.md). diff --git a/docs/guides/core-concepts/connect-webviews/customizing-connect-webviews.md b/docs/guides/core-concepts/connect-webviews/customizing-connect-webviews.md index 584e7a018..eb8b58f3a 100644 --- a/docs/guides/core-concepts/connect-webviews/customizing-connect-webviews.md +++ b/docs/guides/core-concepts/connect-webviews/customizing-connect-webviews.md @@ -48,42 +48,42 @@ When you create a Connect Webview, you can customize the providers—that is, th | Provider Name | Device Provider Key | | -------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------- | -| [2N](../../device-guides/2n-intercom-systems.md) | `my_2n` | +| [2N](../../device-and-system-integration-guides/2n-intercom-systems/) | `my_2n` | | [4SUITES](../../device-and-system-integration-guides/4suites-locks/) | `four_suites` | | [Akiles](../../device-and-system-integration-guides/akiles-locks/) | `akiles` | | [Akuvox](https://akuvox.com/) | `akuvox` | | [ASSA ABLOY Credential Service](../../device-and-system-integration-guides/assa-abloy-vingcard-credential-services.md) | `assa_abloy_credential_service` | | [ASSA ABLOY Visionline Access Control System](../../device-and-system-integration-guides/assa-abloy-visionline-access-control-system/) | `visionline` | | [August Home](../../device-and-system-integration-guides/august-locks.md) | `august` | -| [Avigilon Alta](../../device-guides/avigilon-alta-access-system.md) | `avigilon_alta` | +| [Avigilon Alta](../../device-and-system-integration-guides/avigilon-alta-access-system.md) | `avigilon_alta` | | [Brivo](../../device-and-system-integration-guides/brivo-access/) | `brivo` | -| [ControlByWeb](../../device-guides/get-started-with-controlbyweb-devices.md) | `controlbyweb` | +| [ControlByWeb](../../device-and-system-integration-guides/get-started-with-controlbyweb-devices.md) | `controlbyweb` | | [DoorKing](https://www.doorking.com/) | `doorking` | | [Dormakaba Community](../../device-and-system-integration-guides/dormakaba-community-access-control-system/) | `dormakaba_community` | -| [Dormakaba Oracode](../../device-guides/dormakaba-oracode-locks.md) | `dormakaba_oracode` | -| [ecobee](../../device-guides/ecobee-thermostats.md) | `ecobee` | +| [Dormakaba Oracode](../../device-and-system-integration-guides/dormakaba-oracode-locks/) | `dormakaba_oracode` | +| [ecobee](../../device-and-system-integration-guides/ecobee-thermostats.md) | `ecobee` | | [Genie Aladdin Connect](https://www.geniecompany.com/aladdin-connect-by-genie) | `genie` | | [Honeywell Resideo](../../device-and-system-integration-guides/honeywell-thermostats/) | `honeywell_resideo` | -| [igloohome](../../device-guides/igloohome-locks.md) | `igloohome` | +| [igloohome](../../device-and-system-integration-guides/igloohome-locks/) | `igloohome` | | [Kwikset](../../device-and-system-integration-guides/kwikset-locks.md) | `kwikset` | | [Latch](../../device-and-system-integration-guides/latch-access-control-system/) | `latch` | | [Linear](https://linear-solutions.com/) | `linear` | | [Lockly](../../device-and-system-integration-guides/lockly-locks/) | `lockly` | -| [Minut](../../device-guides/minut-sensors.md) | `minut` | -| [Nest](../../device-guides/google-nest-thermostats/) | `google_nest` | +| [Minut](../../device-and-system-integration-guides/minut-sensors.md) | `minut` | +| [Nest](../../device-and-system-integration-guides/google-nest-thermostats/) | `google_nest` | | [NoiseAware](../../device-and-system-integration-guides/noiseaware-sensors.md) | `noiseaware` | -| [Nuki](../../device-guides/nuki-locks.md) | `nuki` | -| [PTI Storlogix Cloud](../../device-guides/pti-storlogix-cloud.md) | `pti` | +| [Nuki](../../device-and-system-integration-guides/nuki-locks.md) | `nuki` | +| [PTI Storlogix Cloud](../../device-and-system-integration-guides/pti-storlogix-cloud.md) | `pti` | | [Salto KS Access System](../../device-and-system-integration-guides/salto-ks-access-control-system/) | `salto_ks` | | [Salto KS Locks](../../device-and-system-integration-guides/salto-locks.md) | `salto_ks` | | [Salto ProAccess Space Access System](../../device-and-system-integration-guides/salto-proaccess-space-access-system/) | `salto_space` | | [Schlage](../../device-and-system-integration-guides/schlage-locks/) | `schlage` | | [Sensi](../../device-and-system-integration-guides/sensi-thermostats/) | `sensi` | -| [SmartThings](../../device-guides/get-started-with-smartthings-hubs-+-smart-locks.md) | `smartthings` | +| [SmartThings](../../device-and-system-integration-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md) | `smartthings` | | [Tedee](../../device-and-system-integration-guides/tedee-locks/) | `tedee` | -| [TTLock](../../device-guides/ttlock-locks.md) | `ttlock` | -| [Wyze](../../device-guides/wyze-locks.md) | `wyze` | -| [Yale](../../device-guides/yale-locks.md) | `yale` | +| [TTLock](../../device-and-system-integration-guides/ttlock-locks.md) | `ttlock` | +| [Wyze](../../device-and-system-integration-guides/wyze-locks.md) | `wyze` | +| [Yale](../../device-and-system-integration-guides/yale-locks.md) | `yale` | To help you decide which providers to include in a Connect Webview, you can use the [List Device Providers](https://docs.seam.co/latest/api/devices/list_device_providers) method to learn about each provider. The information that this method returns for each provider includes a set of [capability flags](../../capability-guides/device-and-system-capabilities.md#capability-flags), such as `device_provider.can_remotely_unlock`. If at least one supported device from a provider has a specific capability, the corresponding capability flag is `true`. diff --git a/docs/guides/core-concepts/devices/testing-your-app-against-device-disconnection-and-removal.md b/docs/guides/core-concepts/devices/testing-your-app-against-device-disconnection-and-removal.md index 7e317fd7c..c590a1646 100644 --- a/docs/guides/core-concepts/devices/testing-your-app-against-device-disconnection-and-removal.md +++ b/docs/guides/core-concepts/devices/testing-your-app-against-device-disconnection-and-removal.md @@ -14,7 +14,7 @@ When developing an app to control IoT devices—before moving to production—it * [`/devices/simulate/remove`](testing-your-app-against-device-disconnection-and-removal.md#simulate-removing-a-device) {% hint style="info" %} -Currently, Seam supports these endpoints for [August](../../device-guides/sandbox-and-sample-data/august-locks-sample-data.md) and [Yale](../../device-guides/sandbox-and-sample-data/yale-sample-data.md) sandbox devices. +Currently, Seam supports these endpoints for [August](../../developer-tools/sandbox-and-sample-data/august-locks-sample-data.md) and [Yale](../../developer-tools/sandbox-and-sample-data/yale-sample-data.md) sandbox devices. {% endhint %} *** @@ -538,7 +538,7 @@ void You can also use the [Seam Console](https://console.seam.co/) to simulate disconnecting, connecting, and removing a device. {% hint style="info" %} -Currently, Seam supports these actions for [August](../../device-guides/sandbox-and-sample-data/august-locks-sample-data.md) and [Yale](../../device-guides/sandbox-and-sample-data/yale-sample-data.md) sandbox devices. +Currently, Seam supports these actions for [August](../../developer-tools/sandbox-and-sample-data/august-locks-sample-data.md) and [Yale](../../developer-tools/sandbox-and-sample-data/yale-sample-data.md) sandbox devices. {% endhint %} 1. In the upper-right corner of the Seam Console, click the down arrow to display the workspace list and select a sandbox workspace. diff --git a/docs/guides/core-concepts/workspaces/README.md b/docs/guides/core-concepts/workspaces/README.md index 7186490b1..a278dca21 100644 --- a/docs/guides/core-concepts/workspaces/README.md +++ b/docs/guides/core-concepts/workspaces/README.md @@ -104,7 +104,7 @@ You can only connect virtual devices in a sandbox workspace. To connect a real d ### Connecting Virtual Devices -To connect virtual devices, specify the login credentials for test device accounts in the [Seam Console](./#connect-devices-using-the-seam-console) or in [Connect Webviews](./#connect-devices-using-connect-webviews) within you apps. All manufacturers and devices that Seam supports have one or more sandbox test accounts with pre-seeded devices. For login credentials for all test device accounts, see [Sandbox Devices and Systems](../../device-guides/sandbox-and-sample-data/). +To connect virtual devices, specify the login credentials for test device accounts in the [Seam Console](./#connect-devices-using-the-seam-console) or in [Connect Webviews](./#connect-devices-using-connect-webviews) within you apps. All manufacturers and devices that Seam supports have one or more sandbox test accounts with pre-seeded devices. For login credentials for all test device accounts, see [Sandbox Devices and Systems](../../developer-tools/sandbox-and-sample-data/). ### Interacting with a Virtual Device diff --git a/docs/guides/developer-tools/sandbox-and-sample-data/sandbox-assa-abloy-vingcard-credential-services.md b/docs/guides/developer-tools/sandbox-and-sample-data/sandbox-assa-abloy-vingcard-credential-services.md index 39d38d73d..37a3dfd92 100644 --- a/docs/guides/developer-tools/sandbox-and-sample-data/sandbox-assa-abloy-vingcard-credential-services.md +++ b/docs/guides/developer-tools/sandbox-and-sample-data/sandbox-assa-abloy-vingcard-credential-services.md @@ -8,7 +8,7 @@ noIndex: true Use the following set of credentials to add virtual [ASSA ABLOY Credential Services](../../device-and-system-integration-guides/assa-abloy-vingcard-credential-services.md) to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): {% hint style="info" %} -Use the virtual ASSA ABLOY Credential Services with a [virtual Visionline ACS](../../device-guides/sandbox-and-sample-data/assa-abloy-visionline-access-management-system-sample-data.md) to issue mobile keys in a sandbox workspace. +Use the virtual ASSA ABLOY Credential Services with a [virtual Visionline ACS](assa-abloy-visionline-access-management-system-sample-data.md) to issue mobile keys in a sandbox workspace. {% endhint %}
FieldValue
Usernamejane
Password1234
Credential Services URLhttps://example.com
diff --git a/docs/guides/device-and-system-integration-guides/33-lock-devices/README.md b/docs/guides/device-and-system-integration-guides/33-lock-devices/README.md index f4355f439..417fa17e9 100644 --- a/docs/guides/device-and-system-integration-guides/33-lock-devices/README.md +++ b/docs/guides/device-and-system-integration-guides/33-lock-devices/README.md @@ -60,7 +60,7 @@ To control 33 Lock devices using Seam, you must prompt owners of these devices t ## Troubleshooting -For errors and warnings that are relevant to 33 Lock devices, see [Troubleshooting](../../device-guides/ttlock-locks.md#troubleshooting) in the TTLock device integration guide. +For errors and warnings that are relevant to 33 Lock devices, see [Troubleshooting](../ttlock-locks.md#troubleshooting) in the TTLock device integration guide. *** diff --git a/docs/guides/device-and-system-integration-guides/33-lock-devices/get-started-with-33-lock-devices.md b/docs/guides/device-and-system-integration-guides/33-lock-devices/get-started-with-33-lock-devices.md index 9d01f7491..b23c14907 100644 --- a/docs/guides/device-and-system-integration-guides/33-lock-devices/get-started-with-33-lock-devices.md +++ b/docs/guides/device-and-system-integration-guides/33-lock-devices/get-started-with-33-lock-devices.md @@ -272,10 +272,10 @@ In a web browser, go to the URL that the Connect Webview object returned. For application developers, you can redirect your user to this Connect Webview URL so that they can authorize your app to control their devices using Seam. We even provide a prebuilt [Connect Account Button](../../ui-components/overview/react-components/connect-account-button.md) within our suite of [Seam Components](../../ui-components/overview/) that help you build your device management flow. {% hint style="success" %} -Because you're using a sandbox workspace, you can connect Seam's test TTLock account. We provide [virtual devices](../../device-guides/sandbox-and-sample-data/) for each of the brands that we support. These sandbox devices and systems enable you to test your app with devices from multiple brands without the need to own all the corresponding physical devices. +Because you're using a sandbox workspace, you can connect Seam's test TTLock account. We provide [virtual devices](../../developer-tools/sandbox-and-sample-data/) for each of the brands that we support. These sandbox devices and systems enable you to test your app with devices from multiple brands without the need to own all the corresponding physical devices. {% endhint %} -Complete the Connect Webview authorization flow by entering the following [TTLock sandbox account](../../device-guides/sandbox-and-sample-data/ttlock-sample-data.md) credentials: +Complete the Connect Webview authorization flow by entering the following [TTLock sandbox account](../../developer-tools/sandbox-and-sample-data/ttlock-sample-data.md) credentials: * **Email:** jane@example.com * **Password:** 1234 diff --git a/docs/guides/device-and-system-integration-guides/4suites-locks/get-started-with-4suites-locks.md b/docs/guides/device-and-system-integration-guides/4suites-locks/get-started-with-4suites-locks.md index 2f698b773..eab1aa5f0 100644 --- a/docs/guides/device-and-system-integration-guides/4suites-locks/get-started-with-4suites-locks.md +++ b/docs/guides/device-and-system-integration-guides/4suites-locks/get-started-with-4suites-locks.md @@ -272,10 +272,10 @@ In a web browser, go to the URL that the Connect Webview object returned. For application developers, you can redirect your user to this Connect Webview URL so that they can authorize your app to control their devices using Seam. We even provide a prebuilt [Connect Account Button](../../ui-components/overview/react-components/connect-account-button.md) within our suite of [Seam Components](../../ui-components/overview/) that help you build your device management flow. {% hint style="success" %} -Because you're using a sandbox workspace, you can connect Seam's test 4SUITES account. We provide [virtual devices](../../device-guides/sandbox-and-sample-data/) for each of the brands that we support. These sandbox devices and systems enable you to test your app with devices from multiple brands without the need to own all the corresponding physical devices. +Because you're using a sandbox workspace, you can connect Seam's test 4SUITES account. We provide [virtual devices](../../developer-tools/sandbox-and-sample-data/) for each of the brands that we support. These sandbox devices and systems enable you to test your app with devices from multiple brands without the need to own all the corresponding physical devices. {% endhint %} -Complete the Connect Webview authorization flow by entering the following [4SUITES sandbox account](../../device-guides/sandbox-and-sample-data/4suites-locks-sample-data.md) credentials: +Complete the Connect Webview authorization flow by entering the following [4SUITES sandbox account](../../developer-tools/sandbox-and-sample-data/4suites-locks-sample-data.md) credentials: * **Email:** jane@example.com * **Password:** 1234 diff --git a/docs/guides/device-and-system-integration-guides/akiles-locks/get-started-with-akiles-locks.md b/docs/guides/device-and-system-integration-guides/akiles-locks/get-started-with-akiles-locks.md index 23cfc8a76..8e0af98fe 100644 --- a/docs/guides/device-and-system-integration-guides/akiles-locks/get-started-with-akiles-locks.md +++ b/docs/guides/device-and-system-integration-guides/akiles-locks/get-started-with-akiles-locks.md @@ -272,7 +272,7 @@ In a web browser, go to the URL that the Connect Webview object returned. For application developers, you can redirect your user to this Connect Webview URL so that they can authorize your app to control their devices using Seam. We even provide a prebuilt [Connect Account Button](../../ui-components/overview/react-components/connect-account-button.md) within our suite of [Seam Components](../../ui-components/overview/) that help you build your device management flow. {% hint style="success" %} -Because you're using a sandbox workspace, you can connect Seam's test Akiles account. We provide [virtual devices](../../device-guides/sandbox-and-sample-data/) for each of the brands that we support. These sandbox devices and systems enable you to test your app with devices from multiple brands without the need to own all the corresponding physical devices. +Because you're using a sandbox workspace, you can connect Seam's test Akiles account. We provide [virtual devices](../../developer-tools/sandbox-and-sample-data/) for each of the brands that we support. These sandbox devices and systems enable you to test your app with devices from multiple brands without the need to own all the corresponding physical devices. {% endhint %} Complete the Connect Webview authorization flow by entering the following [Akiles sandbox account](../../developer-tools/sandbox-and-sample-data/sandbox-akiles-locks.md) credentials: diff --git a/docs/guides/device-and-system-integration-guides/dormakaba-oracode-locks/creating-dormakaba-oracode-offline-access-codes.md b/docs/guides/device-and-system-integration-guides/dormakaba-oracode-locks/creating-dormakaba-oracode-offline-access-codes.md index 7eb88dbd1..461da983a 100644 --- a/docs/guides/device-and-system-integration-guides/dormakaba-oracode-locks/creating-dormakaba-oracode-offline-access-codes.md +++ b/docs/guides/device-and-system-integration-guides/dormakaba-oracode-locks/creating-dormakaba-oracode-offline-access-codes.md @@ -57,7 +57,7 @@ When you create a dormakaba Oracode offline access code, you must set the durati ### Time Zones -All time zone configuration and display for dormakaba Oracode locks occur in the local time zone of the lock, itself. When you [connect your dormakaba Oracode site to Seam](../../device-guides/dormakaba-oracode-locks.md#setup-instructions) initially, you specify the time zone in which the site is located. Consequently, when you configure an access code for a dormakaba Oracode lock, you set the `starts_at` and `ends_at` properties using a time and offset that match the local time zone of the lock. +All time zone configuration and display for dormakaba Oracode locks occur in the local time zone of the lock, itself. When you [connect your dormakaba Oracode site to Seam](README.md#setup-instructions) initially, you specify the time zone in which the site is located. Consequently, when you configure an access code for a dormakaba Oracode lock, you set the `starts_at` and `ends_at` properties using a time and offset that match the local time zone of the lock. For example, suppose that your lock includes the following user level: @@ -100,7 +100,7 @@ To [create an hourly-bound offline access code](../../capability-guides/smart-lo To create an hourly-bound offline access code, provide the `device_id` of the lock for which you want to create the code and set `is_offline_access_code` to `true`. Specify the `starts_at` and `ends_at` [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamps to define the active time window for the offline code. Make sure to set the duration of the code to match—exactly—one of the [user levels](creating-dormakaba-oracode-offline-access-codes.md#user-levels) on the device. You can also assign an optional `name` to the offline access code. {% hint style="info" %} -Make sure to set the `starts_at` and `ends_at` times and offsets to match the local time zone of the lock, as configured when the corresponding [dormakaba Oracode site was connected to Seam](../../device-guides/dormakaba-oracode-locks.md#setup-instructions). +Make sure to set the `starts_at` and `ends_at` times and offsets to match the local time zone of the lock, as configured when the corresponding [dormakaba Oracode site was connected to Seam](README.md#setup-instructions). {% endhint %} For more details, see the [Create Access Code endpoint](https://docs.seam.co/latest/api/access_codes/create). @@ -386,7 +386,7 @@ To [create a daily-bound offline access code](../../capability-guides/smart-lock To create a daily-bound offline access code, provide the `device_id` of the lock for which you want to create the code and set `is_offline_access_code` to `true`. Specify the `starts_at` and `ends_at` [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamps to define the active time window for the offline code. Make sure to set the duration of the code to match—exactly—one of the [user levels](creating-dormakaba-oracode-offline-access-codes.md#user-levels) on the device. For a daily-bound offline access code, you must specify the same time (but not the same date) in the `starts_at` and `ends_at` properties. {% hint style="info" %} -Make sure to set the `starts_at` and `ends_at` times and offsets to match the local time zone of the lock, as configured when the corresponding [dormakaba Oracode site was connected to Seam](../../device-guides/dormakaba-oracode-locks.md#setup-instructions). +Make sure to set the `starts_at` and `ends_at` times and offsets to match the local time zone of the lock, as configured when the corresponding [dormakaba Oracode site was connected to Seam](README.md#setup-instructions). {% endhint %} Because daily-bound offline access codes require day-level duration granularity, you can also set `max_time_rounding` to `1day` (or `1d`), instead of the default `1hour` (or `1h`). Note that the Seam API returns an error if `max_time_rounding` is `1hour` and the necessary rounding amount exceeds one hour. diff --git a/docs/guides/device-and-system-integration-guides/get-started-with-controlbyweb-devices.md b/docs/guides/device-and-system-integration-guides/get-started-with-controlbyweb-devices.md index bb589f838..e72c3b677 100644 --- a/docs/guides/device-and-system-integration-guides/get-started-with-controlbyweb-devices.md +++ b/docs/guides/device-and-system-integration-guides/get-started-with-controlbyweb-devices.md @@ -120,7 +120,7 @@ puts webview.url #### Authorize Your Workspace -Navigate to the URL returned by the Webview object. Since you are using a sandbox workspace, complete the login flow by entering the ControlByWeb [sandbox test account](https://docs.seam.co/latest/device-guides/sandbox-and-sample-data) credentials below: +Navigate to the URL returned by the Webview object. Since you are using a sandbox workspace, complete the login flow by entering the ControlByWeb [sandbox test account](https://docs.seam.co/latest/developer-tools/sandbox-and-sample-data) credentials below: * **username:** jane * **password:** 1234 diff --git a/docs/guides/device-and-system-integration-guides/get-started-with-kwikset-wifi-locks.md b/docs/guides/device-and-system-integration-guides/get-started-with-kwikset-wifi-locks.md index 1435712e8..f2c273613 100644 --- a/docs/guides/device-and-system-integration-guides/get-started-with-kwikset-wifi-locks.md +++ b/docs/guides/device-and-system-integration-guides/get-started-with-kwikset-wifi-locks.md @@ -130,7 +130,7 @@ puts webview.url #### Authorize Your Workspace -Navigate to the URL returned by the Webview object. Since you are using a sandbox workspace, complete the login flow by entering the Kwikset [sandbox test accounts ](https://docs.seam.co/latest/device-guides/sandbox-and-sample-data)credentials below: +Navigate to the URL returned by the Webview object. Since you are using a sandbox workspace, complete the login flow by entering the Kwikset [sandbox test accounts ](https://docs.seam.co/latest/developer-tools/sandbox-and-sample-data)credentials below: * **email:** jane@example.com * **password:** 1234 diff --git a/docs/guides/device-and-system-integration-guides/get-started-with-minut-sensors.md b/docs/guides/device-and-system-integration-guides/get-started-with-minut-sensors.md index dcb9c5866..5e7c2ec48 100644 --- a/docs/guides/device-and-system-integration-guides/get-started-with-minut-sensors.md +++ b/docs/guides/device-and-system-integration-guides/get-started-with-minut-sensors.md @@ -130,7 +130,7 @@ echo json_encode($webview) ### Authorize Your Workspace -Navigate to the URL returned by the Webview object. Since you are using a sandbox workspace, complete the login flow by entering the Minut [sandbox test accounts ](https://docs.seam.co/latest/device-guides/sandbox-and-sample-data)credentials below: +Navigate to the URL returned by the Webview object. Since you are using a sandbox workspace, complete the login flow by entering the Minut [sandbox test accounts ](https://docs.seam.co/latest/developer-tools/sandbox-and-sample-data)credentials below: * **email**: jane@example.com * **password**: 1234 diff --git a/docs/guides/device-and-system-integration-guides/get-started-with-noiseaware-sensors.md b/docs/guides/device-and-system-integration-guides/get-started-with-noiseaware-sensors.md index 231eefd85..d8867d880 100644 --- a/docs/guides/device-and-system-integration-guides/get-started-with-noiseaware-sensors.md +++ b/docs/guides/device-and-system-integration-guides/get-started-with-noiseaware-sensors.md @@ -139,7 +139,7 @@ echo json_encode($webview) ### Authorize Your Workspace -Navigate to the URL returned by the Webview object. Since you are using a sandbox workspace, complete the login flow by entering the NoiseAware [sandbox test accounts ](https://docs.seam.co/latest/device-guides/sandbox-and-sample-data)credentials below: +Navigate to the URL returned by the Webview object. Since you are using a sandbox workspace, complete the login flow by entering the NoiseAware [sandbox test accounts ](https://docs.seam.co/latest/developer-tools/sandbox-and-sample-data)credentials below: * **email**: jane@example.com * **password**: 1234 diff --git a/docs/guides/device-and-system-integration-guides/get-started-with-nuki-locks.md b/docs/guides/device-and-system-integration-guides/get-started-with-nuki-locks.md index d996797be..b2fb91950 100644 --- a/docs/guides/device-and-system-integration-guides/get-started-with-nuki-locks.md +++ b/docs/guides/device-and-system-integration-guides/get-started-with-nuki-locks.md @@ -129,7 +129,7 @@ print($connect_webview->url); #### Authorize Your Workspace -Navigate to the URL returned by the Webview object. Since you are using a sandbox workspace, complete the login flow by entering the Nuki [sandbox test accounts ](https://docs.seam.co/latest/device-guides/sandbox-and-sample-data)credentials below: +Navigate to the URL returned by the Webview object. Since you are using a sandbox workspace, complete the login flow by entering the Nuki [sandbox test accounts ](https://docs.seam.co/latest/developer-tools/sandbox-and-sample-data)credentials below: * **email:** john@example.com * **password:** 1234 diff --git a/docs/guides/device-and-system-integration-guides/get-started-with-salto-locks.md b/docs/guides/device-and-system-integration-guides/get-started-with-salto-locks.md index f03b4a007..0685e5477 100644 --- a/docs/guides/device-and-system-integration-guides/get-started-with-salto-locks.md +++ b/docs/guides/device-and-system-integration-guides/get-started-with-salto-locks.md @@ -231,7 +231,7 @@ https://connect.getseam.com/connect_webviews/view?connect_webview_id=12345678-12 #### Authorize Your Workspace -Navigate to the URL returned by the Webview object. Since you are using a sandbox workspace, complete the login flow by entering the Salto [sandbox test accounts ](https://docs.seam.co/latest/device-guides/sandbox-and-sample-data)credentials below: +Navigate to the URL returned by the Webview object. Since you are using a sandbox workspace, complete the login flow by entering the Salto [sandbox test accounts ](https://docs.seam.co/latest/developer-tools/sandbox-and-sample-data)credentials below: * **email:** jane@example.com * **password:** 1234 diff --git a/docs/guides/device-and-system-integration-guides/get-started-with-wyze-locks.md b/docs/guides/device-and-system-integration-guides/get-started-with-wyze-locks.md index 22ef15c4d..51bf0729e 100644 --- a/docs/guides/device-and-system-integration-guides/get-started-with-wyze-locks.md +++ b/docs/guides/device-and-system-integration-guides/get-started-with-wyze-locks.md @@ -150,7 +150,7 @@ $webview = $seam->connect_webviews->create( #### Authorize Your Workspace -Navigate to the URL returned by the Webview object. Since you are using a sandbox workspace, complete the login flow by entering the Wyze [sandbox test account](https://docs.seam.co/latest/device-guides/sandbox-and-sample-data)credentials below: +Navigate to the URL returned by the Webview object. Since you are using a sandbox workspace, complete the login flow by entering the Wyze [sandbox test account](https://docs.seam.co/latest/developer-tools/sandbox-and-sample-data)credentials below: * **Wyze API Key ID:** ABC123ABC * **Wyze API Key** ABC123ABC diff --git a/docs/guides/device-and-system-integration-guides/get-started-with-yale-locks.md b/docs/guides/device-and-system-integration-guides/get-started-with-yale-locks.md index d1df3ab43..d47f1746a 100644 --- a/docs/guides/device-and-system-integration-guides/get-started-with-yale-locks.md +++ b/docs/guides/device-and-system-integration-guides/get-started-with-yale-locks.md @@ -126,7 +126,7 @@ puts webview.url #### Authorize Your Workspace -Navigate to the URL returned by the Webview object. Since you are using a sandbox workspace, complete the login flow by entering the Yale [sandbox test accounts ](https://docs.seam.co/latest/device-guides/sandbox-and-sample-data)credentials below: +Navigate to the URL returned by the Webview object. Since you are using a sandbox workspace, complete the login flow by entering the Yale [sandbox test accounts ](https://docs.seam.co/latest/developer-tools/sandbox-and-sample-data)credentials below: * **email:** jane@example.com * **password:** 1234 diff --git a/docs/guides/device-and-system-integration-guides/google-nest-thermostats/get-started-with-nest-thermostats.md b/docs/guides/device-and-system-integration-guides/google-nest-thermostats/get-started-with-nest-thermostats.md index 8a3f3d44a..39d4936f2 100644 --- a/docs/guides/device-and-system-integration-guides/google-nest-thermostats/get-started-with-nest-thermostats.md +++ b/docs/guides/device-and-system-integration-guides/google-nest-thermostats/get-started-with-nest-thermostats.md @@ -274,10 +274,10 @@ In a web browser, go to the URL that the Connect Webview object returned. For application developers, you can redirect your user to this Connect Webview URL so that they can authorize your app to control their devices using Seam. We even provide a prebuilt [Connect Account Button](../../ui-components/overview/react-components/connect-account-button.md) within our suite of [Seam Components](../../ui-components/overview/) that help you build your device management flow. {% hint style="success" %} -Because you're using a sandbox workspace, you can connect Seam's test Google Nest account. We provide [virtual devices](../../device-guides/sandbox-and-sample-data/) for each of the brands that we support. These sandbox devices and systems enable you to test your app with devices from multiple brands without the need to own all the corresponding physical devices. +Because you're using a sandbox workspace, you can connect Seam's test Google Nest account. We provide [virtual devices](../../developer-tools/sandbox-and-sample-data/) for each of the brands that we support. These sandbox devices and systems enable you to test your app with devices from multiple brands without the need to own all the corresponding physical devices. {% endhint %} -Complete the Connect Webview authorization flow by entering the following [Google Nest sandbox account](../../device-guides/sandbox-and-sample-data/google-nest-thermostats-sample-data.md) credentials: +Complete the Connect Webview authorization flow by entering the following [Google Nest sandbox account](../../developer-tools/sandbox-and-sample-data/google-nest-thermostats-sample-data.md) credentials: * **Email:** jane@example.com * **Password:** 1234 @@ -1844,7 +1844,7 @@ $seam->thermostats->update_weekly_program( Now that you have learned the basics of using the Seam API, you can connect and control a real Google Nest device. To do so, make sure to switch to a [non-sandbox workspace](../../core-concepts/workspaces/#production-workspaces) and [API key](../../core-concepts/authentication/api-keys.md). -For more details about setting up your real Google Nest thermostat, see the [Google Nest thermostats integration guide](../../device-guides/google-nest-thermostats/). +For more details about setting up your real Google Nest thermostat, see the [Google Nest thermostats integration guide](../). *** diff --git a/docs/guides/device-and-system-integration-guides/honeywell-thermostats/get-started-with-honeywell-thermostats.md b/docs/guides/device-and-system-integration-guides/honeywell-thermostats/get-started-with-honeywell-thermostats.md index ad4aa897e..a01cff2f2 100644 --- a/docs/guides/device-and-system-integration-guides/honeywell-thermostats/get-started-with-honeywell-thermostats.md +++ b/docs/guides/device-and-system-integration-guides/honeywell-thermostats/get-started-with-honeywell-thermostats.md @@ -274,7 +274,7 @@ In a web browser, go to the URL that the Connect Webview object returned. For application developers, you can redirect your user to this Connect Webview URL so that they can authorize your app to control their devices using Seam. We even provide a prebuilt [Connect Account Button](../../ui-components/overview/react-components/connect-account-button.md) within our suite of [Seam Components](../../ui-components/overview/) that help you build your device management flow. {% hint style="success" %} -Because you're using a sandbox workspace, you can connect Seam's test Honeywell Resideo account. We provide [virtual devices](../../device-guides/sandbox-and-sample-data/) for each of the brands that we support. These sandbox devices and systems enable you to test your app with devices from multiple brands without the need to own all the corresponding physical devices. +Because you're using a sandbox workspace, you can connect Seam's test Honeywell Resideo account. We provide [virtual devices](../../developer-tools/sandbox-and-sample-data/) for each of the brands that we support. These sandbox devices and systems enable you to test your app with devices from multiple brands without the need to own all the corresponding physical devices. {% endhint %} Complete the Connect Webview authorization flow by entering the following [Honeywell Resideo sandbox account](../../developer-tools/sandbox-and-sample-data/sandbox-honeywell-thermostats.md) credentials: diff --git a/docs/guides/device-and-system-integration-guides/igloohome-locks/get-started-with-igloo-locks.md b/docs/guides/device-and-system-integration-guides/igloohome-locks/get-started-with-igloo-locks.md index c52fb3db8..557af6620 100644 --- a/docs/guides/device-and-system-integration-guides/igloohome-locks/get-started-with-igloo-locks.md +++ b/docs/guides/device-and-system-integration-guides/igloohome-locks/get-started-with-igloo-locks.md @@ -135,7 +135,7 @@ echo json_encode($webview) #### Authorize Your Workspace -Navigate to the URL returned by the Webview object. Since you are using a sandbox workspace, complete the login flow by entering the Igloohome [sandbox test accounts ](https://docs.seam.co/latest/device-guides/sandbox-and-sample-data)credentials below: +Navigate to the URL returned by the Webview object. Since you are using a sandbox workspace, complete the login flow by entering the Igloohome [sandbox test accounts ](https://docs.seam.co/latest/developer-tools/sandbox-and-sample-data)credentials below: * **email:** jane@example.com * **password:** 1234 diff --git a/docs/guides/device-and-system-integration-guides/schlage-locks/get-started-with-schlage-locks.md b/docs/guides/device-and-system-integration-guides/schlage-locks/get-started-with-schlage-locks.md index 1b59ff4cc..991ed2721 100644 --- a/docs/guides/device-and-system-integration-guides/schlage-locks/get-started-with-schlage-locks.md +++ b/docs/guides/device-and-system-integration-guides/schlage-locks/get-started-with-schlage-locks.md @@ -122,7 +122,7 @@ puts webview.url #### Authorize Your Workspace -Navigate to the URL returned by the Webview object. Since you are using a sandbox workspace, complete the login flow by entering the Schlage [sandbox test accounts ](https://docs.seam.co/latest/device-guides/sandbox-and-sample-data)credentials below: +Navigate to the URL returned by the Webview object. Since you are using a sandbox workspace, complete the login flow by entering the Schlage [sandbox test accounts ](https://docs.seam.co/latest/developer-tools/sandbox-and-sample-data)credentials below: * **email:** jane@example.com * **password:** 1234 diff --git a/docs/guides/device-and-system-integration-guides/sensi-thermostats/get-started-with-sensi-thermostats.md b/docs/guides/device-and-system-integration-guides/sensi-thermostats/get-started-with-sensi-thermostats.md index a6d3b8e43..f5618d1f0 100644 --- a/docs/guides/device-and-system-integration-guides/sensi-thermostats/get-started-with-sensi-thermostats.md +++ b/docs/guides/device-and-system-integration-guides/sensi-thermostats/get-started-with-sensi-thermostats.md @@ -272,7 +272,7 @@ In a web browser, go to the URL that the Connect Webview object returned. For application developers, you can redirect your user to this Connect Webview URL so that they can authorize your app to control their devices using Seam. We even provide a prebuilt [Connect Account Button](../../ui-components/overview/react-components/connect-account-button.md) within our suite of [Seam Components](../../ui-components/overview/) that help you build your device management flow. {% hint style="success" %} -Because you're using a sandbox workspace, you can connect Seam's test Sensi account. We provide [virtual devices](../../device-guides/sandbox-and-sample-data/) for each of the brands that we support. These sandbox devices and systems enable you to test your app with devices from multiple brands without the need to own all the corresponding physical devices. +Because you're using a sandbox workspace, you can connect Seam's test Sensi account. We provide [virtual devices](../../developer-tools/sandbox-and-sample-data/) for each of the brands that we support. These sandbox devices and systems enable you to test your app with devices from multiple brands without the need to own all the corresponding physical devices. {% endhint %} Complete the Connect Webview authorization flow by entering the following [Sensi sandbox account](../../developer-tools/sandbox-and-sample-data/sandbox-sensi-thermostats.md) credentials: diff --git a/docs/guides/device-and-system-integration-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-thermostats.md b/docs/guides/device-and-system-integration-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-thermostats.md index bdeeab6d0..97d94543b 100644 --- a/docs/guides/device-and-system-integration-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-thermostats.md +++ b/docs/guides/device-and-system-integration-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-thermostats.md @@ -282,10 +282,10 @@ In a web browser, go to the URL that the Connect Webview object returned. For application developers, you can redirect your user to this Connect Webview URL so that they can authorize your app to control their devices using Seam. We even provide a prebuilt [Connect Account Button](../../ui-components/overview/react-components/connect-account-button.md) within our suite of [Seam Components](../../ui-components/overview/) that help you build your device management flow. {% hint style="success" %} -Because you're using a sandbox workspace, you can connect Seam's test SmartThings account. We provide [virtual devices](../../device-guides/sandbox-and-sample-data/) for each of the brands that we support. These sandbox devices and systems enable you to test your app with devices from multiple brands without the need to own all the corresponding physical devices. +Because you're using a sandbox workspace, you can connect Seam's test SmartThings account. We provide [virtual devices](../../developer-tools/sandbox-and-sample-data/) for each of the brands that we support. These sandbox devices and systems enable you to test your app with devices from multiple brands without the need to own all the corresponding physical devices. {% endhint %} -Complete the Connect Webview authorization flow by entering the following [SmartThings sandbox account](../../device-guides/sandbox-and-sample-data/smartthings-sample-data.md) credentials: +Complete the Connect Webview authorization flow by entering the following [SmartThings sandbox account](../../developer-tools/sandbox-and-sample-data/smartthings-sample-data.md) credentials: * **Email:** jane@example.com * **Password:** 1234 diff --git a/docs/guides/device-and-system-integration-guides/tedee-locks/get-started-with-tedee-locks.md b/docs/guides/device-and-system-integration-guides/tedee-locks/get-started-with-tedee-locks.md index 2c1981fed..3a66063bb 100644 --- a/docs/guides/device-and-system-integration-guides/tedee-locks/get-started-with-tedee-locks.md +++ b/docs/guides/device-and-system-integration-guides/tedee-locks/get-started-with-tedee-locks.md @@ -477,9 +477,9 @@ Now that you've completed this guide, you can try to connect a real Tedee device In addition, if you'd like to explore other aspects of Seam, here is a list of helpful resources: -* [Schlage Getting Started Guide](../../device-guides/get-started-with-schlage-locks.md) -* [Yale Getting Started Guide](../../device-guides/get-started-with-yale-locks.md) -* [SmartThings Getting Started Guide](../../device-guides/get-started-with-smartthings-hubs-+-smart-locks.md) +* [Schlage Getting Started Guide](../schlage-locks/get-started-with-schlage-locks.md) +* [Yale Getting Started Guide](../get-started-with-yale-locks.md) +* [SmartThings Getting Started Guide](../smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md) * [Receiving webhook](../../developer-tools/webhooks.md) for [device events](https://docs.seam.co/latest/api/events/list) * [Core Concepts](../../core-concepts/overview.md) From 37b0a8256ccdbc74f7a8f200cb293613fb63fbcd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Louis=20Pr=C3=A9?= Date: Tue, 21 Apr 2026 17:30:36 -0700 Subject: [PATCH 7/7] Fix all broken relative links after file moves Update relative paths in 32 files that broke when files moved from device-guides/ to their correct section directories. Fixes include sandbox data files, brand overview pages, get-started guides, and reconnecting-an-account. Co-Authored-By: Claude Opus 4.6 (1M context) --- .../reconnecting-an-account.md | 2 +- .../2n-intercoms-sample-data.md | 2 +- ...avigilon-alta-access-system-sample-data.md | 2 +- .../dormakaba-oracode-sample-data.md | 2 +- .../ecobee-sample-data.md | 2 +- .../google-nest-thermostats-sample-data.md | 2 +- .../hubitat-hub-sample-data.md | 2 +- .../igloohome-sample-data.md | 2 +- .../minut-noise-sensor-sample-data.md | 2 +- .../nuki-sample-data.md | 2 +- .../pti-storlogix-cloud-sample-data.md | 2 +- .../ttlock-sample-data.md | 2 +- .../wyze-sample-data.md | 2 +- .../yale-sample-data.md | 2 +- .../2n-intercom-systems/README.md | 8 +-- .../get-started-with-2n-intercoms.md | 26 ++++----- .../dormakaba-oracode-locks/README.md | 14 ++--- ...et-started-with-dormakaba-oracode-locks.md | 24 ++++---- .../get-started-with-august-locks.md | 4 +- .../get-started-with-controlbyweb-devices.md | 4 +- .../get-started-with-ecobee-thermostats.md | 4 +- .../get-started-with-kwikset-wifi-locks.md | 4 +- .../get-started-with-nuki-locks.md | 4 +- .../get-started-with-salto-locks.md | 4 +- .../get-started-with-smartlocks-api.md | 4 +- .../get-started-with-ttlock-devices.md | 4 +- .../get-started-with-wyze-locks.md | 4 +- .../get-started-with-yale-locks.md | 6 +- .../igloohome-locks/README.md | 14 ++--- .../get-started-with-igloo-locks.md | 22 ++++---- .../get-started-with-schlage-locks.md | 22 ++++---- ...ted-with-smartthings-hubs-+-smart-locks.md | 56 +++++++++---------- 32 files changed, 128 insertions(+), 128 deletions(-) diff --git a/docs/guides/core-concepts/connected-accounts/reconnecting-an-account.md b/docs/guides/core-concepts/connected-accounts/reconnecting-an-account.md index f59d2b431..4169da56d 100644 --- a/docs/guides/core-concepts/connected-accounts/reconnecting-an-account.md +++ b/docs/guides/core-concepts/connected-accounts/reconnecting-an-account.md @@ -31,4 +31,4 @@ seam.connected_accounts.get(email_address="jane@example.com") Seam recommends adding error handling logic to you application for this error. Your app should also include a fallback case if it encounters an unknown generic error code. -To resolve this error, create a new Connect Webview that the user can use to log in. You may need to instruct them to use the same email address that they used previously. You can use `connected_account.user_identifier` to learn the user's email address. For more information about creating Connect Webviews, see [Connect Webview Process](../core-concepts/connect-webviews/connect-webview-process.md). +To resolve this error, create a new Connect Webview that the user can use to log in. You may need to instruct them to use the same email address that they used previously. You can use `connected_account.user_identifier` to learn the user's email address. For more information about creating Connect Webviews, see [Connect Webview Process](../connect-webviews/connect-webview-process.md). diff --git a/docs/guides/developer-tools/sandbox-and-sample-data/2n-intercoms-sample-data.md b/docs/guides/developer-tools/sandbox-and-sample-data/2n-intercoms-sample-data.md index 5178235aa..115b166ed 100644 --- a/docs/guides/developer-tools/sandbox-and-sample-data/2n-intercoms-sample-data.md +++ b/docs/guides/developer-tools/sandbox-and-sample-data/2n-intercoms-sample-data.md @@ -1,6 +1,6 @@ # Sandbox 2N Intercoms -Use the following sets of account and then device credentials to add virtual [2N intercoms](../2n-intercom-systems.md) to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): +Use the following sets of account and then device credentials to add virtual [2N intercoms](../../device-and-system-integration-guides/2n-intercom-systems/README.md) to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): ## Account Credentials diff --git a/docs/guides/developer-tools/sandbox-and-sample-data/avigilon-alta-access-system-sample-data.md b/docs/guides/developer-tools/sandbox-and-sample-data/avigilon-alta-access-system-sample-data.md index 66bf16981..edf032686 100644 --- a/docs/guides/developer-tools/sandbox-and-sample-data/avigilon-alta-access-system-sample-data.md +++ b/docs/guides/developer-tools/sandbox-and-sample-data/avigilon-alta-access-system-sample-data.md @@ -1,6 +1,6 @@ # Avigilon Alta Access System Sample Data -Use the following set of credentials to add virtual [Avigilon Alta access system](../avigilon-alta-access-system.md)-connected devices to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): +Use the following set of credentials to add virtual [Avigilon Alta access system](../../device-and-system-integration-guides/avigilon-alta-access-system.md)-connected devices to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): | Email Address | Password | | ---------------- | -------- | diff --git a/docs/guides/developer-tools/sandbox-and-sample-data/dormakaba-oracode-sample-data.md b/docs/guides/developer-tools/sandbox-and-sample-data/dormakaba-oracode-sample-data.md index f2f06e68e..491221039 100644 --- a/docs/guides/developer-tools/sandbox-and-sample-data/dormakaba-oracode-sample-data.md +++ b/docs/guides/developer-tools/sandbox-and-sample-data/dormakaba-oracode-sample-data.md @@ -1,6 +1,6 @@ # Sandbox Dormakaba Oracode Locks -Use the following set of credentials to add virtual [Dormakaba Oracode locks](../dormakaba-oracode-locks.md) to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): +Use the following set of credentials to add virtual [Dormakaba Oracode locks](../../device-and-system-integration-guides/dormakaba-oracode-locks/README.md) to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): | Username | Site | Time Zone | | -------- | --------------------- | --------- | diff --git a/docs/guides/developer-tools/sandbox-and-sample-data/ecobee-sample-data.md b/docs/guides/developer-tools/sandbox-and-sample-data/ecobee-sample-data.md index 1709178fd..7792ae3c8 100644 --- a/docs/guides/developer-tools/sandbox-and-sample-data/ecobee-sample-data.md +++ b/docs/guides/developer-tools/sandbox-and-sample-data/ecobee-sample-data.md @@ -1,6 +1,6 @@ # Sandbox ecobee Thermostats -Use the following set of credentials to add virtual [ecobee thermostats](../ecobee-thermostats.md) to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): +Use the following set of credentials to add virtual [ecobee thermostats](../../device-and-system-integration-guides/ecobee-thermostats.md) to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): | Email Address | Password | | --------------------------------------------------------------- | -------- | diff --git a/docs/guides/developer-tools/sandbox-and-sample-data/google-nest-thermostats-sample-data.md b/docs/guides/developer-tools/sandbox-and-sample-data/google-nest-thermostats-sample-data.md index 63324a5b9..7ca427334 100644 --- a/docs/guides/developer-tools/sandbox-and-sample-data/google-nest-thermostats-sample-data.md +++ b/docs/guides/developer-tools/sandbox-and-sample-data/google-nest-thermostats-sample-data.md @@ -1,6 +1,6 @@ # Sandbox Google Nest Thermostats -Use the following set of credentials to add a virtual [Google Nest thermostat](../google-nest-thermostats/) to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): +Use the following set of credentials to add a virtual [Google Nest thermostat](../../device-and-system-integration-guides/google-nest-thermostats/) to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): | Email Address | Password | | --------------------------------------------------------------- | -------- | diff --git a/docs/guides/developer-tools/sandbox-and-sample-data/hubitat-hub-sample-data.md b/docs/guides/developer-tools/sandbox-and-sample-data/hubitat-hub-sample-data.md index be076338d..b9265e79b 100644 --- a/docs/guides/developer-tools/sandbox-and-sample-data/hubitat-hub-sample-data.md +++ b/docs/guides/developer-tools/sandbox-and-sample-data/hubitat-hub-sample-data.md @@ -1,6 +1,6 @@ # Hubitat Elevation Hub Sample Data -Use the following set of credentials to add virtual [Hubitat Elevation Hub](../hubitat-elevation-hub.md)-connected devices to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): +Use the following set of credentials to add virtual [Hubitat Elevation Hub](../../device-guides/hubitat-elevation-hub.md)-connected devices to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): | Maker API Cloud URL | | ------------------------------------------------------------------ | diff --git a/docs/guides/developer-tools/sandbox-and-sample-data/igloohome-sample-data.md b/docs/guides/developer-tools/sandbox-and-sample-data/igloohome-sample-data.md index 2b0e71fb0..979afc901 100644 --- a/docs/guides/developer-tools/sandbox-and-sample-data/igloohome-sample-data.md +++ b/docs/guides/developer-tools/sandbox-and-sample-data/igloohome-sample-data.md @@ -1,6 +1,6 @@ # Sandbox igloohome Locks -Use the following set of credentials to add virtual [igloohome locks](../igloohome-locks.md) to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): +Use the following set of credentials to add virtual [igloohome locks](../../device-and-system-integration-guides/igloohome-locks/README.md) to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): | Email Address | Password | | --------------------------------------------------------------- | -------- | diff --git a/docs/guides/developer-tools/sandbox-and-sample-data/minut-noise-sensor-sample-data.md b/docs/guides/developer-tools/sandbox-and-sample-data/minut-noise-sensor-sample-data.md index aca486480..6fb7fd2b3 100644 --- a/docs/guides/developer-tools/sandbox-and-sample-data/minut-noise-sensor-sample-data.md +++ b/docs/guides/developer-tools/sandbox-and-sample-data/minut-noise-sensor-sample-data.md @@ -1,6 +1,6 @@ # Sandbox Minut Sensors -Use either of the following sets of credentials to add virtual [Minut sensors](../minut-sensors.md) to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): +Use either of the following sets of credentials to add virtual [Minut sensors](../../device-and-system-integration-guides/minut-sensors.md) to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): | Email Address | Password | | --------------------------------------------------------------- | -------- | diff --git a/docs/guides/developer-tools/sandbox-and-sample-data/nuki-sample-data.md b/docs/guides/developer-tools/sandbox-and-sample-data/nuki-sample-data.md index 0aa60d47c..1d51eef38 100644 --- a/docs/guides/developer-tools/sandbox-and-sample-data/nuki-sample-data.md +++ b/docs/guides/developer-tools/sandbox-and-sample-data/nuki-sample-data.md @@ -1,6 +1,6 @@ # Sandbox Nuki Locks -Use the following set of credentials to add virtual [Nuki locks](../nuki-locks.md) to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): +Use the following set of credentials to add virtual [Nuki locks](../../device-and-system-integration-guides/nuki-locks.md) to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): | Email Address | Password | | --------------------------------------------------------------- | -------- | diff --git a/docs/guides/developer-tools/sandbox-and-sample-data/pti-storlogix-cloud-sample-data.md b/docs/guides/developer-tools/sandbox-and-sample-data/pti-storlogix-cloud-sample-data.md index 3b46b871f..a5d82fcce 100644 --- a/docs/guides/developer-tools/sandbox-and-sample-data/pti-storlogix-cloud-sample-data.md +++ b/docs/guides/developer-tools/sandbox-and-sample-data/pti-storlogix-cloud-sample-data.md @@ -1,6 +1,6 @@ # PTI Storlogix Cloud Sample Data -Use the following set of credentials to add virtual [PTI Storlogix Cloud](../pti-storlogix-cloud.md)-connected devices to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): +Use the following set of credentials to add virtual [PTI Storlogix Cloud](../../device-and-system-integration-guides/pti-storlogix-cloud.md)-connected devices to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): | Field | Value | | ----------------------- | ------------------------------- | diff --git a/docs/guides/developer-tools/sandbox-and-sample-data/ttlock-sample-data.md b/docs/guides/developer-tools/sandbox-and-sample-data/ttlock-sample-data.md index 703c2517d..40f03fd88 100644 --- a/docs/guides/developer-tools/sandbox-and-sample-data/ttlock-sample-data.md +++ b/docs/guides/developer-tools/sandbox-and-sample-data/ttlock-sample-data.md @@ -1,6 +1,6 @@ # Sandbox TTLock Locks -Use the following set of credentials to add virtual [TTLock locks](../ttlock-locks.md) to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): +Use the following set of credentials to add virtual [TTLock locks](../../device-and-system-integration-guides/ttlock-locks.md) to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): | Email Address | Password | | --------------------------------------------------------------- | -------- | diff --git a/docs/guides/developer-tools/sandbox-and-sample-data/wyze-sample-data.md b/docs/guides/developer-tools/sandbox-and-sample-data/wyze-sample-data.md index d53667ef9..bcdb05f90 100644 --- a/docs/guides/developer-tools/sandbox-and-sample-data/wyze-sample-data.md +++ b/docs/guides/developer-tools/sandbox-and-sample-data/wyze-sample-data.md @@ -1,6 +1,6 @@ # Sandbox Wyze Locks -Use the following set of credentials to add virtual [Wyze locks](../wyze-locks.md) to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): +Use the following set of credentials to add virtual [Wyze locks](../../device-and-system-integration-guides/wyze-locks.md) to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): | Field | Value | | --------------- | --------------------------------------------------------------- | diff --git a/docs/guides/developer-tools/sandbox-and-sample-data/yale-sample-data.md b/docs/guides/developer-tools/sandbox-and-sample-data/yale-sample-data.md index 8e67d5a7a..faa958e21 100644 --- a/docs/guides/developer-tools/sandbox-and-sample-data/yale-sample-data.md +++ b/docs/guides/developer-tools/sandbox-and-sample-data/yale-sample-data.md @@ -1,6 +1,6 @@ # Sandbox Yale Locks -Use any of the following set of credentials to add virtual [Yale locks](../yale-locks.md) to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): +Use any of the following set of credentials to add virtual [Yale locks](../../device-and-system-integration-guides/yale-locks.md) to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): | Email Address | Password | Two Factor Code | | ----------------- | -------- | --------------- | diff --git a/docs/guides/device-and-system-integration-guides/2n-intercom-systems/README.md b/docs/guides/device-and-system-integration-guides/2n-intercom-systems/README.md index 79442eb8b..0a96b3d53 100644 --- a/docs/guides/device-and-system-integration-guides/2n-intercom-systems/README.md +++ b/docs/guides/device-and-system-integration-guides/2n-intercom-systems/README.md @@ -27,7 +27,7 @@ For a complete compatibility list, see [2N Supported Devices](https://www.seam.c ## Setup and Integration -Follow the step-by-step [System Setup Instructions](../device-and-system-integration-guides/2n-intercom-systems/2n-system-set-up-instructions.md) to connect your My2N company and devices to Seam. +Follow the step-by-step [System Setup Instructions](./2n-system-set-up-instructions.md) to connect your My2N company and devices to Seam. The setup guide covers: @@ -36,7 +36,7 @@ The setup guide covers: * Creating API credentials * Connecting to Seam through the Connect Webview -
Cover image
System Set Up Guideimage (29).png2n-system-set-up-instructions.md
+
Cover image
System Set Up Guideimage (29).png2n-system-set-up-instructions.md
*** @@ -44,7 +44,7 @@ The setup guide covers: To enable 2N device connections in your app’s Connect Webview, add the provider key `my_2n` to your `accepted_providers` list. -For more details, see [Customize Brands in Connect Webviews](../core-concepts/connect-webviews/customizing-connect-webviews.md#customize-the-brands-to-display-in-your-connect-webviews)![Attachment.tiff](file:///Attachment.tiff). +For more details, see [Customize Brands in Connect Webviews](../../core-concepts/connect-webviews/customizing-connect-webviews.md#customize-the-brands-to-display-in-your-connect-webviews)![Attachment.tiff](file:///Attachment.tiff). *** @@ -52,4 +52,4 @@ For more details, see [Customize Brands in Connect Webviews](../core-concepts/co Find your local 2N distributor using the following page: -
Locate Your 2N Distributorhttps://www.2n.com/en_GB/how-to-buy/where-to-buy2n-logo.png
+
Locate Your 2N Distributorhttps://www.2n.com/en_GB/how-to-buy/where-to-buy2n-logo.png
diff --git a/docs/guides/device-and-system-integration-guides/2n-intercom-systems/get-started-with-2n-intercoms.md b/docs/guides/device-and-system-integration-guides/2n-intercom-systems/get-started-with-2n-intercoms.md index b2530c070..2de3d3c55 100644 --- a/docs/guides/device-and-system-integration-guides/2n-intercom-systems/get-started-with-2n-intercoms.md +++ b/docs/guides/device-and-system-integration-guides/2n-intercom-systems/get-started-with-2n-intercoms.md @@ -7,7 +7,7 @@ description: >- # Get started with 2N Intercoms -

2N Intercoms

+

2N Intercoms

## Overview @@ -70,7 +70,7 @@ This guide uses a Sandbox Workspace. Only virtual devices can be connected. If y ## 2 — Link My2N Account with Seam -To control your 2N intercom via the Seam API, you must first authorize your Seam workspace against your My2N account. To do so, Seam provides [Connect Webviews](../core-concepts/connect-webviews/): pre-built UX flows that walk you through authorizing your application to control your 2N intercom. +To control your 2N intercom via the Seam API, you must first authorize your Seam workspace against your My2N account. To do so, Seam provides [Connect Webviews](../../core-concepts/connect-webviews/): pre-built UX flows that walk you through authorizing your application to control your 2N intercom. #### Request a Connect Webview @@ -141,7 +141,7 @@ echo json_encode($webview) #### Authorize Your Workspace -Navigate to the URL returned by the Webview object. Since you are using a sandbox workspace, complete the login flow by entering the My2N [sandbox test account](sandbox-and-sample-data/2n-intercoms-sample-data.md) credentials below: +Navigate to the URL returned by the Webview object. Since you are using a sandbox workspace, complete the login flow by entering the My2N [sandbox test account](../../developer-tools/sandbox-and-sample-data/2n-intercoms-sample-data.md) credentials below: * **email:** jane@example.com * **password:** 1234 @@ -151,7 +151,7 @@ After entering the credentials for My2N, you'll have to enter the credentials of * **username:** jane * **password:** 1234 -

Seam Connect Webview flow to connect My2N account with Seam

+

Seam Connect Webview flow to connect My2N account with Seam

Confirm the Connect Webview was successful by querying its status: @@ -300,7 +300,7 @@ echo json_encode($locks); Next, you can perform the basic action of locking and unlocking the door. -\{% openapi src="../.gitbook/assets/openapi.json" path="/locks/lock\_door" method="post" %\} [openapi.json](../.gitbook/assets/openapi.json) \{% endopenapi %\} +\{% openapi src="../../.gitbook/assets/openapi.json" path="/locks/lock\_door" method="post" %\} [openapi.json](../../.gitbook/assets/openapi.json) \{% endopenapi %\} #### Unlock a door @@ -381,7 +381,7 @@ $seam->locks->lock_door($lock->device_id); 2N devices have a directory with residents. These residents can be assigned PIN codes to unlock the door. -Seam maps these residents to [access codes](../capability-guides/smart-locks/access-codes/) and allows you to create and manage them through the Seam API. +Seam maps these residents to [access codes](../../capability-guides/smart-locks/access-codes/) and allows you to create and manage them through the Seam API. \{% tabs %\} \{% tab title="Python" %\} @@ -551,12 +551,12 @@ Now that you've completed this guide, you can try to connect a real 2N device. T In addition, if you'd like to explore other aspects of Seam, here is a list of helpful resources: -* [Yale Getting Started Guide](get-started-with-yale-locks.md) -* [August Getting Started Guide](get-started-with-august-locks.md) -* [Schlage Getting Started Guide](get-started-with-schlage-locks.md) -* [SmartThings Getting Started Guide](get-started-with-smartthings-hubs-+-smart-locks.md) -* [Minut Getting Started Guide](get-started-with-minut-sensors.md) -* [Receiving webhook](../developer-tools/webhooks.md) for [device events](https://docs.seam.co/latest/api/events/list) -* [Core Concepts](../core-concepts/overview.md) +* [Yale Getting Started Guide](../get-started-with-yale-locks.md) +* [August Getting Started Guide](../get-started-with-august-locks.md) +* [Schlage Getting Started Guide](../schlage-locks/get-started-with-schlage-locks.md) +* [SmartThings Getting Started Guide](../smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md) +* [Minut Getting Started Guide](../get-started-with-minut-sensors.md) +* [Receiving webhook](../../developer-tools/webhooks.md) for [device events](https://docs.seam.co/latest/api/events/list) +* [Core Concepts](../../core-concepts/overview.md) If you have any questions or want to report an issue, email us at support@seam.co. diff --git a/docs/guides/device-and-system-integration-guides/dormakaba-oracode-locks/README.md b/docs/guides/device-and-system-integration-guides/dormakaba-oracode-locks/README.md index 0c2533d49..8db5c2793 100644 --- a/docs/guides/device-and-system-integration-guides/dormakaba-oracode-locks/README.md +++ b/docs/guides/device-and-system-integration-guides/dormakaba-oracode-locks/README.md @@ -8,7 +8,7 @@ description: Guide for using dormakaba Oracode locks with Seam Seam integrates with the dormakaba [Oracode Live](https://www.dormakaba.com/us-en/offering/products/vacation-short-term-rental-solutions/access-control-management/oracode-live--ka_128503) access control management platform. Intended for the vacation and short-term rental industries, the Oracode Live platform supports a "no keys, no cards" concept for efficient and secure access. Further, with the Oracode Live platform, codes expire automatically at the end of the authorized period. -The Seam integration supports the generation of [offline access codes for dormakaba Oracode locks](../device-and-system-integration-guides/dormakaba-oracode-locks/creating-dormakaba-oracode-offline-access-codes.md). +The Seam integration supports the generation of [offline access codes for dormakaba Oracode locks](./creating-dormakaba-oracode-offline-access-codes.md). You can use a variety of dormakaba Oracode smart locks with the Oracode Live platform. These strong and durable locks have commercial-grade finishes to withstand a wide range of climates. @@ -16,7 +16,7 @@ You can use a variety of dormakaba Oracode smart locks with the Oracode Live pla ## Supported Devices -This integration supports all locks connected using the [Oracode Live](https://www.dormakaba.com/us-en/offering/products/vacation-short-term-rental-solutions/access-control-management/oracode-live--ka_128503) platform. This integration supports [offline access code](../device-and-system-integration-guides/dormakaba-oracode-locks/creating-dormakaba-oracode-offline-access-codes.md) provisioning for applicable dormakaba Oracode devices. +This integration supports all locks connected using the [Oracode Live](https://www.dormakaba.com/us-en/offering/products/vacation-short-term-rental-solutions/access-control-management/oracode-live--ka_128503) platform. This integration supports [offline access code](./creating-dormakaba-oracode-offline-access-codes.md) provisioning for applicable dormakaba Oracode devices. For detailed information about the dormakaba Oracode devices that Seam supports, see our [dormakaba Supported Devices page](https://www.seam.co/manufacturers/dormakaba). @@ -26,13 +26,13 @@ For detailed information about the dormakaba Oracode devices that Seam supports, We support the following features: -* [Programming offline access codes](../capability-guides/smart-locks/access-codes/offline-access-codes.md) +* [Programming offline access codes](../../capability-guides/smart-locks/access-codes/offline-access-codes.md) *** ### Device Provider Key -To create a [Connect Webview](../core-concepts/connect-webviews/) that enables your users to connect their dormakaba Oracode devices to Seam, include the `dormakaba_oracode` device provider key in the `accepted_providers` list. For more information, see [Customize the Brands to Display in Your Connect Webviews](../core-concepts/connect-webviews/customizing-connect-webviews.md#customize-the-brands-to-display-in-your-connect-webviews). +To create a [Connect Webview](../../core-concepts/connect-webviews/) that enables your users to connect their dormakaba Oracode devices to Seam, include the `dormakaba_oracode` device provider key in the `accepted_providers` list. For more information, see [Customize the Brands to Display in Your Connect Webviews](../../core-concepts/connect-webviews/customizing-connect-webviews.md#customize-the-brands-to-display-in-your-connect-webviews). *** @@ -45,7 +45,7 @@ To control dormakaba Oracode devices using Seam, you must prompt **the owners or * Log in to your [Oracode Live account](https://www.kabaecodewireless.com). * Note your site name, as shown in the upper-right corner of the Oracode Live portal. -
Note your site name in the Oracle Live portal.

Note your site name in the Oracle Live portal.

+
Note your site name in the Oracle Live portal.

Note your site name in the Oracle Live portal.

2. Contact [dormakaba Oracode Support](mailto:oracode@dormakaba.com) to connect all your dormakaba Live Services sites to Seam.\ You can use the following sample email message: @@ -56,7 +56,7 @@ To control dormakaba Oracode devices using Seam, you must prompt **the owners or > * _..._ Once dormakaba Oracode has connected your dormakaba Live Services sites to Seam, proceed to the next step. -3. Use a [Seam Connect Webview](../core-concepts/connect-webviews/) to add your dormakaba Oracode devices to Seam.\ +3. Use a [Seam Connect Webview](../../core-concepts/connect-webviews/) to add your dormakaba Oracode devices to Seam.\ In the Connect Webview: * Type your dormakaba Oracode username and a comma-separated list of the dormakaba Oracode sites that you want to connect to Seam. * For each site that you have listed, select the time zone in which the site is located.\ @@ -74,6 +74,6 @@ It is important to understand that the developer presents the Connect Webview to To purchase dormakaba Oracode devices, contact the dormakaba Sales team using the dormakaba **Contact** page or order Oracode Live locks from GoKeyless. -
dormakaba Contact Pagehttps://www.dormakaba.com/us-en/contactdormakaba-logo.png
GoKeylesshttps://www.gokeyless.com/shop/advertised/oracode-i-series-locks/gokeyless-logo.png
+
dormakaba Contact Pagehttps://www.dormakaba.com/us-en/contactdormakaba-logo.png
GoKeylesshttps://www.gokeyless.com/shop/advertised/oracode-i-series-locks/gokeyless-logo.png
*** diff --git a/docs/guides/device-and-system-integration-guides/dormakaba-oracode-locks/get-started-with-dormakaba-oracode-locks.md b/docs/guides/device-and-system-integration-guides/dormakaba-oracode-locks/get-started-with-dormakaba-oracode-locks.md index c6ecabb83..52a14b461 100644 --- a/docs/guides/device-and-system-integration-guides/dormakaba-oracode-locks/get-started-with-dormakaba-oracode-locks.md +++ b/docs/guides/device-and-system-integration-guides/dormakaba-oracode-locks/get-started-with-dormakaba-oracode-locks.md @@ -6,7 +6,7 @@ description: >- # Get started with dormakaba Oracode Locks -

Dormakaba Locks

+

Dormakaba Locks

## Overview @@ -64,15 +64,15 @@ $ export SEAM_API_KEY=seam_test2ZTo_0mEYQW2TvNDCxG5Atpj85Ffw ``` {% hint style="info" %} -This guide uses a sandbox [workspace](../core-concepts/workspaces/). You can only connect virtual devices to a sandbox workspace. If you need to connect real Oracode devices, use a non-sandbox workspace and API key. +This guide uses a sandbox [workspace](../../core-concepts/workspaces/). You can only connect virtual devices to a sandbox workspace. If you need to connect real Oracode devices, use a non-sandbox workspace and API key. {% endhint %} ## 2 — Link Your dormakaba Oracode Account with Seam -To control your dormakaba Oracode locks using the Seam API, the owner or manager of these locks must first authorize your Seam workspace to access their dormakaba Oracode account. To do so, Seam provides[ Connect Webviews](../core-concepts/connect-webviews/), which are pre-built UX flows that walk the device owner or manager through authorizing your application to control Oracode locks. +To control your dormakaba Oracode locks using the Seam API, the owner or manager of these locks must first authorize your Seam workspace to access their dormakaba Oracode account. To do so, Seam provides[ Connect Webviews](../../core-concepts/connect-webviews/), which are pre-built UX flows that walk the device owner or manager through authorizing your application to control Oracode locks. {% hint style="info" %} -This guide discusses using a Seam sandbox workspace with virtual devices. However, to connect real devices to Seam, some manufacturers may require additional prerequisite setup steps. For dormakaba Oracode-specific instructions, see the [dormakaba Oracode device integration guide](dormakaba-oracode-locks.md#setup-instructions). +This guide discusses using a Seam sandbox workspace with virtual devices. However, to connect real devices to Seam, some manufacturers may require additional prerequisite setup steps. For dormakaba Oracode-specific instructions, see the [dormakaba Oracode device integration guide](./README.md#setup-instructions). {% endhint %} #### Request a Connect Webview @@ -140,13 +140,13 @@ $webview = $seam->connect_webviews->create( #### Authorize Your Workspace -Navigate to the URL that the Connect Webview object returned. Because you are using a sandbox workspace, complete the login flow by entering the following dormakaba Oracode [sandbox test account ](sandbox-and-sample-data/dormakaba-oracode-sample-data.md)credentials: +Navigate to the URL that the Connect Webview object returned. Because you are using a sandbox workspace, complete the login flow by entering the following dormakaba Oracode [sandbox test account ](../../developer-tools/sandbox-and-sample-data/dormakaba-oracode-sample-data.md)credentials: * **username:** jane * **site:** Ocean Beach Vacations * **time zone:** (Any) -
Seam Connect Webview flow to connect dormakaba Oracode account with Seam

Seam Connect Webview flow to connect dormakaba Oracode account with Seam

+
Seam Connect Webview flow to connect dormakaba Oracode account with Seam

Seam Connect Webview flow to connect dormakaba Oracode account with Seam

Confirm the Connect Webview was successful by querying the status. @@ -243,7 +243,7 @@ echo json_encode($locks); ### 4 — Programming Access Codes on a dormakaba Oracode Lock -The Seam API enables you to create offline access codes on dormakaba Oracode devices, such as the 480i and 660i locks. Users can then enter these codes to unlock the door. For detailed instructions, see [Creating dormakaba Oracode Offline Access Codes](../device-and-system-integration-guides/dormakaba-oracode-locks/creating-dormakaba-oracode-offline-access-codes.md). +The Seam API enables you to create offline access codes on dormakaba Oracode devices, such as the 480i and 660i locks. Users can then enter these codes to unlock the door. For detailed instructions, see [Creating dormakaba Oracode Offline Access Codes](./creating-dormakaba-oracode-offline-access-codes.md). {% hint style="info" %} dormakaba Oracode does not let you specify a code for an access code. Instead it auto-generates a six-digit code, which the Seam API returns. If you try to pass the `code` argument to the access code `create` function, the Seam API returns an error. @@ -255,10 +255,10 @@ Now that you've completed this guide, you can try to connect a real dormakaba Or In addition, if you'd like to explore other aspects of Seam, check out the following helpful resources: -* [Schlage Getting Started Guide](get-started-with-schlage-locks.md) -* [Yale Getting Started Guide](get-started-with-yale-locks.md) -* [SmartThings Getting Started Guide](get-started-with-smartthings-hubs-+-smart-locks.md) -* [Configuring webhooks](../developer-tools/webhooks.md) for [device events](https://docs.seam.co/latest/api/events/list) -* [Core Concepts](../core-concepts/overview.md) +* [Schlage Getting Started Guide](../schlage-locks/get-started-with-schlage-locks.md) +* [Yale Getting Started Guide](../get-started-with-yale-locks.md) +* [SmartThings Getting Started Guide](../smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md) +* [Configuring webhooks](../../developer-tools/webhooks.md) for [device events](https://docs.seam.co/latest/api/events/list) +* [Core Concepts](../../core-concepts/overview.md) If you have any questions or want to report an issue, email us at [support@seam.co](mailto:support@seam.co). diff --git a/docs/guides/device-and-system-integration-guides/get-started-with-august-locks.md b/docs/guides/device-and-system-integration-guides/get-started-with-august-locks.md index 5a3e3ba0d..03b979635 100644 --- a/docs/guides/device-and-system-integration-guides/get-started-with-august-locks.md +++ b/docs/guides/device-and-system-integration-guides/get-started-with-august-locks.md @@ -272,10 +272,10 @@ In a web browser, go to the URL that the Connect Webview object returned. For application developers, you can redirect your user to this Connect Webview URL so that they can authorize your app to control their devices using Seam. We even provide a prebuilt [Connect Account Button](../ui-components/overview/react-components/connect-account-button.md) within our suite of [Seam Components](../ui-components/overview/) that help you build your device management flow. {% hint style="success" %} -Because you're using a sandbox workspace, you can connect Seam's test August account. We provide [virtual devices](sandbox-and-sample-data/) for each of the brands that we support. These sandbox devices and systems enable you to test your app with devices from multiple brands without the need to own all the corresponding physical devices. +Because you're using a sandbox workspace, you can connect Seam's test August account. We provide [virtual devices](../developer-tools/sandbox-and-sample-data/) for each of the brands that we support. These sandbox devices and systems enable you to test your app with devices from multiple brands without the need to own all the corresponding physical devices. {% endhint %} -Complete the Connect Webview authorization flow by entering the following [August sandbox account](sandbox-and-sample-data/august-locks-sample-data.md) credentials: +Complete the Connect Webview authorization flow by entering the following [August sandbox account](../developer-tools/sandbox-and-sample-data/august-locks-sample-data.md) credentials: * **Device Region:** Others * **Email:** jane@example.com diff --git a/docs/guides/device-and-system-integration-guides/get-started-with-controlbyweb-devices.md b/docs/guides/device-and-system-integration-guides/get-started-with-controlbyweb-devices.md index e72c3b677..b1013dadd 100644 --- a/docs/guides/device-and-system-integration-guides/get-started-with-controlbyweb-devices.md +++ b/docs/guides/device-and-system-integration-guides/get-started-with-controlbyweb-devices.md @@ -303,8 +303,8 @@ In addition, if you'd like to explore other aspects of Seam, here is a list of h * [Yale Getting Started Guide](get-started-with-yale-locks.md) * [August Getting Started Guide](get-started-with-august-locks.md) -* [Schlage Getting Started Guide](get-started-with-schlage-locks.md) -* [SmartThings Getting Started Guide](get-started-with-smartthings-hubs-+-smart-locks.md) +* [Schlage Getting Started Guide](schlage-locks/get-started-with-schlage-locks.md) +* [SmartThings Getting Started Guide](smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md) * [Minut Getting Started Guide](get-started-with-minut-sensors.md) * [Receiving webhook](../developer-tools/webhooks.md) for [device events](https://docs.seam.co/latest/api/events/list) * [Core Concepts](../core-concepts/overview.md) diff --git a/docs/guides/device-and-system-integration-guides/get-started-with-ecobee-thermostats.md b/docs/guides/device-and-system-integration-guides/get-started-with-ecobee-thermostats.md index 1b2f2ff89..2d229d4da 100644 --- a/docs/guides/device-and-system-integration-guides/get-started-with-ecobee-thermostats.md +++ b/docs/guides/device-and-system-integration-guides/get-started-with-ecobee-thermostats.md @@ -272,10 +272,10 @@ In a web browser, go to the URL that the Connect Webview object returned. For application developers, you can redirect your user to this Connect Webview URL so that they can authorize your app to control their devices using Seam. We even provide a prebuilt [Connect Account Button](../ui-components/overview/react-components/connect-account-button.md) within our suite of [Seam Components](../ui-components/overview/) that help you build your device management flow. {% hint style="success" %} -Because you're using a sandbox workspace, you can connect Seam's test ecobee account. We provide [virtual devices](sandbox-and-sample-data/) for each of the brands that we support. These sandbox devices and systems enable you to test your app with devices from multiple brands without the need to own all the corresponding physical devices. +Because you're using a sandbox workspace, you can connect Seam's test ecobee account. We provide [virtual devices](../developer-tools/sandbox-and-sample-data/) for each of the brands that we support. These sandbox devices and systems enable you to test your app with devices from multiple brands without the need to own all the corresponding physical devices. {% endhint %} -Complete the Connect Webview authorization flow by entering the following [ecobee sandbox account](sandbox-and-sample-data/ecobee-sample-data.md) credentials: +Complete the Connect Webview authorization flow by entering the following [ecobee sandbox account](../developer-tools/sandbox-and-sample-data/ecobee-sample-data.md) credentials: * **Email:** jane@example.com * **Password:** 1234 diff --git a/docs/guides/device-and-system-integration-guides/get-started-with-kwikset-wifi-locks.md b/docs/guides/device-and-system-integration-guides/get-started-with-kwikset-wifi-locks.md index f2c273613..137688307 100644 --- a/docs/guides/device-and-system-integration-guides/get-started-with-kwikset-wifi-locks.md +++ b/docs/guides/device-and-system-integration-guides/get-started-with-kwikset-wifi-locks.md @@ -548,8 +548,8 @@ In addition, if you'd like to explore other aspects of Seam, here is a list of h * [Yale Getting Started Guide](get-started-with-yale-locks.md) * [August Getting Started Guide](get-started-with-august-locks.md) -* [Schlage Getting Started Guide](get-started-with-schlage-locks.md) -* [SmartThings Getting Started Guide](get-started-with-smartthings-hubs-+-smart-locks.md) +* [Schlage Getting Started Guide](schlage-locks/get-started-with-schlage-locks.md) +* [SmartThings Getting Started Guide](smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md) * [Receiving webhook](../developer-tools/webhooks.md) for [device events](https://docs.seam.co/latest/api/events/list) * [Core Concepts](../core-concepts/overview.md) diff --git a/docs/guides/device-and-system-integration-guides/get-started-with-nuki-locks.md b/docs/guides/device-and-system-integration-guides/get-started-with-nuki-locks.md index b2fb91950..ffc0c7ea6 100644 --- a/docs/guides/device-and-system-integration-guides/get-started-with-nuki-locks.md +++ b/docs/guides/device-and-system-integration-guides/get-started-with-nuki-locks.md @@ -448,9 +448,9 @@ Now that you've completed this guide, you can try to connect a real Nuki device. In addition, if you'd like to explore other aspects of Seam, here is a list of helpful resources: -* [Schlage Getting Started Guide](get-started-with-schlage-locks.md) +* [Schlage Getting Started Guide](schlage-locks/get-started-with-schlage-locks.md) * [Yale Getting Started Guide](get-started-with-yale-locks.md) -* [SmartThings Getting Started Guide](get-started-with-smartthings-hubs-+-smart-locks.md) +* [SmartThings Getting Started Guide](smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md) * [Receiving webhook](../developer-tools/webhooks.md) for [device events](https://docs.seam.co/latest/api/events/list) * [Core Concepts](../core-concepts/overview.md) diff --git a/docs/guides/device-and-system-integration-guides/get-started-with-salto-locks.md b/docs/guides/device-and-system-integration-guides/get-started-with-salto-locks.md index 0685e5477..f13c20c26 100644 --- a/docs/guides/device-and-system-integration-guides/get-started-with-salto-locks.md +++ b/docs/guides/device-and-system-integration-guides/get-started-with-salto-locks.md @@ -622,9 +622,9 @@ Now that you've completed this guide, you can try to connect a real Salto device In addition, if you'd like to explore other aspects of Seam, here is a list of helpful resources: -* [Schlage Getting Started Guide](get-started-with-schlage-locks.md) +* [Schlage Getting Started Guide](schlage-locks/get-started-with-schlage-locks.md) * [Yale Getting Started Guide](get-started-with-yale-locks.md) -* [SmartThings Getting Started Guide](get-started-with-smartthings-hubs-+-smart-locks.md) +* [SmartThings Getting Started Guide](smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md) * [Receiving webhook](../developer-tools/webhooks.md) for [device events](https://docs.seam.co/latest/api/events/list) * [Core Concepts](../core-concepts/overview.md) diff --git a/docs/guides/device-and-system-integration-guides/get-started-with-smartlocks-api.md b/docs/guides/device-and-system-integration-guides/get-started-with-smartlocks-api.md index 5595660ef..b37b29249 100644 --- a/docs/guides/device-and-system-integration-guides/get-started-with-smartlocks-api.md +++ b/docs/guides/device-and-system-integration-guides/get-started-with-smartlocks-api.md @@ -485,7 +485,7 @@ Now that you've completed this guide, you can try to build a real application to * [Yale Getting Started Guide](get-started-with-yale-locks.md) * [August Getting Started Guide](get-started-with-august-locks.md) -* [Schlage Getting Started Guide](get-started-with-schlage-locks.md) -* [SmartThings Getting Started Guide](get-started-with-smartthings-hubs-+-smart-locks.md) +* [Schlage Getting Started Guide](schlage-locks/get-started-with-schlage-locks.md) +* [SmartThings Getting Started Guide](smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md) * [Receiving webhook](../developer-tools/webhooks.md) for [device events](https://docs.seam.co/latest/api/events/list) * [Core Concepts](../core-concepts/overview.md) diff --git a/docs/guides/device-and-system-integration-guides/get-started-with-ttlock-devices.md b/docs/guides/device-and-system-integration-guides/get-started-with-ttlock-devices.md index 6660fefd6..1e2b9873a 100644 --- a/docs/guides/device-and-system-integration-guides/get-started-with-ttlock-devices.md +++ b/docs/guides/device-and-system-integration-guides/get-started-with-ttlock-devices.md @@ -272,10 +272,10 @@ In a web browser, go to the URL that the Connect Webview object returned. For application developers, you can redirect your user to this Connect Webview URL so that they can authorize your app to control their devices using Seam. We even provide a prebuilt [Connect Account Button](../ui-components/overview/react-components/connect-account-button.md) within our suite of [Seam Components](../ui-components/overview/) that help you build your device management flow. {% hint style="success" %} -Because you're using a sandbox workspace, you can connect Seam's test TTLock account. We provide [virtual devices](sandbox-and-sample-data/) for each of the brands that we support. These sandbox devices and systems enable you to test your app with devices from multiple brands without the need to own all the corresponding physical devices. +Because you're using a sandbox workspace, you can connect Seam's test TTLock account. We provide [virtual devices](../developer-tools/sandbox-and-sample-data/) for each of the brands that we support. These sandbox devices and systems enable you to test your app with devices from multiple brands without the need to own all the corresponding physical devices. {% endhint %} -Complete the Connect Webview authorization flow by entering the following [TTLock sandbox account](sandbox-and-sample-data/ttlock-sample-data.md) credentials: +Complete the Connect Webview authorization flow by entering the following [TTLock sandbox account](../developer-tools/sandbox-and-sample-data/ttlock-sample-data.md) credentials: * **Email:** jane@example.com * **Password:** 1234 diff --git a/docs/guides/device-and-system-integration-guides/get-started-with-wyze-locks.md b/docs/guides/device-and-system-integration-guides/get-started-with-wyze-locks.md index 51bf0729e..494a7d573 100644 --- a/docs/guides/device-and-system-integration-guides/get-started-with-wyze-locks.md +++ b/docs/guides/device-and-system-integration-guides/get-started-with-wyze-locks.md @@ -488,8 +488,8 @@ In addition, if you'd like to explore other aspects of Seam, here is a list of h * [Yale Getting Started Guide](get-started-with-yale-locks.md) * [August Getting Started Guide](get-started-with-august-locks.md) -* [Schlage Getting Started Guide](get-started-with-schlage-locks.md) -* [SmartThings Getting Started Guide](get-started-with-smartthings-hubs-+-smart-locks.md) +* [Schlage Getting Started Guide](schlage-locks/get-started-with-schlage-locks.md) +* [SmartThings Getting Started Guide](smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md) * [Receiving webhook](../developer-tools/webhooks.md) for [device events](https://docs.seam.co/latest/api/events/list) * [Core Concepts](../core-concepts/overview.md) diff --git a/docs/guides/device-and-system-integration-guides/get-started-with-yale-locks.md b/docs/guides/device-and-system-integration-guides/get-started-with-yale-locks.md index d47f1746a..7c80299eb 100644 --- a/docs/guides/device-and-system-integration-guides/get-started-with-yale-locks.md +++ b/docs/guides/device-and-system-integration-guides/get-started-with-yale-locks.md @@ -8,7 +8,7 @@ description: Learn how to connect and control your Yale lock with the Seam API. ## Overview -Seam provides a universal API to connect and control many brands of smart locks. This guide provides a rapid introduction to connecting and controlling your [Yale](https://www.seam.co/manufacturers/yale) lock using the Seam API. Note that this guide is intended for Yale locks connected via the Yale wifi bridge and Yale access app. For Z-Wave Yale devices, head over to [our guide for SmartThings](get-started-with-smartthings-hubs-+-smart-locks.md). +Seam provides a universal API to connect and control many brands of smart locks. This guide provides a rapid introduction to connecting and controlling your [Yale](https://www.seam.co/manufacturers/yale) lock using the Seam API. Note that this guide is intended for Yale locks connected via the Yale wifi bridge and Yale access app. For Z-Wave Yale devices, head over to [our guide for SmartThings](smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md). To learn more about other smart lock brands supported by Seam such as August, Schlage, and Salto, head over to our [integration page](https://www.seam.co/supported-devices-and-systems). @@ -454,9 +454,9 @@ Now that you've completed this guide, you can try to connect a real Yale device. In addition, if you'd like to explore other aspects of Seam, here is a list of helpful resources: -* [Schlage Getting Started Guide](get-started-with-schlage-locks.md) +* [Schlage Getting Started Guide](schlage-locks/get-started-with-schlage-locks.md) * [August Getting Started Guide](get-started-with-august-locks.md) -* [SmartThings Getting Started Guide](get-started-with-smartthings-hubs-+-smart-locks.md) +* [SmartThings Getting Started Guide](smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md) * [Receiving webhook](../developer-tools/webhooks.md) for [device events](https://docs.seam.co/latest/api/events/list) * [Core Concepts](../core-concepts/overview.md) diff --git a/docs/guides/device-and-system-integration-guides/igloohome-locks/README.md b/docs/guides/device-and-system-integration-guides/igloohome-locks/README.md index 52005e6f9..35117ee9a 100644 --- a/docs/guides/device-and-system-integration-guides/igloohome-locks/README.md +++ b/docs/guides/device-and-system-integration-guides/igloohome-locks/README.md @@ -10,7 +10,7 @@ igloohome produces various types of smart locks for the residential, rental prop Seam integrates with igloohome locks through the [igloohome Wi-Fi Bridge](https://www.igloohome.co/en-US/products/bridge) to provide lock, unlock, and customizable access code provisioning actions. You can link up to five igloohome locks with a single igloohome Bridge. -In addition, the Seam integration supports the generation of [offline access codes](../device-and-system-integration-guides/igloohome-locks/creating-igloohome-offline-access-codes.md) (that is, igloohome [algoPIN™](https://www.igloohome.co/en-US/how-it-works) codes) for igloohome locks without the need for the igloohome Bridge. +In addition, the Seam integration supports the generation of [offline access codes](./creating-igloohome-offline-access-codes.md) (that is, igloohome [algoPIN™](https://www.igloohome.co/en-US/how-it-works) codes) for igloohome locks without the need for the igloohome Bridge. *** @@ -32,9 +32,9 @@ Each igloohome Bridge supports up to five compatible igloohome locks. We support the following features: -* [Triggering web lock and unlock actions](../capability-guides/smart-locks/lock-and-unlock.md) for igloohome smart locks connected through the igloohome Bridge -* [Programming online access codes](../capability-guides/smart-locks/access-codes/) -* [Programming offline access codes](../capability-guides/smart-locks/access-codes/offline-access-codes.md) +* [Triggering web lock and unlock actions](../../capability-guides/smart-locks/lock-and-unlock.md) for igloohome smart locks connected through the igloohome Bridge +* [Programming online access codes](../../capability-guides/smart-locks/access-codes/) +* [Programming offline access codes](../../capability-guides/smart-locks/access-codes/offline-access-codes.md) {% hint style="info" %} We support customizable access codes for igloohome locks connected through the igloohome Bridge. We support offline algoPIN codes for all igloohome locks, without the need for a bridge. @@ -44,7 +44,7 @@ We support customizable access codes for igloohome locks connected through the i ### Device Provider Key -To create a [Connect Webview](../core-concepts/connect-webviews/) that enables your users to connect their igloohome devices to Seam, include the `igloohome` device provider key in the `accepted_providers` list. For more information, see [Customize the Brands to Display in Your Connect Webviews](../core-concepts/connect-webviews/customizing-connect-webviews.md#customize-the-brands-to-display-in-your-connect-webviews). +To create a [Connect Webview](../../core-concepts/connect-webviews/) that enables your users to connect their igloohome devices to Seam, include the `igloohome` device provider key in the `accepted_providers` list. For more information, see [Customize the Brands to Display in Your Connect Webviews](../../core-concepts/connect-webviews/customizing-connect-webviews.md#customize-the-brands-to-display-in-your-connect-webviews). *** @@ -57,7 +57,7 @@ To control igloohome devices using Seam, you must prompt owners of these devices 2. In the igloohome mobile app, add your igloohome devices.\ For more information, see "Pair your lock" in the [igloohome app quick start guide](https://support.igloohome.co/support/solutions/articles/35000183120-igloohome-app-quick-start-guide). 3. To be able to configure your igloohome smart locks remotely, trigger lock and unlock actions, and use custom codes, install the [igloohome Wi-Fi Bridge](https://www.igloohome.co/en-US/products/bridge), and then pair your locks to the bridge. -4. Note your login credentials for the igloohome mobile app, and use these credentials to log in to the [Seam Connect Webview](../core-concepts/connect-webviews/) to add your devices to Seam. +4. Note your login credentials for the igloohome mobile app, and use these credentials to log in to the [Seam Connect Webview](../../core-concepts/connect-webviews/) to add your devices to Seam. *** @@ -79,6 +79,6 @@ Each time an igloohome device detects an invalid attempt of entry, Seam emits a Order igloohome devices directly from the igloohome website. -
igloohomehttps://store-us.igloohome.co/igloohome-logo.png
+
igloohomehttps://store-us.igloohome.co/igloohome-logo.png
*** diff --git a/docs/guides/device-and-system-integration-guides/igloohome-locks/get-started-with-igloo-locks.md b/docs/guides/device-and-system-integration-guides/igloohome-locks/get-started-with-igloo-locks.md index 557af6620..ac304f71e 100644 --- a/docs/guides/device-and-system-integration-guides/igloohome-locks/get-started-with-igloo-locks.md +++ b/docs/guides/device-and-system-integration-guides/igloohome-locks/get-started-with-igloo-locks.md @@ -4,7 +4,7 @@ description: Learn how to connect and control your Igloohome locks with the Seam # Get started with igloohome Locks -

Igloohome Locks

+

Igloohome Locks

## Overview @@ -63,7 +63,7 @@ This guide uses a Sandbox Workspace. Only virtual devices can be connected. If y ## 2 — Link Your Igloohome Account with Seam -To control your Igloohome locks via the Seam API, you must first authorize your Seam workspace against your Igloohome account. To do so, Seam provides[ Connect Webviews](../core-concepts/connect-webviews/): pre-built UX flows that walk you through authorizing your application to control your Igloohome devices. +To control your Igloohome locks via the Seam API, you must first authorize your Seam workspace against your Igloohome account. To do so, Seam provides[ Connect Webviews](../../core-concepts/connect-webviews/): pre-built UX flows that walk you through authorizing your application to control your Igloohome devices. #### Request a Connect Webview @@ -140,7 +140,7 @@ Navigate to the URL returned by the Webview object. Since you are using a sandbo * **email:** jane@example.com * **password:** 1234 -

Seam Connect Webview flow to connect Igloohome account with Seam

+

Seam Connect Webview flow to connect Igloohome account with Seam

Confirm the Connect Webview was successful by querying its status: @@ -273,8 +273,8 @@ echo json_encode($locks); Next, you can perform the basic action of locking and unlocking a door. -{% openapi src="../.gitbook/assets/openapi.json" path="/locks/lock_door" method="post" %} -[openapi.json](../.gitbook/assets/openapi.json) +{% openapi src="../../.gitbook/assets/openapi.json" path="/locks/lock_door" method="post" %} +[openapi.json](../../.gitbook/assets/openapi.json) {% endopenapi %} ## Unlock a door @@ -350,7 +350,7 @@ $seam->locks->lock_door($lock->device_id); Most Igloohome locks come with a keypad built-in to program access codes. These codes can then be entered to unlock a Igloohome lock. -The Seam API makes it easy to program both `ongoing` codes and `timebound` codes on an Igloohome lock. You can find out more about Igloohome lock access code in our [core concept section on access codes.](../capability-guides/smart-locks/access-codes/) +The Seam API makes it easy to program both `ongoing` codes and `timebound` codes on an Igloohome lock. You can find out more about Igloohome lock access code in our [core concept section on access codes.](../../capability-guides/smart-locks/access-codes/) {% hint style="info" %} Igloohome pins have to be 4-6 digits long, and for time bound access codes, start date can't be on the past. @@ -456,10 +456,10 @@ Now that you've completed this guide, you can try to connect a real Igloohome de In addition, if you'd like to explore other aspects of Seam, here is a list of helpful resources: -* [Schlage Getting Started Guide](get-started-with-schlage-locks.md) -* [Yale Getting Started Guide](get-started-with-yale-locks.md) -* [SmartThings Getting Started Guide](get-started-with-smartthings-hubs-+-smart-locks.md) -* [Receiving webhook](../developer-tools/webhooks.md) for [device events](https://docs.seam.co/latest/api/events/list) -* [Core Concepts](../core-concepts/overview.md) +* [Schlage Getting Started Guide](../schlage-locks/get-started-with-schlage-locks.md) +* [Yale Getting Started Guide](../get-started-with-yale-locks.md) +* [SmartThings Getting Started Guide](../smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md) +* [Receiving webhook](../../developer-tools/webhooks.md) for [device events](https://docs.seam.co/latest/api/events/list) +* [Core Concepts](../../core-concepts/overview.md) If you have any questions or want to report an issue, email us at support@seam.co. diff --git a/docs/guides/device-and-system-integration-guides/schlage-locks/get-started-with-schlage-locks.md b/docs/guides/device-and-system-integration-guides/schlage-locks/get-started-with-schlage-locks.md index 991ed2721..e090ae7d7 100644 --- a/docs/guides/device-and-system-integration-guides/schlage-locks/get-started-with-schlage-locks.md +++ b/docs/guides/device-and-system-integration-guides/schlage-locks/get-started-with-schlage-locks.md @@ -4,11 +4,11 @@ description: Learn how to connect and control your Schlage lock with the Seam AP # Get started with Schlage Locks -

Schlage Smart Locks

+

Schlage Smart Locks

## Overview -Seam provides a universal API to connect and control many brands of smart locks. This guide provides a rapid introduction to connecting and controlling your [Schlage](https://www.seam.co/manufacturers/schlage) lock using the Seam API. Note that this guide is intended for Schlage Sense locks and Schlage Encode locks that connect to wifi. For Z-Wave Schlage locks such as Schlage Connect, head over to [our guide for SmartThings](get-started-with-smartthings-hubs-+-smart-locks.md). +Seam provides a universal API to connect and control many brands of smart locks. This guide provides a rapid introduction to connecting and controlling your [Schlage](https://www.seam.co/manufacturers/schlage) lock using the Seam API. Note that this guide is intended for Schlage Sense locks and Schlage Encode locks that connect to wifi. For Z-Wave Schlage locks such as Schlage Connect, head over to [our guide for SmartThings](../smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md). To learn more about other smart lock brands supported by Seam such as August, Yale, and Salto, head over to our [integration page](https://www.seam.co/supported-devices-and-systems). @@ -65,7 +65,7 @@ This guide uses a Sandbox Workspace. Only virtual devices can be connected. If y ## 2 — Link Schlage Account with Seam -To control your Schlage lock via the Seam API, you must first authorize your Seam workspace against your Schlage account. To do so, Seam provides[ Connect Webviews](../core-concepts/connect-webviews/): pre-built UX flows that walk you through authorizing your application to control your Schlage lock. +To control your Schlage lock via the Seam API, you must first authorize your Seam workspace against your Schlage account. To do so, Seam provides[ Connect Webviews](../../core-concepts/connect-webviews/): pre-built UX flows that walk you through authorizing your application to control your Schlage lock. #### Request a Connect Webview @@ -128,7 +128,7 @@ Navigate to the URL returned by the Webview object. Since you are using a sandbo * **password:** 1234 * **2-factor-auth:** 123456 -

Seam Connect Webview flow to connect Schlage account with Seam

+

Seam Connect Webview flow to connect Schlage account with Seam

Confirm the Connect Webview was successful by querying its status: @@ -253,7 +253,7 @@ Next, you can perform the basic action of locking and unlocking the door.
-[openapi.json](../.gitbook/assets/openapi.json) +[openapi.json](../../.gitbook/assets/openapi.json)
@@ -323,7 +323,7 @@ puts updated_lock.properties.locked # false All Schlage wifi locks come with a keypad built-in to program access codes. These codes can then be entered to unlock a Schlage lock. -The Seam API makes it easy to program both `ongoing` codes and `timebound` codes on a Schlage lock. You can find out more about Schlage lock access code in our [core concept section on access codes.](../capability-guides/smart-locks/access-codes/) +The Seam API makes it easy to program both `ongoing` codes and `timebound` codes on a Schlage lock. You can find out more about Schlage lock access code in our [core concept section on access codes.](../../capability-guides/smart-locks/access-codes/)
@@ -471,11 +471,11 @@ Now that you've completed this guide, you can try to connect a real Schlage devi In addition, if you'd like to explore other aspects of Seam, here is a list of helpful resources: -* [Yale Getting Started Guide](get-started-with-yale-locks.md) -* [August Getting Started Guide](get-started-with-august-locks.md) -* [SmartThings Getting Started Guide](get-started-with-smartthings-hubs-+-smart-locks.md) -* [Receiving webhook](../developer-tools/webhooks.md) for [device events](https://docs.seam.co/latest/api/events/list) -* [Core Concepts](../core-concepts/overview.md) +* [Yale Getting Started Guide](../get-started-with-yale-locks.md) +* [August Getting Started Guide](../get-started-with-august-locks.md) +* [SmartThings Getting Started Guide](../smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md) +* [Receiving webhook](../../developer-tools/webhooks.md) for [device events](https://docs.seam.co/latest/api/events/list) +* [Core Concepts](../../core-concepts/overview.md) If you have any questions or want to report an issue, email us at support@seam.co. If you would like help ```` diff --git a/docs/guides/device-and-system-integration-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md b/docs/guides/device-and-system-integration-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md index 5de34055b..2738b2e98 100644 --- a/docs/guides/device-and-system-integration-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md +++ b/docs/guides/device-and-system-integration-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md @@ -6,7 +6,7 @@ description: >- # Get Started with SmartThings Hubs + Smart Locks -
SmartThings Hub + Devices

SmartThings Hub + Devices

+
SmartThings Hub + Devices

SmartThings Hub + Devices

## Overview @@ -21,7 +21,7 @@ To learn more about other IoT device and system brands that Seam supports—such {% hint style="success" %} This guide shows you how to install a Seam SDK and then control your SmartThings-connected lock using the Seam API. -Another easy way to learn about what you can do with the Seam API is to explore the [interactive Seam CLI](../core-concepts/seam-console/seam-online-cli.md), which you can access from directly within the [Seam Console](../core-concepts/seam-console/). +Another easy way to learn about what you can do with the Seam API is to explore the [interactive Seam CLI](../../core-concepts/seam-console/seam-online-cli.md), which you can access from directly within the [Seam Console](../../core-concepts/seam-console/). :arrow\_forward: [Go to the Seam Console!](https://console.seam.co/) {% endhint %} @@ -71,7 +71,7 @@ Install using [nuget](https://www.nuget.org/packages/Seam). {% endtab %} {% endtabs %} -Next, go to [https://console.seam.co/](https://console.seam.co/) and [sign up for Seam](../core-concepts/seam-console/#create-a-seam-account) to get your [API key](../core-concepts/authentication/api-keys.md). +Next, go to [https://console.seam.co/](https://console.seam.co/) and [sign up for Seam](../../core-concepts/seam-console/#create-a-seam-account) to get your [API key](../../core-concepts/authentication/api-keys.md). Then, export your API key as an environment variable. @@ -80,25 +80,25 @@ $ export SEAM_API_KEY=seam_test2bMS_94SrGUXuNR2JmJkjtvBQDg5c ``` {% hint style="info" %} -This guide uses a [sandbox workspace](../core-concepts/workspaces/#sandbox-workspaces). You can only connect virtual devices and systems in this type of workspace. If you want to connect a real SmartThings-connected lock, use a [non-sandbox workspace](../core-concepts/workspaces/#production-workspaces) and API key. +This guide uses a [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces). You can only connect virtual devices and systems in this type of workspace. If you want to connect a real SmartThings-connected lock, use a [non-sandbox workspace](../../core-concepts/workspaces/#production-workspaces) and API key. {% endhint %} *** ## Step 2: Link your SmartThings account with Seam -To control your SmartThings-connected lock using the Seam API, you must first authorize your Seam workspace to connect to your SmartThings account. If your application needs to connect to your users' SmartThings accounts, Seam provides fully-embedded, [customizable](../core-concepts/connect-webviews/customizing-connect-webviews.md) client-side [Connect Webviews](../core-concepts/connect-webviews/) to collect their authorization securely. These user-friendly pre-built authorization flows walk your users through the process of granting your Seam workspace permission to control their SmartThings-connected locks. The Connect Webview presents a flow that prompts your users to enter their credentials for their SmartThings account. +To control your SmartThings-connected lock using the Seam API, you must first authorize your Seam workspace to connect to your SmartThings account. If your application needs to connect to your users' SmartThings accounts, Seam provides fully-embedded, [customizable](../../core-concepts/connect-webviews/customizing-connect-webviews.md) client-side [Connect Webviews](../../core-concepts/connect-webviews/) to collect their authorization securely. These user-friendly pre-built authorization flows walk your users through the process of granting your Seam workspace permission to control their SmartThings-connected locks. The Connect Webview presents a flow that prompts your users to enter their credentials for their SmartThings account. In this guide, you create a Connect Webview object. Then, you display the graphical component of the created Connect Webview and enter a set of sample credentials to connect a sandbox SmartThings account. {% hint style="success" %} This guide shows you how to create a Connect Webview programmatically using the Seam API. -The [Seam Console](../core-concepts/seam-console/) provides another easy way to connect devices to your Seam workspace. +The [Seam Console](../../core-concepts/seam-console/) provides another easy way to connect devices to your Seam workspace. Go to [https://console.seam.co/](https://console.seam.co/). On the **Devices** page, click **+ Add Devices**. Then, see [Authorize your workspace](get-started-with-smartthings-hubs-+-smart-locks.md#authorize-your-workspace) in this guide to complete the Connect Webview authorization flow. -You can also use the Seam Console to add devices. +You can also use the Seam Console to add devices. {% endhint %} ### Create a Connect Webview @@ -273,18 +273,18 @@ https://connect.getseam.com/connect_webviews/view?connect_webview_id=12345678-12 In a web browser, go to the URL that the Connect Webview object returned. -For application developers, you can redirect your user to this Connect Webview URL so that they can authorize your app to control their devices using Seam. We even provide a prebuilt [Connect Account Button](../ui-components/overview/react-components/connect-account-button.md) within our suite of [Seam Components](../ui-components/overview/) that help you build your device management flow. +For application developers, you can redirect your user to this Connect Webview URL so that they can authorize your app to control their devices using Seam. We even provide a prebuilt [Connect Account Button](../../ui-components/overview/react-components/connect-account-button.md) within our suite of [Seam Components](../../ui-components/overview/) that help you build your device management flow. {% hint style="success" %} -Because you're using a sandbox workspace, you can connect Seam's test SmartThings account. We provide [virtual devices](sandbox-and-sample-data/) for each of the brands that we support. These sandbox devices and systems enable you to test your app with devices from multiple brands without the need to own all the corresponding physical devices. +Because you're using a sandbox workspace, you can connect Seam's test SmartThings account. We provide [virtual devices](../../developer-tools/sandbox-and-sample-data/) for each of the brands that we support. These sandbox devices and systems enable you to test your app with devices from multiple brands without the need to own all the corresponding physical devices. {% endhint %} -Complete the Connect Webview authorization flow by entering the following [SmartThings sandbox account](sandbox-and-sample-data/smartthings-sample-data.md) credentials: +Complete the Connect Webview authorization flow by entering the following [SmartThings sandbox account](../../developer-tools/sandbox-and-sample-data/smartthings-sample-data.md) credentials: * **Email:** jane@example.com * **Password:** 1234 -
Use the Seam Connect Webview authorization flow to connect a SmartThings account with Seam. This flow varies slightly based on the device manufacturer.

Use the Seam Connect Webview authorization flow to connect a SmartThings account with Seam. This flow varies slightly based on the device manufacturer.

+
Use the Seam Connect Webview authorization flow to connect a SmartThings account with Seam. This flow varies slightly based on the device manufacturer.

Use the Seam Connect Webview authorization flow to connect a SmartThings account with Seam. This flow varies slightly based on the device manufacturer.

Confirm that authorization through the Connect Webview was successful by querying its status. @@ -701,7 +701,7 @@ True Next, you can use the Seam API to control your lock. -Each device that you connect to Seam has a specific set of capabilities. These capabilities define the Seam API actions that you can use, such as [remote unlock actions](../capability-guides/smart-locks/lock-and-unlock.md), [programming access codes](../capability-guides/smart-locks/access-codes/), and so on. Seam's intuitive and granular [capability flags](../capability-guides/device-and-system-capabilities.md#capability-flags) inform your application about what features and behaviors each device supports. Notice the capability flags within the code samples in this guide. +Each device that you connect to Seam has a specific set of capabilities. These capabilities define the Seam API actions that you can use, such as [remote unlock actions](../../capability-guides/smart-locks/lock-and-unlock.md), [programming access codes](../../capability-guides/smart-locks/access-codes/), and so on. Seam's intuitive and granular [capability flags](../../capability-guides/device-and-system-capabilities.md#capability-flags) inform your application about what features and behaviors each device supports. Notice the capability flags within the code samples in this guide. Try out the following actions on your SmartThings-connected lock: @@ -710,7 +710,7 @@ Try out the following actions on your SmartThings-connected lock: ### Unlock your lock -To unlock a door, use the [Unlock Door](https://docs.seam.co/latest/api/locks/unlock_door) endpoint. Specify the device that you want to unlock by including the `device_id` in the request body. This endpoint returns an [action attempt](../core-concepts/action-attempts.md) to track the progress of the unlock operation. +To unlock a door, use the [Unlock Door](https://docs.seam.co/latest/api/locks/unlock_door) endpoint. Specify the device that you want to unlock by including the `device_id` in the request body. This endpoint returns an [action attempt](../../core-concepts/action-attempts.md) to track the progress of the unlock operation. {% tabs %} {% tab title="Python" %} @@ -1017,9 +1017,9 @@ Now that you have successfully unlocked your lock, you can use the [Lock Door](h ### Program access codes on your lock -You can use the Seam API to program [online access codes](../capability-guides/smart-locks/access-codes/) on SmartThings-connected locks that have an integrated or accessory keypad. Lock users can then enter these access codes using the keypad to unlock the lock. +You can use the Seam API to program [online access codes](../../capability-guides/smart-locks/access-codes/) on SmartThings-connected locks that have an integrated or accessory keypad. Lock users can then enter these access codes using the keypad to unlock the lock. -The Seam API makes it easy to program both [ongoing](../capability-guides/smart-locks/access-codes/#ongoing-access-codes) and [time-bound](../capability-guides/smart-locks/access-codes/#time-bound-access-codes) online access codes. +The Seam API makes it easy to program both [ongoing](../../capability-guides/smart-locks/access-codes/#ongoing-access-codes) and [time-bound](../../capability-guides/smart-locks/access-codes/#time-bound-access-codes) online access codes. {% tabs %} {% tab title="Python" %} @@ -1376,23 +1376,23 @@ if (updatedFrontDoor.CanProgramOnlineAccessCodes == true) { ## Step 5: Connect a real SmartThings-connected lock -Now that you have learned the basics of using the Seam API, you can connect and control a real SmartThings-connected device. To do so, make sure to switch to a [non-sandbox workspace](../core-concepts/workspaces/#production-workspaces) and [API key](../core-concepts/authentication/api-keys.md). +Now that you have learned the basics of using the Seam API, you can connect and control a real SmartThings-connected device. To do so, make sure to switch to a [non-sandbox workspace](../../core-concepts/workspaces/#production-workspaces) and [API key](../../core-concepts/authentication/api-keys.md). -For more details about setting up your real SmartThings-connected lock, see the [SmartThings Hubs + devices integration guide](../device-and-system-integration-guides/smartthings-hubs-+-devices/). +For more details about setting up your real SmartThings-connected lock, see the [SmartThings Hubs + devices integration guide](../smartthings-hubs-+-devices/). *** ## Step 6: Build your application! -Seam makes it easy to develop your application. In addition to the robust Seam API and the wide variety of programming languages that our SDKs support, we also provide a suite of [Seam Components](../ui-components/overview/). These prebuilt UI components help you to build your device management flow. +Seam makes it easy to develop your application. In addition to the robust Seam API and the wide variety of programming languages that our SDKs support, we also provide a suite of [Seam Components](../../ui-components/overview/). These prebuilt UI components help you to build your device management flow. -
Seam Components make it easy to develop your application!

Seam Components make it easy to develop your application!

+
Seam Components make it easy to develop your application!

Seam Components make it easy to develop your application!

-For example, you can use the [Device Table Seam Component](../ui-components/overview/react-components/device-table.md) to display a list of devices and to identify all devices with issues. You can use the [Device Details Seam Component](../ui-components/overview/react-components/device-details.md) to display a device's properties, settings, and issues, as well as to enable your users to perform actions based on each device's capabilities. The [Access Code Details Seam Component](../ui-components/overview/react-components/access-code-details.md) provides a similar display and actions for access codes. +For example, you can use the [Device Table Seam Component](../../ui-components/overview/react-components/device-table.md) to display a list of devices and to identify all devices with issues. You can use the [Device Details Seam Component](../../ui-components/overview/react-components/device-details.md) to display a device's properties, settings, and issues, as well as to enable your users to perform actions based on each device's capabilities. The [Access Code Details Seam Component](../../ui-components/overview/react-components/access-code-details.md) provides a similar display and actions for access codes. Seam Components use a responsive design to fit seamlessly on any screen size. They also provide device debugging flows to help your users. -To learn about all the Seam Components that we provide, see [Seam Components](../ui-components/overview/). +To learn about all the Seam Components that we provide, see [Seam Components](../../ui-components/overview/). *** @@ -1401,17 +1401,17 @@ To learn about all the Seam Components that we provide, see [Seam Components](.. Now that you've completed this getting started guide for SmartThings-connected devices, you can learn more about what you can do with the Seam API. * [ ] **Explore**\ - See the [other devices and system integrations](../device-and-system-integration-guides/overview.md) that Seam supports. + See the [other devices and system integrations](../overview.md) that Seam supports. * [ ] **Learn**\ - Read about Seam [concepts](../core-concepts/overview.md) and the [device and system capabilities ](../capability-guides/device-and-system-capabilities.md)that Seam supports. + Read about Seam [concepts](../../core-concepts/overview.md) and the [device and system capabilities ](../../capability-guides/device-and-system-capabilities.md)that Seam supports. * [ ] **Use Seam Components**\ - Find out about [Seam Components](../ui-components/overview/), which are prebuilt UI components for building your device management flow. + Find out about [Seam Components](../../ui-components/overview/), which are prebuilt UI components for building your device management flow. * [ ] **Use webhooks**\ - Learn how to use [webhooks](../developer-tools/webhooks.md) as an efficient way to receive device events. + Learn how to use [webhooks](../../developer-tools/webhooks.md) as an efficient way to receive device events. * [ ] **Find out more**\ - Explore the other types of devices and systems that you can control with Seam, including [access control systems](../capability-guides/access-systems/), [thermostats](../capability-guides/thermostats/), and [noise sensors](../capability-guides/noise-sensors/). + Explore the other types of devices and systems that you can control with Seam, including [access control systems](../../capability-guides/access-systems/), [thermostats](../../capability-guides/thermostats/), and [noise sensors](../../capability-guides/noise-sensors/). * [ ] **Develop for mobile access**\ - Learn about Seam's [mobile access solution](../capability-guides/mobile-access/). + Learn about Seam's [mobile access solution](../../capability-guides/mobile-access/). {% hint style="info" %} If you have any questions or want to report an issue, email us at [support@seam.co](mailto:support@seam.co). @@ -1421,4 +1421,4 @@ If you have any questions or want to report an issue, email us at [support@seam. ## Quick links -
Get an API Key (free)Sign up for the Seam Console and get your API keys. →seam-api-key.pnghttps://console.seam.co/
Contact SalesGot a project or a specific question? Contact our team to get answers. →seam-contact-us-light.pnghttps://www.seam.co/contact-us
+
Get an API Key (free)Sign up for the Seam Console and get your API keys. →seam-api-key.pnghttps://console.seam.co/
Contact SalesGot a project or a specific question? Contact our team to get answers. →seam-contact-us-light.pnghttps://www.seam.co/contact-us