From 663ff6f163e85c78d8833cf807fbd44713c4778a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Louis=20Pr=C3=A9?= Date: Tue, 21 Apr 2026 19:49:39 -0700 Subject: [PATCH 1/8] Move brand guide content from guides to docs/brand-guides/ Co-Authored-By: Claude Opus 4.6 (1M context) --- .../2n-intercom-systems/2n-system-set-up-instructions.md | 0 .../2n-intercom-systems/README.md | 0 .../2n-intercom-systems/get-started-with-2n-intercoms.md | 0 .../33-lock-devices/README.md | 0 .../33-lock-devices/get-started-with-33-lock-devices.md | 0 .../4suites-locks/README.md | 0 .../4suites-locks/get-started-with-4suites-locks.md | 0 .../akiles-locks/README.md | 0 .../akiles-locks/get-started-with-akiles-locks.md | 0 .../assa-abloy-vingcard-credential-services.md | 0 .../assa-abloy-visionline-access-control-system/README.md | 0 .../common-use-cases.md | 0 .../configuring-visionline-mobile-credentials/README.md | 0 ...dentity-has-a-phone-that-is-set-up-for-a-credential-manager.md | 0 .../issuing-various-types-of-guest-joiner-mobile-credentials.md | 0 .../issuing-various-types-of-guest-mobile-credentials.md | 0 .../retrieving-guest-and-common-entrances.md | 0 .../revoking-mobile-credentials.md | 0 .../updating-guest-mobile-credentials.md | 0 .../creating-visionline-card-based-credentials.md | 0 .../mobile-credential-related-properties.md | 0 ...cial-requirements-for-android-mobile-access-sdk-development.md | 0 .../special-requirements-for-ios-mobile-access-sdk-development.md | 0 .../visionline-acs-setup-instructions/README.md | 0 .../README.md | 0 .../developing-your-visionline-mobile-key-app/README.md | 0 .../developing-your-visionline-mobile-key-app/next-steps.md | 0 .../step-1-complete-the-assa-abloy-mobile-development-course.md | 0 ...step-10-connect-your-visionline-development-account-to-seam.md | 0 .../step-2-install-your-visionline-application.md | 0 .../step-3-unblock-required-ports.md | 0 .../step-4-configure-a-visionline-user-account.md | 0 ...tep-5-set-up-your-credential-services-account-in-visionline.md | 0 .../step-6-configure-the-mobile-access-uuid-in-visionline.md | 0 .../step-7-set-up-door-locks-with-ble-profiles.md | 0 .../step-8-program-door-locks.md | 0 .../step-9-create-a-production-workspace.md | 0 .../launching-your-visionline-mobile-key-app/README.md | 0 ...p-1-obtain-assa-abloy-certification-for-your-mobile-key-app.md | 0 ...-2-confirm-that-your-visionline-site-meets-the-requirements.md | 0 .../step-3-confirm-ble-module-on-all-locks.md | 0 .../step-4-set-up-door-locks-with-ble-profiles.md | 0 .../step-5-program-door-locks.md | 0 .../step-6-configure-a-visionline-user-account.md | 0 ...ort-the-callback-and-mobile-service-options-from-assa-abloy.md | 0 .../step-8-create-a-production-workspace.md | 0 .../step-9-connect-your-visionline-production-account-to-seam.md | 0 .../README.md | 0 .../README.md | 0 .../next-steps.md | 0 .../step-1-install-your-visionline-application.md | 0 .../step-2-unblock-required-ports.md | 0 .../step-3-configure-a-visionline-user-account.md | 0 .../step-4-install-a-visionline-card-encoder.md | 0 .../step-5-set-up-door-locks.md | 0 .../step-6-program-door-locks.md | 0 .../step-7-create-a-production-workspace.md | 0 .../step-8-connect-your-visionline-development-account-to-seam.md | 0 .../README.md | 0 .../next-steps.md | 0 .../step-1-create-a-sandbox-workspace.md | 0 .../step-2-connect-the-virtual-visionline-acs-to-seam.md | 0 .../README.md | 0 ...-1-confirm-that-your-visionline-site-meets-the-requirements.md | 0 .../step-2-configure-a-visionline-user-account.md | 0 ...p-3-purchase-and-import-the-callback-option-from-assa-abloy.md | 0 .../step-4-create-a-production-workspace.md | 0 .../step-5-connect-your-visionline-production-account-to-seam.md | 0 .../instructions-for-issuing-visionline-instant-keys.md | 0 .../august-locks.md | 0 .../avigilon-alta-access-system.md | 0 .../brivo-access/README.md | 0 .../brivo-access/brivo-access-setup-guide.md | 0 .../dormakaba-ambiance-access-control-system/README.md | 0 .../dormakaba-ambiance-setup-guide.md | 0 .../dormakaba-community-access-control-system/README.md | 0 .../dormakaba-community-setup-guide.md | 0 .../dormakaba-oracode-locks/README.md | 0 .../creating-dormakaba-oracode-offline-access-codes.md | 0 .../dormakaba-oracode-locks/dormakaba-oracode-setup-guide.md | 0 .../get-started-with-dormakaba-oracode-locks.md | 0 ...programming-offline-access-codes-on-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 .../google-nest-thermostats/get-started-with-nest-thermostats.md | 0 ...obtain-google-nest-device-access-and-commercial-development.md | 0 .../honeywell-thermostats/README.md | 0 .../get-started-with-honeywell-thermostats.md | 0 .../igloohome-locks/README.md | 0 .../igloohome-locks/creating-igloohome-offline-access-codes.md | 0 .../igloohome-locks/get-started-with-igloo-locks.md | 0 .../igloohome-locks/igloohome-error-and-warning-codes.md | 0 .../keynest-key-lockers/README.md | 0 .../keynest-key-lockers/keynest-setup-instructions.md | 0 .../kwikset-locks.md | 0 .../latch-access-control-system/README.md | 0 .../latch-access-control-system/latch-setup-guide.md | 0 .../programming-code-based-latch-credentials.md | 0 .../programming-latch-acs-mobile-credentials.md | 0 .../lockly-locks/README.md | 0 .../lockly-locks/creating-lockly-offline-access-codes.md | 0 .../lockly-locks/lockly-setup-guide.md | 0 .../minut-sensors.md | 0 .../noiseaware-sensors.md | 0 .../nuki-locks.md | 0 .../overview.md | 0 .../pti-storlogix-cloud.md | 0 .../salto-ks-access-control-system/README.md | 0 .../programming-code-based-salto-ks-credentials.md | 0 .../programming-salto-ks-mobile-credentials.md | 0 .../salto-ks-access-control-system/salto-ks-setup-instructions.md | 0 ...cial-requirements-for-android-mobile-access-sdk-development.md | 0 .../salto-locks.md | 0 .../salto-proaccess-space-access-system/README.md | 0 .../programming-salto-space-card-based-credentials.md | 0 .../programming-salto-space-mobile-credentials.md | 0 .../salto-space-setup-instructions.md | 0 .../schlage-locks/README.md | 0 .../schlage-locks/get-started-with-schlage-locks.md | 0 .../schlage-locks-daylight-savings-time-adjustments.md | 0 .../schlage-locks/schlage-locks-setup-instructions.md | 0 .../sensi-thermostats/README.md | 0 .../sensi-thermostats/get-started-with-sensi-thermostats.md | 0 .../smartthings-hubs-+-devices/README.md | 0 .../get-started-with-smartthings-hubs-+-smart-locks.md | 0 .../get-started-with-smartthings-hubs-+-thermostats.md | 0 .../smartthings-hubs-+-smart-locks.md | 0 .../tedee-locks/README.md | 0 .../tedee-locks/get-started-with-tedee-locks.md | 0 .../ttlock-locks.md | 0 .../ultraloq-locks/README.md | 0 .../ultraloq-locks/configuring-ultraloq-device-timezones.md | 0 .../ultraloq-locks/creating-ultraloq-access-codes.md | 0 .../ultraloq-locks/ultraloq-setup-guide.md | 0 .../wyze-locks.md | 0 .../yale-locks.md | 0 148 files changed, 0 insertions(+), 0 deletions(-) rename docs/{guides/device-and-system-integration-guides => brand-guides}/2n-intercom-systems/2n-system-set-up-instructions.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/2n-intercom-systems/README.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/2n-intercom-systems/get-started-with-2n-intercoms.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/33-lock-devices/README.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/33-lock-devices/get-started-with-33-lock-devices.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/4suites-locks/README.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/4suites-locks/get-started-with-4suites-locks.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/akiles-locks/README.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/akiles-locks/get-started-with-akiles-locks.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-vingcard-credential-services.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-visionline-access-control-system/README.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-visionline-access-control-system/common-use-cases.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/README.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/checking-if-a-user-identity-has-a-phone-that-is-set-up-for-a-credential-manager.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/issuing-various-types-of-guest-joiner-mobile-credentials.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/issuing-various-types-of-guest-mobile-credentials.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/retrieving-guest-and-common-entrances.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/revoking-mobile-credentials.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/updating-guest-mobile-credentials.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-visionline-access-control-system/creating-visionline-card-based-credentials.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-visionline-access-control-system/mobile-credential-related-properties.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-visionline-access-control-system/special-requirements-for-android-mobile-access-sdk-development.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-visionline-access-control-system/special-requirements-for-ios-mobile-access-sdk-development.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/README.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/README.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/README.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/next-steps.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-1-complete-the-assa-abloy-mobile-development-course.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-10-connect-your-visionline-development-account-to-seam.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-2-install-your-visionline-application.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-3-unblock-required-ports.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-4-configure-a-visionline-user-account.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-5-set-up-your-credential-services-account-in-visionline.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-6-configure-the-mobile-access-uuid-in-visionline.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-7-set-up-door-locks-with-ble-profiles.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-8-program-door-locks.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-9-create-a-production-workspace.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/README.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-1-obtain-assa-abloy-certification-for-your-mobile-key-app.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-2-confirm-that-your-visionline-site-meets-the-requirements.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-3-confirm-ble-module-on-all-locks.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-4-set-up-door-locks-with-ble-profiles.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-5-program-door-locks.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-6-configure-a-visionline-user-account.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-7-purchase-and-import-the-callback-and-mobile-service-options-from-assa-abloy.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-8-create-a-production-workspace.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-9-connect-your-visionline-production-account-to-seam.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/README.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/README.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/next-steps.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-1-install-your-visionline-application.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-2-unblock-required-ports.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-3-configure-a-visionline-user-account.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-4-install-a-visionline-card-encoder.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-5-set-up-door-locks.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-6-program-door-locks.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-7-create-a-production-workspace.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-8-connect-your-visionline-development-account-to-seam.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/README.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/next-steps.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/step-1-create-a-sandbox-workspace.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/step-2-connect-the-virtual-visionline-acs-to-seam.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/README.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-1-confirm-that-your-visionline-site-meets-the-requirements.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-2-configure-a-visionline-user-account.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-3-purchase-and-import-the-callback-option-from-assa-abloy.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-4-create-a-production-workspace.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-5-connect-your-visionline-production-account-to-seam.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/instructions-for-issuing-visionline-instant-keys.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/august-locks.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/avigilon-alta-access-system.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/brivo-access/README.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/brivo-access/brivo-access-setup-guide.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/dormakaba-ambiance-access-control-system/README.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/dormakaba-ambiance-access-control-system/dormakaba-ambiance-setup-guide.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/dormakaba-community-access-control-system/README.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/dormakaba-community-access-control-system/dormakaba-community-setup-guide.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/dormakaba-oracode-locks/README.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/dormakaba-oracode-locks/creating-dormakaba-oracode-offline-access-codes.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/dormakaba-oracode-locks/dormakaba-oracode-setup-guide.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/dormakaba-oracode-locks/get-started-with-dormakaba-oracode-locks.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/dormakaba-oracode-locks/programming-offline-access-codes-on-dormakaba-oracode-locks.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/ecobee-thermostats.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/get-started-with-august-locks.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/get-started-with-controlbyweb-devices.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/get-started-with-ecobee-thermostats.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/get-started-with-kwikset-wifi-locks.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/get-started-with-minut-sensors.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/get-started-with-noiseaware-sensors.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/get-started-with-nuki-locks.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/get-started-with-salto-locks.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/get-started-with-smartlocks-api.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/get-started-with-ttlock-devices.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/get-started-with-wyze-locks.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/get-started-with-yale-locks.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/google-nest-thermostats/README.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/google-nest-thermostats/get-started-with-nest-thermostats.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/google-nest-thermostats/obtain-google-nest-device-access-and-commercial-development.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/honeywell-thermostats/README.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/honeywell-thermostats/get-started-with-honeywell-thermostats.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/igloohome-locks/README.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/igloohome-locks/creating-igloohome-offline-access-codes.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/igloohome-locks/get-started-with-igloo-locks.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/igloohome-locks/igloohome-error-and-warning-codes.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/keynest-key-lockers/README.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/keynest-key-lockers/keynest-setup-instructions.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/kwikset-locks.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/latch-access-control-system/README.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/latch-access-control-system/latch-setup-guide.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/latch-access-control-system/programming-code-based-latch-credentials.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/latch-access-control-system/programming-latch-acs-mobile-credentials.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/lockly-locks/README.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/lockly-locks/creating-lockly-offline-access-codes.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/lockly-locks/lockly-setup-guide.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/minut-sensors.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/noiseaware-sensors.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/nuki-locks.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/overview.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/pti-storlogix-cloud.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/salto-ks-access-control-system/README.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/salto-ks-access-control-system/programming-code-based-salto-ks-credentials.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/salto-ks-access-control-system/programming-salto-ks-mobile-credentials.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/salto-ks-access-control-system/salto-ks-setup-instructions.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/salto-ks-access-control-system/special-requirements-for-android-mobile-access-sdk-development.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/salto-locks.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/salto-proaccess-space-access-system/README.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/salto-proaccess-space-access-system/programming-salto-space-card-based-credentials.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/salto-proaccess-space-access-system/programming-salto-space-mobile-credentials.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/salto-proaccess-space-access-system/salto-space-setup-instructions.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/schlage-locks/README.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/schlage-locks/get-started-with-schlage-locks.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/schlage-locks/schlage-locks-daylight-savings-time-adjustments.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/schlage-locks/schlage-locks-setup-instructions.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/sensi-thermostats/README.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/sensi-thermostats/get-started-with-sensi-thermostats.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/smartthings-hubs-+-devices/README.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-thermostats.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/smartthings-hubs-+-smart-locks.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/tedee-locks/README.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/tedee-locks/get-started-with-tedee-locks.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/ttlock-locks.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/ultraloq-locks/README.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/ultraloq-locks/configuring-ultraloq-device-timezones.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/ultraloq-locks/creating-ultraloq-access-codes.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/ultraloq-locks/ultraloq-setup-guide.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/wyze-locks.md (100%) rename docs/{guides/device-and-system-integration-guides => brand-guides}/yale-locks.md (100%) diff --git a/docs/guides/device-and-system-integration-guides/2n-intercom-systems/2n-system-set-up-instructions.md b/docs/brand-guides/2n-intercom-systems/2n-system-set-up-instructions.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/2n-intercom-systems/2n-system-set-up-instructions.md rename to docs/brand-guides/2n-intercom-systems/2n-system-set-up-instructions.md diff --git a/docs/guides/device-and-system-integration-guides/2n-intercom-systems/README.md b/docs/brand-guides/2n-intercom-systems/README.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/2n-intercom-systems/README.md rename to docs/brand-guides/2n-intercom-systems/README.md diff --git a/docs/guides/device-and-system-integration-guides/2n-intercom-systems/get-started-with-2n-intercoms.md b/docs/brand-guides/2n-intercom-systems/get-started-with-2n-intercoms.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/2n-intercom-systems/get-started-with-2n-intercoms.md rename to docs/brand-guides/2n-intercom-systems/get-started-with-2n-intercoms.md diff --git a/docs/guides/device-and-system-integration-guides/33-lock-devices/README.md b/docs/brand-guides/33-lock-devices/README.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/33-lock-devices/README.md rename to docs/brand-guides/33-lock-devices/README.md diff --git a/docs/guides/device-and-system-integration-guides/33-lock-devices/get-started-with-33-lock-devices.md b/docs/brand-guides/33-lock-devices/get-started-with-33-lock-devices.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/33-lock-devices/get-started-with-33-lock-devices.md rename to docs/brand-guides/33-lock-devices/get-started-with-33-lock-devices.md diff --git a/docs/guides/device-and-system-integration-guides/4suites-locks/README.md b/docs/brand-guides/4suites-locks/README.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/4suites-locks/README.md rename to docs/brand-guides/4suites-locks/README.md diff --git a/docs/guides/device-and-system-integration-guides/4suites-locks/get-started-with-4suites-locks.md b/docs/brand-guides/4suites-locks/get-started-with-4suites-locks.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/4suites-locks/get-started-with-4suites-locks.md rename to docs/brand-guides/4suites-locks/get-started-with-4suites-locks.md diff --git a/docs/guides/device-and-system-integration-guides/akiles-locks/README.md b/docs/brand-guides/akiles-locks/README.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/akiles-locks/README.md rename to docs/brand-guides/akiles-locks/README.md diff --git a/docs/guides/device-and-system-integration-guides/akiles-locks/get-started-with-akiles-locks.md b/docs/brand-guides/akiles-locks/get-started-with-akiles-locks.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/akiles-locks/get-started-with-akiles-locks.md rename to docs/brand-guides/akiles-locks/get-started-with-akiles-locks.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-vingcard-credential-services.md b/docs/brand-guides/assa-abloy-vingcard-credential-services.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-vingcard-credential-services.md rename to docs/brand-guides/assa-abloy-vingcard-credential-services.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/README.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/README.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/README.md rename to docs/brand-guides/assa-abloy-visionline-access-control-system/README.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/common-use-cases.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/common-use-cases.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/common-use-cases.md rename to docs/brand-guides/assa-abloy-visionline-access-control-system/common-use-cases.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/README.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/README.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/README.md rename to docs/brand-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/README.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/checking-if-a-user-identity-has-a-phone-that-is-set-up-for-a-credential-manager.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/checking-if-a-user-identity-has-a-phone-that-is-set-up-for-a-credential-manager.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/checking-if-a-user-identity-has-a-phone-that-is-set-up-for-a-credential-manager.md rename to docs/brand-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/checking-if-a-user-identity-has-a-phone-that-is-set-up-for-a-credential-manager.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/issuing-various-types-of-guest-joiner-mobile-credentials.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/issuing-various-types-of-guest-joiner-mobile-credentials.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/issuing-various-types-of-guest-joiner-mobile-credentials.md rename to docs/brand-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/issuing-various-types-of-guest-joiner-mobile-credentials.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/issuing-various-types-of-guest-mobile-credentials.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/issuing-various-types-of-guest-mobile-credentials.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/issuing-various-types-of-guest-mobile-credentials.md rename to docs/brand-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/issuing-various-types-of-guest-mobile-credentials.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/retrieving-guest-and-common-entrances.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/retrieving-guest-and-common-entrances.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/retrieving-guest-and-common-entrances.md rename to docs/brand-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/retrieving-guest-and-common-entrances.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/revoking-mobile-credentials.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/revoking-mobile-credentials.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/revoking-mobile-credentials.md rename to docs/brand-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/revoking-mobile-credentials.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/updating-guest-mobile-credentials.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/updating-guest-mobile-credentials.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/updating-guest-mobile-credentials.md rename to docs/brand-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/updating-guest-mobile-credentials.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/creating-visionline-card-based-credentials.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/creating-visionline-card-based-credentials.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/creating-visionline-card-based-credentials.md rename to docs/brand-guides/assa-abloy-visionline-access-control-system/creating-visionline-card-based-credentials.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/mobile-credential-related-properties.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/mobile-credential-related-properties.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/mobile-credential-related-properties.md rename to docs/brand-guides/assa-abloy-visionline-access-control-system/mobile-credential-related-properties.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/special-requirements-for-android-mobile-access-sdk-development.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/special-requirements-for-android-mobile-access-sdk-development.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/special-requirements-for-android-mobile-access-sdk-development.md rename to docs/brand-guides/assa-abloy-visionline-access-control-system/special-requirements-for-android-mobile-access-sdk-development.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/special-requirements-for-ios-mobile-access-sdk-development.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/special-requirements-for-ios-mobile-access-sdk-development.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/special-requirements-for-ios-mobile-access-sdk-development.md rename to docs/brand-guides/assa-abloy-visionline-access-control-system/special-requirements-for-ios-mobile-access-sdk-development.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/README.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/README.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/README.md rename to docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/README.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/README.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/README.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/README.md rename to docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/README.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/README.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/README.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/README.md rename to docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/README.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/next-steps.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/next-steps.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/next-steps.md rename to docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/next-steps.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-1-complete-the-assa-abloy-mobile-development-course.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-1-complete-the-assa-abloy-mobile-development-course.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-1-complete-the-assa-abloy-mobile-development-course.md rename to docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-1-complete-the-assa-abloy-mobile-development-course.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-10-connect-your-visionline-development-account-to-seam.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-10-connect-your-visionline-development-account-to-seam.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-10-connect-your-visionline-development-account-to-seam.md rename to docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-10-connect-your-visionline-development-account-to-seam.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-2-install-your-visionline-application.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-2-install-your-visionline-application.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-2-install-your-visionline-application.md rename to docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-2-install-your-visionline-application.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-3-unblock-required-ports.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-3-unblock-required-ports.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-3-unblock-required-ports.md rename to docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-3-unblock-required-ports.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-4-configure-a-visionline-user-account.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-4-configure-a-visionline-user-account.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-4-configure-a-visionline-user-account.md rename to docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-4-configure-a-visionline-user-account.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-5-set-up-your-credential-services-account-in-visionline.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-5-set-up-your-credential-services-account-in-visionline.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-5-set-up-your-credential-services-account-in-visionline.md rename to docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-5-set-up-your-credential-services-account-in-visionline.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-6-configure-the-mobile-access-uuid-in-visionline.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-6-configure-the-mobile-access-uuid-in-visionline.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-6-configure-the-mobile-access-uuid-in-visionline.md rename to docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-6-configure-the-mobile-access-uuid-in-visionline.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-7-set-up-door-locks-with-ble-profiles.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-7-set-up-door-locks-with-ble-profiles.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-7-set-up-door-locks-with-ble-profiles.md rename to docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-7-set-up-door-locks-with-ble-profiles.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-8-program-door-locks.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-8-program-door-locks.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-8-program-door-locks.md rename to docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-8-program-door-locks.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-9-create-a-production-workspace.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-9-create-a-production-workspace.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-9-create-a-production-workspace.md rename to docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-9-create-a-production-workspace.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/README.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/README.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/README.md rename to docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/README.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-1-obtain-assa-abloy-certification-for-your-mobile-key-app.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-1-obtain-assa-abloy-certification-for-your-mobile-key-app.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-1-obtain-assa-abloy-certification-for-your-mobile-key-app.md rename to docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-1-obtain-assa-abloy-certification-for-your-mobile-key-app.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-2-confirm-that-your-visionline-site-meets-the-requirements.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-2-confirm-that-your-visionline-site-meets-the-requirements.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-2-confirm-that-your-visionline-site-meets-the-requirements.md rename to docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-2-confirm-that-your-visionline-site-meets-the-requirements.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-3-confirm-ble-module-on-all-locks.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-3-confirm-ble-module-on-all-locks.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-3-confirm-ble-module-on-all-locks.md rename to docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-3-confirm-ble-module-on-all-locks.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-4-set-up-door-locks-with-ble-profiles.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-4-set-up-door-locks-with-ble-profiles.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-4-set-up-door-locks-with-ble-profiles.md rename to docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-4-set-up-door-locks-with-ble-profiles.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-5-program-door-locks.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-5-program-door-locks.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-5-program-door-locks.md rename to docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-5-program-door-locks.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-6-configure-a-visionline-user-account.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-6-configure-a-visionline-user-account.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-6-configure-a-visionline-user-account.md rename to docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-6-configure-a-visionline-user-account.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-7-purchase-and-import-the-callback-and-mobile-service-options-from-assa-abloy.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-7-purchase-and-import-the-callback-and-mobile-service-options-from-assa-abloy.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-7-purchase-and-import-the-callback-and-mobile-service-options-from-assa-abloy.md rename to docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-7-purchase-and-import-the-callback-and-mobile-service-options-from-assa-abloy.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-8-create-a-production-workspace.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-8-create-a-production-workspace.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-8-create-a-production-workspace.md rename to docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-8-create-a-production-workspace.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-9-connect-your-visionline-production-account-to-seam.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-9-connect-your-visionline-production-account-to-seam.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-9-connect-your-visionline-production-account-to-seam.md rename to docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-9-connect-your-visionline-production-account-to-seam.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/README.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/README.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/README.md rename to docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/README.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/README.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/README.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/README.md rename to docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/README.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/next-steps.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/next-steps.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/next-steps.md rename to docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/next-steps.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-1-install-your-visionline-application.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-1-install-your-visionline-application.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-1-install-your-visionline-application.md rename to docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-1-install-your-visionline-application.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-2-unblock-required-ports.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-2-unblock-required-ports.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-2-unblock-required-ports.md rename to docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-2-unblock-required-ports.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-3-configure-a-visionline-user-account.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-3-configure-a-visionline-user-account.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-3-configure-a-visionline-user-account.md rename to docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-3-configure-a-visionline-user-account.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-4-install-a-visionline-card-encoder.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-4-install-a-visionline-card-encoder.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-4-install-a-visionline-card-encoder.md rename to docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-4-install-a-visionline-card-encoder.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-5-set-up-door-locks.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-5-set-up-door-locks.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-5-set-up-door-locks.md rename to docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-5-set-up-door-locks.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-6-program-door-locks.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-6-program-door-locks.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-6-program-door-locks.md rename to docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-6-program-door-locks.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-7-create-a-production-workspace.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-7-create-a-production-workspace.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-7-create-a-production-workspace.md rename to docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-7-create-a-production-workspace.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-8-connect-your-visionline-development-account-to-seam.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-8-connect-your-visionline-development-account-to-seam.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-8-connect-your-visionline-development-account-to-seam.md rename to docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-8-connect-your-visionline-development-account-to-seam.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/README.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/README.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/README.md rename to docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/README.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/next-steps.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/next-steps.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/next-steps.md rename to docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/next-steps.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/step-1-create-a-sandbox-workspace.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/step-1-create-a-sandbox-workspace.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/step-1-create-a-sandbox-workspace.md rename to docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/step-1-create-a-sandbox-workspace.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/step-2-connect-the-virtual-visionline-acs-to-seam.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/step-2-connect-the-virtual-visionline-acs-to-seam.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/step-2-connect-the-virtual-visionline-acs-to-seam.md rename to docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/step-2-connect-the-virtual-visionline-acs-to-seam.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/README.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/README.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/README.md rename to docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/README.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-1-confirm-that-your-visionline-site-meets-the-requirements.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-1-confirm-that-your-visionline-site-meets-the-requirements.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-1-confirm-that-your-visionline-site-meets-the-requirements.md rename to docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-1-confirm-that-your-visionline-site-meets-the-requirements.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-2-configure-a-visionline-user-account.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-2-configure-a-visionline-user-account.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-2-configure-a-visionline-user-account.md rename to docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-2-configure-a-visionline-user-account.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-3-purchase-and-import-the-callback-option-from-assa-abloy.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-3-purchase-and-import-the-callback-option-from-assa-abloy.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-3-purchase-and-import-the-callback-option-from-assa-abloy.md rename to docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-3-purchase-and-import-the-callback-option-from-assa-abloy.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-4-create-a-production-workspace.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-4-create-a-production-workspace.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-4-create-a-production-workspace.md rename to docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-4-create-a-production-workspace.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-5-connect-your-visionline-production-account-to-seam.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-5-connect-your-visionline-production-account-to-seam.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-5-connect-your-visionline-production-account-to-seam.md rename to docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-5-connect-your-visionline-production-account-to-seam.md diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/instructions-for-issuing-visionline-instant-keys.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/instructions-for-issuing-visionline-instant-keys.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/instructions-for-issuing-visionline-instant-keys.md rename to docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/instructions-for-issuing-visionline-instant-keys.md diff --git a/docs/guides/device-and-system-integration-guides/august-locks.md b/docs/brand-guides/august-locks.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/august-locks.md rename to docs/brand-guides/august-locks.md diff --git a/docs/guides/device-and-system-integration-guides/avigilon-alta-access-system.md b/docs/brand-guides/avigilon-alta-access-system.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/avigilon-alta-access-system.md rename to docs/brand-guides/avigilon-alta-access-system.md diff --git a/docs/guides/device-and-system-integration-guides/brivo-access/README.md b/docs/brand-guides/brivo-access/README.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/brivo-access/README.md rename to docs/brand-guides/brivo-access/README.md diff --git a/docs/guides/device-and-system-integration-guides/brivo-access/brivo-access-setup-guide.md b/docs/brand-guides/brivo-access/brivo-access-setup-guide.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/brivo-access/brivo-access-setup-guide.md rename to docs/brand-guides/brivo-access/brivo-access-setup-guide.md diff --git a/docs/guides/device-and-system-integration-guides/dormakaba-ambiance-access-control-system/README.md b/docs/brand-guides/dormakaba-ambiance-access-control-system/README.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/dormakaba-ambiance-access-control-system/README.md rename to docs/brand-guides/dormakaba-ambiance-access-control-system/README.md diff --git a/docs/guides/device-and-system-integration-guides/dormakaba-ambiance-access-control-system/dormakaba-ambiance-setup-guide.md b/docs/brand-guides/dormakaba-ambiance-access-control-system/dormakaba-ambiance-setup-guide.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/dormakaba-ambiance-access-control-system/dormakaba-ambiance-setup-guide.md rename to docs/brand-guides/dormakaba-ambiance-access-control-system/dormakaba-ambiance-setup-guide.md diff --git a/docs/guides/device-and-system-integration-guides/dormakaba-community-access-control-system/README.md b/docs/brand-guides/dormakaba-community-access-control-system/README.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/dormakaba-community-access-control-system/README.md rename to docs/brand-guides/dormakaba-community-access-control-system/README.md diff --git a/docs/guides/device-and-system-integration-guides/dormakaba-community-access-control-system/dormakaba-community-setup-guide.md b/docs/brand-guides/dormakaba-community-access-control-system/dormakaba-community-setup-guide.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/dormakaba-community-access-control-system/dormakaba-community-setup-guide.md rename to docs/brand-guides/dormakaba-community-access-control-system/dormakaba-community-setup-guide.md diff --git a/docs/guides/device-and-system-integration-guides/dormakaba-oracode-locks/README.md b/docs/brand-guides/dormakaba-oracode-locks/README.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/dormakaba-oracode-locks/README.md rename to docs/brand-guides/dormakaba-oracode-locks/README.md diff --git a/docs/guides/device-and-system-integration-guides/dormakaba-oracode-locks/creating-dormakaba-oracode-offline-access-codes.md b/docs/brand-guides/dormakaba-oracode-locks/creating-dormakaba-oracode-offline-access-codes.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/dormakaba-oracode-locks/creating-dormakaba-oracode-offline-access-codes.md rename to docs/brand-guides/dormakaba-oracode-locks/creating-dormakaba-oracode-offline-access-codes.md diff --git a/docs/guides/device-and-system-integration-guides/dormakaba-oracode-locks/dormakaba-oracode-setup-guide.md b/docs/brand-guides/dormakaba-oracode-locks/dormakaba-oracode-setup-guide.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/dormakaba-oracode-locks/dormakaba-oracode-setup-guide.md rename to docs/brand-guides/dormakaba-oracode-locks/dormakaba-oracode-setup-guide.md diff --git a/docs/guides/device-and-system-integration-guides/dormakaba-oracode-locks/get-started-with-dormakaba-oracode-locks.md b/docs/brand-guides/dormakaba-oracode-locks/get-started-with-dormakaba-oracode-locks.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/dormakaba-oracode-locks/get-started-with-dormakaba-oracode-locks.md rename to docs/brand-guides/dormakaba-oracode-locks/get-started-with-dormakaba-oracode-locks.md diff --git a/docs/guides/device-and-system-integration-guides/dormakaba-oracode-locks/programming-offline-access-codes-on-dormakaba-oracode-locks.md b/docs/brand-guides/dormakaba-oracode-locks/programming-offline-access-codes-on-dormakaba-oracode-locks.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/dormakaba-oracode-locks/programming-offline-access-codes-on-dormakaba-oracode-locks.md rename to docs/brand-guides/dormakaba-oracode-locks/programming-offline-access-codes-on-dormakaba-oracode-locks.md diff --git a/docs/guides/device-and-system-integration-guides/ecobee-thermostats.md b/docs/brand-guides/ecobee-thermostats.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/ecobee-thermostats.md rename to docs/brand-guides/ecobee-thermostats.md diff --git a/docs/guides/device-and-system-integration-guides/get-started-with-august-locks.md b/docs/brand-guides/get-started-with-august-locks.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/get-started-with-august-locks.md rename to docs/brand-guides/get-started-with-august-locks.md diff --git a/docs/guides/device-and-system-integration-guides/get-started-with-controlbyweb-devices.md b/docs/brand-guides/get-started-with-controlbyweb-devices.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/get-started-with-controlbyweb-devices.md rename to docs/brand-guides/get-started-with-controlbyweb-devices.md diff --git a/docs/guides/device-and-system-integration-guides/get-started-with-ecobee-thermostats.md b/docs/brand-guides/get-started-with-ecobee-thermostats.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/get-started-with-ecobee-thermostats.md rename to docs/brand-guides/get-started-with-ecobee-thermostats.md diff --git a/docs/guides/device-and-system-integration-guides/get-started-with-kwikset-wifi-locks.md b/docs/brand-guides/get-started-with-kwikset-wifi-locks.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/get-started-with-kwikset-wifi-locks.md rename to docs/brand-guides/get-started-with-kwikset-wifi-locks.md diff --git a/docs/guides/device-and-system-integration-guides/get-started-with-minut-sensors.md b/docs/brand-guides/get-started-with-minut-sensors.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/get-started-with-minut-sensors.md rename to docs/brand-guides/get-started-with-minut-sensors.md diff --git a/docs/guides/device-and-system-integration-guides/get-started-with-noiseaware-sensors.md b/docs/brand-guides/get-started-with-noiseaware-sensors.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/get-started-with-noiseaware-sensors.md rename to docs/brand-guides/get-started-with-noiseaware-sensors.md diff --git a/docs/guides/device-and-system-integration-guides/get-started-with-nuki-locks.md b/docs/brand-guides/get-started-with-nuki-locks.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/get-started-with-nuki-locks.md rename to docs/brand-guides/get-started-with-nuki-locks.md diff --git a/docs/guides/device-and-system-integration-guides/get-started-with-salto-locks.md b/docs/brand-guides/get-started-with-salto-locks.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/get-started-with-salto-locks.md rename to docs/brand-guides/get-started-with-salto-locks.md diff --git a/docs/guides/device-and-system-integration-guides/get-started-with-smartlocks-api.md b/docs/brand-guides/get-started-with-smartlocks-api.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/get-started-with-smartlocks-api.md rename to docs/brand-guides/get-started-with-smartlocks-api.md diff --git a/docs/guides/device-and-system-integration-guides/get-started-with-ttlock-devices.md b/docs/brand-guides/get-started-with-ttlock-devices.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/get-started-with-ttlock-devices.md rename to docs/brand-guides/get-started-with-ttlock-devices.md diff --git a/docs/guides/device-and-system-integration-guides/get-started-with-wyze-locks.md b/docs/brand-guides/get-started-with-wyze-locks.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/get-started-with-wyze-locks.md rename to docs/brand-guides/get-started-with-wyze-locks.md diff --git a/docs/guides/device-and-system-integration-guides/get-started-with-yale-locks.md b/docs/brand-guides/get-started-with-yale-locks.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/get-started-with-yale-locks.md rename to docs/brand-guides/get-started-with-yale-locks.md diff --git a/docs/guides/device-and-system-integration-guides/google-nest-thermostats/README.md b/docs/brand-guides/google-nest-thermostats/README.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/google-nest-thermostats/README.md rename to docs/brand-guides/google-nest-thermostats/README.md diff --git a/docs/guides/device-and-system-integration-guides/google-nest-thermostats/get-started-with-nest-thermostats.md b/docs/brand-guides/google-nest-thermostats/get-started-with-nest-thermostats.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/google-nest-thermostats/get-started-with-nest-thermostats.md rename to docs/brand-guides/google-nest-thermostats/get-started-with-nest-thermostats.md diff --git a/docs/guides/device-and-system-integration-guides/google-nest-thermostats/obtain-google-nest-device-access-and-commercial-development.md b/docs/brand-guides/google-nest-thermostats/obtain-google-nest-device-access-and-commercial-development.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/google-nest-thermostats/obtain-google-nest-device-access-and-commercial-development.md rename to docs/brand-guides/google-nest-thermostats/obtain-google-nest-device-access-and-commercial-development.md diff --git a/docs/guides/device-and-system-integration-guides/honeywell-thermostats/README.md b/docs/brand-guides/honeywell-thermostats/README.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/honeywell-thermostats/README.md rename to docs/brand-guides/honeywell-thermostats/README.md diff --git a/docs/guides/device-and-system-integration-guides/honeywell-thermostats/get-started-with-honeywell-thermostats.md b/docs/brand-guides/honeywell-thermostats/get-started-with-honeywell-thermostats.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/honeywell-thermostats/get-started-with-honeywell-thermostats.md rename to docs/brand-guides/honeywell-thermostats/get-started-with-honeywell-thermostats.md diff --git a/docs/guides/device-and-system-integration-guides/igloohome-locks/README.md b/docs/brand-guides/igloohome-locks/README.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/igloohome-locks/README.md rename to docs/brand-guides/igloohome-locks/README.md diff --git a/docs/guides/device-and-system-integration-guides/igloohome-locks/creating-igloohome-offline-access-codes.md b/docs/brand-guides/igloohome-locks/creating-igloohome-offline-access-codes.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/igloohome-locks/creating-igloohome-offline-access-codes.md rename to docs/brand-guides/igloohome-locks/creating-igloohome-offline-access-codes.md diff --git a/docs/guides/device-and-system-integration-guides/igloohome-locks/get-started-with-igloo-locks.md b/docs/brand-guides/igloohome-locks/get-started-with-igloo-locks.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/igloohome-locks/get-started-with-igloo-locks.md rename to docs/brand-guides/igloohome-locks/get-started-with-igloo-locks.md diff --git a/docs/guides/device-and-system-integration-guides/igloohome-locks/igloohome-error-and-warning-codes.md b/docs/brand-guides/igloohome-locks/igloohome-error-and-warning-codes.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/igloohome-locks/igloohome-error-and-warning-codes.md rename to docs/brand-guides/igloohome-locks/igloohome-error-and-warning-codes.md diff --git a/docs/guides/device-and-system-integration-guides/keynest-key-lockers/README.md b/docs/brand-guides/keynest-key-lockers/README.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/keynest-key-lockers/README.md rename to docs/brand-guides/keynest-key-lockers/README.md diff --git a/docs/guides/device-and-system-integration-guides/keynest-key-lockers/keynest-setup-instructions.md b/docs/brand-guides/keynest-key-lockers/keynest-setup-instructions.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/keynest-key-lockers/keynest-setup-instructions.md rename to docs/brand-guides/keynest-key-lockers/keynest-setup-instructions.md diff --git a/docs/guides/device-and-system-integration-guides/kwikset-locks.md b/docs/brand-guides/kwikset-locks.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/kwikset-locks.md rename to docs/brand-guides/kwikset-locks.md diff --git a/docs/guides/device-and-system-integration-guides/latch-access-control-system/README.md b/docs/brand-guides/latch-access-control-system/README.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/latch-access-control-system/README.md rename to docs/brand-guides/latch-access-control-system/README.md diff --git a/docs/guides/device-and-system-integration-guides/latch-access-control-system/latch-setup-guide.md b/docs/brand-guides/latch-access-control-system/latch-setup-guide.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/latch-access-control-system/latch-setup-guide.md rename to docs/brand-guides/latch-access-control-system/latch-setup-guide.md diff --git a/docs/guides/device-and-system-integration-guides/latch-access-control-system/programming-code-based-latch-credentials.md b/docs/brand-guides/latch-access-control-system/programming-code-based-latch-credentials.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/latch-access-control-system/programming-code-based-latch-credentials.md rename to docs/brand-guides/latch-access-control-system/programming-code-based-latch-credentials.md diff --git a/docs/guides/device-and-system-integration-guides/latch-access-control-system/programming-latch-acs-mobile-credentials.md b/docs/brand-guides/latch-access-control-system/programming-latch-acs-mobile-credentials.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/latch-access-control-system/programming-latch-acs-mobile-credentials.md rename to docs/brand-guides/latch-access-control-system/programming-latch-acs-mobile-credentials.md diff --git a/docs/guides/device-and-system-integration-guides/lockly-locks/README.md b/docs/brand-guides/lockly-locks/README.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/lockly-locks/README.md rename to docs/brand-guides/lockly-locks/README.md diff --git a/docs/guides/device-and-system-integration-guides/lockly-locks/creating-lockly-offline-access-codes.md b/docs/brand-guides/lockly-locks/creating-lockly-offline-access-codes.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/lockly-locks/creating-lockly-offline-access-codes.md rename to docs/brand-guides/lockly-locks/creating-lockly-offline-access-codes.md diff --git a/docs/guides/device-and-system-integration-guides/lockly-locks/lockly-setup-guide.md b/docs/brand-guides/lockly-locks/lockly-setup-guide.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/lockly-locks/lockly-setup-guide.md rename to docs/brand-guides/lockly-locks/lockly-setup-guide.md diff --git a/docs/guides/device-and-system-integration-guides/minut-sensors.md b/docs/brand-guides/minut-sensors.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/minut-sensors.md rename to docs/brand-guides/minut-sensors.md diff --git a/docs/guides/device-and-system-integration-guides/noiseaware-sensors.md b/docs/brand-guides/noiseaware-sensors.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/noiseaware-sensors.md rename to docs/brand-guides/noiseaware-sensors.md diff --git a/docs/guides/device-and-system-integration-guides/nuki-locks.md b/docs/brand-guides/nuki-locks.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/nuki-locks.md rename to docs/brand-guides/nuki-locks.md diff --git a/docs/guides/device-and-system-integration-guides/overview.md b/docs/brand-guides/overview.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/overview.md rename to docs/brand-guides/overview.md diff --git a/docs/guides/device-and-system-integration-guides/pti-storlogix-cloud.md b/docs/brand-guides/pti-storlogix-cloud.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/pti-storlogix-cloud.md rename to docs/brand-guides/pti-storlogix-cloud.md diff --git a/docs/guides/device-and-system-integration-guides/salto-ks-access-control-system/README.md b/docs/brand-guides/salto-ks-access-control-system/README.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/salto-ks-access-control-system/README.md rename to docs/brand-guides/salto-ks-access-control-system/README.md diff --git a/docs/guides/device-and-system-integration-guides/salto-ks-access-control-system/programming-code-based-salto-ks-credentials.md b/docs/brand-guides/salto-ks-access-control-system/programming-code-based-salto-ks-credentials.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/salto-ks-access-control-system/programming-code-based-salto-ks-credentials.md rename to docs/brand-guides/salto-ks-access-control-system/programming-code-based-salto-ks-credentials.md diff --git a/docs/guides/device-and-system-integration-guides/salto-ks-access-control-system/programming-salto-ks-mobile-credentials.md b/docs/brand-guides/salto-ks-access-control-system/programming-salto-ks-mobile-credentials.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/salto-ks-access-control-system/programming-salto-ks-mobile-credentials.md rename to docs/brand-guides/salto-ks-access-control-system/programming-salto-ks-mobile-credentials.md diff --git a/docs/guides/device-and-system-integration-guides/salto-ks-access-control-system/salto-ks-setup-instructions.md b/docs/brand-guides/salto-ks-access-control-system/salto-ks-setup-instructions.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/salto-ks-access-control-system/salto-ks-setup-instructions.md rename to docs/brand-guides/salto-ks-access-control-system/salto-ks-setup-instructions.md diff --git a/docs/guides/device-and-system-integration-guides/salto-ks-access-control-system/special-requirements-for-android-mobile-access-sdk-development.md b/docs/brand-guides/salto-ks-access-control-system/special-requirements-for-android-mobile-access-sdk-development.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/salto-ks-access-control-system/special-requirements-for-android-mobile-access-sdk-development.md rename to docs/brand-guides/salto-ks-access-control-system/special-requirements-for-android-mobile-access-sdk-development.md diff --git a/docs/guides/device-and-system-integration-guides/salto-locks.md b/docs/brand-guides/salto-locks.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/salto-locks.md rename to docs/brand-guides/salto-locks.md diff --git a/docs/guides/device-and-system-integration-guides/salto-proaccess-space-access-system/README.md b/docs/brand-guides/salto-proaccess-space-access-system/README.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/salto-proaccess-space-access-system/README.md rename to docs/brand-guides/salto-proaccess-space-access-system/README.md diff --git a/docs/guides/device-and-system-integration-guides/salto-proaccess-space-access-system/programming-salto-space-card-based-credentials.md b/docs/brand-guides/salto-proaccess-space-access-system/programming-salto-space-card-based-credentials.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/salto-proaccess-space-access-system/programming-salto-space-card-based-credentials.md rename to docs/brand-guides/salto-proaccess-space-access-system/programming-salto-space-card-based-credentials.md diff --git a/docs/guides/device-and-system-integration-guides/salto-proaccess-space-access-system/programming-salto-space-mobile-credentials.md b/docs/brand-guides/salto-proaccess-space-access-system/programming-salto-space-mobile-credentials.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/salto-proaccess-space-access-system/programming-salto-space-mobile-credentials.md rename to docs/brand-guides/salto-proaccess-space-access-system/programming-salto-space-mobile-credentials.md diff --git a/docs/guides/device-and-system-integration-guides/salto-proaccess-space-access-system/salto-space-setup-instructions.md b/docs/brand-guides/salto-proaccess-space-access-system/salto-space-setup-instructions.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/salto-proaccess-space-access-system/salto-space-setup-instructions.md rename to docs/brand-guides/salto-proaccess-space-access-system/salto-space-setup-instructions.md diff --git a/docs/guides/device-and-system-integration-guides/schlage-locks/README.md b/docs/brand-guides/schlage-locks/README.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/schlage-locks/README.md rename to docs/brand-guides/schlage-locks/README.md diff --git a/docs/guides/device-and-system-integration-guides/schlage-locks/get-started-with-schlage-locks.md b/docs/brand-guides/schlage-locks/get-started-with-schlage-locks.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/schlage-locks/get-started-with-schlage-locks.md rename to docs/brand-guides/schlage-locks/get-started-with-schlage-locks.md diff --git a/docs/guides/device-and-system-integration-guides/schlage-locks/schlage-locks-daylight-savings-time-adjustments.md b/docs/brand-guides/schlage-locks/schlage-locks-daylight-savings-time-adjustments.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/schlage-locks/schlage-locks-daylight-savings-time-adjustments.md rename to docs/brand-guides/schlage-locks/schlage-locks-daylight-savings-time-adjustments.md diff --git a/docs/guides/device-and-system-integration-guides/schlage-locks/schlage-locks-setup-instructions.md b/docs/brand-guides/schlage-locks/schlage-locks-setup-instructions.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/schlage-locks/schlage-locks-setup-instructions.md rename to docs/brand-guides/schlage-locks/schlage-locks-setup-instructions.md diff --git a/docs/guides/device-and-system-integration-guides/sensi-thermostats/README.md b/docs/brand-guides/sensi-thermostats/README.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/sensi-thermostats/README.md rename to docs/brand-guides/sensi-thermostats/README.md diff --git a/docs/guides/device-and-system-integration-guides/sensi-thermostats/get-started-with-sensi-thermostats.md b/docs/brand-guides/sensi-thermostats/get-started-with-sensi-thermostats.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/sensi-thermostats/get-started-with-sensi-thermostats.md rename to docs/brand-guides/sensi-thermostats/get-started-with-sensi-thermostats.md diff --git a/docs/guides/device-and-system-integration-guides/smartthings-hubs-+-devices/README.md b/docs/brand-guides/smartthings-hubs-+-devices/README.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/smartthings-hubs-+-devices/README.md rename to docs/brand-guides/smartthings-hubs-+-devices/README.md diff --git a/docs/guides/device-and-system-integration-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md b/docs/brand-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md rename to docs/brand-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md diff --git a/docs/guides/device-and-system-integration-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-thermostats.md b/docs/brand-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-thermostats.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-thermostats.md rename to docs/brand-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-thermostats.md diff --git a/docs/guides/device-and-system-integration-guides/smartthings-hubs-+-smart-locks.md b/docs/brand-guides/smartthings-hubs-+-smart-locks.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/smartthings-hubs-+-smart-locks.md rename to docs/brand-guides/smartthings-hubs-+-smart-locks.md diff --git a/docs/guides/device-and-system-integration-guides/tedee-locks/README.md b/docs/brand-guides/tedee-locks/README.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/tedee-locks/README.md rename to docs/brand-guides/tedee-locks/README.md diff --git a/docs/guides/device-and-system-integration-guides/tedee-locks/get-started-with-tedee-locks.md b/docs/brand-guides/tedee-locks/get-started-with-tedee-locks.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/tedee-locks/get-started-with-tedee-locks.md rename to docs/brand-guides/tedee-locks/get-started-with-tedee-locks.md diff --git a/docs/guides/device-and-system-integration-guides/ttlock-locks.md b/docs/brand-guides/ttlock-locks.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/ttlock-locks.md rename to docs/brand-guides/ttlock-locks.md diff --git a/docs/guides/device-and-system-integration-guides/ultraloq-locks/README.md b/docs/brand-guides/ultraloq-locks/README.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/ultraloq-locks/README.md rename to docs/brand-guides/ultraloq-locks/README.md diff --git a/docs/guides/device-and-system-integration-guides/ultraloq-locks/configuring-ultraloq-device-timezones.md b/docs/brand-guides/ultraloq-locks/configuring-ultraloq-device-timezones.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/ultraloq-locks/configuring-ultraloq-device-timezones.md rename to docs/brand-guides/ultraloq-locks/configuring-ultraloq-device-timezones.md diff --git a/docs/guides/device-and-system-integration-guides/ultraloq-locks/creating-ultraloq-access-codes.md b/docs/brand-guides/ultraloq-locks/creating-ultraloq-access-codes.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/ultraloq-locks/creating-ultraloq-access-codes.md rename to docs/brand-guides/ultraloq-locks/creating-ultraloq-access-codes.md diff --git a/docs/guides/device-and-system-integration-guides/ultraloq-locks/ultraloq-setup-guide.md b/docs/brand-guides/ultraloq-locks/ultraloq-setup-guide.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/ultraloq-locks/ultraloq-setup-guide.md rename to docs/brand-guides/ultraloq-locks/ultraloq-setup-guide.md diff --git a/docs/guides/device-and-system-integration-guides/wyze-locks.md b/docs/brand-guides/wyze-locks.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/wyze-locks.md rename to docs/brand-guides/wyze-locks.md diff --git a/docs/guides/device-and-system-integration-guides/yale-locks.md b/docs/brand-guides/yale-locks.md similarity index 100% rename from docs/guides/device-and-system-integration-guides/yale-locks.md rename to docs/brand-guides/yale-locks.md From c55fa681e113fdb948524b0c453f3105bbcc8273 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Louis=20Pr=C3=A9?= Date: Tue, 21 Apr 2026 20:28:36 -0700 Subject: [PATCH 2/8] Update both SUMMARY.md files and remove duplicate overview.md Add content entries to brand-guides SUMMARY.md. Remove the Device and System Integration Guides section from guides SUMMARY.md. Delete overview.md (content already in README.md). Co-Authored-By: Claude Opus 4.6 (1M context) --- docs/brand-guides/SUMMARY.md | 146 +++++++++++++++++++++++++++++++++ docs/brand-guides/overview.md | 47 ----------- docs/guides/SUMMARY.md | 150 ---------------------------------- 3 files changed, 146 insertions(+), 197 deletions(-) delete mode 100644 docs/brand-guides/overview.md diff --git a/docs/brand-guides/SUMMARY.md b/docs/brand-guides/SUMMARY.md index 2633551d3..faecdef26 100644 --- a/docs/brand-guides/SUMMARY.md +++ b/docs/brand-guides/SUMMARY.md @@ -1,3 +1,149 @@ # Brand Guides * [Brand Guides](README.md) +* [2N Intercom Systems](2n-intercom-systems/README.md) + * [2N System Set Up Instructions](2n-intercom-systems/2n-system-set-up-instructions.md) + * [Get started with 2N Intercoms](2n-intercom-systems/get-started-with-2n-intercoms.md) +* [33 Lock Devices](33-lock-devices/README.md) + * [Get started with 33 Lock devices](33-lock-devices/get-started-with-33-lock-devices.md) +* [4SUITES Locks](4suites-locks/README.md) + * [Get started with 4SUITES locks](4suites-locks/get-started-with-4suites-locks.md) +* [Akiles Locks](akiles-locks/README.md) + * [Get started with Akiles locks](akiles-locks/get-started-with-akiles-locks.md) +* [ASSA ABLOY Vingcard Credential Services](assa-abloy-vingcard-credential-services.md) +* [ASSA ABLOY Visionline Access Control System](assa-abloy-visionline-access-control-system/README.md) + * [Visionline ACS Setup Instructions](assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/README.md) + * [Instructions for issuing Visionline Instant Keys](assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/instructions-for-issuing-visionline-instant-keys.md) + * [Instructions for Your Visionline Plastic Card Encoding App](assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/README.md) + * [Developing Your Visionline Plastic Card Encoding App Using a Real Visionline Server](assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/README.md) + * [Step 1: Install Your Visionline Application](assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-1-install-your-visionline-application.md) + * [Step 2: Unblock Required Ports](assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-2-unblock-required-ports.md) + * [Step 3: Configure a Visionline User Account](assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-3-configure-a-visionline-user-account.md) + * [Step 4: Install a Visionline Card Encoder](assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-4-install-a-visionline-card-encoder.md) + * [Step 5: Set up Door Locks](assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-5-set-up-door-locks.md) + * [Step 6: Program Door Locks](assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-6-program-door-locks.md) + * [Step 7: Create a Production Workspace](assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-7-create-a-production-workspace.md) + * [Step 8: Connect Your Visionline Development Account to Seam](assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-8-connect-your-visionline-development-account-to-seam.md) + * [Next Steps](assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/next-steps.md) + * [Developing Your Visionline Plastic Card Encoding App Using a Sandbox Workspace](assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/README.md) + * [Step 1: Create a Sandbox Workspace](assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/step-1-create-a-sandbox-workspace.md) + * [Step 2: Connect the Virtual Visionline ACS to Seam](assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/step-2-connect-the-virtual-visionline-acs-to-seam.md) + * [Next Steps](assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/next-steps.md) + * [Launching Your Visionline Plastic Card Encoding App to a Live Site](assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/README.md) + * [Step 1: Confirm That Your Visionline Site Meets the Requirements](assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-1-confirm-that-your-visionline-site-meets-the-requirements.md) + * [Step 2: Configure a Visionline User Account](assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-2-configure-a-visionline-user-account.md) + * [Step 3: Purchase and Import the Callback Option from ASSA ABLOY](assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-3-purchase-and-import-the-callback-option-from-assa-abloy.md) + * [Step 4: Create a Production Workspace](assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-4-create-a-production-workspace.md) + * [Step 5: Connect Your Visionline Production Account to Seam](assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-5-connect-your-visionline-production-account-to-seam.md) + * [Instructions for Your Visionline Mobile Key App](assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/README.md) + * [Developing Your Visionline Mobile Key App](assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/README.md) + * [Step 1: Complete the ASSA ABLOY Mobile Development Course](assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-1-complete-the-assa-abloy-mobile-development-course.md) + * [Step 2: Install Your Visionline Application](assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-2-install-your-visionline-application.md) + * [Step 3: Unblock Required Ports](assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-3-unblock-required-ports.md) + * [Step 4: Configure a Visionline User Account](assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-4-configure-a-visionline-user-account.md) + * [Step 5: Set up Your Credential Services Account in Visionline](assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-5-set-up-your-credential-services-account-in-visionline.md) + * [Step 6: Configure the Mobile Access UUID in Visionline](assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-6-configure-the-mobile-access-uuid-in-visionline.md) + * [Step 7: Set up Door Locks with BLE Profiles](assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-7-set-up-door-locks-with-ble-profiles.md) + * [Step 8: Program Door Locks](assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-8-program-door-locks.md) + * [Step 9: Create a Production Workspace](assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-9-create-a-production-workspace.md) + * [Step 10: Connect Your Visionline Development Account to Seam](assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-10-connect-your-visionline-development-account-to-seam.md) + * [Next Steps](assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/next-steps.md) + * [Launching Your Visionline Mobile Key App](assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/README.md) + * [Step 1: Obtain ASSA ABLOY Certification for Your Mobile Key App](assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-1-obtain-assa-abloy-certification-for-your-mobile-key-app.md) + * [Step 2: Confirm That Your Visionline Site Meets the Requirements](assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-2-confirm-that-your-visionline-site-meets-the-requirements.md) + * [Step 3: Confirm BLE Module on All Locks](assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-3-confirm-ble-module-on-all-locks.md) + * [Step 4: Set up Door Locks with BLE Profiles](assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-4-set-up-door-locks-with-ble-profiles.md) + * [Step 5: Program Door Locks](assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-5-program-door-locks.md) + * [Step 6: Configure a Visionline User Account](assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-6-configure-a-visionline-user-account.md) + * [Step 7: Purchase and Import the Callback and Mobile Service Options from ASSA ABLOY](assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-7-purchase-and-import-the-callback-and-mobile-service-options-from-assa-abloy.md) + * [Step 8: Create a Production Workspace](assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-8-create-a-production-workspace.md) + * [Step 9: Connect Your Visionline Production Account to Seam](assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-9-connect-your-visionline-production-account-to-seam.md) + * [Configuring Visionline Mobile Credentials](assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/README.md) + * [Issuing Various Types of Guest Mobile Credentials](assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/issuing-various-types-of-guest-mobile-credentials.md) + * [Issuing Various Types of Guest Joiner Mobile Credentials](assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/issuing-various-types-of-guest-joiner-mobile-credentials.md) + * [Retrieving Guest and Common Entrances](assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/retrieving-guest-and-common-entrances.md) + * [Checking if a User Identity Has a Phone That Is Set up for a Credential Manager](assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/checking-if-a-user-identity-has-a-phone-that-is-set-up-for-a-credential-manager.md) + * [Updating Guest Mobile Credentials](assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/updating-guest-mobile-credentials.md) + * [Revoking Mobile Credentials](assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/revoking-mobile-credentials.md) + * [Mobile Credential-Related Properties](assa-abloy-visionline-access-control-system/mobile-credential-related-properties.md) + * [Common Use Cases](assa-abloy-visionline-access-control-system/common-use-cases.md) + * [Special Requirements for Android Mobile Access SDK Development](assa-abloy-visionline-access-control-system/special-requirements-for-android-mobile-access-sdk-development.md) + * [Special Requirements for iOS Mobile Access SDK Development](assa-abloy-visionline-access-control-system/special-requirements-for-ios-mobile-access-sdk-development.md) + * [Creating Visionline Card-based Credentials](assa-abloy-visionline-access-control-system/creating-visionline-card-based-credentials.md) +* [August Locks](august-locks.md) + * [Get started with August locks](get-started-with-august-locks.md) +* [Avigilon Alta Access System](avigilon-alta-access-system.md) +* [Brivo Access](brivo-access/README.md) + * [Brivo Access Setup Guide](brivo-access/brivo-access-setup-guide.md) +* [Get started with ControlByWeb Devices](get-started-with-controlbyweb-devices.md) +* [Dormakaba Ambiance Access Control System](dormakaba-ambiance-access-control-system/README.md) + * [Dormakaba Ambiance Setup Guide](dormakaba-ambiance-access-control-system/dormakaba-ambiance-setup-guide.md) +* [Dormakaba Community Access Control System](dormakaba-community-access-control-system/README.md) + * [Dormakaba Community Setup Guide](dormakaba-community-access-control-system/dormakaba-community-setup-guide.md) +* [Dormakaba Oracode Locks](dormakaba-oracode-locks/README.md) + * [Get started with dormakaba Oracode Locks](dormakaba-oracode-locks/get-started-with-dormakaba-oracode-locks.md) + * [Creating dormakaba Oracode Offline Access Codes](dormakaba-oracode-locks/creating-dormakaba-oracode-offline-access-codes.md) + * [Programming Offline Access Codes on Dormakaba Oracode Locks](dormakaba-oracode-locks/programming-offline-access-codes-on-dormakaba-oracode-locks.md) + * [Dormakaba Oracode Setup Guide](dormakaba-oracode-locks/dormakaba-oracode-setup-guide.md) +* [ecobee Thermostats](ecobee-thermostats.md) + * [Get Started with ecobee Thermostats](get-started-with-ecobee-thermostats.md) +* [Google Nest Thermostats](google-nest-thermostats/README.md) + * [Get Started with Nest Thermostats](google-nest-thermostats/get-started-with-nest-thermostats.md) + * [Obtain Google Nest Device Access and Commercial Development](google-nest-thermostats/obtain-google-nest-device-access-and-commercial-development.md) +* [Honeywell Resideo Thermostats](honeywell-thermostats/README.md) + * [Get Started with Honeywell Resideo Thermostats](honeywell-thermostats/get-started-with-honeywell-thermostats.md) +* [igloohome Locks](igloohome-locks/README.md) + * [IglooHome Error and Warning Codes](igloohome-locks/igloohome-error-and-warning-codes.md) + * [Creating igloohome Offline Access Codes](igloohome-locks/creating-igloohome-offline-access-codes.md) + * [Get started with igloohome Locks](igloohome-locks/get-started-with-igloo-locks.md) +* [Keynest Key Lockers](keynest-key-lockers/README.md) + * [Keynest Setup Instructions](keynest-key-lockers/keynest-setup-instructions.md) +* [Kwikset Locks](kwikset-locks.md) + * [Get started with Kwikset Wi-Fi Locks](get-started-with-kwikset-wifi-locks.md) +* [Latch Access Control System](latch-access-control-system/README.md) + * [Latch Setup Guide](latch-access-control-system/latch-setup-guide.md) + * [Programming Code-Based Latch Credentials](latch-access-control-system/programming-code-based-latch-credentials.md) + * [Programming Latch ACS Mobile Credentials](latch-access-control-system/programming-latch-acs-mobile-credentials.md) +* [Lockly Locks](lockly-locks/README.md) + * [Lockly Setup Guide](lockly-locks/lockly-setup-guide.md) + * [Creating Lockly Offline Access Codes](lockly-locks/creating-lockly-offline-access-codes.md) +* [Minut Sensors](minut-sensors.md) + * [Get started with Minut Sensors](get-started-with-minut-sensors.md) +* [NoiseAware Sensors](noiseaware-sensors.md) + * [Get started with NoiseAware Sensors](get-started-with-noiseaware-sensors.md) +* [Nuki Locks](nuki-locks.md) + * [Get Started with Nuki Locks](get-started-with-nuki-locks.md) +* [PTI Storlogix Cloud](pti-storlogix-cloud.md) +* [Salto KS Access Control System](salto-ks-access-control-system/README.md) + * [Salto KS Setup Instructions](salto-ks-access-control-system/salto-ks-setup-instructions.md) + * [Programming Salto KS PIN Code Credentials](salto-ks-access-control-system/programming-code-based-salto-ks-credentials.md) + * [Programming Salto KS Mobile Credentials](salto-ks-access-control-system/programming-salto-ks-mobile-credentials.md) + * [Special Requirements for Android Mobile Access SDK Development](salto-ks-access-control-system/special-requirements-for-android-mobile-access-sdk-development.md) +* [Salto KS Locks](salto-locks.md) + * [Get started with Salto KS Locks](get-started-with-salto-locks.md) +* [Salto ProAccess Space Access System](salto-proaccess-space-access-system/README.md) + * [Salto Space Setup Instructions](salto-proaccess-space-access-system/salto-space-setup-instructions.md) + * [Programming Salto Space Card-based Credentials](salto-proaccess-space-access-system/programming-salto-space-card-based-credentials.md) + * [Programming Salto Space Mobile Credentials](salto-proaccess-space-access-system/programming-salto-space-mobile-credentials.md) +* [Schlage Locks](schlage-locks/README.md) + * [Schlage Locks Setup Instructions](schlage-locks/schlage-locks-setup-instructions.md) + * [Get started with Schlage Locks](schlage-locks/get-started-with-schlage-locks.md) + * [Schlage Locks - Daylight Savings time adjustments](schlage-locks/schlage-locks-daylight-savings-time-adjustments.md) +* [Sensi Thermostats](sensi-thermostats/README.md) + * [Get Started with Sensi Thermostats](sensi-thermostats/get-started-with-sensi-thermostats.md) +* [SmartThings Hubs + Devices](smartthings-hubs-+-devices/README.md) + * [Get Started with SmartThings Hubs + Smart Locks](smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md) + * [Get Started with SmartThings Hubs + Thermostats](smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-thermostats.md) +* [Tedee Locks](tedee-locks/README.md) + * [Get Started with Tedee Locks](tedee-locks/get-started-with-tedee-locks.md) +* [TTLock Locks](ttlock-locks.md) + * [Get started with TTLock Locks](get-started-with-ttlock-devices.md) +* [Ultraloq Locks](ultraloq-locks/README.md) + * [Ultraloq Setup Guide](ultraloq-locks/ultraloq-setup-guide.md) + * [Configuring Ultraloq Device Timezones](ultraloq-locks/configuring-ultraloq-device-timezones.md) + * [Creating Ultraloq Access Codes](ultraloq-locks/creating-ultraloq-access-codes.md) +* [Wyze Locks](wyze-locks.md) + * [Get started with Wyze Locks](get-started-with-wyze-locks.md) +* [Yale Locks](yale-locks.md) + * [Get started with Yale Locks](get-started-with-yale-locks.md) +* [Get started with Smart Locks](get-started-with-smartlocks-api.md) diff --git a/docs/brand-guides/overview.md b/docs/brand-guides/overview.md deleted file mode 100644 index 71dcf3a26..000000000 --- a/docs/brand-guides/overview.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -description: >- - Learn about all the manufacturers, devices, and systems that you can control - with the Seam API, including how to set up your connections and any - manufacturer-specific requirements or restrictions. ---- - -# Overview - -Seam enables you to control a wide variety of devices and systems, from different manufacturers, using the universal Seam API. This section provides a set of device and system integration guides that show you which devices Seam supports from each manufacturer, explain how to set up these devices and systems, and provide any manufacturer-specific requirements or restrictions. - -To find the integration guide for each of your devices or systems, see the following categories: - -* [Smart locks](overview.md#smart-locks) -* [Access control systems](overview.md#access-control-systems) -* [Thermostats](overview.md#thermostats) -* [Noise sensors](overview.md#noise-sensors) - -*** - -## Smart Locks - -
2N Intercom Systems2n-logo.png2n-intercom-systems.md
33 Lock Devices33-lock-logo.png33-lock-devices
4SUITES Locks4suites-logo.png4suites-locks
Akiles Locksakiles-logo.pngakiles-locks
August Locksaugust-logo.pngaugust-locks.md
dormakaba Oracode Locksdormakaba-logo.pngdormakaba-oracode-locks.md
iglooHome Locksigloohome-logo.pngigloohome-locks.md
Kwikset Lockskwikset-logo.pngkwikset-locks.md
Lockly Lockslockly-logo.pnglockly-locks
Nuki Locksnuki-logo.pngnuki-locks.md
Salto KS Lockssalto-logo.pngsalto-locks.md
Schlage Locksschlage-logo.pngget-started-with-schlage-locks.md
SmartThings Hubs + Smart Lockssmartthings-logo.pngsmartthings-hubs-+-devices
Tedee Lockstedee-logo.pngtedee-locks
TTLock Locksttlock-logo.pngttlock-locks.md
Wyze Lockswyze-logo.pngwyze-locks.md
Yale Locksyale-logo.pngyale-locks.md
- -*** - -## Access Control Systems - -
ASSA ABLOY Credential Servicesassa-abloy-logo.pngBroken link
ASSA ABLOY Visionline Access Control Systemassa-abloy-logo.pngassa-abloy-visionline-access-control-system
Avigilon Alta Access Systemavigilon-alta-logo.pngavigilon-alta-access-system.md
Brivo Accessbrivo-logo.pngbrivo-access
Latch Access Control Systemlatch-logo.pnglatch-access-control-system
PTI Storlogix Cloudpti-logo.pngpti-storlogix-cloud.md
Salto KS Access Control Systemsalto-ks-logo.pngsalto-ks-access-control-system
Salto ProAccess Space Access Systemsalto-space-logo.pngsalto-proaccess-space-access-system
- -*** - -## Thermostats - -
ecobee Thermostatsecobee-logo.pngecobee-thermostats.md
Google Nest Thermostatsnest-logo.pnggoogle-nest-thermostats
Honeywell Resideo Thermostatshoneywell-logo.pnghoneywell-thermostats
Sensi Thermostatssensi-logo.pngsensi-thermostats
SmartThings Hubs + Thermostatssmartthings-logo.pngsmartthings-hubs-+-devices
- -*** - -## Noise sensors - -
Minut Sensorsminut-logo.pngminut-sensors.md
NoiseAware Sensorsnoiseaware-logo.pngnoiseaware-sensors.md
- -*** - -## Relays - -
ControlByWeb Relayscontrolbyweb-logo.pngget-started-with-controlbyweb-devices.md
diff --git a/docs/guides/SUMMARY.md b/docs/guides/SUMMARY.md index 78ca7e622..cb7899293 100644 --- a/docs/guides/SUMMARY.md +++ b/docs/guides/SUMMARY.md @@ -223,156 +223,6 @@ * [Granting Access Using Encoded Plastic Key Cards](industry-guides/hospitality-industry-guide/granting-access-using-encoded-plastic-key-cards.md) * [Additional Guest Access Actions](industry-guides/hospitality-industry-guide/additional-guest-access-actions.md) -## Device and System Integration Guides - -* [Overview](device-and-system-integration-guides/overview.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-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) - * [Get started with 4SUITES locks](device-and-system-integration-guides/4suites-locks/get-started-with-4suites-locks.md) -* [Akiles Locks](device-and-system-integration-guides/akiles-locks/README.md) - * [Get started with Akiles locks](device-and-system-integration-guides/akiles-locks/get-started-with-akiles-locks.md) -* [ASSA ABLOY Vingcard Credential Services](device-and-system-integration-guides/assa-abloy-vingcard-credential-services.md) -* [ASSA ABLOY Visionline Access Control System](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/README.md) - * [Visionline ACS Setup Instructions](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/README.md) - * [Instructions for issuing Visionline Instant Keys](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/instructions-for-issuing-visionline-instant-keys.md) - * [Instructions for Your Visionline Plastic Card Encoding App](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/README.md) - * [Developing Your Visionline Plastic Card Encoding App Using a Real Visionline Server](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/README.md) - * [Step 1: Install Your Visionline Application](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-1-install-your-visionline-application.md) - * [Step 2: Unblock Required Ports](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-2-unblock-required-ports.md) - * [Step 3: Configure a Visionline User Account](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-3-configure-a-visionline-user-account.md) - * [Step 4: Install a Visionline Card Encoder](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-4-install-a-visionline-card-encoder.md) - * [Step 5: Set up Door Locks](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-5-set-up-door-locks.md) - * [Step 6: Program Door Locks](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-6-program-door-locks.md) - * [Step 7: Create a Production Workspace](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-7-create-a-production-workspace.md) - * [Step 8: Connect Your Visionline Development Account to Seam](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-8-connect-your-visionline-development-account-to-seam.md) - * [Next Steps](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/next-steps.md) - * [Developing Your Visionline Plastic Card Encoding App Using a Sandbox Workspace](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/README.md) - * [Step 1: Create a Sandbox Workspace](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/step-1-create-a-sandbox-workspace.md) - * [Step 2: Connect the Virtual Visionline ACS to Seam](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/step-2-connect-the-virtual-visionline-acs-to-seam.md) - * [Next Steps](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/next-steps.md) - * [Launching Your Visionline Plastic Card Encoding App to a Live Site](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/README.md) - * [Step 1: Confirm That Your Visionline Site Meets the Requirements](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-1-confirm-that-your-visionline-site-meets-the-requirements.md) - * [Step 2: Configure a Visionline User Account](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-2-configure-a-visionline-user-account.md) - * [Step 3: Purchase and Import the Callback Option from ASSA ABLOY](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-3-purchase-and-import-the-callback-option-from-assa-abloy.md) - * [Step 4: Create a Production Workspace](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-4-create-a-production-workspace.md) - * [Step 5: Connect Your Visionline Production Account to Seam](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-5-connect-your-visionline-production-account-to-seam.md) - * [Instructions for Your Visionline Mobile Key App](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/README.md) - * [Developing Your Visionline Mobile Key App](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/README.md) - * [Step 1: Complete the ASSA ABLOY Mobile Development Course](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-1-complete-the-assa-abloy-mobile-development-course.md) - * [Step 2: Install Your Visionline Application](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-2-install-your-visionline-application.md) - * [Step 3: Unblock Required Ports](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-3-unblock-required-ports.md) - * [Step 4: Configure a Visionline User Account](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-4-configure-a-visionline-user-account.md) - * [Step 5: Set up Your Credential Services Account in Visionline](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-5-set-up-your-credential-services-account-in-visionline.md) - * [Step 6: Configure the Mobile Access UUID in Visionline](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-6-configure-the-mobile-access-uuid-in-visionline.md) - * [Step 7: Set up Door Locks with BLE Profiles](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-7-set-up-door-locks-with-ble-profiles.md) - * [Step 8: Program Door Locks](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-8-program-door-locks.md) - * [Step 9: Create a Production Workspace](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-9-create-a-production-workspace.md) - * [Step 10: Connect Your Visionline Development Account to Seam](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-10-connect-your-visionline-development-account-to-seam.md) - * [Next Steps](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/next-steps.md) - * [Launching Your Visionline Mobile Key App](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/README.md) - * [Step 1: Obtain ASSA ABLOY Certification for Your Mobile Key App](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-1-obtain-assa-abloy-certification-for-your-mobile-key-app.md) - * [Step 2: Confirm That Your Visionline Site Meets the Requirements](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-2-confirm-that-your-visionline-site-meets-the-requirements.md) - * [Step 3: Confirm BLE Module on All Locks](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-3-confirm-ble-module-on-all-locks.md) - * [Step 4: Set up Door Locks with BLE Profiles](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-4-set-up-door-locks-with-ble-profiles.md) - * [Step 5: Program Door Locks](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-5-program-door-locks.md) - * [Step 6: Configure a Visionline User Account](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-6-configure-a-visionline-user-account.md) - * [Step 7: Purchase and Import the Callback and Mobile Service Options from ASSA ABLOY](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-7-purchase-and-import-the-callback-and-mobile-service-options-from-assa-abloy.md) - * [Step 8: Create a Production Workspace](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-8-create-a-production-workspace.md) - * [Step 9: Connect Your Visionline Production Account to Seam](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-9-connect-your-visionline-production-account-to-seam.md) - * [Configuring Visionline Mobile Credentials](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/README.md) - * [Issuing Various Types of Guest Mobile Credentials](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/issuing-various-types-of-guest-mobile-credentials.md) - * [Issuing Various Types of Guest Joiner Mobile Credentials](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/issuing-various-types-of-guest-joiner-mobile-credentials.md) - * [Retrieving Guest and Common Entrances](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/retrieving-guest-and-common-entrances.md) - * [Checking if a User Identity Has a Phone That Is Set up for a Credential Manager](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/checking-if-a-user-identity-has-a-phone-that-is-set-up-for-a-credential-manager.md) - * [Updating Guest Mobile Credentials](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/updating-guest-mobile-credentials.md) - * [Revoking Mobile Credentials](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/revoking-mobile-credentials.md) - * [Mobile Credential-Related Properties](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/mobile-credential-related-properties.md) - * [Common Use Cases](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/common-use-cases.md) - * [Special Requirements for Android Mobile Access SDK Development](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/special-requirements-for-android-mobile-access-sdk-development.md) - * [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-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-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-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-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-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-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-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-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) - * [Programming Latch ACS Mobile Credentials](device-and-system-integration-guides/latch-access-control-system/programming-latch-acs-mobile-credentials.md) -* [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-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-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-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-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-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-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-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 * [Building a Seam-Compatible Smart Lock API](device-manufacturer-guidance/building-a-seam-compatible-smart-lock-api/README.md) From 99a01800fe63aa37155e76b1389d9cd3b0a40416 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Louis=20Pr=C3=A9?= Date: Tue, 21 Apr 2026 20:28:56 -0700 Subject: [PATCH 3/8] Move brand-only assets to docs/brand-guides/.gitbook/assets/ Move 228 assets referenced only from brand-guides. Shared assets (29) remain in docs/guides/.gitbook/assets/. Co-Authored-By: Claude Opus 4.6 (1M context) --- .../.gitbook/assets/2n-logo.png | Bin .../.gitbook/assets/33-lock-logo.png | Bin .../assets/33-lock_connect-flow-screens_dark.png | Bin .../assets/33-lock_connect-flow-screens_light.png | Bin .../assets/33lock-manufacturer-page-cover-dark.png | Bin .../assets/33lock-manufacturer-page-cover-light.png | Bin .../.gitbook/assets/4suites-logo.png | Bin .../assets/4suites_connect-flow-screens_dark.png | Bin .../assets/4suites_connect-flow-screens_light.png | Bin .../assets/4suites_get-started-cover_dark.png | Bin .../assets/4suites_get-started-cover_light.png | Bin ...13 142-8 Installation instruction Visionline.pdf | Bin .../.gitbook/assets/Join only.png | Bin ...eenshot 2025-09-28 at 5.22.31\342\200\257PM.png" | Bin ...eenshot 2025-09-28 at 5.44.01\342\200\257PM.png" | Bin ...enshot 2025-10-31 at 11.36.44\342\200\257AM.png" | Bin ...eenshot 2025-10-31 at 4.56.29\342\200\257PM.png" | Bin ...eenshot 2025-10-31 at 5.43.46\342\200\257PM.png" | Bin ...eenshot 2025-10-31 at 5.46.00\342\200\257PM.png" | Bin ...hot 2025-10-31 at 9.44.42\342\200\257AM (1).png" | Bin ...eenshot 2025-10-31 at 9.45.19\342\200\257AM.png" | Bin ...enshot 2025-11-12 at 12.06.09\342\200\257AM.png" | Bin ...ine Server Client and DCOM Port Requirements.pdf | Bin .../access-systems-tab-production-workspace.png | Bin .../.gitbook/assets/acs-access-group_dark.png | Bin .../.gitbook/assets/acs-credential_dark.png | Bin .../.gitbook/assets/acs-entrance_dark.png | Bin .../acs-quick-start-access-systems-tab (1).png | Bin .../.gitbook/assets/acs-schedule_dark.png | Bin .../.gitbook/assets/acs-schedule_light.png | Bin .../.gitbook/assets/acs-user_dark.png | Bin .../.gitbook/assets/add-devices-button.png | Bin .../.gitbook/assets/akiles-logo.png | Bin .../assets/akiles-manufacturer-page-cover-dark.png | Bin .../assets/akiles-manufacturer-page-cover-light.png | Bin .../assets/akiles_connect-flow-screens_dark.png | Bin .../assets/akiles_connect-flow-screens_light.png | Bin .../.gitbook/assets/ambiance.png | Bin .../assa-abloy-accounts-account-list-menu-item.png | Bin .../.gitbook/assets/assa-abloy-logo.png | Bin .../.gitbook/assets/assa-abloy-settings.png | Bin .../assets/august_connect-flow-screens_dark.png | Bin .../assets/august_connect-flow-screens_light.png | Bin .../assets/august_get-started-cover_dark.png | Bin .../assets/august_get-started-cover_light.png | Bin .../.gitbook/assets/avigilon-alta-acs-devices.png | Bin .../.gitbook/assets/avigilon-alta-logo.png | Bin .../assets/avigilon-alta-user-permissions.png | Bin .../.gitbook/assets/brivo api key.webp | Bin .../.gitbook/assets/brivo api tier.png | Bin .../.gitbook/assets/brivo device brand.webp | Bin .../.gitbook/assets/brivo login.png | Bin .../.gitbook/assets/brivo username.png | Bin .../.gitbook/assets/brivo-logo.png | Bin .../assets/connect-flow-screens (1) (1).png | Bin .../assets/connect-flow-screens (2) (1).png | Bin ...ew-assa-abloy-credential-service-credentials.png | Bin .../.gitbook/assets/contact-pti-sales.png | Bin .../.gitbook/assets/controlbyweb-logo.png | Bin .../.gitbook/assets/d2d0a-yd-accesskit_ya_enc1.jpg | Bin .../.gitbook/assets/dk comm (1).png | Bin .../.gitbook/assets/dormakaba-logo.png | Bin .../dormakaba-oracode_connect-flow-screens.png | Bin .../.gitbook/assets/download.png | Bin .../assets/ecobee-manufacturer-page-cover-dark.png | Bin .../assets/ecobee-manufacturer-page-cover-light.png | Bin .../assets/ecobee_connect-flow-screens_dark.png | Bin .../assets/ecobee_connect-flow-screens_light.png | Bin .../.gitbook/assets/gokeyless-logo.png | Bin ...gle-add-your-oauth-client-id-page-learn-more.png | Bin .../assets/google-add-your-oauth-client-id-page.png | Bin .../assets/google-authorize-an-account-page.png | Bin ...y-smart-device-management-api-search-results.png | Bin .../google-cloud-api-library-welcome-page.png | Bin .../assets/google-cloud-create-credentials-menu.png | Bin .../google-cloud-create-oauth-client-id-page.png | Bin ...gle-cloud-credentials-application-type-field.png | Bin .../assets/google-cloud-credentials-page.png | Bin .../google-cloud-edit-app-registration-page.png | Bin .../google-cloud-enable-apis-and-services-link.png | Bin .../assets/google-cloud-new-project-page.png | Bin .../google-cloud-oauth-2.0-client-ids-table.png | Bin .../google-cloud-oauth-client-created-dialog.png | Bin .../google-cloud-oauth-consent-screen-page.png | Bin .../google-cloud-select-a-resource-window.png | Bin .../.gitbook/assets/google-cloud-summary-page.png | Bin .../assets/google-cloud-test-users-page.png | Bin .../.gitbook/assets/google-cloud-welcome-dialog.png | Bin .../google-commercial-development-application.png | Bin .../assets/google-create-a-project-events-page.png | Bin ...ogle-device-access-console-project-info-page.png | Bin .../google-device-access-console-welcome-page.png | Bin .../assets/google-device-access-home-page.png | Bin .../assets/google-device-access-project-info.png | Bin .../assets/google-non-disclosure-agreement-page.png | Bin ...le-smart-device-management-api-enable-button.png | Bin .../assets/guides/2n-connect-flow-screens.png | Bin .../guides/controlbyweb-connect-flow-screens.jpg | Bin .../controlbyweb-getting-started-guide-cover.jpg | Bin .../dormakaba-oracode-getting-started-seo-cover.jpg | Bin .../assets/guides/igloo-connect-flow-screens.png | Bin .../assets/guides/kwikset-connect-flow-screens.jpg | Bin .../assets/guides/minut-connect-flow-screens.jpg | Bin .../guides/noiseaware-connect-flow-screens.jpg | Bin .../assets/guides/nuki-connect-flow-screens.jpg | Bin .../guides/smart-lock-connect-flow-screens.png | Bin .../assets/guides/smart-locks-16-9-seam.png | Bin .../assets/guides/wyze-connect-flow-screens.jpg | Bin .../assets/guides/wyze-getting-seo-cover.jpg | Bin .../.gitbook/assets/guides/yale-auth-example.png | Bin .../.gitbook/assets/honeywell-logo.png | Bin .../honeywell-manufacturer-page-cover-dark.png | Bin .../honeywell-manufacturer-page-cover-light.png | Bin .../assets/honeywell_connect-flow-screens_dark.png | Bin .../assets/honeywell_connect-flow-screens_light.png | Bin .../.gitbook/assets/igloohome-logo.png | Bin .../.gitbook/assets/image (29) (1).png | Bin .../.gitbook/assets/image (29).png | Bin .../.gitbook/assets/image (36).png | Bin .../.gitbook/assets/image (40).png | Bin .../.gitbook/assets/image (44).png | Bin .../.gitbook/assets/keynest logo transparent.png | Bin .../.gitbook/assets/kwikset-MFA-settings.png | Bin .../assets/kwikset-halo-halo-touch-on-amazon.jpg | Bin .../.gitbook/assets/kwikset-logo.png | Bin .../.gitbook/assets/latch-acs.png | Bin .../.gitbook/assets/latch-building-id.png | Bin .../.gitbook/assets/latch-logo.png | Bin .../assets/latch-manufacturer-page-cover-dark.png | Bin .../assets/latch-manufacturer-page-cover-light.png | Bin .../lock-service-3g-add-server-connection.png | Bin .../assets/lock-service-3g-confirm-ble-module.png | Bin .../assets/lock-service-3g-download-data.png | Bin .../assets/lock-service-3g-get-system-id.png | Bin .../lock-service-3g-initialize-lock-ble-config.png | Bin .../assets/lock-service-3g-initialize-lock.png | Bin .../.gitbook/assets/lock-service-3g-register-pc.png | Bin .../.gitbook/assets/lock-service-3g-select-port.png | Bin .../assets/lock-service-3g-select-server.png | Bin .../assets/lock-service-3g-upload-firmware.png | Bin .../assets/lock-service-3g-upload-fw-save-to-db.png | Bin .../.gitbook/assets/lockly-logo.png | Bin .../lockly-manufacturer-page-cover-16-9-light.png | Bin .../.gitbook/assets/minut-logo.png | Bin .../.gitbook/assets/nest-developer-settings.png | Bin .../assets/nest-manufacturer-page-cover-dark.png | Bin .../assets/nest-manufacturer-page-cover-light.png | Bin .../assets/nest-oauth-redirect-uri-setup.png | Bin .../.gitbook/assets/nest-on-amazon.png | Bin .../assets/nest_connect-flow-screens_dark.png | Bin .../assets/nest_connect-flow-screens_light.png | Bin .../.gitbook/assets/noiseaware-logo.png | Bin .../.gitbook/assets/nuki-logo.png | Bin .../assets/nuki-manufacturer-page-cover-light.png | Bin ...nnect-short-rental-integrators-dialog-w-link.png | Bin ...nuki-web-select-devices-smart-hosting-dialog.png | Bin .../assets/nuki-web-short-term-rental-page.png | Bin .../.gitbook/assets/openapi (1).json | 0 .../.gitbook/assets/openapi.json | 0 .../.gitbook/assets/oracode-live-site-name.png | Bin .../.gitbook/assets/pti-help-center.png | Bin .../.gitbook/assets/pti-logo.png | Bin .../salto-ks-acs-manufacturer-page-cover-dark.png | Bin .../salto-ks-acs-manufacturer-page-cover-light.png | Bin .../.gitbook/assets/salto-ks-acs.png | Bin .../assets/salto-ks-lock-settings-button.png | Bin .../.gitbook/assets/salto-ks-logo.png | Bin .../salto-ks-manufacturer-page-cover-dark.png | Bin .../salto-ks-manufacturer-page-cover-light.png | Bin .../salto-ks-near-detection-mode-edit-button.png | Bin .../assets/salto-ks_connect-flow-screens_dark.png | Bin .../assets/salto-ks_connect-flow-screens_light.png | Bin .../.gitbook/assets/salto-logo.png | Bin .../.gitbook/assets/salto-space-acs.png | Bin .../.gitbook/assets/salto-space-logo.png | Bin .../salto-space-manufacturer-page-cover-dark.png | Bin .../salto-space-manufacturer-page-cover-light.png | Bin .../.gitbook/assets/salto-space-ship-settings.png | Bin .../.gitbook/assets/schlage-logo.png | Bin .../assets/schlage-manufacturer-page-cover-dark.png | Bin .../schlage-manufacturer-page-cover-light.png | Bin .../.gitbook/assets/schlage-on-amazon.png | Bin .../.gitbook/assets/seam-bridge-pairing-code.png | Bin .../.gitbook/assets/seam-contact-us-light.png | Bin .../.gitbook/assets/select-entrances-for-user.png | Bin .../assets/sensi-manufacturer-page-cover-dark.png | Bin .../assets/sensi-manufacturer-page-cover-light.png | Bin .../assets/sensi_connect-flow-screens_dark.png | Bin .../assets/sensi_connect-flow-screens_light.png | Bin .../.gitbook/assets/setup tile.png | Bin .../.gitbook/assets/smartthings-logo.png | Bin .../smartthings-manufacturer-page-cover-dark.png | Bin .../smartthings-manufacturer-page-cover-light.png | Bin .../smartthings_connect-flow-screens_dark.png | Bin .../smartthings_connect-flow-screens_light.png | Bin .../.gitbook/assets/tedee-connect-flow-screens.png | Bin .../.gitbook/assets/tedee-getting-started-cover.jpg | Bin .../.gitbook/assets/tedee-logo.png | Bin .../assets/tedee-manufacturer-page-cover-dark.png | Bin .../assets/tedee-manufacturer-page-cover-light.png | Bin .../.gitbook/assets/ttlock-logo.png | Bin .../assets/ttlock_connect-flow-screens_dark.png | Bin .../assets/ttlock_connect-flow-screens_light.png | Bin .../assets/ttlock_get-started-cover_dark.png | Bin .../ultraloq-manufacturer-page-cover-light.png | Bin .../assets/visionline-add-common-door-area.png | Bin ...ionline-add-common-entrance-door-ble-profile.png | Bin .../assets/visionline-add-common-entrance-door.png | Bin .../visionline-add-device-for-lock-service-3g.png | Bin .../assets/visionline-add-guest-door-area.png | Bin .../visionline-add-guest-doors-ble-profile.png | Bin .../.gitbook/assets/visionline-add-guest-doors.png | Bin .../.gitbook/assets/visionline-add-operator.png | Bin .../.gitbook/assets/visionline-add-user.png | Bin ...isionline-card-encoder-device-details-window.png | Bin .../visionline-card-encoder-select-s-n-field.png | Bin .../assets/visionline-get-registration-code.png | Bin .../visionline-mobile-access-accout-details.png | Bin .../assets/visionline-select-encoder-window.png | Bin .../.gitbook/assets/visionline-set-mobile-uuid.png | Bin .../.gitbook/assets/workspace-id-for-latch.png | Bin .../.gitbook/assets/wyze-api-docs-cover.png | Bin .../.gitbook/assets/wyze-api-key-example.png | Bin .../.gitbook/assets/wyze-logo.png | Bin ...k-z-wave-plus-network-module-ayr202-zwv-usa.jpeg | Bin .../.gitbook/assets/yale-logo.png | Bin .../.gitbook/assets/yale-on-amazon.png | Bin .../.gitbook/assets/yale-on-gokeyless.png | Bin 228 files changed, 0 insertions(+), 0 deletions(-) rename docs/{guides => brand-guides}/.gitbook/assets/2n-logo.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/33-lock-logo.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/33-lock_connect-flow-screens_dark.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/33-lock_connect-flow-screens_light.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/33lock-manufacturer-page-cover-dark.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/33lock-manufacturer-page-cover-light.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/4suites-logo.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/4suites_connect-flow-screens_dark.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/4suites_connect-flow-screens_light.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/4suites_get-started-cover_dark.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/4suites_get-started-cover_light.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/66 5013 142-8 Installation instruction Visionline.pdf (100%) rename docs/{guides => brand-guides}/.gitbook/assets/Join only.png (100%) rename "docs/guides/.gitbook/assets/Screenshot 2025-09-28 at 5.22.31\342\200\257PM.png" => "docs/brand-guides/.gitbook/assets/Screenshot 2025-09-28 at 5.22.31\342\200\257PM.png" (100%) rename "docs/guides/.gitbook/assets/Screenshot 2025-09-28 at 5.44.01\342\200\257PM.png" => "docs/brand-guides/.gitbook/assets/Screenshot 2025-09-28 at 5.44.01\342\200\257PM.png" (100%) rename "docs/guides/.gitbook/assets/Screenshot 2025-10-31 at 11.36.44\342\200\257AM.png" => "docs/brand-guides/.gitbook/assets/Screenshot 2025-10-31 at 11.36.44\342\200\257AM.png" (100%) rename "docs/guides/.gitbook/assets/Screenshot 2025-10-31 at 4.56.29\342\200\257PM.png" => "docs/brand-guides/.gitbook/assets/Screenshot 2025-10-31 at 4.56.29\342\200\257PM.png" (100%) rename "docs/guides/.gitbook/assets/Screenshot 2025-10-31 at 5.43.46\342\200\257PM.png" => "docs/brand-guides/.gitbook/assets/Screenshot 2025-10-31 at 5.43.46\342\200\257PM.png" (100%) rename "docs/guides/.gitbook/assets/Screenshot 2025-10-31 at 5.46.00\342\200\257PM.png" => "docs/brand-guides/.gitbook/assets/Screenshot 2025-10-31 at 5.46.00\342\200\257PM.png" (100%) rename "docs/guides/.gitbook/assets/Screenshot 2025-10-31 at 9.44.42\342\200\257AM (1).png" => "docs/brand-guides/.gitbook/assets/Screenshot 2025-10-31 at 9.44.42\342\200\257AM (1).png" (100%) rename "docs/guides/.gitbook/assets/Screenshot 2025-10-31 at 9.45.19\342\200\257AM.png" => "docs/brand-guides/.gitbook/assets/Screenshot 2025-10-31 at 9.45.19\342\200\257AM.png" (100%) rename "docs/guides/.gitbook/assets/Screenshot 2025-11-12 at 12.06.09\342\200\257AM.png" => "docs/brand-guides/.gitbook/assets/Screenshot 2025-11-12 at 12.06.09\342\200\257AM.png" (100%) rename docs/{guides => brand-guides}/.gitbook/assets/VisiOnline Server Client and DCOM Port Requirements.pdf (100%) rename docs/{guides => brand-guides}/.gitbook/assets/access-systems-tab-production-workspace.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/acs-access-group_dark.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/acs-credential_dark.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/acs-entrance_dark.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/acs-quick-start-access-systems-tab (1).png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/acs-schedule_dark.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/acs-schedule_light.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/acs-user_dark.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/add-devices-button.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/akiles-logo.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/akiles-manufacturer-page-cover-dark.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/akiles-manufacturer-page-cover-light.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/akiles_connect-flow-screens_dark.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/akiles_connect-flow-screens_light.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/ambiance.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/assa-abloy-accounts-account-list-menu-item.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/assa-abloy-logo.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/assa-abloy-settings.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/august_connect-flow-screens_dark.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/august_connect-flow-screens_light.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/august_get-started-cover_dark.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/august_get-started-cover_light.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/avigilon-alta-acs-devices.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/avigilon-alta-logo.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/avigilon-alta-user-permissions.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/brivo api key.webp (100%) rename docs/{guides => brand-guides}/.gitbook/assets/brivo api tier.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/brivo device brand.webp (100%) rename docs/{guides => brand-guides}/.gitbook/assets/brivo login.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/brivo username.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/brivo-logo.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/connect-flow-screens (1) (1).png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/connect-flow-screens (2) (1).png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/connect-webview-assa-abloy-credential-service-credentials.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/contact-pti-sales.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/controlbyweb-logo.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/d2d0a-yd-accesskit_ya_enc1.jpg (100%) rename docs/{guides => brand-guides}/.gitbook/assets/dk comm (1).png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/dormakaba-logo.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/dormakaba-oracode_connect-flow-screens.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/download.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/ecobee-manufacturer-page-cover-dark.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/ecobee-manufacturer-page-cover-light.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/ecobee_connect-flow-screens_dark.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/ecobee_connect-flow-screens_light.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/gokeyless-logo.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/google-add-your-oauth-client-id-page-learn-more.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/google-add-your-oauth-client-id-page.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/google-authorize-an-account-page.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/google-cloud-api-library-smart-device-management-api-search-results.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/google-cloud-api-library-welcome-page.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/google-cloud-create-credentials-menu.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/google-cloud-create-oauth-client-id-page.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/google-cloud-credentials-application-type-field.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/google-cloud-credentials-page.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/google-cloud-edit-app-registration-page.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/google-cloud-enable-apis-and-services-link.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/google-cloud-new-project-page.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/google-cloud-oauth-2.0-client-ids-table.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/google-cloud-oauth-client-created-dialog.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/google-cloud-oauth-consent-screen-page.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/google-cloud-select-a-resource-window.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/google-cloud-summary-page.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/google-cloud-test-users-page.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/google-cloud-welcome-dialog.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/google-commercial-development-application.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/google-create-a-project-events-page.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/google-device-access-console-project-info-page.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/google-device-access-console-welcome-page.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/google-device-access-home-page.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/google-device-access-project-info.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/google-non-disclosure-agreement-page.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/google-smart-device-management-api-enable-button.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/guides/2n-connect-flow-screens.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/guides/controlbyweb-connect-flow-screens.jpg (100%) rename docs/{guides => brand-guides}/.gitbook/assets/guides/controlbyweb-getting-started-guide-cover.jpg (100%) rename docs/{guides => brand-guides}/.gitbook/assets/guides/dormakaba-oracode-getting-started-seo-cover.jpg (100%) rename docs/{guides => brand-guides}/.gitbook/assets/guides/igloo-connect-flow-screens.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/guides/kwikset-connect-flow-screens.jpg (100%) rename docs/{guides => brand-guides}/.gitbook/assets/guides/minut-connect-flow-screens.jpg (100%) rename docs/{guides => brand-guides}/.gitbook/assets/guides/noiseaware-connect-flow-screens.jpg (100%) rename docs/{guides => brand-guides}/.gitbook/assets/guides/nuki-connect-flow-screens.jpg (100%) rename docs/{guides => brand-guides}/.gitbook/assets/guides/smart-lock-connect-flow-screens.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/guides/smart-locks-16-9-seam.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/guides/wyze-connect-flow-screens.jpg (100%) rename docs/{guides => brand-guides}/.gitbook/assets/guides/wyze-getting-seo-cover.jpg (100%) rename docs/{guides => brand-guides}/.gitbook/assets/guides/yale-auth-example.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/honeywell-logo.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/honeywell-manufacturer-page-cover-dark.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/honeywell-manufacturer-page-cover-light.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/honeywell_connect-flow-screens_dark.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/honeywell_connect-flow-screens_light.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/igloohome-logo.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/image (29) (1).png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/image (29).png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/image (36).png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/image (40).png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/image (44).png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/keynest logo transparent.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/kwikset-MFA-settings.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/kwikset-halo-halo-touch-on-amazon.jpg (100%) rename docs/{guides => brand-guides}/.gitbook/assets/kwikset-logo.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/latch-acs.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/latch-building-id.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/latch-logo.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/latch-manufacturer-page-cover-dark.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/latch-manufacturer-page-cover-light.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/lock-service-3g-add-server-connection.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/lock-service-3g-confirm-ble-module.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/lock-service-3g-download-data.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/lock-service-3g-get-system-id.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/lock-service-3g-initialize-lock-ble-config.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/lock-service-3g-initialize-lock.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/lock-service-3g-register-pc.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/lock-service-3g-select-port.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/lock-service-3g-select-server.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/lock-service-3g-upload-firmware.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/lock-service-3g-upload-fw-save-to-db.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/lockly-logo.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/lockly-manufacturer-page-cover-16-9-light.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/minut-logo.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/nest-developer-settings.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/nest-manufacturer-page-cover-dark.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/nest-manufacturer-page-cover-light.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/nest-oauth-redirect-uri-setup.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/nest-on-amazon.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/nest_connect-flow-screens_dark.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/nest_connect-flow-screens_light.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/noiseaware-logo.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/nuki-logo.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/nuki-manufacturer-page-cover-light.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/nuki-web-connect-short-rental-integrators-dialog-w-link.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/nuki-web-select-devices-smart-hosting-dialog.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/nuki-web-short-term-rental-page.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/openapi (1).json (100%) rename docs/{guides => brand-guides}/.gitbook/assets/openapi.json (100%) rename docs/{guides => brand-guides}/.gitbook/assets/oracode-live-site-name.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/pti-help-center.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/pti-logo.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/salto-ks-acs-manufacturer-page-cover-dark.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/salto-ks-acs-manufacturer-page-cover-light.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/salto-ks-acs.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/salto-ks-lock-settings-button.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/salto-ks-logo.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/salto-ks-manufacturer-page-cover-dark.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/salto-ks-manufacturer-page-cover-light.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/salto-ks-near-detection-mode-edit-button.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/salto-ks_connect-flow-screens_dark.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/salto-ks_connect-flow-screens_light.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/salto-logo.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/salto-space-acs.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/salto-space-logo.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/salto-space-manufacturer-page-cover-dark.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/salto-space-manufacturer-page-cover-light.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/salto-space-ship-settings.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/schlage-logo.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/schlage-manufacturer-page-cover-dark.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/schlage-manufacturer-page-cover-light.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/schlage-on-amazon.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/seam-bridge-pairing-code.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/seam-contact-us-light.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/select-entrances-for-user.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/sensi-manufacturer-page-cover-dark.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/sensi-manufacturer-page-cover-light.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/sensi_connect-flow-screens_dark.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/sensi_connect-flow-screens_light.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/setup tile.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/smartthings-logo.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/smartthings-manufacturer-page-cover-dark.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/smartthings-manufacturer-page-cover-light.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/smartthings_connect-flow-screens_dark.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/smartthings_connect-flow-screens_light.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/tedee-connect-flow-screens.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/tedee-getting-started-cover.jpg (100%) rename docs/{guides => brand-guides}/.gitbook/assets/tedee-logo.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/tedee-manufacturer-page-cover-dark.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/tedee-manufacturer-page-cover-light.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/ttlock-logo.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/ttlock_connect-flow-screens_dark.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/ttlock_connect-flow-screens_light.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/ttlock_get-started-cover_dark.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/ultraloq-manufacturer-page-cover-light.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/visionline-add-common-door-area.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/visionline-add-common-entrance-door-ble-profile.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/visionline-add-common-entrance-door.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/visionline-add-device-for-lock-service-3g.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/visionline-add-guest-door-area.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/visionline-add-guest-doors-ble-profile.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/visionline-add-guest-doors.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/visionline-add-operator.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/visionline-add-user.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/visionline-card-encoder-device-details-window.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/visionline-card-encoder-select-s-n-field.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/visionline-get-registration-code.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/visionline-mobile-access-accout-details.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/visionline-select-encoder-window.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/visionline-set-mobile-uuid.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/workspace-id-for-latch.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/wyze-api-docs-cover.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/wyze-api-key-example.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/wyze-logo.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/yale-ayr202-zwv-usa-assure-lock-z-wave-plus-network-module-ayr202-zwv-usa.jpeg (100%) rename docs/{guides => brand-guides}/.gitbook/assets/yale-logo.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/yale-on-amazon.png (100%) rename docs/{guides => brand-guides}/.gitbook/assets/yale-on-gokeyless.png (100%) diff --git a/docs/guides/.gitbook/assets/2n-logo.png b/docs/brand-guides/.gitbook/assets/2n-logo.png similarity index 100% rename from docs/guides/.gitbook/assets/2n-logo.png rename to docs/brand-guides/.gitbook/assets/2n-logo.png diff --git a/docs/guides/.gitbook/assets/33-lock-logo.png b/docs/brand-guides/.gitbook/assets/33-lock-logo.png similarity index 100% rename from docs/guides/.gitbook/assets/33-lock-logo.png rename to docs/brand-guides/.gitbook/assets/33-lock-logo.png diff --git a/docs/guides/.gitbook/assets/33-lock_connect-flow-screens_dark.png b/docs/brand-guides/.gitbook/assets/33-lock_connect-flow-screens_dark.png similarity index 100% rename from docs/guides/.gitbook/assets/33-lock_connect-flow-screens_dark.png rename to docs/brand-guides/.gitbook/assets/33-lock_connect-flow-screens_dark.png diff --git a/docs/guides/.gitbook/assets/33-lock_connect-flow-screens_light.png b/docs/brand-guides/.gitbook/assets/33-lock_connect-flow-screens_light.png similarity index 100% rename from docs/guides/.gitbook/assets/33-lock_connect-flow-screens_light.png rename to docs/brand-guides/.gitbook/assets/33-lock_connect-flow-screens_light.png diff --git a/docs/guides/.gitbook/assets/33lock-manufacturer-page-cover-dark.png b/docs/brand-guides/.gitbook/assets/33lock-manufacturer-page-cover-dark.png similarity index 100% rename from docs/guides/.gitbook/assets/33lock-manufacturer-page-cover-dark.png rename to docs/brand-guides/.gitbook/assets/33lock-manufacturer-page-cover-dark.png diff --git a/docs/guides/.gitbook/assets/33lock-manufacturer-page-cover-light.png b/docs/brand-guides/.gitbook/assets/33lock-manufacturer-page-cover-light.png similarity index 100% rename from docs/guides/.gitbook/assets/33lock-manufacturer-page-cover-light.png rename to docs/brand-guides/.gitbook/assets/33lock-manufacturer-page-cover-light.png diff --git a/docs/guides/.gitbook/assets/4suites-logo.png b/docs/brand-guides/.gitbook/assets/4suites-logo.png similarity index 100% rename from docs/guides/.gitbook/assets/4suites-logo.png rename to docs/brand-guides/.gitbook/assets/4suites-logo.png diff --git a/docs/guides/.gitbook/assets/4suites_connect-flow-screens_dark.png b/docs/brand-guides/.gitbook/assets/4suites_connect-flow-screens_dark.png similarity index 100% rename from docs/guides/.gitbook/assets/4suites_connect-flow-screens_dark.png rename to docs/brand-guides/.gitbook/assets/4suites_connect-flow-screens_dark.png diff --git a/docs/guides/.gitbook/assets/4suites_connect-flow-screens_light.png b/docs/brand-guides/.gitbook/assets/4suites_connect-flow-screens_light.png similarity index 100% rename from docs/guides/.gitbook/assets/4suites_connect-flow-screens_light.png rename to docs/brand-guides/.gitbook/assets/4suites_connect-flow-screens_light.png diff --git a/docs/guides/.gitbook/assets/4suites_get-started-cover_dark.png b/docs/brand-guides/.gitbook/assets/4suites_get-started-cover_dark.png similarity index 100% rename from docs/guides/.gitbook/assets/4suites_get-started-cover_dark.png rename to docs/brand-guides/.gitbook/assets/4suites_get-started-cover_dark.png diff --git a/docs/guides/.gitbook/assets/4suites_get-started-cover_light.png b/docs/brand-guides/.gitbook/assets/4suites_get-started-cover_light.png similarity index 100% rename from docs/guides/.gitbook/assets/4suites_get-started-cover_light.png rename to docs/brand-guides/.gitbook/assets/4suites_get-started-cover_light.png diff --git a/docs/guides/.gitbook/assets/66 5013 142-8 Installation instruction Visionline.pdf b/docs/brand-guides/.gitbook/assets/66 5013 142-8 Installation instruction Visionline.pdf similarity index 100% rename from docs/guides/.gitbook/assets/66 5013 142-8 Installation instruction Visionline.pdf rename to docs/brand-guides/.gitbook/assets/66 5013 142-8 Installation instruction Visionline.pdf diff --git a/docs/guides/.gitbook/assets/Join only.png b/docs/brand-guides/.gitbook/assets/Join only.png similarity index 100% rename from docs/guides/.gitbook/assets/Join only.png rename to docs/brand-guides/.gitbook/assets/Join only.png diff --git "a/docs/guides/.gitbook/assets/Screenshot 2025-09-28 at 5.22.31\342\200\257PM.png" "b/docs/brand-guides/.gitbook/assets/Screenshot 2025-09-28 at 5.22.31\342\200\257PM.png" similarity index 100% rename from "docs/guides/.gitbook/assets/Screenshot 2025-09-28 at 5.22.31\342\200\257PM.png" rename to "docs/brand-guides/.gitbook/assets/Screenshot 2025-09-28 at 5.22.31\342\200\257PM.png" diff --git "a/docs/guides/.gitbook/assets/Screenshot 2025-09-28 at 5.44.01\342\200\257PM.png" "b/docs/brand-guides/.gitbook/assets/Screenshot 2025-09-28 at 5.44.01\342\200\257PM.png" similarity index 100% rename from "docs/guides/.gitbook/assets/Screenshot 2025-09-28 at 5.44.01\342\200\257PM.png" rename to "docs/brand-guides/.gitbook/assets/Screenshot 2025-09-28 at 5.44.01\342\200\257PM.png" diff --git "a/docs/guides/.gitbook/assets/Screenshot 2025-10-31 at 11.36.44\342\200\257AM.png" "b/docs/brand-guides/.gitbook/assets/Screenshot 2025-10-31 at 11.36.44\342\200\257AM.png" similarity index 100% rename from "docs/guides/.gitbook/assets/Screenshot 2025-10-31 at 11.36.44\342\200\257AM.png" rename to "docs/brand-guides/.gitbook/assets/Screenshot 2025-10-31 at 11.36.44\342\200\257AM.png" diff --git "a/docs/guides/.gitbook/assets/Screenshot 2025-10-31 at 4.56.29\342\200\257PM.png" "b/docs/brand-guides/.gitbook/assets/Screenshot 2025-10-31 at 4.56.29\342\200\257PM.png" similarity index 100% rename from "docs/guides/.gitbook/assets/Screenshot 2025-10-31 at 4.56.29\342\200\257PM.png" rename to "docs/brand-guides/.gitbook/assets/Screenshot 2025-10-31 at 4.56.29\342\200\257PM.png" diff --git "a/docs/guides/.gitbook/assets/Screenshot 2025-10-31 at 5.43.46\342\200\257PM.png" "b/docs/brand-guides/.gitbook/assets/Screenshot 2025-10-31 at 5.43.46\342\200\257PM.png" similarity index 100% rename from "docs/guides/.gitbook/assets/Screenshot 2025-10-31 at 5.43.46\342\200\257PM.png" rename to "docs/brand-guides/.gitbook/assets/Screenshot 2025-10-31 at 5.43.46\342\200\257PM.png" diff --git "a/docs/guides/.gitbook/assets/Screenshot 2025-10-31 at 5.46.00\342\200\257PM.png" "b/docs/brand-guides/.gitbook/assets/Screenshot 2025-10-31 at 5.46.00\342\200\257PM.png" similarity index 100% rename from "docs/guides/.gitbook/assets/Screenshot 2025-10-31 at 5.46.00\342\200\257PM.png" rename to "docs/brand-guides/.gitbook/assets/Screenshot 2025-10-31 at 5.46.00\342\200\257PM.png" diff --git "a/docs/guides/.gitbook/assets/Screenshot 2025-10-31 at 9.44.42\342\200\257AM (1).png" "b/docs/brand-guides/.gitbook/assets/Screenshot 2025-10-31 at 9.44.42\342\200\257AM (1).png" similarity index 100% rename from "docs/guides/.gitbook/assets/Screenshot 2025-10-31 at 9.44.42\342\200\257AM (1).png" rename to "docs/brand-guides/.gitbook/assets/Screenshot 2025-10-31 at 9.44.42\342\200\257AM (1).png" diff --git "a/docs/guides/.gitbook/assets/Screenshot 2025-10-31 at 9.45.19\342\200\257AM.png" "b/docs/brand-guides/.gitbook/assets/Screenshot 2025-10-31 at 9.45.19\342\200\257AM.png" similarity index 100% rename from "docs/guides/.gitbook/assets/Screenshot 2025-10-31 at 9.45.19\342\200\257AM.png" rename to "docs/brand-guides/.gitbook/assets/Screenshot 2025-10-31 at 9.45.19\342\200\257AM.png" diff --git "a/docs/guides/.gitbook/assets/Screenshot 2025-11-12 at 12.06.09\342\200\257AM.png" "b/docs/brand-guides/.gitbook/assets/Screenshot 2025-11-12 at 12.06.09\342\200\257AM.png" similarity index 100% rename from "docs/guides/.gitbook/assets/Screenshot 2025-11-12 at 12.06.09\342\200\257AM.png" rename to "docs/brand-guides/.gitbook/assets/Screenshot 2025-11-12 at 12.06.09\342\200\257AM.png" diff --git a/docs/guides/.gitbook/assets/VisiOnline Server Client and DCOM Port Requirements.pdf b/docs/brand-guides/.gitbook/assets/VisiOnline Server Client and DCOM Port Requirements.pdf similarity index 100% rename from docs/guides/.gitbook/assets/VisiOnline Server Client and DCOM Port Requirements.pdf rename to docs/brand-guides/.gitbook/assets/VisiOnline Server Client and DCOM Port Requirements.pdf diff --git a/docs/guides/.gitbook/assets/access-systems-tab-production-workspace.png b/docs/brand-guides/.gitbook/assets/access-systems-tab-production-workspace.png similarity index 100% rename from docs/guides/.gitbook/assets/access-systems-tab-production-workspace.png rename to docs/brand-guides/.gitbook/assets/access-systems-tab-production-workspace.png diff --git a/docs/guides/.gitbook/assets/acs-access-group_dark.png b/docs/brand-guides/.gitbook/assets/acs-access-group_dark.png similarity index 100% rename from docs/guides/.gitbook/assets/acs-access-group_dark.png rename to docs/brand-guides/.gitbook/assets/acs-access-group_dark.png diff --git a/docs/guides/.gitbook/assets/acs-credential_dark.png b/docs/brand-guides/.gitbook/assets/acs-credential_dark.png similarity index 100% rename from docs/guides/.gitbook/assets/acs-credential_dark.png rename to docs/brand-guides/.gitbook/assets/acs-credential_dark.png diff --git a/docs/guides/.gitbook/assets/acs-entrance_dark.png b/docs/brand-guides/.gitbook/assets/acs-entrance_dark.png similarity index 100% rename from docs/guides/.gitbook/assets/acs-entrance_dark.png rename to docs/brand-guides/.gitbook/assets/acs-entrance_dark.png diff --git a/docs/guides/.gitbook/assets/acs-quick-start-access-systems-tab (1).png b/docs/brand-guides/.gitbook/assets/acs-quick-start-access-systems-tab (1).png similarity index 100% rename from docs/guides/.gitbook/assets/acs-quick-start-access-systems-tab (1).png rename to docs/brand-guides/.gitbook/assets/acs-quick-start-access-systems-tab (1).png diff --git a/docs/guides/.gitbook/assets/acs-schedule_dark.png b/docs/brand-guides/.gitbook/assets/acs-schedule_dark.png similarity index 100% rename from docs/guides/.gitbook/assets/acs-schedule_dark.png rename to docs/brand-guides/.gitbook/assets/acs-schedule_dark.png diff --git a/docs/guides/.gitbook/assets/acs-schedule_light.png b/docs/brand-guides/.gitbook/assets/acs-schedule_light.png similarity index 100% rename from docs/guides/.gitbook/assets/acs-schedule_light.png rename to docs/brand-guides/.gitbook/assets/acs-schedule_light.png diff --git a/docs/guides/.gitbook/assets/acs-user_dark.png b/docs/brand-guides/.gitbook/assets/acs-user_dark.png similarity index 100% rename from docs/guides/.gitbook/assets/acs-user_dark.png rename to docs/brand-guides/.gitbook/assets/acs-user_dark.png diff --git a/docs/guides/.gitbook/assets/add-devices-button.png b/docs/brand-guides/.gitbook/assets/add-devices-button.png similarity index 100% rename from docs/guides/.gitbook/assets/add-devices-button.png rename to docs/brand-guides/.gitbook/assets/add-devices-button.png diff --git a/docs/guides/.gitbook/assets/akiles-logo.png b/docs/brand-guides/.gitbook/assets/akiles-logo.png similarity index 100% rename from docs/guides/.gitbook/assets/akiles-logo.png rename to docs/brand-guides/.gitbook/assets/akiles-logo.png diff --git a/docs/guides/.gitbook/assets/akiles-manufacturer-page-cover-dark.png b/docs/brand-guides/.gitbook/assets/akiles-manufacturer-page-cover-dark.png similarity index 100% rename from docs/guides/.gitbook/assets/akiles-manufacturer-page-cover-dark.png rename to docs/brand-guides/.gitbook/assets/akiles-manufacturer-page-cover-dark.png diff --git a/docs/guides/.gitbook/assets/akiles-manufacturer-page-cover-light.png b/docs/brand-guides/.gitbook/assets/akiles-manufacturer-page-cover-light.png similarity index 100% rename from docs/guides/.gitbook/assets/akiles-manufacturer-page-cover-light.png rename to docs/brand-guides/.gitbook/assets/akiles-manufacturer-page-cover-light.png diff --git a/docs/guides/.gitbook/assets/akiles_connect-flow-screens_dark.png b/docs/brand-guides/.gitbook/assets/akiles_connect-flow-screens_dark.png similarity index 100% rename from docs/guides/.gitbook/assets/akiles_connect-flow-screens_dark.png rename to docs/brand-guides/.gitbook/assets/akiles_connect-flow-screens_dark.png diff --git a/docs/guides/.gitbook/assets/akiles_connect-flow-screens_light.png b/docs/brand-guides/.gitbook/assets/akiles_connect-flow-screens_light.png similarity index 100% rename from docs/guides/.gitbook/assets/akiles_connect-flow-screens_light.png rename to docs/brand-guides/.gitbook/assets/akiles_connect-flow-screens_light.png diff --git a/docs/guides/.gitbook/assets/ambiance.png b/docs/brand-guides/.gitbook/assets/ambiance.png similarity index 100% rename from docs/guides/.gitbook/assets/ambiance.png rename to docs/brand-guides/.gitbook/assets/ambiance.png diff --git a/docs/guides/.gitbook/assets/assa-abloy-accounts-account-list-menu-item.png b/docs/brand-guides/.gitbook/assets/assa-abloy-accounts-account-list-menu-item.png similarity index 100% rename from docs/guides/.gitbook/assets/assa-abloy-accounts-account-list-menu-item.png rename to docs/brand-guides/.gitbook/assets/assa-abloy-accounts-account-list-menu-item.png diff --git a/docs/guides/.gitbook/assets/assa-abloy-logo.png b/docs/brand-guides/.gitbook/assets/assa-abloy-logo.png similarity index 100% rename from docs/guides/.gitbook/assets/assa-abloy-logo.png rename to docs/brand-guides/.gitbook/assets/assa-abloy-logo.png diff --git a/docs/guides/.gitbook/assets/assa-abloy-settings.png b/docs/brand-guides/.gitbook/assets/assa-abloy-settings.png similarity index 100% rename from docs/guides/.gitbook/assets/assa-abloy-settings.png rename to docs/brand-guides/.gitbook/assets/assa-abloy-settings.png diff --git a/docs/guides/.gitbook/assets/august_connect-flow-screens_dark.png b/docs/brand-guides/.gitbook/assets/august_connect-flow-screens_dark.png similarity index 100% rename from docs/guides/.gitbook/assets/august_connect-flow-screens_dark.png rename to docs/brand-guides/.gitbook/assets/august_connect-flow-screens_dark.png diff --git a/docs/guides/.gitbook/assets/august_connect-flow-screens_light.png b/docs/brand-guides/.gitbook/assets/august_connect-flow-screens_light.png similarity index 100% rename from docs/guides/.gitbook/assets/august_connect-flow-screens_light.png rename to docs/brand-guides/.gitbook/assets/august_connect-flow-screens_light.png diff --git a/docs/guides/.gitbook/assets/august_get-started-cover_dark.png b/docs/brand-guides/.gitbook/assets/august_get-started-cover_dark.png similarity index 100% rename from docs/guides/.gitbook/assets/august_get-started-cover_dark.png rename to docs/brand-guides/.gitbook/assets/august_get-started-cover_dark.png diff --git a/docs/guides/.gitbook/assets/august_get-started-cover_light.png b/docs/brand-guides/.gitbook/assets/august_get-started-cover_light.png similarity index 100% rename from docs/guides/.gitbook/assets/august_get-started-cover_light.png rename to docs/brand-guides/.gitbook/assets/august_get-started-cover_light.png diff --git a/docs/guides/.gitbook/assets/avigilon-alta-acs-devices.png b/docs/brand-guides/.gitbook/assets/avigilon-alta-acs-devices.png similarity index 100% rename from docs/guides/.gitbook/assets/avigilon-alta-acs-devices.png rename to docs/brand-guides/.gitbook/assets/avigilon-alta-acs-devices.png diff --git a/docs/guides/.gitbook/assets/avigilon-alta-logo.png b/docs/brand-guides/.gitbook/assets/avigilon-alta-logo.png similarity index 100% rename from docs/guides/.gitbook/assets/avigilon-alta-logo.png rename to docs/brand-guides/.gitbook/assets/avigilon-alta-logo.png diff --git a/docs/guides/.gitbook/assets/avigilon-alta-user-permissions.png b/docs/brand-guides/.gitbook/assets/avigilon-alta-user-permissions.png similarity index 100% rename from docs/guides/.gitbook/assets/avigilon-alta-user-permissions.png rename to docs/brand-guides/.gitbook/assets/avigilon-alta-user-permissions.png diff --git a/docs/guides/.gitbook/assets/brivo api key.webp b/docs/brand-guides/.gitbook/assets/brivo api key.webp similarity index 100% rename from docs/guides/.gitbook/assets/brivo api key.webp rename to docs/brand-guides/.gitbook/assets/brivo api key.webp diff --git a/docs/guides/.gitbook/assets/brivo api tier.png b/docs/brand-guides/.gitbook/assets/brivo api tier.png similarity index 100% rename from docs/guides/.gitbook/assets/brivo api tier.png rename to docs/brand-guides/.gitbook/assets/brivo api tier.png diff --git a/docs/guides/.gitbook/assets/brivo device brand.webp b/docs/brand-guides/.gitbook/assets/brivo device brand.webp similarity index 100% rename from docs/guides/.gitbook/assets/brivo device brand.webp rename to docs/brand-guides/.gitbook/assets/brivo device brand.webp diff --git a/docs/guides/.gitbook/assets/brivo login.png b/docs/brand-guides/.gitbook/assets/brivo login.png similarity index 100% rename from docs/guides/.gitbook/assets/brivo login.png rename to docs/brand-guides/.gitbook/assets/brivo login.png diff --git a/docs/guides/.gitbook/assets/brivo username.png b/docs/brand-guides/.gitbook/assets/brivo username.png similarity index 100% rename from docs/guides/.gitbook/assets/brivo username.png rename to docs/brand-guides/.gitbook/assets/brivo username.png diff --git a/docs/guides/.gitbook/assets/brivo-logo.png b/docs/brand-guides/.gitbook/assets/brivo-logo.png similarity index 100% rename from docs/guides/.gitbook/assets/brivo-logo.png rename to docs/brand-guides/.gitbook/assets/brivo-logo.png diff --git a/docs/guides/.gitbook/assets/connect-flow-screens (1) (1).png b/docs/brand-guides/.gitbook/assets/connect-flow-screens (1) (1).png similarity index 100% rename from docs/guides/.gitbook/assets/connect-flow-screens (1) (1).png rename to docs/brand-guides/.gitbook/assets/connect-flow-screens (1) (1).png diff --git a/docs/guides/.gitbook/assets/connect-flow-screens (2) (1).png b/docs/brand-guides/.gitbook/assets/connect-flow-screens (2) (1).png similarity index 100% rename from docs/guides/.gitbook/assets/connect-flow-screens (2) (1).png rename to docs/brand-guides/.gitbook/assets/connect-flow-screens (2) (1).png diff --git a/docs/guides/.gitbook/assets/connect-webview-assa-abloy-credential-service-credentials.png b/docs/brand-guides/.gitbook/assets/connect-webview-assa-abloy-credential-service-credentials.png similarity index 100% rename from docs/guides/.gitbook/assets/connect-webview-assa-abloy-credential-service-credentials.png rename to docs/brand-guides/.gitbook/assets/connect-webview-assa-abloy-credential-service-credentials.png diff --git a/docs/guides/.gitbook/assets/contact-pti-sales.png b/docs/brand-guides/.gitbook/assets/contact-pti-sales.png similarity index 100% rename from docs/guides/.gitbook/assets/contact-pti-sales.png rename to docs/brand-guides/.gitbook/assets/contact-pti-sales.png diff --git a/docs/guides/.gitbook/assets/controlbyweb-logo.png b/docs/brand-guides/.gitbook/assets/controlbyweb-logo.png similarity index 100% rename from docs/guides/.gitbook/assets/controlbyweb-logo.png rename to docs/brand-guides/.gitbook/assets/controlbyweb-logo.png diff --git a/docs/guides/.gitbook/assets/d2d0a-yd-accesskit_ya_enc1.jpg b/docs/brand-guides/.gitbook/assets/d2d0a-yd-accesskit_ya_enc1.jpg similarity index 100% rename from docs/guides/.gitbook/assets/d2d0a-yd-accesskit_ya_enc1.jpg rename to docs/brand-guides/.gitbook/assets/d2d0a-yd-accesskit_ya_enc1.jpg diff --git a/docs/guides/.gitbook/assets/dk comm (1).png b/docs/brand-guides/.gitbook/assets/dk comm (1).png similarity index 100% rename from docs/guides/.gitbook/assets/dk comm (1).png rename to docs/brand-guides/.gitbook/assets/dk comm (1).png diff --git a/docs/guides/.gitbook/assets/dormakaba-logo.png b/docs/brand-guides/.gitbook/assets/dormakaba-logo.png similarity index 100% rename from docs/guides/.gitbook/assets/dormakaba-logo.png rename to docs/brand-guides/.gitbook/assets/dormakaba-logo.png diff --git a/docs/guides/.gitbook/assets/dormakaba-oracode_connect-flow-screens.png b/docs/brand-guides/.gitbook/assets/dormakaba-oracode_connect-flow-screens.png similarity index 100% rename from docs/guides/.gitbook/assets/dormakaba-oracode_connect-flow-screens.png rename to docs/brand-guides/.gitbook/assets/dormakaba-oracode_connect-flow-screens.png diff --git a/docs/guides/.gitbook/assets/download.png b/docs/brand-guides/.gitbook/assets/download.png similarity index 100% rename from docs/guides/.gitbook/assets/download.png rename to docs/brand-guides/.gitbook/assets/download.png diff --git a/docs/guides/.gitbook/assets/ecobee-manufacturer-page-cover-dark.png b/docs/brand-guides/.gitbook/assets/ecobee-manufacturer-page-cover-dark.png similarity index 100% rename from docs/guides/.gitbook/assets/ecobee-manufacturer-page-cover-dark.png rename to docs/brand-guides/.gitbook/assets/ecobee-manufacturer-page-cover-dark.png diff --git a/docs/guides/.gitbook/assets/ecobee-manufacturer-page-cover-light.png b/docs/brand-guides/.gitbook/assets/ecobee-manufacturer-page-cover-light.png similarity index 100% rename from docs/guides/.gitbook/assets/ecobee-manufacturer-page-cover-light.png rename to docs/brand-guides/.gitbook/assets/ecobee-manufacturer-page-cover-light.png diff --git a/docs/guides/.gitbook/assets/ecobee_connect-flow-screens_dark.png b/docs/brand-guides/.gitbook/assets/ecobee_connect-flow-screens_dark.png similarity index 100% rename from docs/guides/.gitbook/assets/ecobee_connect-flow-screens_dark.png rename to docs/brand-guides/.gitbook/assets/ecobee_connect-flow-screens_dark.png diff --git a/docs/guides/.gitbook/assets/ecobee_connect-flow-screens_light.png b/docs/brand-guides/.gitbook/assets/ecobee_connect-flow-screens_light.png similarity index 100% rename from docs/guides/.gitbook/assets/ecobee_connect-flow-screens_light.png rename to docs/brand-guides/.gitbook/assets/ecobee_connect-flow-screens_light.png diff --git a/docs/guides/.gitbook/assets/gokeyless-logo.png b/docs/brand-guides/.gitbook/assets/gokeyless-logo.png similarity index 100% rename from docs/guides/.gitbook/assets/gokeyless-logo.png rename to docs/brand-guides/.gitbook/assets/gokeyless-logo.png diff --git a/docs/guides/.gitbook/assets/google-add-your-oauth-client-id-page-learn-more.png b/docs/brand-guides/.gitbook/assets/google-add-your-oauth-client-id-page-learn-more.png similarity index 100% rename from docs/guides/.gitbook/assets/google-add-your-oauth-client-id-page-learn-more.png rename to docs/brand-guides/.gitbook/assets/google-add-your-oauth-client-id-page-learn-more.png diff --git a/docs/guides/.gitbook/assets/google-add-your-oauth-client-id-page.png b/docs/brand-guides/.gitbook/assets/google-add-your-oauth-client-id-page.png similarity index 100% rename from docs/guides/.gitbook/assets/google-add-your-oauth-client-id-page.png rename to docs/brand-guides/.gitbook/assets/google-add-your-oauth-client-id-page.png diff --git a/docs/guides/.gitbook/assets/google-authorize-an-account-page.png b/docs/brand-guides/.gitbook/assets/google-authorize-an-account-page.png similarity index 100% rename from docs/guides/.gitbook/assets/google-authorize-an-account-page.png rename to docs/brand-guides/.gitbook/assets/google-authorize-an-account-page.png diff --git a/docs/guides/.gitbook/assets/google-cloud-api-library-smart-device-management-api-search-results.png b/docs/brand-guides/.gitbook/assets/google-cloud-api-library-smart-device-management-api-search-results.png similarity index 100% rename from docs/guides/.gitbook/assets/google-cloud-api-library-smart-device-management-api-search-results.png rename to docs/brand-guides/.gitbook/assets/google-cloud-api-library-smart-device-management-api-search-results.png diff --git a/docs/guides/.gitbook/assets/google-cloud-api-library-welcome-page.png b/docs/brand-guides/.gitbook/assets/google-cloud-api-library-welcome-page.png similarity index 100% rename from docs/guides/.gitbook/assets/google-cloud-api-library-welcome-page.png rename to docs/brand-guides/.gitbook/assets/google-cloud-api-library-welcome-page.png diff --git a/docs/guides/.gitbook/assets/google-cloud-create-credentials-menu.png b/docs/brand-guides/.gitbook/assets/google-cloud-create-credentials-menu.png similarity index 100% rename from docs/guides/.gitbook/assets/google-cloud-create-credentials-menu.png rename to docs/brand-guides/.gitbook/assets/google-cloud-create-credentials-menu.png diff --git a/docs/guides/.gitbook/assets/google-cloud-create-oauth-client-id-page.png b/docs/brand-guides/.gitbook/assets/google-cloud-create-oauth-client-id-page.png similarity index 100% rename from docs/guides/.gitbook/assets/google-cloud-create-oauth-client-id-page.png rename to docs/brand-guides/.gitbook/assets/google-cloud-create-oauth-client-id-page.png diff --git a/docs/guides/.gitbook/assets/google-cloud-credentials-application-type-field.png b/docs/brand-guides/.gitbook/assets/google-cloud-credentials-application-type-field.png similarity index 100% rename from docs/guides/.gitbook/assets/google-cloud-credentials-application-type-field.png rename to docs/brand-guides/.gitbook/assets/google-cloud-credentials-application-type-field.png diff --git a/docs/guides/.gitbook/assets/google-cloud-credentials-page.png b/docs/brand-guides/.gitbook/assets/google-cloud-credentials-page.png similarity index 100% rename from docs/guides/.gitbook/assets/google-cloud-credentials-page.png rename to docs/brand-guides/.gitbook/assets/google-cloud-credentials-page.png diff --git a/docs/guides/.gitbook/assets/google-cloud-edit-app-registration-page.png b/docs/brand-guides/.gitbook/assets/google-cloud-edit-app-registration-page.png similarity index 100% rename from docs/guides/.gitbook/assets/google-cloud-edit-app-registration-page.png rename to docs/brand-guides/.gitbook/assets/google-cloud-edit-app-registration-page.png diff --git a/docs/guides/.gitbook/assets/google-cloud-enable-apis-and-services-link.png b/docs/brand-guides/.gitbook/assets/google-cloud-enable-apis-and-services-link.png similarity index 100% rename from docs/guides/.gitbook/assets/google-cloud-enable-apis-and-services-link.png rename to docs/brand-guides/.gitbook/assets/google-cloud-enable-apis-and-services-link.png diff --git a/docs/guides/.gitbook/assets/google-cloud-new-project-page.png b/docs/brand-guides/.gitbook/assets/google-cloud-new-project-page.png similarity index 100% rename from docs/guides/.gitbook/assets/google-cloud-new-project-page.png rename to docs/brand-guides/.gitbook/assets/google-cloud-new-project-page.png diff --git a/docs/guides/.gitbook/assets/google-cloud-oauth-2.0-client-ids-table.png b/docs/brand-guides/.gitbook/assets/google-cloud-oauth-2.0-client-ids-table.png similarity index 100% rename from docs/guides/.gitbook/assets/google-cloud-oauth-2.0-client-ids-table.png rename to docs/brand-guides/.gitbook/assets/google-cloud-oauth-2.0-client-ids-table.png diff --git a/docs/guides/.gitbook/assets/google-cloud-oauth-client-created-dialog.png b/docs/brand-guides/.gitbook/assets/google-cloud-oauth-client-created-dialog.png similarity index 100% rename from docs/guides/.gitbook/assets/google-cloud-oauth-client-created-dialog.png rename to docs/brand-guides/.gitbook/assets/google-cloud-oauth-client-created-dialog.png diff --git a/docs/guides/.gitbook/assets/google-cloud-oauth-consent-screen-page.png b/docs/brand-guides/.gitbook/assets/google-cloud-oauth-consent-screen-page.png similarity index 100% rename from docs/guides/.gitbook/assets/google-cloud-oauth-consent-screen-page.png rename to docs/brand-guides/.gitbook/assets/google-cloud-oauth-consent-screen-page.png diff --git a/docs/guides/.gitbook/assets/google-cloud-select-a-resource-window.png b/docs/brand-guides/.gitbook/assets/google-cloud-select-a-resource-window.png similarity index 100% rename from docs/guides/.gitbook/assets/google-cloud-select-a-resource-window.png rename to docs/brand-guides/.gitbook/assets/google-cloud-select-a-resource-window.png diff --git a/docs/guides/.gitbook/assets/google-cloud-summary-page.png b/docs/brand-guides/.gitbook/assets/google-cloud-summary-page.png similarity index 100% rename from docs/guides/.gitbook/assets/google-cloud-summary-page.png rename to docs/brand-guides/.gitbook/assets/google-cloud-summary-page.png diff --git a/docs/guides/.gitbook/assets/google-cloud-test-users-page.png b/docs/brand-guides/.gitbook/assets/google-cloud-test-users-page.png similarity index 100% rename from docs/guides/.gitbook/assets/google-cloud-test-users-page.png rename to docs/brand-guides/.gitbook/assets/google-cloud-test-users-page.png diff --git a/docs/guides/.gitbook/assets/google-cloud-welcome-dialog.png b/docs/brand-guides/.gitbook/assets/google-cloud-welcome-dialog.png similarity index 100% rename from docs/guides/.gitbook/assets/google-cloud-welcome-dialog.png rename to docs/brand-guides/.gitbook/assets/google-cloud-welcome-dialog.png diff --git a/docs/guides/.gitbook/assets/google-commercial-development-application.png b/docs/brand-guides/.gitbook/assets/google-commercial-development-application.png similarity index 100% rename from docs/guides/.gitbook/assets/google-commercial-development-application.png rename to docs/brand-guides/.gitbook/assets/google-commercial-development-application.png diff --git a/docs/guides/.gitbook/assets/google-create-a-project-events-page.png b/docs/brand-guides/.gitbook/assets/google-create-a-project-events-page.png similarity index 100% rename from docs/guides/.gitbook/assets/google-create-a-project-events-page.png rename to docs/brand-guides/.gitbook/assets/google-create-a-project-events-page.png diff --git a/docs/guides/.gitbook/assets/google-device-access-console-project-info-page.png b/docs/brand-guides/.gitbook/assets/google-device-access-console-project-info-page.png similarity index 100% rename from docs/guides/.gitbook/assets/google-device-access-console-project-info-page.png rename to docs/brand-guides/.gitbook/assets/google-device-access-console-project-info-page.png diff --git a/docs/guides/.gitbook/assets/google-device-access-console-welcome-page.png b/docs/brand-guides/.gitbook/assets/google-device-access-console-welcome-page.png similarity index 100% rename from docs/guides/.gitbook/assets/google-device-access-console-welcome-page.png rename to docs/brand-guides/.gitbook/assets/google-device-access-console-welcome-page.png diff --git a/docs/guides/.gitbook/assets/google-device-access-home-page.png b/docs/brand-guides/.gitbook/assets/google-device-access-home-page.png similarity index 100% rename from docs/guides/.gitbook/assets/google-device-access-home-page.png rename to docs/brand-guides/.gitbook/assets/google-device-access-home-page.png diff --git a/docs/guides/.gitbook/assets/google-device-access-project-info.png b/docs/brand-guides/.gitbook/assets/google-device-access-project-info.png similarity index 100% rename from docs/guides/.gitbook/assets/google-device-access-project-info.png rename to docs/brand-guides/.gitbook/assets/google-device-access-project-info.png diff --git a/docs/guides/.gitbook/assets/google-non-disclosure-agreement-page.png b/docs/brand-guides/.gitbook/assets/google-non-disclosure-agreement-page.png similarity index 100% rename from docs/guides/.gitbook/assets/google-non-disclosure-agreement-page.png rename to docs/brand-guides/.gitbook/assets/google-non-disclosure-agreement-page.png diff --git a/docs/guides/.gitbook/assets/google-smart-device-management-api-enable-button.png b/docs/brand-guides/.gitbook/assets/google-smart-device-management-api-enable-button.png similarity index 100% rename from docs/guides/.gitbook/assets/google-smart-device-management-api-enable-button.png rename to docs/brand-guides/.gitbook/assets/google-smart-device-management-api-enable-button.png diff --git a/docs/guides/.gitbook/assets/guides/2n-connect-flow-screens.png b/docs/brand-guides/.gitbook/assets/guides/2n-connect-flow-screens.png similarity index 100% rename from docs/guides/.gitbook/assets/guides/2n-connect-flow-screens.png rename to docs/brand-guides/.gitbook/assets/guides/2n-connect-flow-screens.png diff --git a/docs/guides/.gitbook/assets/guides/controlbyweb-connect-flow-screens.jpg b/docs/brand-guides/.gitbook/assets/guides/controlbyweb-connect-flow-screens.jpg similarity index 100% rename from docs/guides/.gitbook/assets/guides/controlbyweb-connect-flow-screens.jpg rename to docs/brand-guides/.gitbook/assets/guides/controlbyweb-connect-flow-screens.jpg diff --git a/docs/guides/.gitbook/assets/guides/controlbyweb-getting-started-guide-cover.jpg b/docs/brand-guides/.gitbook/assets/guides/controlbyweb-getting-started-guide-cover.jpg similarity index 100% rename from docs/guides/.gitbook/assets/guides/controlbyweb-getting-started-guide-cover.jpg rename to docs/brand-guides/.gitbook/assets/guides/controlbyweb-getting-started-guide-cover.jpg diff --git a/docs/guides/.gitbook/assets/guides/dormakaba-oracode-getting-started-seo-cover.jpg b/docs/brand-guides/.gitbook/assets/guides/dormakaba-oracode-getting-started-seo-cover.jpg similarity index 100% rename from docs/guides/.gitbook/assets/guides/dormakaba-oracode-getting-started-seo-cover.jpg rename to docs/brand-guides/.gitbook/assets/guides/dormakaba-oracode-getting-started-seo-cover.jpg diff --git a/docs/guides/.gitbook/assets/guides/igloo-connect-flow-screens.png b/docs/brand-guides/.gitbook/assets/guides/igloo-connect-flow-screens.png similarity index 100% rename from docs/guides/.gitbook/assets/guides/igloo-connect-flow-screens.png rename to docs/brand-guides/.gitbook/assets/guides/igloo-connect-flow-screens.png diff --git a/docs/guides/.gitbook/assets/guides/kwikset-connect-flow-screens.jpg b/docs/brand-guides/.gitbook/assets/guides/kwikset-connect-flow-screens.jpg similarity index 100% rename from docs/guides/.gitbook/assets/guides/kwikset-connect-flow-screens.jpg rename to docs/brand-guides/.gitbook/assets/guides/kwikset-connect-flow-screens.jpg diff --git a/docs/guides/.gitbook/assets/guides/minut-connect-flow-screens.jpg b/docs/brand-guides/.gitbook/assets/guides/minut-connect-flow-screens.jpg similarity index 100% rename from docs/guides/.gitbook/assets/guides/minut-connect-flow-screens.jpg rename to docs/brand-guides/.gitbook/assets/guides/minut-connect-flow-screens.jpg diff --git a/docs/guides/.gitbook/assets/guides/noiseaware-connect-flow-screens.jpg b/docs/brand-guides/.gitbook/assets/guides/noiseaware-connect-flow-screens.jpg similarity index 100% rename from docs/guides/.gitbook/assets/guides/noiseaware-connect-flow-screens.jpg rename to docs/brand-guides/.gitbook/assets/guides/noiseaware-connect-flow-screens.jpg diff --git a/docs/guides/.gitbook/assets/guides/nuki-connect-flow-screens.jpg b/docs/brand-guides/.gitbook/assets/guides/nuki-connect-flow-screens.jpg similarity index 100% rename from docs/guides/.gitbook/assets/guides/nuki-connect-flow-screens.jpg rename to docs/brand-guides/.gitbook/assets/guides/nuki-connect-flow-screens.jpg diff --git a/docs/guides/.gitbook/assets/guides/smart-lock-connect-flow-screens.png b/docs/brand-guides/.gitbook/assets/guides/smart-lock-connect-flow-screens.png similarity index 100% rename from docs/guides/.gitbook/assets/guides/smart-lock-connect-flow-screens.png rename to docs/brand-guides/.gitbook/assets/guides/smart-lock-connect-flow-screens.png diff --git a/docs/guides/.gitbook/assets/guides/smart-locks-16-9-seam.png b/docs/brand-guides/.gitbook/assets/guides/smart-locks-16-9-seam.png similarity index 100% rename from docs/guides/.gitbook/assets/guides/smart-locks-16-9-seam.png rename to docs/brand-guides/.gitbook/assets/guides/smart-locks-16-9-seam.png diff --git a/docs/guides/.gitbook/assets/guides/wyze-connect-flow-screens.jpg b/docs/brand-guides/.gitbook/assets/guides/wyze-connect-flow-screens.jpg similarity index 100% rename from docs/guides/.gitbook/assets/guides/wyze-connect-flow-screens.jpg rename to docs/brand-guides/.gitbook/assets/guides/wyze-connect-flow-screens.jpg diff --git a/docs/guides/.gitbook/assets/guides/wyze-getting-seo-cover.jpg b/docs/brand-guides/.gitbook/assets/guides/wyze-getting-seo-cover.jpg similarity index 100% rename from docs/guides/.gitbook/assets/guides/wyze-getting-seo-cover.jpg rename to docs/brand-guides/.gitbook/assets/guides/wyze-getting-seo-cover.jpg diff --git a/docs/guides/.gitbook/assets/guides/yale-auth-example.png b/docs/brand-guides/.gitbook/assets/guides/yale-auth-example.png similarity index 100% rename from docs/guides/.gitbook/assets/guides/yale-auth-example.png rename to docs/brand-guides/.gitbook/assets/guides/yale-auth-example.png diff --git a/docs/guides/.gitbook/assets/honeywell-logo.png b/docs/brand-guides/.gitbook/assets/honeywell-logo.png similarity index 100% rename from docs/guides/.gitbook/assets/honeywell-logo.png rename to docs/brand-guides/.gitbook/assets/honeywell-logo.png diff --git a/docs/guides/.gitbook/assets/honeywell-manufacturer-page-cover-dark.png b/docs/brand-guides/.gitbook/assets/honeywell-manufacturer-page-cover-dark.png similarity index 100% rename from docs/guides/.gitbook/assets/honeywell-manufacturer-page-cover-dark.png rename to docs/brand-guides/.gitbook/assets/honeywell-manufacturer-page-cover-dark.png diff --git a/docs/guides/.gitbook/assets/honeywell-manufacturer-page-cover-light.png b/docs/brand-guides/.gitbook/assets/honeywell-manufacturer-page-cover-light.png similarity index 100% rename from docs/guides/.gitbook/assets/honeywell-manufacturer-page-cover-light.png rename to docs/brand-guides/.gitbook/assets/honeywell-manufacturer-page-cover-light.png diff --git a/docs/guides/.gitbook/assets/honeywell_connect-flow-screens_dark.png b/docs/brand-guides/.gitbook/assets/honeywell_connect-flow-screens_dark.png similarity index 100% rename from docs/guides/.gitbook/assets/honeywell_connect-flow-screens_dark.png rename to docs/brand-guides/.gitbook/assets/honeywell_connect-flow-screens_dark.png diff --git a/docs/guides/.gitbook/assets/honeywell_connect-flow-screens_light.png b/docs/brand-guides/.gitbook/assets/honeywell_connect-flow-screens_light.png similarity index 100% rename from docs/guides/.gitbook/assets/honeywell_connect-flow-screens_light.png rename to docs/brand-guides/.gitbook/assets/honeywell_connect-flow-screens_light.png diff --git a/docs/guides/.gitbook/assets/igloohome-logo.png b/docs/brand-guides/.gitbook/assets/igloohome-logo.png similarity index 100% rename from docs/guides/.gitbook/assets/igloohome-logo.png rename to docs/brand-guides/.gitbook/assets/igloohome-logo.png diff --git a/docs/guides/.gitbook/assets/image (29) (1).png b/docs/brand-guides/.gitbook/assets/image (29) (1).png similarity index 100% rename from docs/guides/.gitbook/assets/image (29) (1).png rename to docs/brand-guides/.gitbook/assets/image (29) (1).png diff --git a/docs/guides/.gitbook/assets/image (29).png b/docs/brand-guides/.gitbook/assets/image (29).png similarity index 100% rename from docs/guides/.gitbook/assets/image (29).png rename to docs/brand-guides/.gitbook/assets/image (29).png diff --git a/docs/guides/.gitbook/assets/image (36).png b/docs/brand-guides/.gitbook/assets/image (36).png similarity index 100% rename from docs/guides/.gitbook/assets/image (36).png rename to docs/brand-guides/.gitbook/assets/image (36).png diff --git a/docs/guides/.gitbook/assets/image (40).png b/docs/brand-guides/.gitbook/assets/image (40).png similarity index 100% rename from docs/guides/.gitbook/assets/image (40).png rename to docs/brand-guides/.gitbook/assets/image (40).png diff --git a/docs/guides/.gitbook/assets/image (44).png b/docs/brand-guides/.gitbook/assets/image (44).png similarity index 100% rename from docs/guides/.gitbook/assets/image (44).png rename to docs/brand-guides/.gitbook/assets/image (44).png diff --git a/docs/guides/.gitbook/assets/keynest logo transparent.png b/docs/brand-guides/.gitbook/assets/keynest logo transparent.png similarity index 100% rename from docs/guides/.gitbook/assets/keynest logo transparent.png rename to docs/brand-guides/.gitbook/assets/keynest logo transparent.png diff --git a/docs/guides/.gitbook/assets/kwikset-MFA-settings.png b/docs/brand-guides/.gitbook/assets/kwikset-MFA-settings.png similarity index 100% rename from docs/guides/.gitbook/assets/kwikset-MFA-settings.png rename to docs/brand-guides/.gitbook/assets/kwikset-MFA-settings.png diff --git a/docs/guides/.gitbook/assets/kwikset-halo-halo-touch-on-amazon.jpg b/docs/brand-guides/.gitbook/assets/kwikset-halo-halo-touch-on-amazon.jpg similarity index 100% rename from docs/guides/.gitbook/assets/kwikset-halo-halo-touch-on-amazon.jpg rename to docs/brand-guides/.gitbook/assets/kwikset-halo-halo-touch-on-amazon.jpg diff --git a/docs/guides/.gitbook/assets/kwikset-logo.png b/docs/brand-guides/.gitbook/assets/kwikset-logo.png similarity index 100% rename from docs/guides/.gitbook/assets/kwikset-logo.png rename to docs/brand-guides/.gitbook/assets/kwikset-logo.png diff --git a/docs/guides/.gitbook/assets/latch-acs.png b/docs/brand-guides/.gitbook/assets/latch-acs.png similarity index 100% rename from docs/guides/.gitbook/assets/latch-acs.png rename to docs/brand-guides/.gitbook/assets/latch-acs.png diff --git a/docs/guides/.gitbook/assets/latch-building-id.png b/docs/brand-guides/.gitbook/assets/latch-building-id.png similarity index 100% rename from docs/guides/.gitbook/assets/latch-building-id.png rename to docs/brand-guides/.gitbook/assets/latch-building-id.png diff --git a/docs/guides/.gitbook/assets/latch-logo.png b/docs/brand-guides/.gitbook/assets/latch-logo.png similarity index 100% rename from docs/guides/.gitbook/assets/latch-logo.png rename to docs/brand-guides/.gitbook/assets/latch-logo.png diff --git a/docs/guides/.gitbook/assets/latch-manufacturer-page-cover-dark.png b/docs/brand-guides/.gitbook/assets/latch-manufacturer-page-cover-dark.png similarity index 100% rename from docs/guides/.gitbook/assets/latch-manufacturer-page-cover-dark.png rename to docs/brand-guides/.gitbook/assets/latch-manufacturer-page-cover-dark.png diff --git a/docs/guides/.gitbook/assets/latch-manufacturer-page-cover-light.png b/docs/brand-guides/.gitbook/assets/latch-manufacturer-page-cover-light.png similarity index 100% rename from docs/guides/.gitbook/assets/latch-manufacturer-page-cover-light.png rename to docs/brand-guides/.gitbook/assets/latch-manufacturer-page-cover-light.png diff --git a/docs/guides/.gitbook/assets/lock-service-3g-add-server-connection.png b/docs/brand-guides/.gitbook/assets/lock-service-3g-add-server-connection.png similarity index 100% rename from docs/guides/.gitbook/assets/lock-service-3g-add-server-connection.png rename to docs/brand-guides/.gitbook/assets/lock-service-3g-add-server-connection.png diff --git a/docs/guides/.gitbook/assets/lock-service-3g-confirm-ble-module.png b/docs/brand-guides/.gitbook/assets/lock-service-3g-confirm-ble-module.png similarity index 100% rename from docs/guides/.gitbook/assets/lock-service-3g-confirm-ble-module.png rename to docs/brand-guides/.gitbook/assets/lock-service-3g-confirm-ble-module.png diff --git a/docs/guides/.gitbook/assets/lock-service-3g-download-data.png b/docs/brand-guides/.gitbook/assets/lock-service-3g-download-data.png similarity index 100% rename from docs/guides/.gitbook/assets/lock-service-3g-download-data.png rename to docs/brand-guides/.gitbook/assets/lock-service-3g-download-data.png diff --git a/docs/guides/.gitbook/assets/lock-service-3g-get-system-id.png b/docs/brand-guides/.gitbook/assets/lock-service-3g-get-system-id.png similarity index 100% rename from docs/guides/.gitbook/assets/lock-service-3g-get-system-id.png rename to docs/brand-guides/.gitbook/assets/lock-service-3g-get-system-id.png diff --git a/docs/guides/.gitbook/assets/lock-service-3g-initialize-lock-ble-config.png b/docs/brand-guides/.gitbook/assets/lock-service-3g-initialize-lock-ble-config.png similarity index 100% rename from docs/guides/.gitbook/assets/lock-service-3g-initialize-lock-ble-config.png rename to docs/brand-guides/.gitbook/assets/lock-service-3g-initialize-lock-ble-config.png diff --git a/docs/guides/.gitbook/assets/lock-service-3g-initialize-lock.png b/docs/brand-guides/.gitbook/assets/lock-service-3g-initialize-lock.png similarity index 100% rename from docs/guides/.gitbook/assets/lock-service-3g-initialize-lock.png rename to docs/brand-guides/.gitbook/assets/lock-service-3g-initialize-lock.png diff --git a/docs/guides/.gitbook/assets/lock-service-3g-register-pc.png b/docs/brand-guides/.gitbook/assets/lock-service-3g-register-pc.png similarity index 100% rename from docs/guides/.gitbook/assets/lock-service-3g-register-pc.png rename to docs/brand-guides/.gitbook/assets/lock-service-3g-register-pc.png diff --git a/docs/guides/.gitbook/assets/lock-service-3g-select-port.png b/docs/brand-guides/.gitbook/assets/lock-service-3g-select-port.png similarity index 100% rename from docs/guides/.gitbook/assets/lock-service-3g-select-port.png rename to docs/brand-guides/.gitbook/assets/lock-service-3g-select-port.png diff --git a/docs/guides/.gitbook/assets/lock-service-3g-select-server.png b/docs/brand-guides/.gitbook/assets/lock-service-3g-select-server.png similarity index 100% rename from docs/guides/.gitbook/assets/lock-service-3g-select-server.png rename to docs/brand-guides/.gitbook/assets/lock-service-3g-select-server.png diff --git a/docs/guides/.gitbook/assets/lock-service-3g-upload-firmware.png b/docs/brand-guides/.gitbook/assets/lock-service-3g-upload-firmware.png similarity index 100% rename from docs/guides/.gitbook/assets/lock-service-3g-upload-firmware.png rename to docs/brand-guides/.gitbook/assets/lock-service-3g-upload-firmware.png diff --git a/docs/guides/.gitbook/assets/lock-service-3g-upload-fw-save-to-db.png b/docs/brand-guides/.gitbook/assets/lock-service-3g-upload-fw-save-to-db.png similarity index 100% rename from docs/guides/.gitbook/assets/lock-service-3g-upload-fw-save-to-db.png rename to docs/brand-guides/.gitbook/assets/lock-service-3g-upload-fw-save-to-db.png diff --git a/docs/guides/.gitbook/assets/lockly-logo.png b/docs/brand-guides/.gitbook/assets/lockly-logo.png similarity index 100% rename from docs/guides/.gitbook/assets/lockly-logo.png rename to docs/brand-guides/.gitbook/assets/lockly-logo.png diff --git a/docs/guides/.gitbook/assets/lockly-manufacturer-page-cover-16-9-light.png b/docs/brand-guides/.gitbook/assets/lockly-manufacturer-page-cover-16-9-light.png similarity index 100% rename from docs/guides/.gitbook/assets/lockly-manufacturer-page-cover-16-9-light.png rename to docs/brand-guides/.gitbook/assets/lockly-manufacturer-page-cover-16-9-light.png diff --git a/docs/guides/.gitbook/assets/minut-logo.png b/docs/brand-guides/.gitbook/assets/minut-logo.png similarity index 100% rename from docs/guides/.gitbook/assets/minut-logo.png rename to docs/brand-guides/.gitbook/assets/minut-logo.png diff --git a/docs/guides/.gitbook/assets/nest-developer-settings.png b/docs/brand-guides/.gitbook/assets/nest-developer-settings.png similarity index 100% rename from docs/guides/.gitbook/assets/nest-developer-settings.png rename to docs/brand-guides/.gitbook/assets/nest-developer-settings.png diff --git a/docs/guides/.gitbook/assets/nest-manufacturer-page-cover-dark.png b/docs/brand-guides/.gitbook/assets/nest-manufacturer-page-cover-dark.png similarity index 100% rename from docs/guides/.gitbook/assets/nest-manufacturer-page-cover-dark.png rename to docs/brand-guides/.gitbook/assets/nest-manufacturer-page-cover-dark.png diff --git a/docs/guides/.gitbook/assets/nest-manufacturer-page-cover-light.png b/docs/brand-guides/.gitbook/assets/nest-manufacturer-page-cover-light.png similarity index 100% rename from docs/guides/.gitbook/assets/nest-manufacturer-page-cover-light.png rename to docs/brand-guides/.gitbook/assets/nest-manufacturer-page-cover-light.png diff --git a/docs/guides/.gitbook/assets/nest-oauth-redirect-uri-setup.png b/docs/brand-guides/.gitbook/assets/nest-oauth-redirect-uri-setup.png similarity index 100% rename from docs/guides/.gitbook/assets/nest-oauth-redirect-uri-setup.png rename to docs/brand-guides/.gitbook/assets/nest-oauth-redirect-uri-setup.png diff --git a/docs/guides/.gitbook/assets/nest-on-amazon.png b/docs/brand-guides/.gitbook/assets/nest-on-amazon.png similarity index 100% rename from docs/guides/.gitbook/assets/nest-on-amazon.png rename to docs/brand-guides/.gitbook/assets/nest-on-amazon.png diff --git a/docs/guides/.gitbook/assets/nest_connect-flow-screens_dark.png b/docs/brand-guides/.gitbook/assets/nest_connect-flow-screens_dark.png similarity index 100% rename from docs/guides/.gitbook/assets/nest_connect-flow-screens_dark.png rename to docs/brand-guides/.gitbook/assets/nest_connect-flow-screens_dark.png diff --git a/docs/guides/.gitbook/assets/nest_connect-flow-screens_light.png b/docs/brand-guides/.gitbook/assets/nest_connect-flow-screens_light.png similarity index 100% rename from docs/guides/.gitbook/assets/nest_connect-flow-screens_light.png rename to docs/brand-guides/.gitbook/assets/nest_connect-flow-screens_light.png diff --git a/docs/guides/.gitbook/assets/noiseaware-logo.png b/docs/brand-guides/.gitbook/assets/noiseaware-logo.png similarity index 100% rename from docs/guides/.gitbook/assets/noiseaware-logo.png rename to docs/brand-guides/.gitbook/assets/noiseaware-logo.png diff --git a/docs/guides/.gitbook/assets/nuki-logo.png b/docs/brand-guides/.gitbook/assets/nuki-logo.png similarity index 100% rename from docs/guides/.gitbook/assets/nuki-logo.png rename to docs/brand-guides/.gitbook/assets/nuki-logo.png diff --git a/docs/guides/.gitbook/assets/nuki-manufacturer-page-cover-light.png b/docs/brand-guides/.gitbook/assets/nuki-manufacturer-page-cover-light.png similarity index 100% rename from docs/guides/.gitbook/assets/nuki-manufacturer-page-cover-light.png rename to docs/brand-guides/.gitbook/assets/nuki-manufacturer-page-cover-light.png diff --git a/docs/guides/.gitbook/assets/nuki-web-connect-short-rental-integrators-dialog-w-link.png b/docs/brand-guides/.gitbook/assets/nuki-web-connect-short-rental-integrators-dialog-w-link.png similarity index 100% rename from docs/guides/.gitbook/assets/nuki-web-connect-short-rental-integrators-dialog-w-link.png rename to docs/brand-guides/.gitbook/assets/nuki-web-connect-short-rental-integrators-dialog-w-link.png diff --git a/docs/guides/.gitbook/assets/nuki-web-select-devices-smart-hosting-dialog.png b/docs/brand-guides/.gitbook/assets/nuki-web-select-devices-smart-hosting-dialog.png similarity index 100% rename from docs/guides/.gitbook/assets/nuki-web-select-devices-smart-hosting-dialog.png rename to docs/brand-guides/.gitbook/assets/nuki-web-select-devices-smart-hosting-dialog.png diff --git a/docs/guides/.gitbook/assets/nuki-web-short-term-rental-page.png b/docs/brand-guides/.gitbook/assets/nuki-web-short-term-rental-page.png similarity index 100% rename from docs/guides/.gitbook/assets/nuki-web-short-term-rental-page.png rename to docs/brand-guides/.gitbook/assets/nuki-web-short-term-rental-page.png diff --git a/docs/guides/.gitbook/assets/openapi (1).json b/docs/brand-guides/.gitbook/assets/openapi (1).json similarity index 100% rename from docs/guides/.gitbook/assets/openapi (1).json rename to docs/brand-guides/.gitbook/assets/openapi (1).json diff --git a/docs/guides/.gitbook/assets/openapi.json b/docs/brand-guides/.gitbook/assets/openapi.json similarity index 100% rename from docs/guides/.gitbook/assets/openapi.json rename to docs/brand-guides/.gitbook/assets/openapi.json diff --git a/docs/guides/.gitbook/assets/oracode-live-site-name.png b/docs/brand-guides/.gitbook/assets/oracode-live-site-name.png similarity index 100% rename from docs/guides/.gitbook/assets/oracode-live-site-name.png rename to docs/brand-guides/.gitbook/assets/oracode-live-site-name.png diff --git a/docs/guides/.gitbook/assets/pti-help-center.png b/docs/brand-guides/.gitbook/assets/pti-help-center.png similarity index 100% rename from docs/guides/.gitbook/assets/pti-help-center.png rename to docs/brand-guides/.gitbook/assets/pti-help-center.png diff --git a/docs/guides/.gitbook/assets/pti-logo.png b/docs/brand-guides/.gitbook/assets/pti-logo.png similarity index 100% rename from docs/guides/.gitbook/assets/pti-logo.png rename to docs/brand-guides/.gitbook/assets/pti-logo.png diff --git a/docs/guides/.gitbook/assets/salto-ks-acs-manufacturer-page-cover-dark.png b/docs/brand-guides/.gitbook/assets/salto-ks-acs-manufacturer-page-cover-dark.png similarity index 100% rename from docs/guides/.gitbook/assets/salto-ks-acs-manufacturer-page-cover-dark.png rename to docs/brand-guides/.gitbook/assets/salto-ks-acs-manufacturer-page-cover-dark.png diff --git a/docs/guides/.gitbook/assets/salto-ks-acs-manufacturer-page-cover-light.png b/docs/brand-guides/.gitbook/assets/salto-ks-acs-manufacturer-page-cover-light.png similarity index 100% rename from docs/guides/.gitbook/assets/salto-ks-acs-manufacturer-page-cover-light.png rename to docs/brand-guides/.gitbook/assets/salto-ks-acs-manufacturer-page-cover-light.png diff --git a/docs/guides/.gitbook/assets/salto-ks-acs.png b/docs/brand-guides/.gitbook/assets/salto-ks-acs.png similarity index 100% rename from docs/guides/.gitbook/assets/salto-ks-acs.png rename to docs/brand-guides/.gitbook/assets/salto-ks-acs.png diff --git a/docs/guides/.gitbook/assets/salto-ks-lock-settings-button.png b/docs/brand-guides/.gitbook/assets/salto-ks-lock-settings-button.png similarity index 100% rename from docs/guides/.gitbook/assets/salto-ks-lock-settings-button.png rename to docs/brand-guides/.gitbook/assets/salto-ks-lock-settings-button.png diff --git a/docs/guides/.gitbook/assets/salto-ks-logo.png b/docs/brand-guides/.gitbook/assets/salto-ks-logo.png similarity index 100% rename from docs/guides/.gitbook/assets/salto-ks-logo.png rename to docs/brand-guides/.gitbook/assets/salto-ks-logo.png diff --git a/docs/guides/.gitbook/assets/salto-ks-manufacturer-page-cover-dark.png b/docs/brand-guides/.gitbook/assets/salto-ks-manufacturer-page-cover-dark.png similarity index 100% rename from docs/guides/.gitbook/assets/salto-ks-manufacturer-page-cover-dark.png rename to docs/brand-guides/.gitbook/assets/salto-ks-manufacturer-page-cover-dark.png diff --git a/docs/guides/.gitbook/assets/salto-ks-manufacturer-page-cover-light.png b/docs/brand-guides/.gitbook/assets/salto-ks-manufacturer-page-cover-light.png similarity index 100% rename from docs/guides/.gitbook/assets/salto-ks-manufacturer-page-cover-light.png rename to docs/brand-guides/.gitbook/assets/salto-ks-manufacturer-page-cover-light.png diff --git a/docs/guides/.gitbook/assets/salto-ks-near-detection-mode-edit-button.png b/docs/brand-guides/.gitbook/assets/salto-ks-near-detection-mode-edit-button.png similarity index 100% rename from docs/guides/.gitbook/assets/salto-ks-near-detection-mode-edit-button.png rename to docs/brand-guides/.gitbook/assets/salto-ks-near-detection-mode-edit-button.png diff --git a/docs/guides/.gitbook/assets/salto-ks_connect-flow-screens_dark.png b/docs/brand-guides/.gitbook/assets/salto-ks_connect-flow-screens_dark.png similarity index 100% rename from docs/guides/.gitbook/assets/salto-ks_connect-flow-screens_dark.png rename to docs/brand-guides/.gitbook/assets/salto-ks_connect-flow-screens_dark.png diff --git a/docs/guides/.gitbook/assets/salto-ks_connect-flow-screens_light.png b/docs/brand-guides/.gitbook/assets/salto-ks_connect-flow-screens_light.png similarity index 100% rename from docs/guides/.gitbook/assets/salto-ks_connect-flow-screens_light.png rename to docs/brand-guides/.gitbook/assets/salto-ks_connect-flow-screens_light.png diff --git a/docs/guides/.gitbook/assets/salto-logo.png b/docs/brand-guides/.gitbook/assets/salto-logo.png similarity index 100% rename from docs/guides/.gitbook/assets/salto-logo.png rename to docs/brand-guides/.gitbook/assets/salto-logo.png diff --git a/docs/guides/.gitbook/assets/salto-space-acs.png b/docs/brand-guides/.gitbook/assets/salto-space-acs.png similarity index 100% rename from docs/guides/.gitbook/assets/salto-space-acs.png rename to docs/brand-guides/.gitbook/assets/salto-space-acs.png diff --git a/docs/guides/.gitbook/assets/salto-space-logo.png b/docs/brand-guides/.gitbook/assets/salto-space-logo.png similarity index 100% rename from docs/guides/.gitbook/assets/salto-space-logo.png rename to docs/brand-guides/.gitbook/assets/salto-space-logo.png diff --git a/docs/guides/.gitbook/assets/salto-space-manufacturer-page-cover-dark.png b/docs/brand-guides/.gitbook/assets/salto-space-manufacturer-page-cover-dark.png similarity index 100% rename from docs/guides/.gitbook/assets/salto-space-manufacturer-page-cover-dark.png rename to docs/brand-guides/.gitbook/assets/salto-space-manufacturer-page-cover-dark.png diff --git a/docs/guides/.gitbook/assets/salto-space-manufacturer-page-cover-light.png b/docs/brand-guides/.gitbook/assets/salto-space-manufacturer-page-cover-light.png similarity index 100% rename from docs/guides/.gitbook/assets/salto-space-manufacturer-page-cover-light.png rename to docs/brand-guides/.gitbook/assets/salto-space-manufacturer-page-cover-light.png diff --git a/docs/guides/.gitbook/assets/salto-space-ship-settings.png b/docs/brand-guides/.gitbook/assets/salto-space-ship-settings.png similarity index 100% rename from docs/guides/.gitbook/assets/salto-space-ship-settings.png rename to docs/brand-guides/.gitbook/assets/salto-space-ship-settings.png diff --git a/docs/guides/.gitbook/assets/schlage-logo.png b/docs/brand-guides/.gitbook/assets/schlage-logo.png similarity index 100% rename from docs/guides/.gitbook/assets/schlage-logo.png rename to docs/brand-guides/.gitbook/assets/schlage-logo.png diff --git a/docs/guides/.gitbook/assets/schlage-manufacturer-page-cover-dark.png b/docs/brand-guides/.gitbook/assets/schlage-manufacturer-page-cover-dark.png similarity index 100% rename from docs/guides/.gitbook/assets/schlage-manufacturer-page-cover-dark.png rename to docs/brand-guides/.gitbook/assets/schlage-manufacturer-page-cover-dark.png diff --git a/docs/guides/.gitbook/assets/schlage-manufacturer-page-cover-light.png b/docs/brand-guides/.gitbook/assets/schlage-manufacturer-page-cover-light.png similarity index 100% rename from docs/guides/.gitbook/assets/schlage-manufacturer-page-cover-light.png rename to docs/brand-guides/.gitbook/assets/schlage-manufacturer-page-cover-light.png diff --git a/docs/guides/.gitbook/assets/schlage-on-amazon.png b/docs/brand-guides/.gitbook/assets/schlage-on-amazon.png similarity index 100% rename from docs/guides/.gitbook/assets/schlage-on-amazon.png rename to docs/brand-guides/.gitbook/assets/schlage-on-amazon.png diff --git a/docs/guides/.gitbook/assets/seam-bridge-pairing-code.png b/docs/brand-guides/.gitbook/assets/seam-bridge-pairing-code.png similarity index 100% rename from docs/guides/.gitbook/assets/seam-bridge-pairing-code.png rename to docs/brand-guides/.gitbook/assets/seam-bridge-pairing-code.png diff --git a/docs/guides/.gitbook/assets/seam-contact-us-light.png b/docs/brand-guides/.gitbook/assets/seam-contact-us-light.png similarity index 100% rename from docs/guides/.gitbook/assets/seam-contact-us-light.png rename to docs/brand-guides/.gitbook/assets/seam-contact-us-light.png diff --git a/docs/guides/.gitbook/assets/select-entrances-for-user.png b/docs/brand-guides/.gitbook/assets/select-entrances-for-user.png similarity index 100% rename from docs/guides/.gitbook/assets/select-entrances-for-user.png rename to docs/brand-guides/.gitbook/assets/select-entrances-for-user.png diff --git a/docs/guides/.gitbook/assets/sensi-manufacturer-page-cover-dark.png b/docs/brand-guides/.gitbook/assets/sensi-manufacturer-page-cover-dark.png similarity index 100% rename from docs/guides/.gitbook/assets/sensi-manufacturer-page-cover-dark.png rename to docs/brand-guides/.gitbook/assets/sensi-manufacturer-page-cover-dark.png diff --git a/docs/guides/.gitbook/assets/sensi-manufacturer-page-cover-light.png b/docs/brand-guides/.gitbook/assets/sensi-manufacturer-page-cover-light.png similarity index 100% rename from docs/guides/.gitbook/assets/sensi-manufacturer-page-cover-light.png rename to docs/brand-guides/.gitbook/assets/sensi-manufacturer-page-cover-light.png diff --git a/docs/guides/.gitbook/assets/sensi_connect-flow-screens_dark.png b/docs/brand-guides/.gitbook/assets/sensi_connect-flow-screens_dark.png similarity index 100% rename from docs/guides/.gitbook/assets/sensi_connect-flow-screens_dark.png rename to docs/brand-guides/.gitbook/assets/sensi_connect-flow-screens_dark.png diff --git a/docs/guides/.gitbook/assets/sensi_connect-flow-screens_light.png b/docs/brand-guides/.gitbook/assets/sensi_connect-flow-screens_light.png similarity index 100% rename from docs/guides/.gitbook/assets/sensi_connect-flow-screens_light.png rename to docs/brand-guides/.gitbook/assets/sensi_connect-flow-screens_light.png diff --git a/docs/guides/.gitbook/assets/setup tile.png b/docs/brand-guides/.gitbook/assets/setup tile.png similarity index 100% rename from docs/guides/.gitbook/assets/setup tile.png rename to docs/brand-guides/.gitbook/assets/setup tile.png diff --git a/docs/guides/.gitbook/assets/smartthings-logo.png b/docs/brand-guides/.gitbook/assets/smartthings-logo.png similarity index 100% rename from docs/guides/.gitbook/assets/smartthings-logo.png rename to docs/brand-guides/.gitbook/assets/smartthings-logo.png diff --git a/docs/guides/.gitbook/assets/smartthings-manufacturer-page-cover-dark.png b/docs/brand-guides/.gitbook/assets/smartthings-manufacturer-page-cover-dark.png similarity index 100% rename from docs/guides/.gitbook/assets/smartthings-manufacturer-page-cover-dark.png rename to docs/brand-guides/.gitbook/assets/smartthings-manufacturer-page-cover-dark.png diff --git a/docs/guides/.gitbook/assets/smartthings-manufacturer-page-cover-light.png b/docs/brand-guides/.gitbook/assets/smartthings-manufacturer-page-cover-light.png similarity index 100% rename from docs/guides/.gitbook/assets/smartthings-manufacturer-page-cover-light.png rename to docs/brand-guides/.gitbook/assets/smartthings-manufacturer-page-cover-light.png diff --git a/docs/guides/.gitbook/assets/smartthings_connect-flow-screens_dark.png b/docs/brand-guides/.gitbook/assets/smartthings_connect-flow-screens_dark.png similarity index 100% rename from docs/guides/.gitbook/assets/smartthings_connect-flow-screens_dark.png rename to docs/brand-guides/.gitbook/assets/smartthings_connect-flow-screens_dark.png diff --git a/docs/guides/.gitbook/assets/smartthings_connect-flow-screens_light.png b/docs/brand-guides/.gitbook/assets/smartthings_connect-flow-screens_light.png similarity index 100% rename from docs/guides/.gitbook/assets/smartthings_connect-flow-screens_light.png rename to docs/brand-guides/.gitbook/assets/smartthings_connect-flow-screens_light.png diff --git a/docs/guides/.gitbook/assets/tedee-connect-flow-screens.png b/docs/brand-guides/.gitbook/assets/tedee-connect-flow-screens.png similarity index 100% rename from docs/guides/.gitbook/assets/tedee-connect-flow-screens.png rename to docs/brand-guides/.gitbook/assets/tedee-connect-flow-screens.png diff --git a/docs/guides/.gitbook/assets/tedee-getting-started-cover.jpg b/docs/brand-guides/.gitbook/assets/tedee-getting-started-cover.jpg similarity index 100% rename from docs/guides/.gitbook/assets/tedee-getting-started-cover.jpg rename to docs/brand-guides/.gitbook/assets/tedee-getting-started-cover.jpg diff --git a/docs/guides/.gitbook/assets/tedee-logo.png b/docs/brand-guides/.gitbook/assets/tedee-logo.png similarity index 100% rename from docs/guides/.gitbook/assets/tedee-logo.png rename to docs/brand-guides/.gitbook/assets/tedee-logo.png diff --git a/docs/guides/.gitbook/assets/tedee-manufacturer-page-cover-dark.png b/docs/brand-guides/.gitbook/assets/tedee-manufacturer-page-cover-dark.png similarity index 100% rename from docs/guides/.gitbook/assets/tedee-manufacturer-page-cover-dark.png rename to docs/brand-guides/.gitbook/assets/tedee-manufacturer-page-cover-dark.png diff --git a/docs/guides/.gitbook/assets/tedee-manufacturer-page-cover-light.png b/docs/brand-guides/.gitbook/assets/tedee-manufacturer-page-cover-light.png similarity index 100% rename from docs/guides/.gitbook/assets/tedee-manufacturer-page-cover-light.png rename to docs/brand-guides/.gitbook/assets/tedee-manufacturer-page-cover-light.png diff --git a/docs/guides/.gitbook/assets/ttlock-logo.png b/docs/brand-guides/.gitbook/assets/ttlock-logo.png similarity index 100% rename from docs/guides/.gitbook/assets/ttlock-logo.png rename to docs/brand-guides/.gitbook/assets/ttlock-logo.png diff --git a/docs/guides/.gitbook/assets/ttlock_connect-flow-screens_dark.png b/docs/brand-guides/.gitbook/assets/ttlock_connect-flow-screens_dark.png similarity index 100% rename from docs/guides/.gitbook/assets/ttlock_connect-flow-screens_dark.png rename to docs/brand-guides/.gitbook/assets/ttlock_connect-flow-screens_dark.png diff --git a/docs/guides/.gitbook/assets/ttlock_connect-flow-screens_light.png b/docs/brand-guides/.gitbook/assets/ttlock_connect-flow-screens_light.png similarity index 100% rename from docs/guides/.gitbook/assets/ttlock_connect-flow-screens_light.png rename to docs/brand-guides/.gitbook/assets/ttlock_connect-flow-screens_light.png diff --git a/docs/guides/.gitbook/assets/ttlock_get-started-cover_dark.png b/docs/brand-guides/.gitbook/assets/ttlock_get-started-cover_dark.png similarity index 100% rename from docs/guides/.gitbook/assets/ttlock_get-started-cover_dark.png rename to docs/brand-guides/.gitbook/assets/ttlock_get-started-cover_dark.png diff --git a/docs/guides/.gitbook/assets/ultraloq-manufacturer-page-cover-light.png b/docs/brand-guides/.gitbook/assets/ultraloq-manufacturer-page-cover-light.png similarity index 100% rename from docs/guides/.gitbook/assets/ultraloq-manufacturer-page-cover-light.png rename to docs/brand-guides/.gitbook/assets/ultraloq-manufacturer-page-cover-light.png diff --git a/docs/guides/.gitbook/assets/visionline-add-common-door-area.png b/docs/brand-guides/.gitbook/assets/visionline-add-common-door-area.png similarity index 100% rename from docs/guides/.gitbook/assets/visionline-add-common-door-area.png rename to docs/brand-guides/.gitbook/assets/visionline-add-common-door-area.png diff --git a/docs/guides/.gitbook/assets/visionline-add-common-entrance-door-ble-profile.png b/docs/brand-guides/.gitbook/assets/visionline-add-common-entrance-door-ble-profile.png similarity index 100% rename from docs/guides/.gitbook/assets/visionline-add-common-entrance-door-ble-profile.png rename to docs/brand-guides/.gitbook/assets/visionline-add-common-entrance-door-ble-profile.png diff --git a/docs/guides/.gitbook/assets/visionline-add-common-entrance-door.png b/docs/brand-guides/.gitbook/assets/visionline-add-common-entrance-door.png similarity index 100% rename from docs/guides/.gitbook/assets/visionline-add-common-entrance-door.png rename to docs/brand-guides/.gitbook/assets/visionline-add-common-entrance-door.png diff --git a/docs/guides/.gitbook/assets/visionline-add-device-for-lock-service-3g.png b/docs/brand-guides/.gitbook/assets/visionline-add-device-for-lock-service-3g.png similarity index 100% rename from docs/guides/.gitbook/assets/visionline-add-device-for-lock-service-3g.png rename to docs/brand-guides/.gitbook/assets/visionline-add-device-for-lock-service-3g.png diff --git a/docs/guides/.gitbook/assets/visionline-add-guest-door-area.png b/docs/brand-guides/.gitbook/assets/visionline-add-guest-door-area.png similarity index 100% rename from docs/guides/.gitbook/assets/visionline-add-guest-door-area.png rename to docs/brand-guides/.gitbook/assets/visionline-add-guest-door-area.png diff --git a/docs/guides/.gitbook/assets/visionline-add-guest-doors-ble-profile.png b/docs/brand-guides/.gitbook/assets/visionline-add-guest-doors-ble-profile.png similarity index 100% rename from docs/guides/.gitbook/assets/visionline-add-guest-doors-ble-profile.png rename to docs/brand-guides/.gitbook/assets/visionline-add-guest-doors-ble-profile.png diff --git a/docs/guides/.gitbook/assets/visionline-add-guest-doors.png b/docs/brand-guides/.gitbook/assets/visionline-add-guest-doors.png similarity index 100% rename from docs/guides/.gitbook/assets/visionline-add-guest-doors.png rename to docs/brand-guides/.gitbook/assets/visionline-add-guest-doors.png diff --git a/docs/guides/.gitbook/assets/visionline-add-operator.png b/docs/brand-guides/.gitbook/assets/visionline-add-operator.png similarity index 100% rename from docs/guides/.gitbook/assets/visionline-add-operator.png rename to docs/brand-guides/.gitbook/assets/visionline-add-operator.png diff --git a/docs/guides/.gitbook/assets/visionline-add-user.png b/docs/brand-guides/.gitbook/assets/visionline-add-user.png similarity index 100% rename from docs/guides/.gitbook/assets/visionline-add-user.png rename to docs/brand-guides/.gitbook/assets/visionline-add-user.png diff --git a/docs/guides/.gitbook/assets/visionline-card-encoder-device-details-window.png b/docs/brand-guides/.gitbook/assets/visionline-card-encoder-device-details-window.png similarity index 100% rename from docs/guides/.gitbook/assets/visionline-card-encoder-device-details-window.png rename to docs/brand-guides/.gitbook/assets/visionline-card-encoder-device-details-window.png diff --git a/docs/guides/.gitbook/assets/visionline-card-encoder-select-s-n-field.png b/docs/brand-guides/.gitbook/assets/visionline-card-encoder-select-s-n-field.png similarity index 100% rename from docs/guides/.gitbook/assets/visionline-card-encoder-select-s-n-field.png rename to docs/brand-guides/.gitbook/assets/visionline-card-encoder-select-s-n-field.png diff --git a/docs/guides/.gitbook/assets/visionline-get-registration-code.png b/docs/brand-guides/.gitbook/assets/visionline-get-registration-code.png similarity index 100% rename from docs/guides/.gitbook/assets/visionline-get-registration-code.png rename to docs/brand-guides/.gitbook/assets/visionline-get-registration-code.png diff --git a/docs/guides/.gitbook/assets/visionline-mobile-access-accout-details.png b/docs/brand-guides/.gitbook/assets/visionline-mobile-access-accout-details.png similarity index 100% rename from docs/guides/.gitbook/assets/visionline-mobile-access-accout-details.png rename to docs/brand-guides/.gitbook/assets/visionline-mobile-access-accout-details.png diff --git a/docs/guides/.gitbook/assets/visionline-select-encoder-window.png b/docs/brand-guides/.gitbook/assets/visionline-select-encoder-window.png similarity index 100% rename from docs/guides/.gitbook/assets/visionline-select-encoder-window.png rename to docs/brand-guides/.gitbook/assets/visionline-select-encoder-window.png diff --git a/docs/guides/.gitbook/assets/visionline-set-mobile-uuid.png b/docs/brand-guides/.gitbook/assets/visionline-set-mobile-uuid.png similarity index 100% rename from docs/guides/.gitbook/assets/visionline-set-mobile-uuid.png rename to docs/brand-guides/.gitbook/assets/visionline-set-mobile-uuid.png diff --git a/docs/guides/.gitbook/assets/workspace-id-for-latch.png b/docs/brand-guides/.gitbook/assets/workspace-id-for-latch.png similarity index 100% rename from docs/guides/.gitbook/assets/workspace-id-for-latch.png rename to docs/brand-guides/.gitbook/assets/workspace-id-for-latch.png diff --git a/docs/guides/.gitbook/assets/wyze-api-docs-cover.png b/docs/brand-guides/.gitbook/assets/wyze-api-docs-cover.png similarity index 100% rename from docs/guides/.gitbook/assets/wyze-api-docs-cover.png rename to docs/brand-guides/.gitbook/assets/wyze-api-docs-cover.png diff --git a/docs/guides/.gitbook/assets/wyze-api-key-example.png b/docs/brand-guides/.gitbook/assets/wyze-api-key-example.png similarity index 100% rename from docs/guides/.gitbook/assets/wyze-api-key-example.png rename to docs/brand-guides/.gitbook/assets/wyze-api-key-example.png diff --git a/docs/guides/.gitbook/assets/wyze-logo.png b/docs/brand-guides/.gitbook/assets/wyze-logo.png similarity index 100% rename from docs/guides/.gitbook/assets/wyze-logo.png rename to docs/brand-guides/.gitbook/assets/wyze-logo.png diff --git a/docs/guides/.gitbook/assets/yale-ayr202-zwv-usa-assure-lock-z-wave-plus-network-module-ayr202-zwv-usa.jpeg b/docs/brand-guides/.gitbook/assets/yale-ayr202-zwv-usa-assure-lock-z-wave-plus-network-module-ayr202-zwv-usa.jpeg similarity index 100% rename from docs/guides/.gitbook/assets/yale-ayr202-zwv-usa-assure-lock-z-wave-plus-network-module-ayr202-zwv-usa.jpeg rename to docs/brand-guides/.gitbook/assets/yale-ayr202-zwv-usa-assure-lock-z-wave-plus-network-module-ayr202-zwv-usa.jpeg diff --git a/docs/guides/.gitbook/assets/yale-logo.png b/docs/brand-guides/.gitbook/assets/yale-logo.png similarity index 100% rename from docs/guides/.gitbook/assets/yale-logo.png rename to docs/brand-guides/.gitbook/assets/yale-logo.png diff --git a/docs/guides/.gitbook/assets/yale-on-amazon.png b/docs/brand-guides/.gitbook/assets/yale-on-amazon.png similarity index 100% rename from docs/guides/.gitbook/assets/yale-on-amazon.png rename to docs/brand-guides/.gitbook/assets/yale-on-amazon.png diff --git a/docs/guides/.gitbook/assets/yale-on-gokeyless.png b/docs/brand-guides/.gitbook/assets/yale-on-gokeyless.png similarity index 100% rename from docs/guides/.gitbook/assets/yale-on-gokeyless.png rename to docs/brand-guides/.gitbook/assets/yale-on-gokeyless.png From 2902735f9e1100e272959266c3358e25f574083c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Louis=20Pr=C3=A9?= Date: Tue, 21 Apr 2026 20:29:05 -0700 Subject: [PATCH 4/8] Add Brand Guides to site sections config Co-Authored-By: Claude Opus 4.6 (1M context) --- codegen/lib/config.ts | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/codegen/lib/config.ts b/codegen/lib/config.ts index 3c6e0f2bf..4419e8323 100644 --- a/codegen/lib/config.ts +++ b/codegen/lib/config.ts @@ -24,6 +24,11 @@ export const siteSections: SiteSection[] = [ root: join('docs', 'api-reference'), urlPrefix: '/api', }, + { + name: 'Brand Guides', + root: join('docs', 'brand-guides'), + urlPrefix: '/device-and-system-integration-guides', + }, { name: 'Guides', root: join('docs', 'guides'), urlPrefix: '' }, ] From d94c9b2ff961df106d1d10814aaee62470108b9e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Louis=20Pr=C3=A9?= Date: Tue, 21 Apr 2026 20:29:13 -0700 Subject: [PATCH 5/8] Fix all cross-section and asset links after brand guides move Convert relative links that cross site section boundaries into absolute URLs. Update asset paths for moved brand-only assets. Fix references to deleted overview.md. Co-Authored-By: Claude Opus 4.6 (1M context) --- codegen/data/paths.yaml | 2 +- .../2n-intercom-systems/README.md | 2 +- .../get-started-with-2n-intercoms.md | 10 +-- docs/brand-guides/33-lock-devices/README.md | 6 +- .../get-started-with-33-lock-devices.md | 44 ++++++------- docs/brand-guides/4suites-locks/README.md | 8 +-- .../get-started-with-4suites-locks.md | 40 ++++++------ docs/brand-guides/README.md | 10 +-- docs/brand-guides/akiles-locks/README.md | 8 +-- .../get-started-with-akiles-locks.md | 44 ++++++------- ...assa-abloy-vingcard-credential-services.md | 2 +- .../README.md | 10 +-- .../README.md | 6 +- .../revoking-mobile-credentials.md | 2 +- ...ating-visionline-card-based-credentials.md | 14 ++-- .../README.md | 2 +- ...-visionline-development-account-to-seam.md | 6 +- ...r-visionline-production-account-to-seam.md | 6 +- ...-visionline-development-account-to-seam.md | 4 +- .../README.md | 2 +- ...nect-the-virtual-visionline-acs-to-seam.md | 2 +- ...r-visionline-production-account-to-seam.md | 4 +- docs/brand-guides/august-locks.md | 8 +-- .../avigilon-alta-access-system.md | 6 +- docs/brand-guides/brivo-access/README.md | 8 +-- .../README.md | 8 +-- .../dormakaba-ambiance-setup-guide.md | 2 +- .../README.md | 8 +-- .../dormakaba-community-setup-guide.md | 2 +- .../dormakaba-oracode-locks/README.md | 6 +- ...-dormakaba-oracode-offline-access-codes.md | 22 +++---- ...et-started-with-dormakaba-oracode-locks.md | 10 +-- ...access-codes-on-dormakaba-oracode-locks.md | 2 +- docs/brand-guides/ecobee-thermostats.md | 14 ++-- .../get-started-with-august-locks.md | 48 +++++++------- .../get-started-with-controlbyweb-devices.md | 6 +- .../get-started-with-ecobee-thermostats.md | 36 +++++------ .../get-started-with-kwikset-wifi-locks.md | 8 +-- .../get-started-with-minut-sensors.md | 6 +- .../get-started-with-noiseaware-sensors.md | 6 +- .../get-started-with-nuki-locks.md | 8 +-- .../get-started-with-salto-locks.md | 8 +-- .../get-started-with-smartlocks-api.md | 10 +-- .../get-started-with-ttlock-devices.md | 44 ++++++------- .../get-started-with-wyze-locks.md | 8 +-- .../get-started-with-yale-locks.md | 8 +-- .../google-nest-thermostats/README.md | 20 +++--- .../get-started-with-nest-thermostats.md | 36 +++++------ ...evice-access-and-commercial-development.md | 8 +-- .../honeywell-thermostats/README.md | 14 ++-- .../get-started-with-honeywell-thermostats.md | 36 +++++------ docs/brand-guides/igloohome-locks/README.md | 10 +-- ...creating-igloohome-offline-access-codes.md | 24 +++---- .../get-started-with-igloo-locks.md | 8 +-- .../keynest-key-lockers/README.md | 2 +- docs/brand-guides/kwikset-locks.md | 10 +-- .../latch-access-control-system/README.md | 18 +++--- .../latch-setup-guide.md | 2 +- ...rogramming-code-based-latch-credentials.md | 14 ++-- ...rogramming-latch-acs-mobile-credentials.md | 18 +++--- docs/brand-guides/lockly-locks/README.md | 2 +- .../creating-lockly-offline-access-codes.md | 10 +-- docs/brand-guides/minut-sensors.md | 6 +- docs/brand-guides/noiseaware-sensors.md | 6 +- docs/brand-guides/nuki-locks.md | 8 +-- docs/brand-guides/pti-storlogix-cloud.md | 18 +++--- .../salto-ks-access-control-system/README.md | 16 ++--- ...ramming-code-based-salto-ks-credentials.md | 16 ++--- ...programming-salto-ks-mobile-credentials.md | 20 +++--- .../salto-ks-setup-instructions.md | 2 +- docs/brand-guides/salto-locks.md | 8 +-- .../README.md | 18 +++--- ...ming-salto-space-card-based-credentials.md | 26 ++++---- ...gramming-salto-space-mobile-credentials.md | 20 +++--- .../salto-space-setup-instructions.md | 4 +- docs/brand-guides/schlage-locks/README.md | 6 +- .../get-started-with-schlage-locks.md | 8 +-- .../schlage-locks-setup-instructions.md | 4 +- docs/brand-guides/sensi-thermostats/README.md | 16 ++--- .../get-started-with-sensi-thermostats.md | 36 +++++------ .../smartthings-hubs-+-devices/README.md | 20 +++--- ...ted-with-smartthings-hubs-+-smart-locks.md | 44 ++++++------- ...ted-with-smartthings-hubs-+-thermostats.md | 36 +++++------ .../smartthings-hubs-+-smart-locks.md | 8 +-- docs/brand-guides/tedee-locks/README.md | 8 +-- .../get-started-with-tedee-locks.md | 14 ++-- docs/brand-guides/ttlock-locks.md | 10 +-- docs/brand-guides/ultraloq-locks/README.md | 2 +- .../configuring-ultraloq-device-timezones.md | 2 +- .../creating-ultraloq-access-codes.md | 4 +- .../ultraloq-locks/ultraloq-setup-guide.md | 10 +-- docs/brand-guides/wyze-locks.md | 8 +-- docs/brand-guides/yale-locks.md | 4 +- .../capability-guides/access-grants/README.md | 2 +- ...reating-an-access-grant-using-entrances.md | 2 +- .../creating-an-access-grant-using-spaces.md | 2 +- .../access-systems/README.md | 2 +- .../access-systems/acs-quick-starts/README.md | 2 +- .../encodable-key-card-quick-start.md | 6 +- .../mobile-key-quick-start.md | 4 +- .../acs-quick-starts/pin-code-quick-start.md | 4 +- .../assigning-credentials-to-users.md | 20 +++--- .../connect-an-acs-to-seam/README.md | 2 +- .../access-control-system-resources.md | 2 +- ...nding-access-control-system-differences.md | 8 +-- .../access-systems/managing-credentials.md | 56 ++++++++-------- ...ng-credentials-and-associated-entrances.md | 10 +-- .../retrieving-entrance-details.md | 16 ++--- ...ubleshooting-your-access-control-system.md | 4 +- .../access-systems/user-management.md | 2 +- .../assigning-users-to-access-groups.md | 2 +- ...ing-and-encoding-card-based-credentials.md | 4 +- .../setting-up-your-site-for-instant-keys.md | 2 +- ...edentials-from-an-access-control-system.md | 2 +- .../mobile-access/mobile-access-setup.md | 10 +-- .../initializing-the-seam-mobile-sdk.md | 2 +- docs/guides/capability-guides/seam-bridge.md | 4 +- .../smart-locks/access-codes/README.md | 12 ++-- .../understanding-code-constraints.md | 2 +- .../migrating-existing-access-codes.md | 6 +- .../access-codes/offline-access-codes.md | 18 +++--- .../customizing-connect-webviews.md | 64 +++++++++---------- .../developer-tools/mobile-sdks/README.md | 2 +- .../2n-intercoms-sample-data.md | 2 +- .../4suites-locks-sample-data.md | 2 +- ...ne-access-management-system-sample-data.md | 4 +- .../august-locks-sample-data.md | 2 +- ...avigilon-alta-access-system-sample-data.md | 2 +- .../brivo-access-sample-data.md | 2 +- .../dormakaba-oracode-sample-data.md | 2 +- .../ecobee-sample-data.md | 2 +- .../google-nest-thermostats-sample-data.md | 2 +- .../igloohome-sample-data.md | 2 +- .../kwikset-locks-sample-data.md | 2 +- .../lockly-lock-sample-data.md | 2 +- .../minut-noise-sensor-sample-data.md | 2 +- .../noiseaware-sample-data.md | 2 +- .../nuki-sample-data.md | 2 +- .../pti-storlogix-cloud-sample-data.md | 2 +- .../sandbox-akiles-locks.md | 2 +- ...assa-abloy-vingcard-credential-services.md | 2 +- ...assa-abloy-vostio-access-control-system.md | 2 +- ...ormakaba-ambiance-access-control-system.md | 2 +- ...rmakaba-community-access-control-system.md | 2 +- .../sandbox-honeywell-thermostats.md | 2 +- .../sandbox-latch-access-control-system.md | 2 +- .../sandbox-salto-ks-access-control-system.md | 2 +- .../sandbox-salto-ks-locks.md | 2 +- .../sandbox-sensi-thermostats.md | 2 +- .../sandbox-tedee-locks.md | 2 +- .../ttlock-sample-data.md | 2 +- .../wyze-sample-data.md | 2 +- .../yale-sample-data.md | 2 +- .../setting-up-the-hotel-site.md | 6 +- 154 files changed, 754 insertions(+), 754 deletions(-) diff --git a/codegen/data/paths.yaml b/codegen/data/paths.yaml index dfd11b176..42ddea1e4 100644 --- a/codegen/data/paths.yaml +++ b/codegen/data/paths.yaml @@ -14,7 +14,7 @@ 1. Create `acs_user`s. 2. Configure access for these users. - For some access control systems, configure the allowed entrances and access schedule. For other systems, use `acs_access_group`s. For details, see the [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems) for your access control system. + For some access control systems, configure the allowed entrances and access schedule. For other systems, use `acs_access_group`s. For details, see the [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems) for your access control system. 3. Create `acs_credential`s, which are the digital means of granting access to users, such as PIN codes, mobile keys, and plastic (RFID) cards. If you are developing a mobile app to provide access for your users, you can also use [Seam's iOS and Android SDKs](https://docs.seam.co/latest/capability-guides/mobile-access/mobile-device-sdks) that pair with the Seam API to create and manage mobile keys. diff --git a/docs/brand-guides/2n-intercom-systems/README.md b/docs/brand-guides/2n-intercom-systems/README.md index 0a96b3d53..346862897 100644 --- a/docs/brand-guides/2n-intercom-systems/README.md +++ b/docs/brand-guides/2n-intercom-systems/README.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](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews)![Attachment.tiff](file:///Attachment.tiff). *** diff --git a/docs/brand-guides/2n-intercom-systems/get-started-with-2n-intercoms.md b/docs/brand-guides/2n-intercom-systems/get-started-with-2n-intercoms.md index 2de3d3c55..eacef598a 100644 --- a/docs/brand-guides/2n-intercom-systems/get-started-with-2n-intercoms.md +++ b/docs/brand-guides/2n-intercom-systems/get-started-with-2n-intercoms.md @@ -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](https://docs.seam.co/latest/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](../../developer-tools/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](https://docs.seam.co/latest/developer-tools/sandbox-and-sample-data/2n-intercoms-sample-data) credentials below: * **email:** jane@example.com * **password:** 1234 @@ -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](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) and allows you to create and manage them through the Seam API. \{% tabs %\} \{% tab title="Python" %\} @@ -556,7 +556,7 @@ In addition, if you'd like to explore other aspects of Seam, here is a list of h * [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) +* [Receiving webhook](https://docs.seam.co/latest/developer-tools/webhooks) for [device events](https://docs.seam.co/latest/api/events/list) +* [Core Concepts](https://docs.seam.co/latest/core-concepts/overview) If you have any questions or want to report an issue, email us at support@seam.co. diff --git a/docs/brand-guides/33-lock-devices/README.md b/docs/brand-guides/33-lock-devices/README.md index 417fa17e9..c2dfc4759 100644 --- a/docs/brand-guides/33-lock-devices/README.md +++ b/docs/brand-guides/33-lock-devices/README.md @@ -24,14 +24,14 @@ For detailed information about the 33 Lock devices that Seam supports, see our [ We support the following features: -* [Triggering web lock and unlock actions](../../capability-guides/smart-locks/lock-and-unlock.md) -* [Programming access codes](../../capability-guides/smart-locks/access-codes/) +* [Triggering web lock and unlock actions](https://docs.seam.co/latest/capability-guides/smart-locks/lock-and-unlock) +* [Programming access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) *** ### Device Provider Key -To create a [Connect Webview](../../core-concepts/connect-webviews/) that enables your users to connect their 33 Lock devices to Seam, include the `ttlock` 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](https://docs.seam.co/latest/core-concepts/connect-webviews) that enables your users to connect their 33 Lock devices to Seam, include the `ttlock` device provider key in the `accepted_providers` list. For more information, see [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). *** diff --git a/docs/brand-guides/33-lock-devices/get-started-with-33-lock-devices.md b/docs/brand-guides/33-lock-devices/get-started-with-33-lock-devices.md index b23c14907..680dc0b29 100644 --- a/docs/brand-guides/33-lock-devices/get-started-with-33-lock-devices.md +++ b/docs/brand-guides/33-lock-devices/get-started-with-33-lock-devices.md @@ -19,7 +19,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 33 Lock device 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](https://docs.seam.co/latest/core-concepts/seam-console/seam-online-cli), which you can access from directly within the [Seam Console](https://docs.seam.co/latest/core-concepts/seam-console). :arrow\_forward: [Go to the Seam Console!](https://console.seam.co/) {% endhint %} @@ -69,7 +69,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](https://docs.seam.co/latest/core-concepts/seam-console#create-a-seam-account) to get your [API key](https://docs.seam.co/latest/core-concepts/authentication/api-keys). Then, export your API key as an environment variable. @@ -78,21 +78,21 @@ $ 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 33 Lock device, use a [non-sandbox workspace](../../core-concepts/workspaces/#production-workspaces) and API key. +This guide uses a [sandbox workspace](https://docs.seam.co/latest/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 33 Lock device, use a [non-sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#production-workspaces) and API key. {% endhint %} *** ## Step 2: Link your 33 Lock with Seam -To control your 33 Lock device using the Seam API, you must first authorize your Seam workspace to connect to your associated TTLock account. If your application needs to connect to your users' TTLock 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 33 Lock devices. The Connect Webview presents a flow that prompts your users to enter their credentials for their TTLock account. +To control your 33 Lock device using the Seam API, you must first authorize your Seam workspace to connect to your associated TTLock account. If your application needs to connect to your users' TTLock accounts, Seam provides fully-embedded, [customizable](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews) client-side [Connect Webviews](https://docs.seam.co/latest/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 33 Lock devices. The Connect Webview presents a flow that prompts your users to enter their credentials for their TTLock 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 TTLock 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](https://docs.seam.co/latest/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-33-lock-devices.md#authorize-your-workspace) in this guide to complete the Connect Webview authorization flow. @@ -269,13 +269,13 @@ 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](https://docs.seam.co/latest/ui-components/overview/react-components/connect-account-button) within our suite of [Seam Components](https://docs.seam.co/latest/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](../../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. +Because you're using a sandbox workspace, you can connect Seam's test TTLock account. We provide [virtual devices](https://docs.seam.co/latest/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](../../developer-tools/sandbox-and-sample-data/ttlock-sample-data.md) credentials: +Complete the Connect Webview authorization flow by entering the following [TTLock sandbox account](https://docs.seam.co/latest/developer-tools/sandbox-and-sample-data/ttlock-sample-data) credentials: * **Email:** jane@example.com * **Password:** 1234 @@ -697,7 +697,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](https://docs.seam.co/latest/capability-guides/smart-locks/lock-and-unlock), [programming access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes), and so on. Seam's intuitive and granular [capability flags](https://docs.seam.co/latest/capability-guides/device-and-system-capabilities#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 33 Lock device: @@ -706,7 +706,7 @@ Try out the following actions on your 33 Lock device: ### 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](https://docs.seam.co/latest/core-concepts/action-attempts) to track the progress of the unlock operation. {% tabs %} {% tab title="Python" %} @@ -1014,9 +1014,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 33 Lock devices. These devices have an integrated 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](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) on 33 Lock devices. These devices have an integrated 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](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes) online access codes. {% tabs %} {% tab title="Python" %} @@ -1373,7 +1373,7 @@ if (updatedFrontDoor.CanProgramOnlineAccessCodes == true) { ## Step 5: Connect a real 33 Lock device -Now that you have learned the basics of using the Seam API, you can connect and control a real 33 Lock 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 33 Lock device. To do so, make sure to switch to a [non-sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#production-workspaces) and [API key](https://docs.seam.co/latest/core-concepts/authentication/api-keys). For more details about setting up your real 33 Lock device, see the [33 Lock locks integration guide](./). @@ -1381,15 +1381,15 @@ For more details about setting up your real 33 Lock device, see the [33 Lock loc ## 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](https://docs.seam.co/latest/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!

-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](https://docs.seam.co/latest/ui-components/overview/react-components/device-table) to display a list of devices and to identify all devices with issues. You can use the [Device Details Seam Component](https://docs.seam.co/latest/ui-components/overview/react-components/device-details) 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](https://docs.seam.co/latest/ui-components/overview/react-components/access-code-details) 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](https://docs.seam.co/latest/ui-components/overview). *** @@ -1398,17 +1398,17 @@ To learn about all the Seam Components that we provide, see [Seam Components](.. Now that you've completed this getting started guide for 33 Lock devices, you can learn more about what you can do with the Seam API. * [ ] **Explore**\ - See the [other devices and system integrations](../overview.md) that Seam supports. + See the [other devices and system integrations](https://docs.seam.co/latest/device-and-system-integration-guides) 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](https://docs.seam.co/latest/core-concepts/overview) and the [device and system capabilities ](https://docs.seam.co/latest/capability-guides/device-and-system-capabilities)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](https://docs.seam.co/latest/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](https://docs.seam.co/latest/developer-tools/webhooks) 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](https://docs.seam.co/latest/capability-guides/access-systems), [thermostats](https://docs.seam.co/latest/capability-guides/thermostats), and [noise sensors](https://docs.seam.co/latest/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](https://docs.seam.co/latest/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). diff --git a/docs/brand-guides/4suites-locks/README.md b/docs/brand-guides/4suites-locks/README.md index e359a73b3..2c0690410 100644 --- a/docs/brand-guides/4suites-locks/README.md +++ b/docs/brand-guides/4suites-locks/README.md @@ -22,14 +22,14 @@ For detailed information about the 4SUITES devices that Seam supports, see our [ We support the following features: -* [Triggering web lock and unlock actions](../../capability-guides/smart-locks/lock-and-unlock.md) -* [Programming access codes](../../capability-guides/smart-locks/access-codes/) +* [Triggering web lock and unlock actions](https://docs.seam.co/latest/capability-guides/smart-locks/lock-and-unlock) +* [Programming access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) *** ### Device Provider Key -To create a [Connect Webview](../../core-concepts/connect-webviews/) that enables your users to connect their 4SUITES devices to Seam, include the `four_suites` 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](https://docs.seam.co/latest/core-concepts/connect-webviews) that enables your users to connect their 4SUITES devices to Seam, include the `four_suites` device provider key in the `accepted_providers` list. For more information, see [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). *** @@ -38,7 +38,7 @@ To create a [Connect Webview](../../core-concepts/connect-webviews/) that enable To control 4SUITES devices using Seam, you must prompt owners of these devices to perform the following steps: 1. Obtain the credentials that you use to log in to your [4SUITES account](https://app.4suites.nl/auth/login). -2. Use these credentials to log in to the [Seam Connect Webview](../../core-concepts/connect-webviews/) to add your 4SUITES devices to Seam. +2. Use these credentials to log in to the [Seam Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) to add your 4SUITES devices to Seam. *** diff --git a/docs/brand-guides/4suites-locks/get-started-with-4suites-locks.md b/docs/brand-guides/4suites-locks/get-started-with-4suites-locks.md index eab1aa5f0..084dfa567 100644 --- a/docs/brand-guides/4suites-locks/get-started-with-4suites-locks.md +++ b/docs/brand-guides/4suites-locks/get-started-with-4suites-locks.md @@ -19,7 +19,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 4SUITES 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](https://docs.seam.co/latest/core-concepts/seam-console/seam-online-cli), which you can access from directly within the [Seam Console](https://docs.seam.co/latest/core-concepts/seam-console). :arrow\_forward: [Go to the Seam Console!](https://console.seam.co/) {% endhint %} @@ -69,7 +69,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](https://docs.seam.co/latest/core-concepts/seam-console#create-a-seam-account) to get your [API key](https://docs.seam.co/latest/core-concepts/authentication/api-keys). Then, export your API key as an environment variable. @@ -78,21 +78,21 @@ $ 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 4SUITES lock, use a [non-sandbox workspace](../../core-concepts/workspaces/#production-workspaces) and API key. +This guide uses a [sandbox workspace](https://docs.seam.co/latest/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 4SUITES lock, use a [non-sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#production-workspaces) and API key. {% endhint %} *** ## Step 2: Link your 4SUITES account with Seam -To control your 4SUITES lock using the Seam API, you must first authorize your Seam workspace to connect to your 4SUITES account. If your application needs to connect to your users' 4SUITES 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 4SUITES locks. The Connect Webview presents a flow that prompts your users to enter their credentials for their 4SUITES account. +To control your 4SUITES lock using the Seam API, you must first authorize your Seam workspace to connect to your 4SUITES account. If your application needs to connect to your users' 4SUITES accounts, Seam provides fully-embedded, [customizable](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews) client-side [Connect Webviews](https://docs.seam.co/latest/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 4SUITES locks. The Connect Webview presents a flow that prompts your users to enter their credentials for their 4SUITES 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 4SUITES 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](https://docs.seam.co/latest/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-4suites-locks.md#authorize-your-workspace) in this guide to complete the Connect Webview authorization flow. @@ -269,13 +269,13 @@ 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](https://docs.seam.co/latest/ui-components/overview/react-components/connect-account-button) within our suite of [Seam Components](https://docs.seam.co/latest/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](../../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. +Because you're using a sandbox workspace, you can connect Seam's test 4SUITES account. We provide [virtual devices](https://docs.seam.co/latest/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](../../developer-tools/sandbox-and-sample-data/4suites-locks-sample-data.md) credentials: +Complete the Connect Webview authorization flow by entering the following [4SUITES sandbox account](https://docs.seam.co/latest/developer-tools/sandbox-and-sample-data/4suites-locks-sample-data) credentials: * **Email:** jane@example.com * **Password:** 1234 @@ -679,7 +679,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](https://docs.seam.co/latest/capability-guides/smart-locks/lock-and-unlock), [programming access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes), and so on. Seam's intuitive and granular [capability flags](https://docs.seam.co/latest/capability-guides/device-and-system-capabilities#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 4SUITES lock: @@ -687,7 +687,7 @@ Try out the following actions on your 4SUITES 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](https://docs.seam.co/latest/core-concepts/action-attempts) to track the progress of the unlock operation. {% tabs %} {% tab title="Python" %} @@ -991,7 +991,7 @@ False ## Step 5: Connect a real 4SUITES lock -Now that you have learned the basics of using the Seam API, you can connect and control a real 4SUITES 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 4SUITES device. To do so, make sure to switch to a [non-sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#production-workspaces) and [API key](https://docs.seam.co/latest/core-concepts/authentication/api-keys). For more details about setting up your real 4SUITES lock, see the [4SUITES locks integration guide](./). @@ -999,15 +999,15 @@ For more details about setting up your real 4SUITES lock, see the [4SUITES locks ## 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](https://docs.seam.co/latest/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!

-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](https://docs.seam.co/latest/ui-components/overview/react-components/device-table) to display a list of devices and to identify all devices with issues. You can use the [Device Details Seam Component](https://docs.seam.co/latest/ui-components/overview/react-components/device-details) 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](https://docs.seam.co/latest/ui-components/overview/react-components/access-code-details) 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](https://docs.seam.co/latest/ui-components/overview). *** @@ -1016,17 +1016,17 @@ To learn about all the Seam Components that we provide, see [Seam Components](.. Now that you've completed this getting started guide for 4SUITES devices, you can learn more about what you can do with the Seam API. * [ ] **Explore**\ - See the [other devices and system integrations](../overview.md) that Seam supports. + See the [other devices and system integrations](https://docs.seam.co/latest/device-and-system-integration-guides) 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](https://docs.seam.co/latest/core-concepts/overview) and the [device and system capabilities ](https://docs.seam.co/latest/capability-guides/device-and-system-capabilities)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](https://docs.seam.co/latest/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](https://docs.seam.co/latest/developer-tools/webhooks) 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](https://docs.seam.co/latest/capability-guides/access-systems), [thermostats](https://docs.seam.co/latest/capability-guides/thermostats), and [noise sensors](https://docs.seam.co/latest/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](https://docs.seam.co/latest/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). diff --git a/docs/brand-guides/README.md b/docs/brand-guides/README.md index 6a9819892..471a65466 100644 --- a/docs/brand-guides/README.md +++ b/docs/brand-guides/README.md @@ -20,28 +20,28 @@ To find the integration guide for each of your devices or systems, see the follo ## Smart Locks -
2N Intercom Systems2n-logo.png2n-intercom-systems.md
33 Lock Devices33-lock-logo.png33-lock-devices
4SUITES Locks4suites-logo.png4suites-locks
Akiles Locksakiles-logo.pngakiles-locks
August Locksaugust-logo.pngaugust-locks.md
dormakaba Oracode Locksdormakaba-logo.pngdormakaba-oracode-locks.md
iglooHome Locksigloohome-logo.pngigloohome-locks.md
Kwikset Lockskwikset-logo.pngkwikset-locks.md
Lockly Lockslockly-logo.pnglockly-locks
Nuki Locksnuki-logo.pngnuki-locks.md
Salto KS Lockssalto-logo.pngsalto-locks.md
Schlage Locksschlage-logo.pngget-started-with-schlage-locks.md
SmartThings Hubs + Smart Lockssmartthings-logo.pngsmartthings-hubs-+-devices
Tedee Lockstedee-logo.pngtedee-locks
TTLock Locksttlock-logo.pngttlock-locks.md
Wyze Lockswyze-logo.pngwyze-locks.md
Yale Locksyale-logo.pngyale-locks.md
+
2N Intercom Systems2n-logo.png2n-intercom-systems.md
33 Lock Devices33-lock-logo.png33-lock-devices
4SUITES Locks4suites-logo.png4suites-locks
Akiles Locksakiles-logo.pngakiles-locks
August Locksaugust-logo.pngaugust-locks.md
dormakaba Oracode Locksdormakaba-logo.pngdormakaba-oracode-locks.md
iglooHome Locksigloohome-logo.pngigloohome-locks.md
Kwikset Lockskwikset-logo.pngkwikset-locks.md
Lockly Lockslockly-logo.pnglockly-locks
Nuki Locksnuki-logo.pngnuki-locks.md
Salto KS Lockssalto-logo.pngsalto-locks.md
Schlage Locksschlage-logo.pngget-started-with-schlage-locks.md
SmartThings Hubs + Smart Lockssmartthings-logo.pngsmartthings-hubs-+-devices
Tedee Lockstedee-logo.pngtedee-locks
TTLock Locksttlock-logo.pngttlock-locks.md
Wyze Lockswyze-logo.pngwyze-locks.md
Yale Locksyale-logo.pngyale-locks.md
*** ## Access Control Systems -
ASSA ABLOY Credential Servicesassa-abloy-logo.pngBroken link
ASSA ABLOY Visionline Access Control Systemassa-abloy-logo.pngassa-abloy-visionline-access-control-system
Avigilon Alta Access Systemavigilon-alta-logo.pngavigilon-alta-access-system.md
Brivo Accessbrivo-logo.pngbrivo-access
Latch Access Control Systemlatch-logo.pnglatch-access-control-system
PTI Storlogix Cloudpti-logo.pngpti-storlogix-cloud.md
Salto KS Access Control Systemsalto-ks-logo.pngsalto-ks-access-control-system
Salto ProAccess Space Access Systemsalto-space-logo.pngsalto-proaccess-space-access-system
+
ASSA ABLOY Credential Servicesassa-abloy-logo.pngBroken link
ASSA ABLOY Visionline Access Control Systemassa-abloy-logo.pngassa-abloy-visionline-access-control-system
Avigilon Alta Access Systemavigilon-alta-logo.pngavigilon-alta-access-system.md
Brivo Accessbrivo-logo.pngbrivo-access
Latch Access Control Systemlatch-logo.pnglatch-access-control-system
PTI Storlogix Cloudpti-logo.pngpti-storlogix-cloud.md
Salto KS Access Control Systemsalto-ks-logo.pngsalto-ks-access-control-system
Salto ProAccess Space Access Systemsalto-space-logo.pngsalto-proaccess-space-access-system
*** ## Thermostats -
ecobee Thermostatsecobee-logo.pngecobee-thermostats.md
Google Nest Thermostatsnest-logo.pnggoogle-nest-thermostats
Honeywell Resideo Thermostatshoneywell-logo.pnghoneywell-thermostats
Sensi Thermostatssensi-logo.pngsensi-thermostats
SmartThings Hubs + Thermostatssmartthings-logo.pngsmartthings-hubs-+-devices
+
ecobee Thermostatsecobee-logo.pngecobee-thermostats.md
Google Nest Thermostatsnest-logo.pnggoogle-nest-thermostats
Honeywell Resideo Thermostatshoneywell-logo.pnghoneywell-thermostats
Sensi Thermostatssensi-logo.pngsensi-thermostats
SmartThings Hubs + Thermostatssmartthings-logo.pngsmartthings-hubs-+-devices
*** ## Noise sensors -
Minut Sensorsminut-logo.pngminut-sensors.md
NoiseAware Sensorsnoiseaware-logo.pngnoiseaware-sensors.md
+
Minut Sensorsminut-logo.pngminut-sensors.md
NoiseAware Sensorsnoiseaware-logo.pngnoiseaware-sensors.md
*** ## Relays -
ControlByWeb Relayscontrolbyweb-logo.pngget-started-with-controlbyweb-devices.md
+
ControlByWeb Relayscontrolbyweb-logo.pngget-started-with-controlbyweb-devices.md
diff --git a/docs/brand-guides/akiles-locks/README.md b/docs/brand-guides/akiles-locks/README.md index 8b4fb448d..fd6f52769 100644 --- a/docs/brand-guides/akiles-locks/README.md +++ b/docs/brand-guides/akiles-locks/README.md @@ -28,14 +28,14 @@ For detailed information about the Akiles devices that Seam supports, see our [A We support the following features: -* [Triggering web unlock actions](../../capability-guides/smart-locks/lock-and-unlock.md) -* [Programming access codes](../../capability-guides/smart-locks/access-codes/) on devices that have an integrated keypad or Akiles Pinpad +* [Triggering web unlock actions](https://docs.seam.co/latest/capability-guides/smart-locks/lock-and-unlock) +* [Programming access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) on devices that have an integrated keypad or Akiles Pinpad *** ### Device Provider Key -To create a [Connect Webview](../../core-concepts/connect-webviews/) that enables your users to connect their Tedee devices to Seam, include the `akiles` 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](https://docs.seam.co/latest/core-concepts/connect-webviews) that enables your users to connect their Tedee devices to Seam, include the `akiles` device provider key in the `accepted_providers` list. For more information, see [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). *** @@ -85,7 +85,7 @@ To control Akiles devices using Seam, you must prompt owners of these devices to ### Connect Akiles Devices to Seam -Use your credentials for the Akiles app to log in to the [Seam Connect Webview](../../core-concepts/connect-webviews/) to add your devices to Seam. +Use your credentials for the Akiles app to log in to the [Seam Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) to add your devices to Seam. *** diff --git a/docs/brand-guides/akiles-locks/get-started-with-akiles-locks.md b/docs/brand-guides/akiles-locks/get-started-with-akiles-locks.md index 8e0af98fe..ae6f66c15 100644 --- a/docs/brand-guides/akiles-locks/get-started-with-akiles-locks.md +++ b/docs/brand-guides/akiles-locks/get-started-with-akiles-locks.md @@ -19,7 +19,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 Akiles 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](https://docs.seam.co/latest/core-concepts/seam-console/seam-online-cli), which you can access from directly within the [Seam Console](https://docs.seam.co/latest/core-concepts/seam-console). :arrow\_forward: [Go to the Seam Console!](https://console.seam.co/) {% endhint %} @@ -69,7 +69,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](https://docs.seam.co/latest/core-concepts/seam-console#create-a-seam-account) to get your [API key](https://docs.seam.co/latest/core-concepts/authentication/api-keys). Then, export your API key as an environment variable. @@ -78,21 +78,21 @@ $ 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 Akiles lock, use a [non-sandbox workspace](../../core-concepts/workspaces/#production-workspaces) and API key. +This guide uses a [sandbox workspace](https://docs.seam.co/latest/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 Akiles lock, use a [non-sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#production-workspaces) and API key. {% endhint %} *** ## Step 2: Link your Akiles account with Seam -To control your Akiles lock using the Seam API, you must first authorize your Seam workspace to connect to your Akiles account. If your application needs to connect to your users' Akiles 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 Akiles locks. The Connect Webview presents a flow that prompts your users to enter their credentials for their Akiles account. +To control your Akiles lock using the Seam API, you must first authorize your Seam workspace to connect to your Akiles account. If your application needs to connect to your users' Akiles accounts, Seam provides fully-embedded, [customizable](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews) client-side [Connect Webviews](https://docs.seam.co/latest/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 Akiles locks. The Connect Webview presents a flow that prompts your users to enter their credentials for their Akiles 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 Akiles 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](https://docs.seam.co/latest/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-akiles-locks.md#authorize-your-workspace) in this guide to complete the Connect Webview authorization flow. @@ -269,13 +269,13 @@ 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](https://docs.seam.co/latest/ui-components/overview/react-components/connect-account-button) within our suite of [Seam Components](https://docs.seam.co/latest/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](../../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. +Because you're using a sandbox workspace, you can connect Seam's test Akiles account. We provide [virtual devices](https://docs.seam.co/latest/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: +Complete the Connect Webview authorization flow by entering the following [Akiles sandbox account](https://docs.seam.co/latest/developer-tools/sandbox-and-sample-data/sandbox-akiles-locks) credentials: * **Email:** jane@example.com * **Password:** 1234 @@ -679,7 +679,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](https://docs.seam.co/latest/capability-guides/smart-locks/lock-and-unlock), [programming access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes), and so on. Seam's intuitive and granular [capability flags](https://docs.seam.co/latest/capability-guides/device-and-system-capabilities#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 Akiles lock: @@ -688,7 +688,7 @@ Try out the following actions on your Akiles 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](https://docs.seam.co/latest/core-concepts/action-attempts) to track the progress of the unlock operation. {% tabs %} {% tab title="Python" %} @@ -991,9 +991,9 @@ False ### Program access codes on your lock -You can use the Seam API to program [online access codes](../../capability-guides/smart-locks/access-codes/) on Akiles locks that have an integrated keypad or an Akiles Pinpad. Lock users can then enter these access codes using the keypad or Pinpad to unlock the lock. +You can use the Seam API to program [online access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) on Akiles locks that have an integrated keypad or an Akiles Pinpad. Lock users can then enter these access codes using the keypad or Pinpad 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](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes) online access codes. {% tabs %} {% tab title="Python" %} @@ -1350,7 +1350,7 @@ if (updatedFrontDoor.CanProgramOnlineAccessCodes == true) { ## Step 5: Connect a real Akiles lock -Now that you have learned the basics of using the Seam API, you can connect and control a real Akiles 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 Akiles device. To do so, make sure to switch to a [non-sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#production-workspaces) and [API key](https://docs.seam.co/latest/core-concepts/authentication/api-keys). For more details about setting up your real Akiles lock, see the [Akiles locks integration guide](./). @@ -1358,15 +1358,15 @@ For more details about setting up your real Akiles lock, see the [Akiles locks i ## 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](https://docs.seam.co/latest/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!

-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](https://docs.seam.co/latest/ui-components/overview/react-components/device-table) to display a list of devices and to identify all devices with issues. You can use the [Device Details Seam Component](https://docs.seam.co/latest/ui-components/overview/react-components/device-details) 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](https://docs.seam.co/latest/ui-components/overview/react-components/access-code-details) 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](https://docs.seam.co/latest/ui-components/overview). *** @@ -1375,17 +1375,17 @@ To learn about all the Seam Components that we provide, see [Seam Components](.. Now that you've completed this getting started guide for Akiles devices, you can learn more about what you can do with the Seam API. * [ ] **Explore**\ - See the [other devices and system integrations](../overview.md) that Seam supports. + See the [other devices and system integrations](https://docs.seam.co/latest/device-and-system-integration-guides) 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](https://docs.seam.co/latest/core-concepts/overview) and the [device and system capabilities ](https://docs.seam.co/latest/capability-guides/device-and-system-capabilities)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](https://docs.seam.co/latest/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](https://docs.seam.co/latest/developer-tools/webhooks) 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](https://docs.seam.co/latest/capability-guides/access-systems), [thermostats](https://docs.seam.co/latest/capability-guides/thermostats), and [noise sensors](https://docs.seam.co/latest/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](https://docs.seam.co/latest/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). diff --git a/docs/brand-guides/assa-abloy-vingcard-credential-services.md b/docs/brand-guides/assa-abloy-vingcard-credential-services.md index f72b4e165..ed6c45f56 100644 --- a/docs/brand-guides/assa-abloy-vingcard-credential-services.md +++ b/docs/brand-guides/assa-abloy-vingcard-credential-services.md @@ -39,7 +39,7 @@ Once you have received certification, ASSA ABLOY provides your production creden ## Setup Instructions -1. Create and then display a [Connect Webview](../core-concepts/connect-webviews/), including `assa_abloy_credential_service` in the set of [`accepted_providers`](https://docs.seam.co/latest/api/connect_webviews/).\ +1. Create and then display a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews), including `assa_abloy_credential_service` in the set of [`accepted_providers`](https://docs.seam.co/latest/api/connect_webviews/).\ Alternately, in the top navigation pane of [Seam Console](https://console.seam.co/), click **ACS Systems**. Then, in the upper-right corner of the **Access Systems** page, click **New Access System**.
Click ACS Systems to go to the Access Systems page.

Click ACS Systems to go to the Access Systems page.

diff --git a/docs/brand-guides/assa-abloy-visionline-access-control-system/README.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/README.md index ea72ee15c..006bfcdbb 100644 --- a/docs/brand-guides/assa-abloy-visionline-access-control-system/README.md +++ b/docs/brand-guides/assa-abloy-visionline-access-control-system/README.md @@ -22,21 +22,21 @@ For detailed information about the ASSA ABLOY Visionline devices that Seam suppo We support the following features: -* [Managing access systems](../../capability-guides/access-systems/) -* [Issuing plastic card credentials](../../capability-guides/access-systems/managing-credentials.md#create-a-key-card-based-credential) -* [Issuing mobile access credentials](../../capability-guides/mobile-access/) +* [Managing access systems](https://docs.seam.co/latest/capability-guides/access-systems) +* [Issuing plastic card credentials](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#create-a-key-card-based-credential) +* [Issuing mobile access credentials](https://docs.seam.co/latest/capability-guides/mobile-access) *** ### Device Provider Key -To create a [Connect Webview](../../core-concepts/connect-webviews/) that enables you to connect your Visionline ACS to Seam, include the `visionline` 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](https://docs.seam.co/latest/core-concepts/connect-webviews) that enables you to connect your Visionline ACS to Seam, include the `visionline` device provider key in the `accepted_providers` list. For more information, see [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). *** ## Troubleshooting -For information about Visionline ACS-related errors, including issues related to the connection between your ACS and Seam, see [Troubleshooting Your ACS](../../capability-guides/access-systems/troubleshooting-your-access-control-system.md). +For information about Visionline ACS-related errors, including issues related to the connection between your ACS and Seam, see [Troubleshooting Your ACS](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system). *** diff --git a/docs/brand-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/README.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/README.md index fbafbe076..9642a9c4f 100644 --- a/docs/brand-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/README.md +++ b/docs/brand-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/README.md @@ -10,7 +10,7 @@ This guide describes how to issue guest and staff mobile credentials on the Visi ## Access Permission Assignment for Visionline -Visionline is a [credential-based access control system](../../../capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md#credential-based-access-control-systems). That is, you create ACS users and credentials. Within these credentials, you specify the set of entrances to which you want to grant access and the schedules for this access. +Visionline is a [credential-based access control system](https://docs.seam.co/latest/capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences#credential-based-access-control-systems). That is, you create ACS users and credentials. Within these credentials, you specify the set of entrances to which you want to grant access and the schedules for this access.
Seam resource relationships for a credential-based ACS

Seam resource relationships for a credential-based ACS

@@ -30,8 +30,8 @@ Seam currently only supports issuing guest mobile credentials and plastic cards. Use the following basic process to grant access in a Visionline ACS: -1. Set up the mobile user account by creating a [user identity](../../../capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities.md#what-is-a-user-identity). -2. Associate the user identity with an [ACS user](../../../capability-guides/access-systems/#what-is-a-user). +1. Set up the mobile user account by creating a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). +2. Associate the user identity with an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems#what-is-a-user). 3. Gather the entrances to which the credential should have access. 4. Create the [guest](./#issuing-guest-mobile-credentials) mobile credential. diff --git a/docs/brand-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/revoking-mobile-credentials.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/revoking-mobile-credentials.md index 2abb27d5a..49234a72b 100644 --- a/docs/brand-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/revoking-mobile-credentials.md +++ b/docs/brand-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/revoking-mobile-credentials.md @@ -4,7 +4,7 @@ description: Learn how to delete mobile credentials. # Revoking Mobile Credentials -To revoke a mobile credential, [delete the credential](../../../capability-guides/access-systems/managing-credentials.md#delete-a-credential). Seam issues a discard command for the Visionline card. If you are deleting a [multi-phone sync credential](../../../capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system.md#what-are-multi-phone-sync-credentials), Seam discards all of the credentials that were created underneath it. +To revoke a mobile credential, [delete the credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#delete-a-credential). Seam issues a discard command for the Visionline card. If you are deleting a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials), Seam discards all of the credentials that were created underneath it. {% tabs %} {% tab title="Python" %} diff --git a/docs/brand-guides/assa-abloy-visionline-access-control-system/creating-visionline-card-based-credentials.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/creating-visionline-card-based-credentials.md index 9aa444fad..d1c86f1d1 100644 --- a/docs/brand-guides/assa-abloy-visionline-access-control-system/creating-visionline-card-based-credentials.md +++ b/docs/brand-guides/assa-abloy-visionline-access-control-system/creating-visionline-card-based-credentials.md @@ -6,8 +6,8 @@ description: Learn how to create a card-based credential for Visionline. To create a credential to encode onto a plastic key card for a Visionline ACS: -1. Set up an [ACS user](../../capability-guides/access-systems/user-management.md). -2. Create a [credential](../../capability-guides/access-systems/managing-credentials.md#create-a-card-based-credential) with the `access_method` set to `card` and the appropriate [`visionline_metadata`](mobile-credential-related-properties.md#acs_credential.visionline_metadata-properties), such as the card format. +1. Set up an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). +2. Create a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#create-a-card-based-credential) with the `access_method` set to `card` and the appropriate [`visionline_metadata`](mobile-credential-related-properties.md#acs_credential.visionline_metadata-properties), such as the card format. * To issue the first credential for a reservation—that is, an "override" credential—make sure to set `visionline_metadata.override` to `true`. * To issue subsequent credentials for a reservation, set the `visionline_metadata.joiner_acs_credential_ids`. @@ -15,11 +15,11 @@ To create a credential to encode onto a plastic key card for a Visionline ACS: For more information about Visionline credential types, see [Credential Types for Visionline](configuring-visionline-mobile-credentials/#credential-types-for-visionline) and [Guest Mobile Credential Types](configuring-visionline-mobile-credentials/#guest-mobile-credential-types). 3. Encode the credential onto a plastic card. 1. Use the `/acs/encoders/list` endpoint to retrieve a list of available encoders. Then, choose the encoder that you want to use to write the credential to the card.\ - See [Retrieve Encoders](../../capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials.md#id-2.-retrieve-encoders). + See [Retrieve Encoders](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials#id-2.-retrieve-encoders). 2. Use the `/acs/encoders/encode_credential` endpoint to encode the credential onto the card, using the encoder that you have chosen.\ - See [Encode the Card](../../capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials.md#id-3.-encode-the-card). - 3. Confirm that the card was encoded successfully using polling or a [webhook](../../developer-tools/webhooks.md).\ - See [Confirm Successful Encoding](../../capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials.md#id-4.-confirm-successful-encoding). Also, see a list of [common encoding errors](../../capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials.md#common-encoding-errors). + See [Encode the Card](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials#id-3.-encode-the-card). + 3. Confirm that the card was encoded successfully using polling or a [webhook](https://docs.seam.co/latest/developer-tools/webhooks).\ + See [Confirm Successful Encoding](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials#id-4.-confirm-successful-encoding). Also, see a list of [common encoding errors](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials#common-encoding-errors). The following example shows how to create a card-based override credential for Visionline and encode it onto a plastic card: @@ -476,4 +476,4 @@ $seam->action_attempts->get( ## Next Steps -You can use an encoder to scan a plastic key card to read its encoded parameters. The scan result includes the card's properties, such as its card number, serial number, and other useful details. For more information, see [Scanning Encoded Cards](../../capability-guides/access-systems/working-with-card-encoders-and-scanners/scanning-encoded-cards.md). \ No newline at end of file +You can use an encoder to scan a plastic key card to read its encoded parameters. The scan result includes the card's properties, such as its card number, serial number, and other useful details. For more information, see [Scanning Encoded Cards](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/scanning-encoded-cards). \ No newline at end of file diff --git a/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/README.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/README.md index 390ff0ae5..9a12cc832 100644 --- a/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/README.md +++ b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/README.md @@ -10,7 +10,7 @@ Seam's Visionline ACS integration enables you to create the following two types * Mobile apps that issue Visionline mobile keys {% hint style="info" %} -For information about Seam mobile keys, see [Mobile Access](../../../capability-guides/mobile-access/). +For information about Seam mobile keys, see [Mobile Access](https://docs.seam.co/latest/capability-guides/mobile-access). {% endhint %} Integrating Visionline with Seam consists of a development phase and a production phase. The setup processes and requirements differ between these two phases. diff --git a/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-10-connect-your-visionline-development-account-to-seam.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-10-connect-your-visionline-development-account-to-seam.md index e7aa96fad..8d50a24d9 100644 --- a/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-10-connect-your-visionline-development-account-to-seam.md +++ b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-10-connect-your-visionline-development-account-to-seam.md @@ -11,7 +11,7 @@ To develop your mobile key app, perform the following procedures to connect your 1. [Connect your ASSA ABLOY Credential Services development account to Seam.](step-10-connect-your-visionline-development-account-to-seam.md#connect-credential-services-to-seam) 2. [Connect your Visionline development account to Seam.](step-10-connect-your-visionline-development-account-to-seam.md#connect-visionline-to-seam) - This process includes installing and running Seam Bridge to connect your on-premises Visionline application to Seam. For more information, see [Seam Bridge](../../../../../capability-guides/seam-bridge.md). + This process includes installing and running Seam Bridge to connect your on-premises Visionline application to Seam. For more information, see [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). *** @@ -86,10 +86,10 @@ Perform this process for each Visionline site that you want to connect to Seam. 4. If the Connect Webview displays multiple brand options, click **Visionline**. 5. On the **Set up your Seam Bridge** page, click [**latest Seam Bridge client**](https://www.seam.co/seam-bridge/releases/latest). - [Seam Bridge](../../../../../capability-guides/seam-bridge.md) is a software-only component that enables you to connect on-premises software systems to the Seam platform. Because Visionline is an on-premises ACS, Seam Bridge is required for Visionline systems. + [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) is a software-only component that enables you to connect on-premises software systems to the Seam platform. Because Visionline is an on-premises ACS, Seam Bridge is required for Visionline systems. 6. Download the Seam Bridge executable onto the on-premises computer that is running Visionline or onto a computer on the same network. - For systems requirements, see [Seam Bridge](../../../../../capability-guides/seam-bridge.md). + For systems requirements, see [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). 7. Run the downloaded Seam Bridge app. 8. In the **Welcome to Seam Bridge** window, type a name for the site that you are connecting using Seam Bridge and then click **Start pairing**. 9. Copy the pairing code. diff --git a/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-9-connect-your-visionline-production-account-to-seam.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-9-connect-your-visionline-production-account-to-seam.md index aa9d0c894..57d5ce120 100644 --- a/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-9-connect-your-visionline-production-account-to-seam.md +++ b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-9-connect-your-visionline-production-account-to-seam.md @@ -9,7 +9,7 @@ To launch your mobile key app into production, perform the following procedures 1. [Connect your ASSA ABLOY Credential Services production account to Seam.](step-9-connect-your-visionline-production-account-to-seam.md#connect-credential-services-to-seam) 2. [Connect your Visionline production account to Seam.](step-9-connect-your-visionline-production-account-to-seam.md#connect-visionline-to-seam) - This process includes installing and running Seam Bridge to connect your on-premises Visionline application to Seam. For more information, see [Seam Bridge](../../../../../capability-guides/seam-bridge.md). + This process includes installing and running Seam Bridge to connect your on-premises Visionline application to Seam. For more information, see [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). {% hint style="info" %} If you already connected your Visionline ACS to Seam during the development phase—using your Visionline development account—you must now reconnect Visionline to Seam using your production Visionline credentials. @@ -81,10 +81,10 @@ Perform this process for each Visionline site that you want to connect to Seam. 5. If the Connect Webview displays multiple brand options, click **Visionline**. 6. On the **Set up your Seam Bridge** page, click [**latest Seam Bridge client**](https://www.seam.co/seam-bridge/releases/latest). - [Seam Bridge](../../../../../capability-guides/seam-bridge.md) is a software-only component that enables you to connect on-premises software systems to the Seam platform. Because Visionline is an on-premises ACS, Seam Bridge is required for Visionline systems. + [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) is a software-only component that enables you to connect on-premises software systems to the Seam platform. Because Visionline is an on-premises ACS, Seam Bridge is required for Visionline systems. 7. Download the Seam Bridge executable onto the on-premises computer that is running Visionline or onto a computer on the same network. - For systems requirements, see [Seam Bridge](../../../../../capability-guides/seam-bridge.md). + For systems requirements, see [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). 8. Run the downloaded Seam Bridge app. 9. In the **Welcome to Seam Bridge** window, type a name for the site that you are connecting using Seam Bridge and then click **Start pairing**. 10. Copy the pairing code. diff --git a/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-8-connect-your-visionline-development-account-to-seam.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-8-connect-your-visionline-development-account-to-seam.md index aa5e621dd..b5817d4db 100644 --- a/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-8-connect-your-visionline-development-account-to-seam.md +++ b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-8-connect-your-visionline-development-account-to-seam.md @@ -16,10 +16,10 @@ Perform this process for each Visionline site that you want to connect to Seam. 4. If the Connect Webview displays multiple brand options, click **Visionline**. 5. On the **Set up your Seam Bridge** page, click [**latest Seam Bridge client**](https://www.seam.co/seam-bridge/releases/latest). - [Seam Bridge](../../../../../capability-guides/seam-bridge.md) is a software-only component that enables you to connect on-premises software systems to the Seam platform. Because Visionline is an on-premises ACS, Seam Bridge is required for Visionline systems. + [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) is a software-only component that enables you to connect on-premises software systems to the Seam platform. Because Visionline is an on-premises ACS, Seam Bridge is required for Visionline systems. 6. Download the Seam Bridge executable onto the on-premises computer that is running Visionline or onto a computer on the same network. - For systems requirements, see [Seam Bridge](../../../../../capability-guides/seam-bridge.md). + For systems requirements, see [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). 7. Run the downloaded Seam Bridge app. 8. In the **Welcome to Seam Bridge** window, type a name for the site that you are connecting using Seam Bridge and then click **Start pairing**. 9. Copy the pairing code. diff --git a/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/README.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/README.md index 4e2865d9a..d47de8141 100644 --- a/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/README.md +++ b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/README.md @@ -6,7 +6,7 @@ description: >- # Developing Your Visionline Plastic Card Encoding App Using a Sandbox Workspace -If you do not have access to an unlicensed Visionline account, you can use a [sandbox workspace](../../../../../core-concepts/workspaces/#sandbox-workspaces) and Seam-provided virtual Visionline ACS to develop and test your Visionline plastic card encoding app. Seam sandbox workspaces provide test accounts and virtual devices and systems that you can connect and control. Importantly, virtual devices and systems behave identically to the corresponding real devices and systems. +If you do not have access to an unlicensed Visionline account, you can use a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces) and Seam-provided virtual Visionline ACS to develop and test your Visionline plastic card encoding app. Seam sandbox workspaces provide test accounts and virtual devices and systems that you can connect and control. Importantly, virtual devices and systems behave identically to the corresponding real devices and systems. For detailed instructions, see the following topics: diff --git a/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/step-2-connect-the-virtual-visionline-acs-to-seam.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/step-2-connect-the-virtual-visionline-acs-to-seam.md index 57872fdfb..2253637ce 100644 --- a/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/step-2-connect-the-virtual-visionline-acs-to-seam.md +++ b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/step-2-connect-the-virtual-visionline-acs-to-seam.md @@ -19,7 +19,7 @@ Once you've created a sandbox workspace, add a virtual Visionline ACS to start d 2. If the Connect Webview displays multiple brand options, click **Visionline**. 3. On the **Set up your Seam Bridge** page, click **Continue**. - [Seam Bridge](../../../../../capability-guides/seam-bridge.md) is a software-only component that enables you to connect on-premises software systems to the Seam platform. Because Visionline is an on-premises ACS, Seam Bridge is required for real Visionline systems. However, this option uses a virtual Visionline ACS, so you do not need to install Seam Bridge. + [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) is a software-only component that enables you to connect on-premises software systems to the Seam platform. Because Visionline is an on-premises ACS, Seam Bridge is required for real Visionline systems. However, this option uses a virtual Visionline ACS, so you do not need to install Seam Bridge. 4. On the **Set up your Seam Bridge** page, click **Submit**. 5. On the **Enter your credentials** page: 1. In the **Visionline Site Name** field, type any string to identify this virtual Visionline ACS site, for example, `My Visionline Site`. diff --git a/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-5-connect-your-visionline-production-account-to-seam.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-5-connect-your-visionline-production-account-to-seam.md index f107c8a2c..f91a5a3ef 100644 --- a/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-5-connect-your-visionline-production-account-to-seam.md +++ b/docs/brand-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-5-connect-your-visionline-production-account-to-seam.md @@ -20,10 +20,10 @@ If you already connected your Visionline ACS to Seam during the development phas 4. If the Connect Webview displays multiple brand options, click **Visionline**. 5. On the **Set up your Seam Bridge** page, click [**latest Seam Bridge client**](https://www.seam.co/seam-bridge/releases/latest). - [Seam Bridge](../../../../../capability-guides/seam-bridge.md) is a software-only component that enables you to connect on-premises software systems to the Seam platform. Because Visionline is an on-premises ACS, Seam Bridge is required for Visionline systems. + [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) is a software-only component that enables you to connect on-premises software systems to the Seam platform. Because Visionline is an on-premises ACS, Seam Bridge is required for Visionline systems. 6. Download the Seam Bridge executable onto the on-premises computer that is running Visionline or onto a computer on the same network. - For systems requirements, see [Seam Bridge](../../../../../capability-guides/seam-bridge.md). + For systems requirements, see [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). 7. 8. Run the downloaded Seam Bridge app. 9. In the **Welcome to Seam Bridge** window, type a name for the site that you are connecting using Seam Bridge and then click **Start pairing**. diff --git a/docs/brand-guides/august-locks.md b/docs/brand-guides/august-locks.md index 05621e7bd..92fc5073a 100644 --- a/docs/brand-guides/august-locks.md +++ b/docs/brand-guides/august-locks.md @@ -32,14 +32,14 @@ For detailed information about the August devices that Seam supports, see our [A We support the following features: -* [Triggering web lock and unlock actions](../capability-guides/smart-locks/lock-and-unlock.md) -* [Programming access codes](../capability-guides/smart-locks/access-codes/) on locks that have an installed August Smart Keypad +* [Triggering web lock and unlock actions](https://docs.seam.co/latest/capability-guides/smart-locks/lock-and-unlock) +* [Programming access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) on locks that have an installed August Smart Keypad *** ### Device Provider Key -To create a [Connect Webview](../core-concepts/connect-webviews/) that enables your users to connect their August devices to Seam, include the `august` 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](https://docs.seam.co/latest/core-concepts/connect-webviews) that enables your users to connect their August devices to Seam, include the `august` device provider key in the `accepted_providers` list. For more information, see [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). *** @@ -49,7 +49,7 @@ To control August devices using Seam, you must prompt owners of these devices to 1. Create an account in the [August Home App](https://august.com/pages/app) if you have not done so already. 2. In the August Home App, add your August devices. -3. Note your login credentials for the August Home App, and use these credentials to log in to the [Seam Connect Webview](../core-concepts/connect-webviews/) to add your devices to Seam. +3. Note your login credentials for the August Home App, and use these credentials to log in to the [Seam Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) to add your devices to Seam. *** diff --git a/docs/brand-guides/avigilon-alta-access-system.md b/docs/brand-guides/avigilon-alta-access-system.md index 97d74f17d..dd821426e 100644 --- a/docs/brand-guides/avigilon-alta-access-system.md +++ b/docs/brand-guides/avigilon-alta-access-system.md @@ -24,13 +24,13 @@ For detailed information about the Avigilon Alta-connected devices that Seam sup We support the following features: -* [Triggering web lock and unlock actions](../capability-guides/smart-locks/lock-and-unlock.md) +* [Triggering web lock and unlock actions](https://docs.seam.co/latest/capability-guides/smart-locks/lock-and-unlock) *** ### Device Provider Key -To create a [Connect Webview](../core-concepts/connect-webviews/) that enables you to connect your Avigilon Alta access system and devices to Seam, include the `avigilon_alta` 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](https://docs.seam.co/latest/core-concepts/connect-webviews) that enables you to connect your Avigilon Alta access system and devices to Seam, include the `avigilon_alta` device provider key in the `accepted_providers` list. For more information, see [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). *** @@ -46,7 +46,7 @@ To control Avigilon Alta-connected devices using Seam, you must prompt owners of 2. Make sure that the **Roles** for the user include **Super Admin**.
Verify user permissions in the Avigilon Alta dashboard.
-4. Use the credentials for the user to log in to the [Seam Connect Webview](../core-concepts/connect-webviews/) to add your Avigilon Alta access system and devices to Seam. +4. Use the credentials for the user to log in to the [Seam Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) to add your Avigilon Alta access system and devices to Seam. *** diff --git a/docs/brand-guides/brivo-access/README.md b/docs/brand-guides/brivo-access/README.md index 89064cdcf..8848ca291 100644 --- a/docs/brand-guides/brivo-access/README.md +++ b/docs/brand-guides/brivo-access/README.md @@ -26,15 +26,15 @@ For detailed information about the Brivo-connected devices that Seam supports, s We support the following features: -* [Triggering web lock and unlock actions](../../capability-guides/smart-locks/lock-and-unlock.md) -* [Programming access codes](../../capability-guides/smart-locks/access-codes/) for readers and locks that have a keypad -* [Managing access systems](../../capability-guides/access-systems/) +* [Triggering web lock and unlock actions](https://docs.seam.co/latest/capability-guides/smart-locks/lock-and-unlock) +* [Programming access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) for readers and locks that have a keypad +* [Managing access systems](https://docs.seam.co/latest/capability-guides/access-systems) *** ### Device Provider Key -To create a [Connect Webview](../../core-concepts/connect-webviews/) that enables you to connect your Brivo Access platform and devices to Seam, include the `brivo` 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](https://docs.seam.co/latest/core-concepts/connect-webviews) that enables you to connect your Brivo Access platform and devices to Seam, include the `brivo` device provider key in the `accepted_providers` list. For more information, see [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). *** diff --git a/docs/brand-guides/dormakaba-ambiance-access-control-system/README.md b/docs/brand-guides/dormakaba-ambiance-access-control-system/README.md index d778229ce..f24280686 100644 --- a/docs/brand-guides/dormakaba-ambiance-access-control-system/README.md +++ b/docs/brand-guides/dormakaba-ambiance-access-control-system/README.md @@ -40,16 +40,16 @@ This integration supports all wireless locks and readers connected to the Dormak ## Related Features -* [**Access Grants**](../../capability-guides/access-grants/reservation-access-grants.md) – The universal way to manage access in Seam. Integrate once, and your access model works consistently across all providers, including Dormakaba Ambiance. For advanced, low-level control, you can still work directly with the ACS API. -* [**Mobile Keys**](../../capability-guides/mobile-access/) – Provision and revoke Bluetooth and wallet-based credentials directly from your PMS or app. -* [**Instant Keys**](../../capability-guides/instant-keys/) - Instantly issue temporary mobile pass that is shareable via an email or text. +* [**Access Grants**](https://docs.seam.co/latest/capability-guides/access-grants/reservation-access-grants) – The universal way to manage access in Seam. Integrate once, and your access model works consistently across all providers, including Dormakaba Ambiance. For advanced, low-level control, you can still work directly with the ACS API. +* [**Mobile Keys**](https://docs.seam.co/latest/capability-guides/mobile-access) – Provision and revoke Bluetooth and wallet-based credentials directly from your PMS or app. +* [**Instant Keys**](https://docs.seam.co/latest/capability-guides/instant-keys) - Instantly issue temporary mobile pass that is shareable via an email or text. * [**Plastic Card Encoding**](https://docs.seam.co/latest/api/acs/encoders/encode_credential) – Encode and issue physical access cards using Seam’s card management API. *** ## Connecting Dormakaba Ambiance to Seam -To enable your users to [connect an Ambiance system through Connect Webviews](../../core-concepts/connect-webviews/customizing-connect-webviews.md#customize-the-brands-to-display-in-your-connect-webviews), include the Dormakaba Ambiance provider: +To enable your users to [connect an Ambiance system through Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews), include the Dormakaba Ambiance provider: ```json { diff --git a/docs/brand-guides/dormakaba-ambiance-access-control-system/dormakaba-ambiance-setup-guide.md b/docs/brand-guides/dormakaba-ambiance-access-control-system/dormakaba-ambiance-setup-guide.md index 2894116ac..5547bdc14 100644 --- a/docs/brand-guides/dormakaba-ambiance-access-control-system/dormakaba-ambiance-setup-guide.md +++ b/docs/brand-guides/dormakaba-ambiance-access-control-system/dormakaba-ambiance-setup-guide.md @@ -75,7 +75,7 @@ You’ll enter all six in the next step. ## 2. Connect Ambiance to Seam {% hint style="info" %} -If your Ambiance server is on-premises, [install Seam Bridge](../../capability-guides/seam-bridge.md) before continuing.\ +If your Ambiance server is on-premises, [install Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) before continuing.\ Seam Bridge provides the secure outbound connection Seam uses to reach your Ambiance REST and SOAP APIs.\ Install it on the same computer as Ambiance or on a machine with network access to Ambiance and verify it’s running. {% endhint %} diff --git a/docs/brand-guides/dormakaba-community-access-control-system/README.md b/docs/brand-guides/dormakaba-community-access-control-system/README.md index cb9e9d1a6..d175827fa 100644 --- a/docs/brand-guides/dormakaba-community-access-control-system/README.md +++ b/docs/brand-guides/dormakaba-community-access-control-system/README.md @@ -42,16 +42,16 @@ This integration supports all wireless locks and readers connected to the Dormak ## Related Features -* [**Access Grants**](../../capability-guides/access-grants/reservation-access-grants.md) – The universal way to manage access in Seam. Integrate once, and your access model works consistently across all providers, including Dormakaba Community. For advanced, low-level control, you can still work directly with the ACS API. -* [**Mobile Keys**](../../capability-guides/mobile-access/) – Provision and revoke Bluetooth and wallet-based credentials directly from your PMS or app. -* [**Instant Keys**](../../capability-guides/instant-keys/) - Instantly issue temporary mobile pass that is shareable via an email or text. +* [**Access Grants**](https://docs.seam.co/latest/capability-guides/access-grants/reservation-access-grants) – The universal way to manage access in Seam. Integrate once, and your access model works consistently across all providers, including Dormakaba Community. For advanced, low-level control, you can still work directly with the ACS API. +* [**Mobile Keys**](https://docs.seam.co/latest/capability-guides/mobile-access) – Provision and revoke Bluetooth and wallet-based credentials directly from your PMS or app. +* [**Instant Keys**](https://docs.seam.co/latest/capability-guides/instant-keys) - Instantly issue temporary mobile pass that is shareable via an email or text. * [**Plastic Card Encoding**](https://docs.seam.co/latest/api/acs/encoders/encode_credential) – Encode and issue physical access cards using Seam’s card management API. *** ## Connecting Dormakaba Ambiance to Seam -To enable your users to [connect a Community system through Connect Webviews](../../core-concepts/connect-webviews/customizing-connect-webviews.md#customize-the-brands-to-display-in-your-connect-webviews), include the Dormakaba Community provider: +To enable your users to [connect a Community system through Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews), include the Dormakaba Community provider: ```json { diff --git a/docs/brand-guides/dormakaba-community-access-control-system/dormakaba-community-setup-guide.md b/docs/brand-guides/dormakaba-community-access-control-system/dormakaba-community-setup-guide.md index fb76706a8..6396bf579 100644 --- a/docs/brand-guides/dormakaba-community-access-control-system/dormakaba-community-setup-guide.md +++ b/docs/brand-guides/dormakaba-community-access-control-system/dormakaba-community-setup-guide.md @@ -17,7 +17,7 @@ The setup process has three parts: ## Prepare Community for Seam Integration 1. Install Seam Bridge - 1. Install the [Seam Bridge](../../capability-guides/seam-bridge.md) on the computer hosting the Community System. + 1. Install the [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) on the computer hosting the Community System. 2. Enable Community API 1. Go to **System Settings** > **Community API**.\ ![](<../../.gitbook/assets/unknown (1).png>) diff --git a/docs/brand-guides/dormakaba-oracode-locks/README.md b/docs/brand-guides/dormakaba-oracode-locks/README.md index 8db5c2793..788294972 100644 --- a/docs/brand-guides/dormakaba-oracode-locks/README.md +++ b/docs/brand-guides/dormakaba-oracode-locks/README.md @@ -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](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) *** ### 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](https://docs.seam.co/latest/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](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). *** @@ -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](https://docs.seam.co/latest/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.\ diff --git a/docs/brand-guides/dormakaba-oracode-locks/creating-dormakaba-oracode-offline-access-codes.md b/docs/brand-guides/dormakaba-oracode-locks/creating-dormakaba-oracode-offline-access-codes.md index 461da983a..601d857bc 100644 --- a/docs/brand-guides/dormakaba-oracode-locks/creating-dormakaba-oracode-offline-access-codes.md +++ b/docs/brand-guides/dormakaba-oracode-locks/creating-dormakaba-oracode-offline-access-codes.md @@ -7,15 +7,15 @@ hidden: true # Creating dormakaba Oracode Offline Access Codes -The Seam integration for dormakaba Oracode enables you to manage [offline access codes](../../capability-guides/smart-locks/access-codes/offline-access-codes.md) for dormakaba Oracode locks. You generate offline access (PIN) codes remotely, and the manufacturer maintains a server-based registry of synchronized encryption keys (tokens) to enable these offline codes. Then, owners or managers can share these codes with users through messaging or other similar applications, and the users do not need to install a special application to unlock the device. +The Seam integration for dormakaba Oracode enables you to manage [offline access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for dormakaba Oracode locks. You generate offline access (PIN) codes remotely, and the manufacturer maintains a server-based registry of synchronized encryption keys (tokens) to enable these offline codes. Then, owners or managers can share these codes with users through messaging or other similar applications, and the users do not need to install a special application to unlock the device. -To learn about the special requirements regarding offline access codes for dormakaba Oracode locks, see [Offline Access Code Requirements](creating-dormakaba-oracode-offline-access-codes.md#offline-access-code-requirements). For more information about using offline access codes, see [Offline Access Codes](../../capability-guides/smart-locks/access-codes/#offline-access-codes) and [Managing Offline Access Codes](../../capability-guides/smart-locks/access-codes/offline-access-codes.md). +To learn about the special requirements regarding offline access codes for dormakaba Oracode locks, see [Offline Access Code Requirements](creating-dormakaba-oracode-offline-access-codes.md#offline-access-code-requirements). For more information about using offline access codes, see [Offline Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#offline-access-codes) and [Managing Offline Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes). *** ## Offline Access Code Requirements -Seam supports daily-bound and hourly-bound [offline access codes](../../capability-guides/smart-locks/access-codes/offline-access-codes.md) for dormakaba Oracode locks. Note the following dormakaba Oracode-specific restrictions and requirements for offline access codes: +Seam supports daily-bound and hourly-bound [offline access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for dormakaba Oracode locks. Note the following dormakaba Oracode-specific restrictions and requirements for offline access codes: ### Duration @@ -93,7 +93,7 @@ You can create hourly- and daily-bound offline access codes for dormakaba Oracod ### Hourly-Bound Offline Access Codes -To [create an hourly-bound offline access code](../../capability-guides/smart-locks/access-codes/offline-access-codes.md#creating-time-bound-offline-access-codes), issue an access code creation request. Then, poll or use a webhook to confirm that the code was registered successfully in the dormakaba Oracode offline access code server. +To [create an hourly-bound offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes#creating-time-bound-offline-access-codes), issue an access code creation request. Then, poll or use a webhook to confirm that the code was registered successfully in the dormakaba Oracode offline access code server. #### 1. Create an Hourly-Bound Offline Access Code @@ -364,7 +364,7 @@ if (device.CanProgramOfflineAccessCodes == true) { #### 2. Verify Successful Time-Bound Code Registration -The [lifecycle of a time-bound access code](../../capability-guides/smart-locks/access-codes/lifecycle-of-access-codes.md) is marked by distinct phases: +The [lifecycle of a time-bound access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/lifecycle-of-access-codes) is marked by distinct phases: 1. `Unset`: When initially created on Seam, the offline access code remains in an `unset` state, indicating that it is not yet available for use on the lock due to a configured future activation time. 2. `Setting`: As the scheduled `starts_at` time approaches, Seam initiates the process of readying the code for use on the lock, transitioning the `status` of the offline code to `setting`. @@ -372,14 +372,14 @@ The [lifecycle of a time-bound access code](../../capability-guides/smart-locks/ There are two methods to verify that an time-bound offline access code has been registered in the offline access code server that the device manufacturer maintains: -* **Polling**: Continuously query the access code until the `status` is updated. For instructions, see [Polling Method](../../capability-guides/smart-locks/access-codes/creating-access-codes/#polling-method-1). -* **Webhook**: Wait for updates to arrive using webhook requests from the Seam API. For instructions, see [Webhook Events Method](../../capability-guides/smart-locks/access-codes/creating-access-codes/#webhook-events-method-1). +* **Polling**: Continuously query the access code until the `status` is updated. For instructions, see [Polling Method](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/creating-access-codes#polling-method-1). +* **Webhook**: Wait for updates to arrive using webhook requests from the Seam API. For instructions, see [Webhook Events Method](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/creating-access-codes#webhook-events-method-1). *** ### Daily-Bound Offline Access Codes -To [create a daily-bound offline access code](../../capability-guides/smart-locks/access-codes/offline-access-codes.md#creating-time-bound-offline-access-codes), first issue a creation request. Then, poll or use a webhook to confirm that the code was registered successfully in the dormakaba Oracode offline access code server. +To [create a daily-bound offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes#creating-time-bound-offline-access-codes), first issue a creation request. Then, poll or use a webhook to confirm that the code was registered successfully in the dormakaba Oracode offline access code server. #### 1. Create a Daily-Bound Access Code @@ -658,7 +658,7 @@ if (device.CanProgramOfflineAccessCodes == true) { #### 2. Verify Successful Time-Bound Code Registration -The [lifecycle of a time-bound access code](../../capability-guides/smart-locks/access-codes/lifecycle-of-access-codes.md) is marked by distinct phases: +The [lifecycle of a time-bound access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/lifecycle-of-access-codes) is marked by distinct phases: 1. `Unset`: When initially created on Seam, the offline access code remains in an `unset` state, indicating that it is not yet available for use on the lock due to a configured future activation time. 2. `Setting`: As the scheduled `starts_at` time approaches, Seam initiates the process of readying the code for use on the lock, transitioning the `status` of the offline code to `setting`. @@ -666,5 +666,5 @@ The [lifecycle of a time-bound access code](../../capability-guides/smart-locks/ There are two methods to verify that an time-bound offline access code has been registered in the offline access code server that the device manufacturer maintains: -* **Polling**: Continuously query the access code until the `status` is updated. For instructions, see [Polling Method](../../capability-guides/smart-locks/access-codes/creating-access-codes/#polling-method-1). -* **Webhook**: Wait for updates to arrive using webhook requests from the Seam API. For instructions, see [Webhook Events Method](../../capability-guides/smart-locks/access-codes/creating-access-codes/#webhook-events-method-1). +* **Polling**: Continuously query the access code until the `status` is updated. For instructions, see [Polling Method](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/creating-access-codes#polling-method-1). +* **Webhook**: Wait for updates to arrive using webhook requests from the Seam API. For instructions, see [Webhook Events Method](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/creating-access-codes#webhook-events-method-1). diff --git a/docs/brand-guides/dormakaba-oracode-locks/get-started-with-dormakaba-oracode-locks.md b/docs/brand-guides/dormakaba-oracode-locks/get-started-with-dormakaba-oracode-locks.md index 52a14b461..f7e5d322d 100644 --- a/docs/brand-guides/dormakaba-oracode-locks/get-started-with-dormakaba-oracode-locks.md +++ b/docs/brand-guides/dormakaba-oracode-locks/get-started-with-dormakaba-oracode-locks.md @@ -64,12 +64,12 @@ $ 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](https://docs.seam.co/latest/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](https://docs.seam.co/latest/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](./README.md#setup-instructions). @@ -140,7 +140,7 @@ $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 ](../../developer-tools/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 ](https://docs.seam.co/latest/developer-tools/sandbox-and-sample-data/dormakaba-oracode-sample-data)credentials: * **username:** jane * **site:** Ocean Beach Vacations @@ -258,7 +258,7 @@ In addition, if you'd like to explore other aspects of Seam, check out the follo * [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) +* [Configuring webhooks](https://docs.seam.co/latest/developer-tools/webhooks) for [device events](https://docs.seam.co/latest/api/events/list) +* [Core Concepts](https://docs.seam.co/latest/core-concepts/overview) 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/brand-guides/dormakaba-oracode-locks/programming-offline-access-codes-on-dormakaba-oracode-locks.md b/docs/brand-guides/dormakaba-oracode-locks/programming-offline-access-codes-on-dormakaba-oracode-locks.md index bbb2a6985..3cc38005c 100644 --- a/docs/brand-guides/dormakaba-oracode-locks/programming-offline-access-codes-on-dormakaba-oracode-locks.md +++ b/docs/brand-guides/dormakaba-oracode-locks/programming-offline-access-codes-on-dormakaba-oracode-locks.md @@ -4,7 +4,7 @@ Dormakaba Oracode locks use offline access codes (PIN codes) that are generated ### Understanding Oracode offline access codes -[**Offline access codes**](../../capability-guides/smart-locks/access-codes/offline-access-codes.md) are PIN codes generated by Seam that work on the lock without an internet connection. Dormakaba maintains a server-based registry of synchronized encryption keys that enable these codes to work offline. +[**Offline access codes**](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) are PIN codes generated by Seam that work on the lock without an internet connection. Dormakaba maintains a server-based registry of synchronized encryption keys that enable these codes to work offline. Once generated, you can share these codes with guests through messaging or your property management system—guests don't need to install any special app to unlock the door. diff --git a/docs/brand-guides/ecobee-thermostats.md b/docs/brand-guides/ecobee-thermostats.md index a7794c43e..c1e24438b 100644 --- a/docs/brand-guides/ecobee-thermostats.md +++ b/docs/brand-guides/ecobee-thermostats.md @@ -24,17 +24,17 @@ For detailed information about the ecobee devices that Seam supports, see our [e We support the following features: -* [Configuring current thermostat settings](../capability-guides/thermostats/configure-current-climate-settings.md) -* [Creating and managing climate presets](../capability-guides/thermostats/creating-and-managing-climate-presets/) -* [Creating and managing thermostat schedules](../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) -* [Creating and managing thermostat weekly programs](../capability-guides/thermostats/creating-and-managing-thermostat-programs.md) -* [Setting and monitoring temperature thresholds](../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md) +* [Configuring current thermostat settings](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings) +* [Creating and managing climate presets](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) +* [Creating and managing thermostat schedules](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) +* [Creating and managing thermostat weekly programs](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-programs) +* [Setting and monitoring temperature thresholds](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) *** ### Device Provider Key -To create a [Connect Webview](../core-concepts/connect-webviews/) that enables your users to connect their ecobee devices to Seam, include the `ecobee` 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](https://docs.seam.co/latest/core-concepts/connect-webviews) that enables your users to connect their ecobee devices to Seam, include the `ecobee` device provider key in the `accepted_providers` list. For more information, see [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). *** @@ -44,7 +44,7 @@ To control ecobee devices using Seam, you must prompt owners of these devices to 1. Create an account in the [ecobee app](https://www.ecobee.com/en-us/installation/) if you have not done so already. 2. In the ecobee app, add your ecobee thermostats. -3. Note your login credentials for the ecobee app, and use these credentials to log in to the [Seam Connect Webview](../core-concepts/connect-webviews/) to add your devices to Seam. +3. Note your login credentials for the ecobee app, and use these credentials to log in to the [Seam Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) to add your devices to Seam. {% hint style="info" %} Make sure that you're authenticating with the user to whom the devices are registered. ecobee devices can only be registered to a single user. diff --git a/docs/brand-guides/get-started-with-august-locks.md b/docs/brand-guides/get-started-with-august-locks.md index 03b979635..92a90a021 100644 --- a/docs/brand-guides/get-started-with-august-locks.md +++ b/docs/brand-guides/get-started-with-august-locks.md @@ -10,7 +10,7 @@ description: Learn how to connect and control August locks with the Seam API. Seam provides a universal API to connect and control many brands of IoT devices and systems, including smart locks, access control systems (ACSs), thermostats, and noise sensors. -This guide gives you a rapid introduction to connecting and controlling your [August lock](../device-and-system-integration-guides/august-locks.md) using the Seam API. For application developers, you can use the Seam API in your app, and your users can authorize your app to control their devices using Seam. +This guide gives you a rapid introduction to connecting and controlling your [August lock](https://docs.seam.co/latest/device-and-system-integration-guides/august-locks) using the Seam API. For application developers, you can use the Seam API in your app, and your users can authorize your app to control their devices using Seam. For detailed information about the August devices that Seam supports, see our [August Supported Devices page](https://www.seam.co/manufacturers/august). @@ -19,7 +19,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 August 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](https://docs.seam.co/latest/core-concepts/seam-console/seam-online-cli), which you can access from directly within the [Seam Console](https://docs.seam.co/latest/core-concepts/seam-console). :arrow\_forward: [Go to the Seam Console!](https://console.seam.co/) {% endhint %} @@ -69,7 +69,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](https://docs.seam.co/latest/core-concepts/seam-console#create-a-seam-account) to get your [API key](https://docs.seam.co/latest/core-concepts/authentication/api-keys). Then, export your API key as an environment variable. @@ -78,21 +78,21 @@ $ 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 August lock, use a [non-sandbox workspace](../core-concepts/workspaces/#production-workspaces) and API key. +This guide uses a [sandbox workspace](https://docs.seam.co/latest/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 August lock, use a [non-sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#production-workspaces) and API key. {% endhint %} *** ## Step 2: Link your August account with Seam -To control your August lock using the Seam API, you must first authorize your Seam workspace to connect to your August account. If your application needs to connect to your users' August 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 August locks. The Connect Webview presents a flow that prompts your users to enter their credentials for their August account. +To control your August lock using the Seam API, you must first authorize your Seam workspace to connect to your August account. If your application needs to connect to your users' August accounts, Seam provides fully-embedded, [customizable](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews) client-side [Connect Webviews](https://docs.seam.co/latest/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 August locks. The Connect Webview presents a flow that prompts your users to enter their credentials for their August 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 August 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](https://docs.seam.co/latest/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-august-locks.md#authorize-your-workspace) in this guide to complete the Connect Webview authorization flow. @@ -269,13 +269,13 @@ 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](https://docs.seam.co/latest/ui-components/overview/react-components/connect-account-button) within our suite of [Seam Components](https://docs.seam.co/latest/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](../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. +Because you're using a sandbox workspace, you can connect Seam's test August account. We provide [virtual devices](https://docs.seam.co/latest/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](../developer-tools/sandbox-and-sample-data/august-locks-sample-data.md) credentials: +Complete the Connect Webview authorization flow by entering the following [August sandbox account](https://docs.seam.co/latest/developer-tools/sandbox-and-sample-data/august-locks-sample-data) credentials: * **Device Region:** Others * **Email:** jane@example.com @@ -700,7 +700,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](https://docs.seam.co/latest/capability-guides/smart-locks/lock-and-unlock), [programming access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes), and so on. Seam's intuitive and granular [capability flags](https://docs.seam.co/latest/capability-guides/device-and-system-capabilities#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 August lock: @@ -709,7 +709,7 @@ Try out the following actions on your August 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](https://docs.seam.co/latest/core-concepts/action-attempts) to track the progress of the unlock operation. {% tabs %} {% tab title="Python" %} @@ -1016,9 +1016,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 August 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](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) on August 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](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes) online access codes. {% tabs %} {% tab title="Python" %} @@ -1375,23 +1375,23 @@ if (updatedFrontDoor.CanProgramOnlineAccessCodes == true) { ## Step 5: Connect a real August lock -Now that you have learned the basics of using the Seam API, you can connect and control a real August 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 August device. To do so, make sure to switch to a [non-sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#production-workspaces) and [API key](https://docs.seam.co/latest/core-concepts/authentication/api-keys). -For more details about setting up your real August lock, see the [August locks integration guide](../device-and-system-integration-guides/august-locks.md). +For more details about setting up your real August lock, see the [August locks integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/august-locks). *** ## 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](https://docs.seam.co/latest/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!

-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](https://docs.seam.co/latest/ui-components/overview/react-components/device-table) to display a list of devices and to identify all devices with issues. You can use the [Device Details Seam Component](https://docs.seam.co/latest/ui-components/overview/react-components/device-details) 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](https://docs.seam.co/latest/ui-components/overview/react-components/access-code-details) 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](https://docs.seam.co/latest/ui-components/overview). *** @@ -1400,17 +1400,17 @@ To learn about all the Seam Components that we provide, see [Seam Components](.. Now that you've completed this getting started guide for August 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](https://docs.seam.co/latest/device-and-system-integration-guides) 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](https://docs.seam.co/latest/core-concepts/overview) and the [device and system capabilities ](https://docs.seam.co/latest/capability-guides/device-and-system-capabilities)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](https://docs.seam.co/latest/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](https://docs.seam.co/latest/developer-tools/webhooks) 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](https://docs.seam.co/latest/capability-guides/access-systems), [thermostats](https://docs.seam.co/latest/capability-guides/thermostats), and [noise sensors](https://docs.seam.co/latest/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](https://docs.seam.co/latest/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). diff --git a/docs/brand-guides/get-started-with-controlbyweb-devices.md b/docs/brand-guides/get-started-with-controlbyweb-devices.md index b1013dadd..598ddbd8e 100644 --- a/docs/brand-guides/get-started-with-controlbyweb-devices.md +++ b/docs/brand-guides/get-started-with-controlbyweb-devices.md @@ -63,7 +63,7 @@ This guide uses a Sandbox Workspace. Only virtual devices can be connected. If y ## 2 — Link ControlByWeb Account with Seam -To control your ControlByWeb relay device via the Seam API, you must first authorize your Seam workspace against your ControlByWeb Cloud 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 ControlByWeb device. +To control your ControlByWeb relay device via the Seam API, you must first authorize your Seam workspace against your ControlByWeb Cloud account. To do so, Seam provides[ Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews): pre-built UX flows that walk you through authorizing your application to control your ControlByWeb device. #### Request a Connect Webview @@ -306,7 +306,7 @@ In addition, if you'd like to explore other aspects of Seam, here is a list of h * [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) +* [Receiving webhook](https://docs.seam.co/latest/developer-tools/webhooks) for [device events](https://docs.seam.co/latest/api/events/list) +* [Core Concepts](https://docs.seam.co/latest/core-concepts/overview) If you have any questions or want to report an issue, email us at support@seam.co. diff --git a/docs/brand-guides/get-started-with-ecobee-thermostats.md b/docs/brand-guides/get-started-with-ecobee-thermostats.md index 2d229d4da..6dc537116 100644 --- a/docs/brand-guides/get-started-with-ecobee-thermostats.md +++ b/docs/brand-guides/get-started-with-ecobee-thermostats.md @@ -19,7 +19,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 ecobee thermostat 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](https://docs.seam.co/latest/core-concepts/seam-console/seam-online-cli), which you can access from directly within the [Seam Console](https://docs.seam.co/latest/core-concepts/seam-console). :arrow\_forward: [Go to the Seam Console!](https://console.seam.co/) {% endhint %} @@ -69,7 +69,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](https://docs.seam.co/latest/core-concepts/seam-console#create-a-seam-account) to get your [API key](https://docs.seam.co/latest/core-concepts/authentication/api-keys). Then, export your API key as an environment variable. @@ -78,21 +78,21 @@ $ 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 ecobee thermostat, use a [non-sandbox workspace](../core-concepts/workspaces/#production-workspaces) and API key. +This guide uses a [sandbox workspace](https://docs.seam.co/latest/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 ecobee thermostat, use a [non-sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#production-workspaces) and API key. {% endhint %} *** ## Step 2: Link your ecobee account with Seam -To control your ecobee thermostat using the Seam API, you must first authorize your Seam workspace to connect to your ecobee account. If your application needs to connect to your users' ecobee 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 ecobee thermostats. The Connect Webview presents a flow that prompts your users to enter their credentials for their ecobee account. +To control your ecobee thermostat using the Seam API, you must first authorize your Seam workspace to connect to your ecobee account. If your application needs to connect to your users' ecobee accounts, Seam provides fully-embedded, [customizable](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews) client-side [Connect Webviews](https://docs.seam.co/latest/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 ecobee thermostats. The Connect Webview presents a flow that prompts your users to enter their credentials for their ecobee 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 ecobee 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](https://docs.seam.co/latest/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-ecobee-thermostats.md#authorize-your-workspace) in this guide to complete the Connect Webview authorization flow. @@ -269,13 +269,13 @@ 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](https://docs.seam.co/latest/ui-components/overview/react-components/connect-account-button) within our suite of [Seam Components](https://docs.seam.co/latest/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](../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. +Because you're using a sandbox workspace, you can connect Seam's test ecobee account. We provide [virtual devices](https://docs.seam.co/latest/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](../developer-tools/sandbox-and-sample-data/ecobee-sample-data.md) credentials: +Complete the Connect Webview authorization flow by entering the following [ecobee sandbox account](https://docs.seam.co/latest/developer-tools/sandbox-and-sample-data/ecobee-sample-data) credentials: * **Email:** jane@example.com * **Password:** 1234 @@ -720,7 +720,7 @@ Fan running: false Next, you can use the Seam API to control your ecobee thermostat. -Each device that you connect to Seam has a specific set of capabilities. These capabilities define the Seam API actions that you can use. For thermostats, device-specific capabilities include whether you can [set the HVAC mode](../capability-guides/thermostats/configure-current-climate-settings.md) to `heat`, `cool`, or `heat_cool`. 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. For thermostats, device-specific capabilities include whether you can [set the HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings) to `heat`, `cool`, or `heat_cool`. Seam's intuitive and granular [capability flags](https://docs.seam.co/latest/capability-guides/device-and-system-capabilities#capability-flags) inform your application about what features and behaviors each device supports. Notice the capability flags within the code samples in this guide. Seam provides additional actions for thermostats, such as setting the fan mode, creating and scheduling climate presets, setting temperature thresholds, and configuring weekly thermostat programs. You can also monitor for Seam thermostat-related events, such as reported temperatures outside your set thresholds. @@ -742,11 +742,11 @@ To set the HVAC mode, use any of the following endpoints or their equivalents in This endpoint is a consolidated version of the other four endpoints. -Specify the thermostat that you want to control by including the `device_id` in the request body. Also, include the desired temperature [set point](../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md). +Specify the thermostat that you want to control by including the `device_id` in the request body. Also, include the desired temperature [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). In this example, set the HVAC mode to `heat` and the desired heating set point to 68 °F. -Each of these HVAC mode endpoints returns an [action attempt](../core-concepts/action-attempts.md) to track the progress of the operation. +Each of these HVAC mode endpoints returns an [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) to track the progress of the operation. {% tabs %} {% tab title="Python" %} @@ -1840,7 +1840,7 @@ $seam->thermostats->update_weekly_program( ## Step 5: Connect a real ecobee thermostat -Now that you have learned the basics of using the Seam API, you can connect and control a real ecobee 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 ecobee device. To do so, make sure to switch to a [non-sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#production-workspaces) and [API key](https://docs.seam.co/latest/core-concepts/authentication/api-keys). For more details about setting up your real ecobee thermostat, see the [ecobee thermostats integration guide](ecobee-thermostats.md). @@ -1857,17 +1857,17 @@ Seam makes it easy to develop your application. The robust Seam API and Seam SDK Now that you've completed this getting started guide for ecobee 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](https://docs.seam.co/latest/device-and-system-integration-guides) 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](https://docs.seam.co/latest/core-concepts/overview) and the [device and system capabilities ](https://docs.seam.co/latest/capability-guides/device-and-system-capabilities)that Seam supports. * [ ] **Expand your abilities**\ - Find out what other [thermostat actions](../capability-guides/thermostats/) you can perform using the Seam API. + Find out what other [thermostat actions](https://docs.seam.co/latest/capability-guides/thermostats) you can perform using the Seam API. * [ ] **Use webhooks**\ - Learn how to use [webhooks](../developer-tools/webhooks.md) as an efficient way to receive device events. + Learn how to use [webhooks](https://docs.seam.co/latest/developer-tools/webhooks) 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 [smart locks](../capability-guides/smart-locks/), [access control systems](../capability-guides/access-systems/), and [noise sensors](../capability-guides/noise-sensors/). + Explore the other types of devices and systems that you can control with Seam, including [smart locks](https://docs.seam.co/latest/capability-guides/smart-locks), [access control systems](https://docs.seam.co/latest/capability-guides/access-systems), and [noise sensors](https://docs.seam.co/latest/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](https://docs.seam.co/latest/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). diff --git a/docs/brand-guides/get-started-with-kwikset-wifi-locks.md b/docs/brand-guides/get-started-with-kwikset-wifi-locks.md index 137688307..df236c286 100644 --- a/docs/brand-guides/get-started-with-kwikset-wifi-locks.md +++ b/docs/brand-guides/get-started-with-kwikset-wifi-locks.md @@ -73,7 +73,7 @@ This guide uses a Sandbox Workspace. Only virtual devices can be connected. If y ## 2 — Link Kwikset Account with Seam -To control your Kwikset Halo lock via the Seam API, you must first authorize your Seam workspace against your Kwikset 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 Kwikset Halo lock. +To control your Kwikset Halo lock via the Seam API, you must first authorize your Seam workspace against your Kwikset account. To do so, Seam provides[ Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews): pre-built UX flows that walk you through authorizing your application to control your Kwikset Halo lock. #### Request a Connect Webview @@ -367,7 +367,7 @@ If you're connected through Wi-Fi and not Bluetooth, the Kwikset app _only_ show Some Kwikset locks have a keypad paired to them to program access codes. These codes can then be entered to unlock a Kwikset lock. -The Seam API makes it easy to program both `ongoing` codes and `timebound` codes on a Kwikset lock. You can find out more about Kwikset 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 Kwikset lock. You can find out more about Kwikset lock access code in our [core concept section on access codes.](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) **Access Code Constraints** @@ -550,7 +550,7 @@ In addition, if you'd like to explore other aspects of Seam, here is a list of h * [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) -* [Receiving webhook](../developer-tools/webhooks.md) for [device events](https://docs.seam.co/latest/api/events/list) -* [Core Concepts](../core-concepts/overview.md) +* [Receiving webhook](https://docs.seam.co/latest/developer-tools/webhooks) for [device events](https://docs.seam.co/latest/api/events/list) +* [Core Concepts](https://docs.seam.co/latest/core-concepts/overview) If you have any questions or want to report an issue, email us at support@seam.co. diff --git a/docs/brand-guides/get-started-with-minut-sensors.md b/docs/brand-guides/get-started-with-minut-sensors.md index 5e7c2ec48..6becc0109 100644 --- a/docs/brand-guides/get-started-with-minut-sensors.md +++ b/docs/brand-guides/get-started-with-minut-sensors.md @@ -64,7 +64,7 @@ This guide uses a Sandbox Workspace. Only virtual sensors can be connected. If y ## 2. Link Minut Account with Seam -To control your Minut sensor via the Seam API, you must first authorize your Seam workspace against your Minut 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 Minut sensor. +To control your Minut sensor via the Seam API, you must first authorize your Seam workspace against your Minut account. To do so, Seam provides[ Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews): pre-built UX flows that walk you through authorizing your application to control your Minut sensor. ### Create a Connect Webview @@ -139,7 +139,7 @@ Navigate to the URL returned by the Webview object. Since you are using a sandbo ### Get the New Webview -After you complete the login above, you'll get an event for [`connected_account.created`](https://docs.seam.co/latest/api/events/)if you set up a [webhook handler](../developer-tools/webhooks.md). Otherwise you can just poll for the webview until it's status changes, as shown below: +After you complete the login above, you'll get an event for [`connected_account.created`](https://docs.seam.co/latest/api/events/)if you set up a [webhook handler](https://docs.seam.co/latest/developer-tools/webhooks). Otherwise you can just poll for the webview until it's status changes, as shown below: {% tabs %} {% tab title="Python" %} @@ -498,7 +498,7 @@ echo json_encode($device[0]); Minut users can define noise thresholds at which noise alerts are sent. -You'll get an event for `noise_threshold.noise_threshold_triggered` when you set up a [webhook handler](../developer-tools/webhooks.md). You can also [poll for events](https://docs.seam.co/latest/api/events/list). +You'll get an event for `noise_threshold.noise_threshold_triggered` when you set up a [webhook handler](https://docs.seam.co/latest/developer-tools/webhooks). You can also [poll for events](https://docs.seam.co/latest/api/events/list). {% hint style="info" %} Minut has a builtin threshold that can be triggered multiple times. Each Minut notice will trigger a `noise_threshold_triggered` event with the `minut_metadata.event_name` containing the Minut event name, which can be any of the following: diff --git a/docs/brand-guides/get-started-with-noiseaware-sensors.md b/docs/brand-guides/get-started-with-noiseaware-sensors.md index d8867d880..70985cd52 100644 --- a/docs/brand-guides/get-started-with-noiseaware-sensors.md +++ b/docs/brand-guides/get-started-with-noiseaware-sensors.md @@ -66,7 +66,7 @@ This guide uses a Sandbox Workspace. Only virtual activity zones can be connecte ## 2. Link NoiseAware Account with Seam -To control your NoiseAware device via the Seam API, you must first authorize your Seam workspace against your NoiseAware 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 NoiseAware device. +To control your NoiseAware device via the Seam API, you must first authorize your Seam workspace against your NoiseAware account. To do so, Seam provides[ Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews): pre-built UX flows that walk you through authorizing your application to control your NoiseAware device. ### Create a Connect Webview @@ -148,7 +148,7 @@ Navigate to the URL returned by the Webview object. Since you are using a sandbo ### Get the New Webview -After you complete the login above, you'll get an event for [`connected_account.created`](https://docs.seam.co/latest/api/events/)if you set up a [webhook handler](../developer-tools/webhooks.md). Otherwise you can just poll for the webview until it's status changes, as shown below: +After you complete the login above, you'll get an event for [`connected_account.created`](https://docs.seam.co/latest/api/events/)if you set up a [webhook handler](https://docs.seam.co/latest/developer-tools/webhooks). Otherwise you can just poll for the webview until it's status changes, as shown below: {% tabs %} {% tab title="Python" %} @@ -327,7 +327,7 @@ echo json_encode($device[0]); NoiseAware users can define noise thresholds at which noise alerts are sent. -You'll get an event for `noise_threshold.noise_threshold_triggered` when you set up a [webhook handler](../developer-tools/webhooks.md). You can also [poll for events](https://docs.seam.co/latest/api/events/list). +You'll get an event for `noise_threshold.noise_threshold_triggered` when you set up a [webhook handler](https://docs.seam.co/latest/developer-tools/webhooks). You can also [poll for events](https://docs.seam.co/latest/api/events/list). {% hint style="info" %} NoiseAware has three distinct noise alerts: `newNoise`, `continuedNoise`, and `resolvedNoise`. It is essential to keep in mind that Seam will solely trigger the `noise_threshold.noise_threshold_triggered` event for `newNoise`. diff --git a/docs/brand-guides/get-started-with-nuki-locks.md b/docs/brand-guides/get-started-with-nuki-locks.md index ffc0c7ea6..8ba3d5e3f 100644 --- a/docs/brand-guides/get-started-with-nuki-locks.md +++ b/docs/brand-guides/get-started-with-nuki-locks.md @@ -63,7 +63,7 @@ This guide uses a Sandbox Workspace. Only virtual devices can be connected. If y ## 2 — Link Your Nuki Account with Seam -To control your Nuki locks via the Seam API, you must first authorize your Seam workspace against your Nuki KS 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 Nuki sites. +To control your Nuki locks via the Seam API, you must first authorize your Seam workspace against your Nuki KS account. To do so, Seam provides[ Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews): pre-built UX flows that walk you through authorizing your application to control your Nuki sites. #### Request a Connect Webview @@ -344,7 +344,7 @@ $seam->locks->lock_door($lock->device_id); Some Nuki locks also have a keypad paired to them to program access codes. These codes can then be entered to unlock a Nuki lock. -The Seam API makes it easy to program both `ongoing` codes and `timebound` codes on a Nuki lock. You can find out more about Nuki 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 Nuki lock. You can find out more about Nuki lock access code in our [core concept section on access codes.](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) {% hint style="info" %} Nuki does not let you create a code starting with the digits "12". Codes cannot contain the digit 0. @@ -451,7 +451,7 @@ In addition, if you'd like to explore other aspects of Seam, here is a list of h * [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) +* [Receiving webhook](https://docs.seam.co/latest/developer-tools/webhooks) for [device events](https://docs.seam.co/latest/api/events/list) +* [Core Concepts](https://docs.seam.co/latest/core-concepts/overview) 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/brand-guides/get-started-with-salto-locks.md b/docs/brand-guides/get-started-with-salto-locks.md index f13c20c26..3f5225ad0 100644 --- a/docs/brand-guides/get-started-with-salto-locks.md +++ b/docs/brand-guides/get-started-with-salto-locks.md @@ -65,7 +65,7 @@ This guide uses a Sandbox Workspace. Only virtual devices can be connected. If y ## 2 — Link Your Salto KS Account with Seam -To control your Salto locks via the Seam API, you must first authorize your Seam workspace against your Salto KS 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 Salto sites. +To control your Salto locks via the Seam API, you must first authorize your Seam workspace against your Salto KS account. To do so, Seam provides[ Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews): pre-built UX flows that walk you through authorizing your application to control your Salto sites. #### Create a Connect Webview @@ -466,7 +466,7 @@ $seam->locks->lock_door($lock->device_id); Some Salto locks and access points will have a keypad available to program access codes. These codes can then be entered to unlock the door. -The Seam API makes it easy to program both `ongoing` codes and `timebound` codes on an Salto lock. You can find out more about Salto 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 Salto lock. You can find out more about Salto lock access code in our [core concept section on access codes.](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) {% hint style="info" %} Salto does not let you specify a code for an access code. Instead Salto generates a 6-digit code, which the Seam API returns. @@ -625,7 +625,7 @@ In addition, if you'd like to explore other aspects of Seam, here is a list of h * [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) +* [Receiving webhook](https://docs.seam.co/latest/developer-tools/webhooks) for [device events](https://docs.seam.co/latest/api/events/list) +* [Core Concepts](https://docs.seam.co/latest/core-concepts/overview) 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/brand-guides/get-started-with-smartlocks-api.md b/docs/brand-guides/get-started-with-smartlocks-api.md index b37b29249..f513a9cd3 100644 --- a/docs/brand-guides/get-started-with-smartlocks-api.md +++ b/docs/brand-guides/get-started-with-smartlocks-api.md @@ -10,7 +10,7 @@ description: Learn how to connect and control smartlocks with the Seam API. Seam is a simple API to connect and control almost any smartlocks. Seam already integrates popular smartlock brands such as [August](https://seam.co/manufacturers/august), [Yale](https://seam.co/manufacturers/yale), [Schlage](https://seam.co/manufacturers/schlage), [Igloo](https://www.seam.co/manufacturers/igloohome), and [Kwikset](https://www.seam.co/manufacturers/kwikset), as well as lesser known ones like [Nuki](https://www.seam.co/manufacturers/nuki), [Wyze](https://www.seam.co/manufacturers/wyze), or [TTLock](https://www.seam.co/manufacturers/ttlock). -The main benefit of Seam is that you can connect devices from these brands and control them with an easy to use API without having to worry about the underlying specific of each devices. Seam abstracts functions in [capabilities](../capability-guides/device-and-system-capabilities.md) such as `access_codes` or `locks` which you can use to integrate devices from multiple brands while expecting them to all behave more or less in the same way. +The main benefit of Seam is that you can connect devices from these brands and control them with an easy to use API without having to worry about the underlying specific of each devices. Seam abstracts functions in [capabilities](https://docs.seam.co/latest/capability-guides/device-and-system-capabilities) such as `access_codes` or `locks` which you can use to integrate devices from multiple brands while expecting them to all behave more or less in the same way. This guide is intended to show you how to connect and control smartlocks. To learn more about all devices supported by Seam such as thermostats and sensors, head over to our [integration page](https://www.seam.co/supported-devices-and-systems). @@ -69,7 +69,7 @@ This guide uses a Sandbox Workspace. Only virtual devices can be connected. If y ## 2 — Link Your Smartlock Account with Seam -To control a smartlock via the Seam API, we need to first connect to your smartlock account and authorize your Seam workspace to control its device(s). To make this easy, Seam provides [Connect Webviews](../core-concepts/connect-webviews/) authorization flows that walk you (or a device owner) through authorizing your workspace to control your device. +To control a smartlock via the Seam API, we need to first connect to your smartlock account and authorize your Seam workspace to control its device(s). To make this easy, Seam provides [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) authorization flows that walk you (or a device owner) through authorizing your workspace to control your device. #### Request a Connect Webview @@ -325,7 +325,7 @@ Many smartlocks have a built-in keypad or an external one that can be paired ove ![](<../.gitbook/assets/code_unlock (1).gif>) -The Seam API makes it easy to program both `ongoing` codes and `timebound` codes on a smartlock. An `ongoing` code is a code that will be permanently programmed onto the device until you tell the Seam API you wish to remove it. A `timebound` code is, as the time implies, time bound by a set of ISO8601 timestamp that you provide the Seam API. You can find out more about 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 smartlock. An `ongoing` code is a code that will be permanently programmed onto the device until you tell the Seam API you wish to remove it. A `timebound` code is, as the time implies, time bound by a set of ISO8601 timestamp that you provide the Seam API. You can find out more about access code in our [core concept section on access codes.](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) {% tabs %} {% tab title="Python" %} @@ -487,5 +487,5 @@ Now that you've completed this guide, you can try to build a real application to * [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) -* [Receiving webhook](../developer-tools/webhooks.md) for [device events](https://docs.seam.co/latest/api/events/list) -* [Core Concepts](../core-concepts/overview.md) +* [Receiving webhook](https://docs.seam.co/latest/developer-tools/webhooks) for [device events](https://docs.seam.co/latest/api/events/list) +* [Core Concepts](https://docs.seam.co/latest/core-concepts/overview) diff --git a/docs/brand-guides/get-started-with-ttlock-devices.md b/docs/brand-guides/get-started-with-ttlock-devices.md index 1e2b9873a..abb19bf49 100644 --- a/docs/brand-guides/get-started-with-ttlock-devices.md +++ b/docs/brand-guides/get-started-with-ttlock-devices.md @@ -19,7 +19,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 TTLock 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](https://docs.seam.co/latest/core-concepts/seam-console/seam-online-cli), which you can access from directly within the [Seam Console](https://docs.seam.co/latest/core-concepts/seam-console). :arrow\_forward: [Go to the Seam Console!](https://console.seam.co/) {% endhint %} @@ -69,7 +69,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](https://docs.seam.co/latest/core-concepts/seam-console#create-a-seam-account) to get your [API key](https://docs.seam.co/latest/core-concepts/authentication/api-keys). Then, export your API key as an environment variable. @@ -78,21 +78,21 @@ $ 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 TTLock lock, use a [non-sandbox workspace](../core-concepts/workspaces/#production-workspaces) and API key. +This guide uses a [sandbox workspace](https://docs.seam.co/latest/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 TTLock lock, use a [non-sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#production-workspaces) and API key. {% endhint %} *** ## Step 2: Link your TTLock account with Seam -To control your TTLock lock using the Seam API, you must first authorize your Seam workspace to connect to your TTLock account. If your application needs to connect to your users' TTLock 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 TTLock locks. The Connect Webview presents a flow that prompts your users to enter their credentials for their TTLock account. +To control your TTLock lock using the Seam API, you must first authorize your Seam workspace to connect to your TTLock account. If your application needs to connect to your users' TTLock accounts, Seam provides fully-embedded, [customizable](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews) client-side [Connect Webviews](https://docs.seam.co/latest/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 TTLock locks. The Connect Webview presents a flow that prompts your users to enter their credentials for their TTLock 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 TTLock 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](https://docs.seam.co/latest/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-ttlock-devices.md#authorize-your-workspace) in this guide to complete the Connect Webview authorization flow. @@ -269,13 +269,13 @@ 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](https://docs.seam.co/latest/ui-components/overview/react-components/connect-account-button) within our suite of [Seam Components](https://docs.seam.co/latest/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](../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. +Because you're using a sandbox workspace, you can connect Seam's test TTLock account. We provide [virtual devices](https://docs.seam.co/latest/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](../developer-tools/sandbox-and-sample-data/ttlock-sample-data.md) credentials: +Complete the Connect Webview authorization flow by entering the following [TTLock sandbox account](https://docs.seam.co/latest/developer-tools/sandbox-and-sample-data/ttlock-sample-data) credentials: * **Email:** jane@example.com * **Password:** 1234 @@ -697,7 +697,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](https://docs.seam.co/latest/capability-guides/smart-locks/lock-and-unlock), [programming access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes), and so on. Seam's intuitive and granular [capability flags](https://docs.seam.co/latest/capability-guides/device-and-system-capabilities#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 TTLock lock: @@ -706,7 +706,7 @@ Try out the following actions on your TTLock 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](https://docs.seam.co/latest/core-concepts/action-attempts) to track the progress of the unlock operation. {% tabs %} {% tab title="Python" %} @@ -1014,9 +1014,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 TTLock 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](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) on TTLock 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](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes) online access codes. {% tabs %} {% tab title="Python" %} @@ -1373,7 +1373,7 @@ if (updatedFrontDoor.CanProgramOnlineAccessCodes == true) { ## Step 5: Connect a real TTLock lock -Now that you have learned the basics of using the Seam API, you can connect and control a real TTLock 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 TTLock device. To do so, make sure to switch to a [non-sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#production-workspaces) and [API key](https://docs.seam.co/latest/core-concepts/authentication/api-keys). For more details about setting up your real TTLock lock, see the [TTLock locks integration guide](ttlock-locks.md). @@ -1381,15 +1381,15 @@ For more details about setting up your real TTLock lock, see the [TTLock locks i ## 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](https://docs.seam.co/latest/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!

-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](https://docs.seam.co/latest/ui-components/overview/react-components/device-table) to display a list of devices and to identify all devices with issues. You can use the [Device Details Seam Component](https://docs.seam.co/latest/ui-components/overview/react-components/device-details) 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](https://docs.seam.co/latest/ui-components/overview/react-components/access-code-details) 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](https://docs.seam.co/latest/ui-components/overview). *** @@ -1398,17 +1398,17 @@ To learn about all the Seam Components that we provide, see [Seam Components](.. Now that you've completed this getting started guide for TTLock 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](https://docs.seam.co/latest/device-and-system-integration-guides) 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](https://docs.seam.co/latest/core-concepts/overview) and the [device and system capabilities ](https://docs.seam.co/latest/capability-guides/device-and-system-capabilities)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](https://docs.seam.co/latest/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](https://docs.seam.co/latest/developer-tools/webhooks) 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](https://docs.seam.co/latest/capability-guides/access-systems), [thermostats](https://docs.seam.co/latest/capability-guides/thermostats), and [noise sensors](https://docs.seam.co/latest/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](https://docs.seam.co/latest/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). diff --git a/docs/brand-guides/get-started-with-wyze-locks.md b/docs/brand-guides/get-started-with-wyze-locks.md index 494a7d573..3aa55e41f 100644 --- a/docs/brand-guides/get-started-with-wyze-locks.md +++ b/docs/brand-guides/get-started-with-wyze-locks.md @@ -71,7 +71,7 @@ This guide uses a Sandbox Workspace. Only virtual devices can be connected. If y ## 2 — Link Your Wyze with Seam -To control your Wyze locks via the Seam API, you must first authorize your Seam workspace against your Wyze 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 Wyze locks. +To control your Wyze locks via the Seam API, you must first authorize your Seam workspace against your Wyze account. To do so, Seam provides[Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews): pre-built UX flows that walk you through authorizing your application to control Wyze locks. #### Obtain a Wyze API Key and Wyze API Key ID @@ -330,7 +330,7 @@ $seam->locks->lock_door($lock->device_id); ## 5 — Programming Access Code on a Wyze Lock -The Seam API lets you create access codes on Wyze locks with a gateway. These codes can then be entered to unlock the door. You can find out more info about how Seam access codes in our [core concept section on access codes.](../capability-guides/smart-locks/access-codes/) +The Seam API lets you create access codes on Wyze locks with a gateway. These codes can then be entered to unlock the door. You can find out more info about how Seam access codes in our [core concept section on access codes.](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) {% hint style="info" %} Wyze does not allow pin code values to be seen after the code is created. If you create a code through Seam, avoid changing the pin code through the app and instead use Seam to change any information about the code! @@ -490,7 +490,7 @@ In addition, if you'd like to explore other aspects of Seam, here is a list of h * [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) -* [Receiving webhook](../developer-tools/webhooks.md) for [device events](https://docs.seam.co/latest/api/events/list) -* [Core Concepts](../core-concepts/overview.md) +* [Receiving webhook](https://docs.seam.co/latest/developer-tools/webhooks) for [device events](https://docs.seam.co/latest/api/events/list) +* [Core Concepts](https://docs.seam.co/latest/core-concepts/overview) If you have any questions or want to report an issue, email us at support@seam.co. diff --git a/docs/brand-guides/get-started-with-yale-locks.md b/docs/brand-guides/get-started-with-yale-locks.md index 7c80299eb..45d72cc4f 100644 --- a/docs/brand-guides/get-started-with-yale-locks.md +++ b/docs/brand-guides/get-started-with-yale-locks.md @@ -65,7 +65,7 @@ This guide uses a Sandbox Workspace. Only virtual devices can be connected. If y ## 2 — Link Yale Account with Seam -To control your Yale lock via the Seam API, you must first authorize your Seam workspace against your Yale 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 Yale lock. +To control your Yale lock via the Seam API, you must first authorize your Seam workspace against your Yale account. To do so, Seam provides[ Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews): pre-built UX flows that walk you through authorizing your application to control your Yale lock. {% hint style="info" %} Note that `yale_access` or `yale_home` are now deprecated in favor of just`yale` which will work with whichever version of the Yale backend. @@ -314,7 +314,7 @@ puts updated_lock.properties.locked # false Most Yale locks come with a keypad built-in to program access codes. These codes can then be entered to unlock a Yale lock. -The Seam API makes it easy to program both `ongoing` codes and `timebound` codes on a Yale lock. You can find out more about Yale 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 Yale lock. You can find out more about Yale lock access code in our [core concept section on access codes.](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) {% tabs %} {% tab title="Python" %} @@ -457,7 +457,7 @@ In addition, if you'd like to explore other aspects of Seam, here is a list of h * [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](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) +* [Receiving webhook](https://docs.seam.co/latest/developer-tools/webhooks) for [device events](https://docs.seam.co/latest/api/events/list) +* [Core Concepts](https://docs.seam.co/latest/core-concepts/overview) 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/brand-guides/google-nest-thermostats/README.md b/docs/brand-guides/google-nest-thermostats/README.md index 08d458098..49ef4303d 100644 --- a/docs/brand-guides/google-nest-thermostats/README.md +++ b/docs/brand-guides/google-nest-thermostats/README.md @@ -24,17 +24,17 @@ For detailed information about the Google Nest devices that Seam supports, see o We support the following features: -* [Configuring current thermostat settings](../../capability-guides/thermostats/configure-current-climate-settings.md) -* [Creating and managing climate presets](../../capability-guides/thermostats/creating-and-managing-climate-presets/) -* [Creating and managing thermostat schedules](../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) -* [Creating and managing thermostat weekly programs](../../capability-guides/thermostats/creating-and-managing-thermostat-programs.md) -* [Setting and monitoring temperature thresholds](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md) +* [Configuring current thermostat settings](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings) +* [Creating and managing climate presets](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) +* [Creating and managing thermostat schedules](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) +* [Creating and managing thermostat weekly programs](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-programs) +* [Setting and monitoring temperature thresholds](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) *** ### Device Provider Key -To create a [Connect Webview](../../core-concepts/connect-webviews/) that enables your users to connect their Nest devices to Seam, include the `google_nest` 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](https://docs.seam.co/latest/core-concepts/connect-webviews) that enables your users to connect their Nest devices to Seam, include the `google_nest` device provider key in the `accepted_providers` list. For more information, see [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). *** @@ -44,7 +44,7 @@ This integration requires several steps, including both Google Nest and Seam. ### Create a Google Device Access Project -First, create a [Google Device Access](https://developers.google.com/nest/device-access) project—including an associated OAuth client—and provide information about this project to Seam through the [Seam Console](../../core-concepts/seam-console/). +First, create a [Google Device Access](https://developers.google.com/nest/device-access) project—including an associated OAuth client—and provide information about this project to Seam through the [Seam Console](https://docs.seam.co/latest/core-concepts/seam-console). ### Apply for Google Commercial Development @@ -64,19 +64,19 @@ Once you have set up Google Device Access, prompt the owners of these Google Nes 1. Create an account in the [Google Home app](https://home.google.com/get-app/) if you have not done so already. 2. In the Google Home app, add your Nest thermostats. -3. Note your login credentials for the Google Home app, and use these credentials to log in to the [Seam Connect Webview](../../core-concepts/connect-webviews/) to add your devices to Seam. +3. Note your login credentials for the Google Home app, and use these credentials to log in to the [Seam Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) to add your devices to Seam. *** ## Brand-Specific Features -Google Nest thermostats support an eco HVAC mode. To set a Google Nest thermostat to eco mode, use the [`/thermostats/set_hvac_mode`](https://docs.seam.co/latest/api/thermostats/set_hvac_mode) endpoint. For details, see [HVAC Mode](../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) and [Setting the Current HVAC and Fan Mode Settings](../../capability-guides/thermostats/configure-current-climate-settings.md). +Google Nest thermostats support an eco HVAC mode. To set a Google Nest thermostat to eco mode, use the [`/thermostats/set_hvac_mode`](https://docs.seam.co/latest/api/thermostats/set_hvac_mode) endpoint. For details, see [HVAC Mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) and [Setting the Current HVAC and Fan Mode Settings](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). *** ## Troubleshooting -If you have not yet [obtained Google Commercial Development](obtain-google-nest-device-access-and-commercial-development.md), and your end user attempts to connect a Google Nest thermostat to Seam using a [Connect Webview](../../core-concepts/connect-webviews/), the Connect Webview displays the following error: +If you have not yet [obtained Google Commercial Development](obtain-google-nest-device-access-and-commercial-development.md), and your end user attempts to connect a Google Nest thermostat to Seam using a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews), the Connect Webview displays the following error: > No access to partner > diff --git a/docs/brand-guides/google-nest-thermostats/get-started-with-nest-thermostats.md b/docs/brand-guides/google-nest-thermostats/get-started-with-nest-thermostats.md index 39d4936f2..b6feac3fc 100644 --- a/docs/brand-guides/google-nest-thermostats/get-started-with-nest-thermostats.md +++ b/docs/brand-guides/google-nest-thermostats/get-started-with-nest-thermostats.md @@ -19,7 +19,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 Google Nest thermostat 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](https://docs.seam.co/latest/core-concepts/seam-console/seam-online-cli), which you can access from directly within the [Seam Console](https://docs.seam.co/latest/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](https://docs.seam.co/latest/core-concepts/seam-console#create-a-seam-account) to get your [API key](https://docs.seam.co/latest/core-concepts/authentication/api-keys). Then, export your API key as an environment variable. @@ -80,21 +80,21 @@ $ 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 Google Nest thermostat, use a [non-sandbox workspace](../../core-concepts/workspaces/#production-workspaces) and API key. +This guide uses a [sandbox workspace](https://docs.seam.co/latest/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 Google Nest thermostat, use a [non-sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#production-workspaces) and API key. {% endhint %} *** ## Step 2: Link your Google Nest account with Seam -To control your Google Nest thermostat using the Seam API, you must first authorize your Seam workspace to connect to your Google Nest account. If your application needs to connect to your users' Google Nest 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 Google Nest thermostats. The Connect Webview presents a flow that prompts your users to enter their credentials for their Google Nest account. +To control your Google Nest thermostat using the Seam API, you must first authorize your Seam workspace to connect to your Google Nest account. If your application needs to connect to your users' Google Nest accounts, Seam provides fully-embedded, [customizable](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews) client-side [Connect Webviews](https://docs.seam.co/latest/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 Google Nest thermostats. The Connect Webview presents a flow that prompts your users to enter their credentials for their Google Nest 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 Google Nest 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](https://docs.seam.co/latest/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-nest-thermostats.md#authorize-your-workspace) in this guide to complete the Connect Webview authorization flow. @@ -271,13 +271,13 @@ 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](https://docs.seam.co/latest/ui-components/overview/react-components/connect-account-button) within our suite of [Seam Components](https://docs.seam.co/latest/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](../../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. +Because you're using a sandbox workspace, you can connect Seam's test Google Nest account. We provide [virtual devices](https://docs.seam.co/latest/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](../../developer-tools/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](https://docs.seam.co/latest/developer-tools/sandbox-and-sample-data/google-nest-thermostats-sample-data) credentials: * **Email:** jane@example.com * **Password:** 1234 @@ -722,7 +722,7 @@ Fan running: false Next, you can use the Seam API to control your Google Nest thermostat. -Each device that you connect to Seam has a specific set of capabilities. These capabilities define the Seam API actions that you can use. For thermostats, device-specific capabilities include whether you can [set the HVAC mode](../../capability-guides/thermostats/configure-current-climate-settings.md) to `heat`, `cool`, or `heat_cool`. 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. For thermostats, device-specific capabilities include whether you can [set the HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings) to `heat`, `cool`, or `heat_cool`. Seam's intuitive and granular [capability flags](https://docs.seam.co/latest/capability-guides/device-and-system-capabilities#capability-flags) inform your application about what features and behaviors each device supports. Notice the capability flags within the code samples in this guide. Seam provides additional actions for thermostats, such as setting the fan mode, creating and scheduling climate presets, setting temperature thresholds, and configuring weekly thermostat programs. You can also monitor for Seam thermostat-related events, such as reported temperatures outside your set thresholds. @@ -744,11 +744,11 @@ To set the HVAC mode, use any of the following endpoints or their equivalents in This endpoint is a consolidated version of the other four endpoints. -Specify the thermostat that you want to control by including the `device_id` in the request body. Also, include the desired temperature [set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md). +Specify the thermostat that you want to control by including the `device_id` in the request body. Also, include the desired temperature [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). In this example, set the HVAC mode to `heat` and the desired heating set point to 68 °F. -Each of these HVAC mode endpoints returns an [action attempt](../../core-concepts/action-attempts.md) to track the progress of the operation. +Each of these HVAC mode endpoints returns an [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) to track the progress of the operation. {% tabs %} {% tab title="Python" %} @@ -1842,7 +1842,7 @@ $seam->thermostats->update_weekly_program( ## Step 5: Connect a real Google Nest thermostat -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). +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](https://docs.seam.co/latest/core-concepts/workspaces#production-workspaces) and [API key](https://docs.seam.co/latest/core-concepts/authentication/api-keys). For more details about setting up your real Google Nest thermostat, see the [Google Nest thermostats integration guide](../). @@ -1859,17 +1859,17 @@ Seam makes it easy to develop your application. The robust Seam API and Seam SDK Now that you've completed this getting started guide for Google Nest thermostats, you can learn more about what you can do with the Seam API. * [ ] **Explore**\ - See the [other devices and system integrations](../overview.md) that Seam supports. + See the [other devices and system integrations](https://docs.seam.co/latest/device-and-system-integration-guides) 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](https://docs.seam.co/latest/core-concepts/overview) and the [device and system capabilities ](https://docs.seam.co/latest/capability-guides/device-and-system-capabilities)that Seam supports. * [ ] **Expand your abilities**\ - Find out what other [thermostat actions](../../capability-guides/thermostats/) you can perform using the Seam API. + Find out what other [thermostat actions](https://docs.seam.co/latest/capability-guides/thermostats) you can perform using the Seam API. * [ ] **Use webhooks**\ - Learn how to use [webhooks](../../developer-tools/webhooks.md) as an efficient way to receive device events. + Learn how to use [webhooks](https://docs.seam.co/latest/developer-tools/webhooks) 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 [smart locks](../../capability-guides/smart-locks/), [access control systems](../../capability-guides/access-systems/), and [noise sensors](../../capability-guides/noise-sensors/). + Explore the other types of devices and systems that you can control with Seam, including [smart locks](https://docs.seam.co/latest/capability-guides/smart-locks), [access control systems](https://docs.seam.co/latest/capability-guides/access-systems), and [noise sensors](https://docs.seam.co/latest/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](https://docs.seam.co/latest/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). diff --git a/docs/brand-guides/google-nest-thermostats/obtain-google-nest-device-access-and-commercial-development.md b/docs/brand-guides/google-nest-thermostats/obtain-google-nest-device-access-and-commercial-development.md index 5e83e02db..22ce042b0 100644 --- a/docs/brand-guides/google-nest-thermostats/obtain-google-nest-device-access-and-commercial-development.md +++ b/docs/brand-guides/google-nest-thermostats/obtain-google-nest-device-access-and-commercial-development.md @@ -7,7 +7,7 @@ description: >- # Obtain Google Nest Device Access and Commercial Development -To control Nest devices using Seam, you must first create a [Google Device Access](https://developers.google.com/nest/device-access) project—including an associated OAuth client—and provide information about this project to Seam through the [Seam Console](../../core-concepts/seam-console/). We recommend that you apply for [Google Commercial Development](https://developers.google.com/nest/device-access/project/apply) for your Nest devices. +To control Nest devices using Seam, you must first create a [Google Device Access](https://developers.google.com/nest/device-access) project—including an associated OAuth client—and provide information about this project to Seam through the [Seam Console](https://docs.seam.co/latest/core-concepts/seam-console). We recommend that you apply for [Google Commercial Development](https://developers.google.com/nest/device-access/project/apply) for your Nest devices. {% hint style="info" %} The period of time that Google takes to approve Commercial Development may range from a week to more than a month. For more information, see [Apply for Commercial Development](https://developers.google.com/nest/device-access/project/apply) on the Google Device Access site. @@ -181,10 +181,10 @@ However, we can help you test the settings and configuration of the original tes ## 6. Provide Your Project Information to Seam through the Seam Console -In the [Seam Console](../../core-concepts/seam-console/), add your Google Device Access project information. It is not necessary to wait for Google Commercial Development approval before adding this information in the Seam Console. +In the [Seam Console](https://docs.seam.co/latest/core-concepts/seam-console), add your Google Device Access project information. It is not necessary to wait for Google Commercial Development approval before adding this information in the Seam Console. {% hint style="info" %} -You must be the owner of your Seam [workspace](../../core-concepts/workspaces/) to perform this procedure. +You must be the owner of your Seam [workspace](https://docs.seam.co/latest/core-concepts/workspaces) to perform this procedure. {% endhint %} 1. Locate and note the following information: @@ -196,7 +196,7 @@ You must be the owner of your Seam [workspace](../../core-concepts/workspaces/) * OAuth client ID and secret\ Find this information in the JSON file that you downloaded when creating the OAuth client earlier in this procedure. 2. In a web browser, go to [https://console.seam.co](https://console.seam.co). -3. [Log in to the Seam Console](../../core-concepts/seam-console/#log-in-to-the-seam-console-using-an-email-address). +3. [Log in to the Seam Console](https://docs.seam.co/latest/core-concepts/seam-console#log-in-to-the-seam-console-using-an-email-address). 4. In upper-right corner of the Seam Console, click your username and then select **Workspace Settings**. 5. On the **Workspace Settings** page, next to **Nest Developer Settings**, click **Edit**. 6. In the **Nest Developer Settings** dialog, type or paste your project ID, Client ID, and Client secret. diff --git a/docs/brand-guides/honeywell-thermostats/README.md b/docs/brand-guides/honeywell-thermostats/README.md index 744c94685..9e4a831b4 100644 --- a/docs/brand-guides/honeywell-thermostats/README.md +++ b/docs/brand-guides/honeywell-thermostats/README.md @@ -24,17 +24,17 @@ For detailed information about the Honeywell devices that Seam supports, see our We support the following features: -* [Configuring current thermostat settings](../../capability-guides/thermostats/configure-current-climate-settings.md) -* [Creating and managing climate presets](../../capability-guides/thermostats/creating-and-managing-climate-presets/) -* [Creating and managing thermostat schedules](../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) -* [Creating and managing thermostat weekly programs](../../capability-guides/thermostats/creating-and-managing-thermostat-programs.md) -* [Setting and monitoring temperature thresholds](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md) +* [Configuring current thermostat settings](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings) +* [Creating and managing climate presets](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) +* [Creating and managing thermostat schedules](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) +* [Creating and managing thermostat weekly programs](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-programs) +* [Setting and monitoring temperature thresholds](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) *** ### Device Provider Key -To create a [Connect Webview](../../core-concepts/connect-webviews/) that enables your users to connect their Honeywell Resideo devices to Seam, include the `honeywell_resideo` 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](https://docs.seam.co/latest/core-concepts/connect-webviews) that enables your users to connect their Honeywell Resideo devices to Seam, include the `honeywell_resideo` device provider key in the `accepted_providers` list. For more information, see [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). *** @@ -44,7 +44,7 @@ To control Honeywell Resideo devices using Seam, you must prompt owners of these 1. Create an account in the [Resideo app](https://www.resideo.com/us/en/resideo-smart-home-app/) if you have not done so already. 2. In the Resideo app, add your Honeywell Resideo thermostats. -3. Note your login credentials for the Resideo app, and use these credentials to log in to the [Seam Connect Webview](../../core-concepts/connect-webviews/) to add your devices to Seam. +3. Note your login credentials for the Resideo app, and use these credentials to log in to the [Seam Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) to add your devices to Seam. *** diff --git a/docs/brand-guides/honeywell-thermostats/get-started-with-honeywell-thermostats.md b/docs/brand-guides/honeywell-thermostats/get-started-with-honeywell-thermostats.md index a01cff2f2..ccbd3c5d5 100644 --- a/docs/brand-guides/honeywell-thermostats/get-started-with-honeywell-thermostats.md +++ b/docs/brand-guides/honeywell-thermostats/get-started-with-honeywell-thermostats.md @@ -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 Honeywell Resideo thermostat 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](https://docs.seam.co/latest/core-concepts/seam-console/seam-online-cli), which you can access from directly within the [Seam Console](https://docs.seam.co/latest/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](https://docs.seam.co/latest/core-concepts/seam-console#create-a-seam-account) to get your [API key](https://docs.seam.co/latest/core-concepts/authentication/api-keys). Then, export your API key as an environment variable. @@ -80,21 +80,21 @@ $ 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 Honeywell Resideo thermostat, use a [non-sandbox workspace](../../core-concepts/workspaces/#production-workspaces) and API key. +This guide uses a [sandbox workspace](https://docs.seam.co/latest/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 Honeywell Resideo thermostat, use a [non-sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#production-workspaces) and API key. {% endhint %} *** ## Step 2: Link your Honeywell Resideo account with Seam -To control your Honeywell Resideo thermostat using the Seam API, you must first authorize your Seam workspace to connect to your Honeywell Resideo account. If your application needs to connect to your users' Honeywell Resideo 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 Honeywell Resideo thermostats. The Connect Webview presents a flow that prompts your users to enter their credentials for their Honeywell Resideo account. +To control your Honeywell Resideo thermostat using the Seam API, you must first authorize your Seam workspace to connect to your Honeywell Resideo account. If your application needs to connect to your users' Honeywell Resideo accounts, Seam provides fully-embedded, [customizable](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews) client-side [Connect Webviews](https://docs.seam.co/latest/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 Honeywell Resideo thermostats. The Connect Webview presents a flow that prompts your users to enter their credentials for their Honeywell Resideo 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 Honeywell Resideo 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](https://docs.seam.co/latest/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-honeywell-thermostats.md#authorize-your-workspace) in this guide to complete the Connect Webview authorization flow. @@ -271,13 +271,13 @@ 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](https://docs.seam.co/latest/ui-components/overview/react-components/connect-account-button) within our suite of [Seam Components](https://docs.seam.co/latest/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](../../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. +Because you're using a sandbox workspace, you can connect Seam's test Honeywell Resideo account. We provide [virtual devices](https://docs.seam.co/latest/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: +Complete the Connect Webview authorization flow by entering the following [Honeywell Resideo sandbox account](https://docs.seam.co/latest/developer-tools/sandbox-and-sample-data/sandbox-honeywell-thermostats) credentials: * **Email:** jane@example.com * **Password:** 1234 @@ -722,7 +722,7 @@ Fan running: false Next, you can use the Seam API to control your Honeywell Resideo thermostat. -Each device that you connect to Seam has a specific set of capabilities. These capabilities define the Seam API actions that you can use. For thermostats, device-specific capabilities include whether you can [set the HVAC mode](../../capability-guides/thermostats/configure-current-climate-settings.md) to `heat`, `cool`, or `heat_cool`. 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. For thermostats, device-specific capabilities include whether you can [set the HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings) to `heat`, `cool`, or `heat_cool`. Seam's intuitive and granular [capability flags](https://docs.seam.co/latest/capability-guides/device-and-system-capabilities#capability-flags) inform your application about what features and behaviors each device supports. Notice the capability flags within the code samples in this guide. Seam provides additional actions for thermostats, such as setting the fan mode, creating and scheduling climate presets, setting temperature thresholds, and configuring weekly thermostat programs. You can also monitor for Seam thermostat-related events, such as reported temperatures outside your set thresholds. @@ -744,11 +744,11 @@ To set the HVAC mode, use any of the following endpoints or their equivalents in This endpoint is a consolidated version of the other four endpoints. -Specify the thermostat that you want to control by including the `device_id` in the request body. Also, include the desired temperature [set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md). +Specify the thermostat that you want to control by including the `device_id` in the request body. Also, include the desired temperature [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). In this example, set the HVAC mode to `heat` and the desired heating set point to 68 °F. -Each of these HVAC mode endpoints returns an [action attempt](../../core-concepts/action-attempts.md) to track the progress of the operation. +Each of these HVAC mode endpoints returns an [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) to track the progress of the operation. {% tabs %} {% tab title="Python" %} @@ -1842,7 +1842,7 @@ $seam->thermostats->update_weekly_program( ## Step 5: Connect a real Honeywell Resideo thermostat -Now that you have learned the basics of using the Seam API, you can connect and control a real Honeywell Resideo 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 Honeywell Resideo device. To do so, make sure to switch to a [non-sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#production-workspaces) and [API key](https://docs.seam.co/latest/core-concepts/authentication/api-keys). For more details about setting up your real Honeywell Resideo thermostat, see the [Honeywell Resideo thermostats integration guide](./). @@ -1859,17 +1859,17 @@ Seam makes it easy to develop your application. The robust Seam API and Seam SDK Now that you've completed this getting started guide for Honeywell Resideo devices, you can learn more about what you can do with the Seam API. * [ ] **Explore**\ - See the [other devices and system integrations](../overview.md) that Seam supports. + See the [other devices and system integrations](https://docs.seam.co/latest/device-and-system-integration-guides) 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](https://docs.seam.co/latest/core-concepts/overview) and the [device and system capabilities ](https://docs.seam.co/latest/capability-guides/device-and-system-capabilities)that Seam supports. * [ ] **Expand your abilities**\ - Find out what other [thermostat actions](../../capability-guides/thermostats/) you can perform using the Seam API. + Find out what other [thermostat actions](https://docs.seam.co/latest/capability-guides/thermostats) you can perform using the Seam API. * [ ] **Use webhooks**\ - Learn how to use [webhooks](../../developer-tools/webhooks.md) as an efficient way to receive device events. + Learn how to use [webhooks](https://docs.seam.co/latest/developer-tools/webhooks) 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 [smart locks](../../capability-guides/smart-locks/), [access control systems](../../capability-guides/access-systems/), and [noise sensors](../../capability-guides/noise-sensors/). + Explore the other types of devices and systems that you can control with Seam, including [smart locks](https://docs.seam.co/latest/capability-guides/smart-locks), [access control systems](https://docs.seam.co/latest/capability-guides/access-systems), and [noise sensors](https://docs.seam.co/latest/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](https://docs.seam.co/latest/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). diff --git a/docs/brand-guides/igloohome-locks/README.md b/docs/brand-guides/igloohome-locks/README.md index 35117ee9a..265bab186 100644 --- a/docs/brand-guides/igloohome-locks/README.md +++ b/docs/brand-guides/igloohome-locks/README.md @@ -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](https://docs.seam.co/latest/capability-guides/smart-locks/lock-and-unlock) for igloohome smart locks connected through the igloohome Bridge +* [Programming online access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) +* [Programming offline access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) {% 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](https://docs.seam.co/latest/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](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#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](https://docs.seam.co/latest/core-concepts/connect-webviews) to add your devices to Seam. *** diff --git a/docs/brand-guides/igloohome-locks/creating-igloohome-offline-access-codes.md b/docs/brand-guides/igloohome-locks/creating-igloohome-offline-access-codes.md index 75d444c7a..648789dbd 100644 --- a/docs/brand-guides/igloohome-locks/creating-igloohome-offline-access-codes.md +++ b/docs/brand-guides/igloohome-locks/creating-igloohome-offline-access-codes.md @@ -6,15 +6,15 @@ description: >- # Creating igloohome Offline Access Codes -In addition to supporting [online access codes](../../capability-guides/smart-locks/access-codes/), the Seam integration for igloohome supports the generation of offline access codes (that is, igloohome [algoPIN™](https://www.igloohome.co/en-US/how-it-works) codes) for all igloohome lock models, without the need for a bridge. You generate offline access (PIN) codes remotely, and the manufacturer maintains a server-based registry of synchronized encryption keys (tokens) to enable these offline codes. Then, owners or managers can share these codes with users through messaging or other similar applications, and the users do not need to install a special application to unlock the device. +In addition to supporting [online access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes), the Seam integration for igloohome supports the generation of offline access codes (that is, igloohome [algoPIN™](https://www.igloohome.co/en-US/how-it-works) codes) for all igloohome lock models, without the need for a bridge. You generate offline access (PIN) codes remotely, and the manufacturer maintains a server-based registry of synchronized encryption keys (tokens) to enable these offline codes. Then, owners or managers can share these codes with users through messaging or other similar applications, and the users do not need to install a special application to unlock the device. -To learn about the special requirements regarding offline access codes for igloohome locks, see [Offline Access Code Requirements](creating-igloohome-offline-access-codes.md#offline-access-code-requirements). For more information about using offline access codes, see [Offline Access Codes](../../capability-guides/smart-locks/access-codes/#offline-access-codes) and [Managing Offline Access Codes](../../capability-guides/smart-locks/access-codes/offline-access-codes.md). +To learn about the special requirements regarding offline access codes for igloohome locks, see [Offline Access Code Requirements](creating-igloohome-offline-access-codes.md#offline-access-code-requirements). For more information about using offline access codes, see [Offline Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#offline-access-codes) and [Managing Offline Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes). *** ## Offline Access Code Requirements -Seam supports the following types of [offline access codes](../../capability-guides/smart-locks/access-codes/offline-access-codes.md) for igloohome locks: +Seam supports the following types of [offline access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for igloohome locks: * [Hourly-bound](creating-igloohome-offline-access-codes.md#hourly-bound-offline-access-codes) * [Daily-bound](creating-igloohome-offline-access-codes.md#daily-bound-offline-access-codes) @@ -63,7 +63,7 @@ You can create hourly-bound, daily-bound, and one-time-use offline access codes ### Hourly-Bound Offline Access Codes -To [create an hourly-bound offline access code](../../capability-guides/smart-locks/access-codes/offline-access-codes.md#creating-time-bound-offline-access-codes), issue an access code creation request. Then, poll or use a webhook to confirm that the code was registered successfully in the igloohome offline access code server. +To [create an hourly-bound offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes#creating-time-bound-offline-access-codes), issue an access code creation request. Then, poll or use a webhook to confirm that the code was registered successfully in the igloohome offline access code server. #### 1. Create an Hourly-Bound Offline Access Code @@ -319,7 +319,7 @@ if (device.CanProgramOfflineAccessCodes == true) { #### 2. Verify Successful Time-Bound Code Registration -The [lifecycle of a time-bound access code](../../capability-guides/smart-locks/access-codes/lifecycle-of-access-codes.md) is marked by distinct phases: +The [lifecycle of a time-bound access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/lifecycle-of-access-codes) is marked by distinct phases: 1. `Unset`: When initially created on Seam, the offline access code remains in an `unset` state, indicating that it is not yet available for use on the lock due to a configured future activation time. 2. `Setting`: As the scheduled `starts_at` time approaches, Seam initiates the process of readying the code for use on the lock, transitioning the `status` of the offline code to `setting`. @@ -327,14 +327,14 @@ The [lifecycle of a time-bound access code](../../capability-guides/smart-locks/ There are two methods to verify that an time-bound offline access code has been registered in the offline access code server that the device manufacturer maintains: -* **Polling**: Continuously query the access code until the `status` is updated. For instructions, see [Polling Method](../../capability-guides/smart-locks/access-codes/creating-access-codes/#polling-method-1). -* **Webhook**: Wait for updates to arrive using webhook requests from the Seam API. For instructions, see [Webhook Events Method](../../capability-guides/smart-locks/access-codes/creating-access-codes/#webhook-events-method-1). +* **Polling**: Continuously query the access code until the `status` is updated. For instructions, see [Polling Method](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/creating-access-codes#polling-method-1). +* **Webhook**: Wait for updates to arrive using webhook requests from the Seam API. For instructions, see [Webhook Events Method](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/creating-access-codes#webhook-events-method-1). *** ### Daily-Bound Offline Access Codes -To [create a daily-bound offline access code](../../capability-guides/smart-locks/access-codes/offline-access-codes.md#creating-time-bound-offline-access-codes), first issue a creation request. Then, poll or use a webhook to confirm that the code was registered successfully in the igloohome offline access code server. +To [create a daily-bound offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes#creating-time-bound-offline-access-codes), first issue a creation request. Then, poll or use a webhook to confirm that the code was registered successfully in the igloohome offline access code server. #### 1. Create a Daily-Bound Access Code @@ -600,7 +600,7 @@ if (device.CanProgramOfflineAccessCodes == true) { #### 2. Verify Successful Time-Bound Code Registration -The [lifecycle of a time-bound access code](../../capability-guides/smart-locks/access-codes/lifecycle-of-access-codes.md) is marked by distinct phases: +The [lifecycle of a time-bound access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/lifecycle-of-access-codes) is marked by distinct phases: 1. `Unset`: When initially created on Seam, the offline access code remains in an `unset` state, indicating that it is not yet available for use on the lock due to a configured future activation time. 2. `Setting`: As the scheduled `starts_at` time approaches, Seam initiates the process of readying the code for use on the lock, transitioning the `status` of the offline code to `setting`. @@ -608,11 +608,11 @@ The [lifecycle of a time-bound access code](../../capability-guides/smart-locks/ There are two methods to verify that an time-bound offline access code has been registered in the offline access code server that the device manufacturer maintains: -* **Polling**: Continuously query the access code until the `status` is updated. For instructions, see [Polling Method](../../capability-guides/smart-locks/access-codes/creating-access-codes/#polling-method-1). -* **Webhook**: Wait for updates to arrive using webhook requests from the Seam API. For instructions, see [Webhook Events Method](../../capability-guides/smart-locks/access-codes/creating-access-codes/#webhook-events-method-1). +* **Polling**: Continuously query the access code until the `status` is updated. For instructions, see [Polling Method](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/creating-access-codes#polling-method-1). +* **Webhook**: Wait for updates to arrive using webhook requests from the Seam API. For instructions, see [Webhook Events Method](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/creating-access-codes#webhook-events-method-1). *** ### 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. These codes expire after a single use. For detailed instructions, see [Creating One-Time-Use Offline Access Codes](../../capability-guides/smart-locks/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. These codes expire after a single use. For detailed instructions, see [Creating One-Time-Use Offline Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes#creating-one-time-use-offline-access-codes). diff --git a/docs/brand-guides/igloohome-locks/get-started-with-igloo-locks.md b/docs/brand-guides/igloohome-locks/get-started-with-igloo-locks.md index ac304f71e..36672ca1d 100644 --- a/docs/brand-guides/igloohome-locks/get-started-with-igloo-locks.md +++ b/docs/brand-guides/igloohome-locks/get-started-with-igloo-locks.md @@ -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](https://docs.seam.co/latest/core-concepts/connect-webviews): pre-built UX flows that walk you through authorizing your application to control your Igloohome devices. #### Request a Connect Webview @@ -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.](https://docs.seam.co/latest/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. @@ -459,7 +459,7 @@ In addition, if you'd like to explore other aspects of Seam, here is a list of h * [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) +* [Receiving webhook](https://docs.seam.co/latest/developer-tools/webhooks) for [device events](https://docs.seam.co/latest/api/events/list) +* [Core Concepts](https://docs.seam.co/latest/core-concepts/overview) If you have any questions or want to report an issue, email us at support@seam.co. diff --git a/docs/brand-guides/keynest-key-lockers/README.md b/docs/brand-guides/keynest-key-lockers/README.md index 4d834b24b..81d8d7b96 100644 --- a/docs/brand-guides/keynest-key-lockers/README.md +++ b/docs/brand-guides/keynest-key-lockers/README.md @@ -37,7 +37,7 @@ With this integration, users can manage: ## Device Provider Key for Connect Webview -To create a [Connect Webview](../../core-concepts/connect-webviews/) that enables your users to connect their Keynest keys to Seam, include the `keynest` 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](https://docs.seam.co/latest/core-concepts/connect-webviews) that enables your users to connect their Keynest keys to Seam, include the `keynest` device provider key in the `accepted_providers` list. For more information, see [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). *** diff --git a/docs/brand-guides/kwikset-locks.md b/docs/brand-guides/kwikset-locks.md index 9a3599c8f..7ccb9d3d7 100644 --- a/docs/brand-guides/kwikset-locks.md +++ b/docs/brand-guides/kwikset-locks.md @@ -22,18 +22,18 @@ For detailed information about the Kwikset devices that Seam supports, see our [ We support the following features: -* [Triggering web lock and unlock actions](../capability-guides/smart-locks/lock-and-unlock.md) -* [Programming access codes](../capability-guides/smart-locks/access-codes/) +* [Triggering web lock and unlock actions](https://docs.seam.co/latest/capability-guides/smart-locks/lock-and-unlock) +* [Programming access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) {% hint style="info" %} -Seam does not support [unmanaged access codes](../capability-guides/smart-locks/access-codes/migrating-existing-access-codes.md) for Kwikset. +Seam does not support [unmanaged access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) for Kwikset. {% endhint %} *** ### Device Provider Key -To create a [Connect Webview](../core-concepts/connect-webviews/) that enables your users to connect their Kwikset devices to Seam, include the `kwikset` 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](https://docs.seam.co/latest/core-concepts/connect-webviews) that enables your users to connect their Kwikset devices to Seam, include the `kwikset` device provider key in the `accepted_providers` list. For more information, see [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). *** @@ -50,7 +50,7 @@ To control Kwikset devices using Seam, you must prompt owners of these devices t
Disable 2-Step Verification before connecting your Kwikset account to Seam.

Disable 2-Step Verification before connecting your Kwikset account to Seam.

{% hint style="warning" %} -You must disable **2-Step Verification**—that is, multifactor authentication (MFA)—before connecting your Kwikset account to Seam using the [Seam Connect Webview](../core-concepts/connect-webviews/). +You must disable **2-Step Verification**—that is, multifactor authentication (MFA)—before connecting your Kwikset account to Seam using the [Seam Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews). Enabling MFA in the Kwikset App can block the Seam login process from performing successful authorization using your Kwikset account. After you connect your Kwikset account to Seam, you can reenable **2-Step Verification** in the Kwikset App **Account Settings**. {% endhint %} diff --git a/docs/brand-guides/latch-access-control-system/README.md b/docs/brand-guides/latch-access-control-system/README.md index a47e33040..1bcc97d85 100644 --- a/docs/brand-guides/latch-access-control-system/README.md +++ b/docs/brand-guides/latch-access-control-system/README.md @@ -8,7 +8,7 @@ description: Guide for using the Latch Access Control System with Seam ## Overview -Seam integrates seamlessly with the [Latch](https://www.latch.com/) management platform. Property managers and owners use the Latch [access control system](../../capability-guides/access-systems/) (ACS) to control access across their properties. Latch enables them to manage who has access to which spaces and when, view access history, and set up and manage multiple users and guests. +Seam integrates seamlessly with the [Latch](https://www.latch.com/) management platform. Property managers and owners use the Latch [access control system](https://docs.seam.co/latest/capability-guides/access-systems) (ACS) to control access across their properties. Latch enables them to manage who has access to which spaces and when, view access history, and set up and manage multiple users and guests. The Seam integration for Latch enables you to automate the creation of residents and the issuing of credentials to these residents. Within these credentials, you specify the entrances to which the residents have access and the access schedules. @@ -18,7 +18,7 @@ Latch enables you to install wireless door locks and intercom systems in your bu ## Latch ACS Resources -The Seam ACS schema consists of a series of resources that interact intuitively, enabling you to use the Seam API to manage your Latch ACS in a logical, efficient manner. Latch is a [credential-based ACS](../../capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md#credential-based-access-control-systems), so you [create ACS users](../../capability-guides/access-systems/user-management.md#create-an-acs-user) and then grant them access permissions using credentials. When you create a credential, you specify the ACS user to which to assign the credential, as well as the allowed entrances and the start and end times for the access schedule. +The Seam ACS schema consists of a series of resources that interact intuitively, enabling you to use the Seam API to manage your Latch ACS in a logical, efficient manner. Latch is a [credential-based ACS](https://docs.seam.co/latest/capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences#credential-based-access-control-systems), so you [create ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management#create-an-acs-user) and then grant them access permissions using credentials. When you create a credential, you specify the ACS user to which to assign the credential, as well as the allowed entrances and the start and end times for the access schedule. The following diagram shows the Seam resources for a Latch ACS and the relationships between these resources: @@ -32,9 +32,9 @@ For more information about managing your Latch ACS through Seam, see the followi * [Programming Code-Based Latch Credentials](programming-code-based-latch-credentials.md) * [Programming Latch ACS Mobile Credentials](programming-latch-acs-mobile-credentials.md) -* [Credential-based ACS](../../capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md#credential-based-acs) -* [Access Control Systems](../../capability-guides/access-systems/) -* [Mobile Access](../../capability-guides/mobile-access/) +* [Credential-based ACS](https://docs.seam.co/latest/capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences#credential-based-acs) +* [Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems) +* [Mobile Access](https://docs.seam.co/latest/capability-guides/mobile-access) *** @@ -48,14 +48,14 @@ This integration supports all wireless locks and readers connected to the Latch We support the following features: -* [Managing access systems](../../capability-guides/access-systems/) -* [Issuing mobile access credentials](../../capability-guides/mobile-access/) +* [Managing access systems](https://docs.seam.co/latest/capability-guides/access-systems) +* [Issuing mobile access credentials](https://docs.seam.co/latest/capability-guides/mobile-access) *** ### Device Provider Key -To create a [Connect Webview](../../core-concepts/connect-webviews/) that enables you to connect your Latch ACS to Seam, include the `latch` 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](https://docs.seam.co/latest/core-concepts/connect-webviews) that enables you to connect your Latch ACS to Seam, include the `latch` device provider key in the `accepted_providers` list. For more information, see [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). *** @@ -70,7 +70,7 @@ Note the following restrictions on using Seam to manage your Latch ACS: ## Troubleshooting -For information about Latch ACS-related errors, including issues related to the connection between your ACS and Seam, see [Troubleshooting Your ACS](../../capability-guides/access-systems/troubleshooting-your-access-control-system.md). +For information about Latch ACS-related errors, including issues related to the connection between your ACS and Seam, see [Troubleshooting Your ACS](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system). *** diff --git a/docs/brand-guides/latch-access-control-system/latch-setup-guide.md b/docs/brand-guides/latch-access-control-system/latch-setup-guide.md index 9def6d57f..5b3dc7f25 100644 --- a/docs/brand-guides/latch-access-control-system/latch-setup-guide.md +++ b/docs/brand-guides/latch-access-control-system/latch-setup-guide.md @@ -32,7 +32,7 @@ The property manager performs most of this procedure. The following instructions The property manager or application developer must perform the following steps: -1. Create a [Connect Webview](../../core-concepts/connect-webviews/), including `latch` in the set of `accepted_providers`. +1. Create a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews), including `latch` in the set of `accepted_providers`. 2. Display the Connect Webview and perform the following steps: * If the Connect Webview displays multiple brand options, select **Latch**. * In the **Connect a Latch Building** dialog, copy and note your Seam Connect ID. You must send this Connect ID to Seam. Save the Connect ID for a later step with further instructions. diff --git a/docs/brand-guides/latch-access-control-system/programming-code-based-latch-credentials.md b/docs/brand-guides/latch-access-control-system/programming-code-based-latch-credentials.md index e056ac355..d61cd75a0 100644 --- a/docs/brand-guides/latch-access-control-system/programming-code-based-latch-credentials.md +++ b/docs/brand-guides/latch-access-control-system/programming-code-based-latch-credentials.md @@ -16,10 +16,10 @@ Alternately, you can update entrances manually using the [Latch Manager App](htt To use the Seam API to program codes for users in a [Latch ACS](./): -1. Create an [ACS user](../../capability-guides/access-systems/user-management.md). +1. Create an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). * Specify the `acs_system_id` of the Latch ACS in the building to which you want to grant the new user access. * Specify the details of the new ACS user, such as their `full_name`, `email_address`, and so on. -2. Create an [ACS credential](../../capability-guides/access-systems/managing-credentials.md). +2. Create an [ACS credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). * Specify the `acs_user_id` of the user that you just created. * Specify the ID of the entrance to which you want to grant access.\ @@ -394,10 +394,10 @@ foreach (AcsEntrance entrance in entrances) To learn more about using the Seam API with your Latch ACS, see the following topics: * [Programming Latch ACS Mobile Keys for App Users](programming-latch-acs-mobile-credentials.md) -* [Access Control Systems](../../capability-guides/access-systems/) -* [Credential-based ACS](../../capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md#credential-based-acs) -* [Managing ACS Users](../../capability-guides/access-systems/user-management.md) -* [Managing Credentials](../../capability-guides/access-systems/managing-credentials.md) -* [Mobile Access](../../capability-guides/mobile-access/) +* [Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems) +* [Credential-based ACS](https://docs.seam.co/latest/capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences#credential-based-acs) +* [Managing ACS Users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) +* [Managing Credentials](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) +* [Mobile Access](https://docs.seam.co/latest/capability-guides/mobile-access) * [Access Control Systems](https://docs.seam.co/latest/api/acs/) in the Seam API reference * [User Identities](https://docs.seam.co/latest/api/user_identities/) in the Seam API reference diff --git a/docs/brand-guides/latch-access-control-system/programming-latch-acs-mobile-credentials.md b/docs/brand-guides/latch-access-control-system/programming-latch-acs-mobile-credentials.md index 00239cecd..faf6a5708 100644 --- a/docs/brand-guides/latch-access-control-system/programming-latch-acs-mobile-credentials.md +++ b/docs/brand-guides/latch-access-control-system/programming-latch-acs-mobile-credentials.md @@ -4,22 +4,22 @@ description: Learn how to create mobile credentials in the Latch ACS. # Programming Latch ACS Mobile Credentials -You can create mobile credentials that enable your mobile app users to unlock entrances in your [Latch access system](./). For more information about Seam mobile keys, see [Mobile Access](../../capability-guides/mobile-access/). +You can create mobile credentials that enable your mobile app users to unlock entrances in your [Latch access system](./). For more information about Seam mobile keys, see [Mobile Access](https://docs.seam.co/latest/capability-guides/mobile-access). To use the Seam API to create mobile credentials for mobile app users in a Latch ACS: 1. Create a [user identity](https://docs.seam.co/latest/api/user_identities/) that corresponds to your user's app account. Seam [user identities](https://docs.seam.co/latest/api/user_identities/) enable you to match your own mobile app users to ACS users that you create using the Seam API. -2. Create an [access system user](../../capability-guides/access-systems/user-management.md) on the Latch access system or assign an existing access system user to the user identity.\ +2. Create an [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) on the Latch access system or assign an existing access system user to the user identity.\ The resources that you create for the access system user are available under the associated user identity. * In the access system user creation command, set the `user_identity_id` property for a new access system user. Alternately, use the `add_acs_user` command for user identities to assign an existing access system user to a user identity. * If you choose to create a new access system user, specify the `acs_system_id` of the Latch access system in the building to which you want to grant the new user access. * Specify the details of the access system user, such as their `full_name`, `email_address`, and so on. -3. Create a [credential](../../capability-guides/access-systems/managing-credentials.md) to represent the mobile key. +3. Create a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) to represent the mobile key. * Specify the `acs_user_id`. - * Set [`is_multi_phone_sync_credential`](../../capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system.md#what-are-multi-phone-sync-credentials) to `true`. + * Set [`is_multi_phone_sync_credential`](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials) to `true`. * Set the `access_method` to `mobile_key`. * Specify the IDs of the entrances to which you want to grant access.\ Note that you can include multiple entrances in a single mobile key credential. @@ -460,10 +460,10 @@ seam.CredentialsAcs.ListAccessibleEntrances( To learn more about using the Seam API with your Latch ACS, see the following topics: * [Programming PIN Codes for Latch ACS Users](programming-code-based-latch-credentials.md) -* [Access Control Systems](../../capability-guides/access-systems/) -* [Credential-based ACS](../../capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md#credential-based-acs) -* [Managing ACS Users](../../capability-guides/access-systems/user-management.md) -* [Managing Credentials](../../capability-guides/access-systems/managing-credentials.md) -* [Mobile Access](../../capability-guides/mobile-access/) +* [Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems) +* [Credential-based ACS](https://docs.seam.co/latest/capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences#credential-based-acs) +* [Managing ACS Users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) +* [Managing Credentials](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) +* [Mobile Access](https://docs.seam.co/latest/capability-guides/mobile-access) * [Access Control Systems](https://docs.seam.co/latest/api/acs/) in the Seam API reference * [User Identities](https://docs.seam.co/latest/api/user_identities/) in the Seam API reference diff --git a/docs/brand-guides/lockly-locks/README.md b/docs/brand-guides/lockly-locks/README.md index a7e78e5ff..2e5191c64 100644 --- a/docs/brand-guides/lockly-locks/README.md +++ b/docs/brand-guides/lockly-locks/README.md @@ -52,7 +52,7 @@ We support the following features: ## Connecting Lockly to Seam -To enable your users to [connect Lockly devices through Connect Webviews](../../core-concepts/connect-webviews/customizing-connect-webviews.md#customize-the-brands-to-display-in-your-connect-webviews), include the Lockly provider: +To enable your users to [connect Lockly devices through Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews), include the Lockly provider: ```json { diff --git a/docs/brand-guides/lockly-locks/creating-lockly-offline-access-codes.md b/docs/brand-guides/lockly-locks/creating-lockly-offline-access-codes.md index f317e46cd..1d5e033c3 100644 --- a/docs/brand-guides/lockly-locks/creating-lockly-offline-access-codes.md +++ b/docs/brand-guides/lockly-locks/creating-lockly-offline-access-codes.md @@ -6,20 +6,20 @@ description: >- # Creating Lockly Offline Access Codes -In addition to supporting [online access codes](../../capability-guides/smart-locks/access-codes/), the Seam integration for Lockly supports the generation of offline access codes for all Lockly lock models that have a keypad. You generate offline access (PIN) codes remotely, and the manufacturer maintains a server-based registry of synchronized encryption keys (tokens) to enable these offline codes. Then, owners or managers can share these codes with users through messaging or other similar applications, and the users do not need to install a special application to unlock the device. +In addition to supporting [online access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes), the Seam integration for Lockly supports the generation of offline access codes for all Lockly lock models that have a keypad. You generate offline access (PIN) codes remotely, and the manufacturer maintains a server-based registry of synchronized encryption keys (tokens) to enable these offline codes. Then, owners or managers can share these codes with users through messaging or other similar applications, and the users do not need to install a special application to unlock the device. -For Lockly locks with keypads, you can program [time-bound](../../capability-guides/smart-locks/access-codes/offline-access-codes.md#creating-time-bound-offline-access-codes) and [one-time-use](../../capability-guides/smart-locks/access-codes/offline-access-codes.md#creating-one-time-use-offline-access-codes) offline access codes. To define the validity period for each Lockly offline access code, specify the desired `starts_at` and `ends_at` timestamp. You can create as many offline access codes as you'd like, up to the limits of your device memory capacity and your Lockly subscription. You can verify your Lockly subscription in the [Lockly Access Portal](https://lap.lockly.com/lap/index.html#/login). +For Lockly locks with keypads, you can program [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes#creating-time-bound-offline-access-codes) and [one-time-use](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes#creating-one-time-use-offline-access-codes) offline access codes. To define the validity period for each Lockly offline access code, specify the desired `starts_at` and `ends_at` timestamp. You can create as many offline access codes as you'd like, up to the limits of your device memory capacity and your Lockly subscription. You can verify your Lockly subscription in the [Lockly Access Portal](https://lap.lockly.com/lap/index.html#/login). {% hint style="info" %} It is important to inform your Lockly lock users that the mechanism for entering offline access codes on Lockly devices is different from the mechanism for entering online access codes on these devices. For instructions, see [https://www.support.lockly.com/faq/how-to-use-oac/](https://www.support.lockly.com/faq/how-to-use-oac/). {% endhint %} -For more information about using offline access codes, see [Offline Access Codes](../../capability-guides/smart-locks/access-codes/#offline-access-codes) and [Managing Offline Access Codes](../../capability-guides/smart-locks/access-codes/offline-access-codes.md). +For more information about using offline access codes, see [Offline Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#offline-access-codes) and [Managing Offline Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes). *** ## Programming Lockly Offline Access Codes -For detailed instructions for creating time-bound offline access codes for Lockly locks, see [Creating Time-Bound Offline Access Codes](../../capability-guides/smart-locks/access-codes/offline-access-codes.md#creating-time-bound-offline-access-codes). +For detailed instructions for creating time-bound offline access codes for Lockly locks, see [Creating Time-Bound Offline Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes#creating-time-bound-offline-access-codes). -For detailed instructions for creating one-time-use offline access codes for Lockly locks, see [Creating One-Time-Use Offline Access Codes](../../capability-guides/smart-locks/access-codes/offline-access-codes.md#creating-one-time-use-offline-access-codes). +For detailed instructions for creating one-time-use offline access codes for Lockly locks, see [Creating One-Time-Use Offline Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes#creating-one-time-use-offline-access-codes). diff --git a/docs/brand-guides/minut-sensors.md b/docs/brand-guides/minut-sensors.md index 672e53174..f414c348f 100644 --- a/docs/brand-guides/minut-sensors.md +++ b/docs/brand-guides/minut-sensors.md @@ -22,7 +22,7 @@ For detailed information about the Minut devices that Seam supports, see our [Mi We support the following features: -* [Configuring noise threshold settings](../capability-guides/noise-sensors/configure-noise-threshold-settings.md)\ +* [Configuring noise threshold settings](https://docs.seam.co/latest/capability-guides/noise-sensors/configure-noise-threshold-settings)\ You can configure a maximum of two noise thresholds per Minut sensor. The first threshold is required and represents the regular threshold for the whole day. The second threshold is optional and represents the threshold for the quiet hours timeframe. * [Receiving noise sensor events when noise events occur](https://docs.seam.co/latest/api/events/)\ For more information, see the [`noise_sensor.noise_threshold_triggered` event](https://docs.seam.co/latest/api/events/). @@ -31,7 +31,7 @@ We support the following features: ### Device Provider Key -To create a [Connect Webview](../core-concepts/connect-webviews/) that enables your users to connect their Minut devices to Seam, include the `minut` 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](https://docs.seam.co/latest/core-concepts/connect-webviews) that enables your users to connect their Minut devices to Seam, include the `minut` device provider key in the `accepted_providers` list. For more information, see [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). *** @@ -41,7 +41,7 @@ To control Minut devices using Seam, you must prompt owners of these devices to 1. Create an account in the [Minut app](https://www.minut.com/setup) if you have not done so already. 2. In the Minut app, add your Minut sensors. -3. Note your login credentials for the Minut app, and use these credentials to log in to the [Seam Connect Webview](../core-concepts/connect-webviews/) to add your devices to Seam. +3. Note your login credentials for the Minut app, and use these credentials to log in to the [Seam Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) to add your devices to Seam. *** diff --git a/docs/brand-guides/noiseaware-sensors.md b/docs/brand-guides/noiseaware-sensors.md index ecbeb7153..7f006902d 100644 --- a/docs/brand-guides/noiseaware-sensors.md +++ b/docs/brand-guides/noiseaware-sensors.md @@ -22,7 +22,7 @@ For detailed information about the NoiseAware devices that Seam supports, see ou We support the following features: -* [Configuring noise threshold settings](../capability-guides/noise-sensors/configure-noise-threshold-settings.md)\ +* [Configuring noise threshold settings](https://docs.seam.co/latest/capability-guides/noise-sensors/configure-noise-threshold-settings)\ You can configure a maximum of one noise threshold per hour per Noiseaware sensor. You cannot configure thresholds with time periods that overlap. * [Receiving noise sensor events when noise events occur](https://docs.seam.co/latest/api/events/)\ For more information, see the [`noise_sensor.noise_threshold_triggered` event](https://docs.seam.co/latest/api/events/). @@ -31,7 +31,7 @@ We support the following features: ### Device Provider Key -To create a [Connect Webview](../core-concepts/connect-webviews/) that enables your users to connect their NoiseAware devices to Seam, include the `noiseaware` 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](https://docs.seam.co/latest/core-concepts/connect-webviews) that enables your users to connect their NoiseAware devices to Seam, include the `noiseaware` device provider key in the `accepted_providers` list. For more information, see [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). *** @@ -42,7 +42,7 @@ To control NoiseAware devices using Seam, you must prompt owners of these device 1. Install the NoiseAware [iOS](https://apps.apple.com/us/app/noiseaware/id1436213179) or [Android](https://play.google.com/store/apps/details?id=io.noiseaware.mobile\&hl=en_US\&gl=US) mobile app. 2. Create an account in the NoiseAware mobile app if you have not done so already. 3. In the NoiseAware mobile app, add your NoiseAware sensors. -4. Note your login credentials for the NoiseAware 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 NoiseAware mobile app, and use these credentials to log in to the [Seam Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) to add your devices to Seam. *** diff --git a/docs/brand-guides/nuki-locks.md b/docs/brand-guides/nuki-locks.md index d72921885..9e2b3f976 100644 --- a/docs/brand-guides/nuki-locks.md +++ b/docs/brand-guides/nuki-locks.md @@ -34,8 +34,8 @@ For detailed information about the Nuki devices that Seam supports, see our [Nuk We support the following features: -* [Triggering web lock and unlock actions](../capability-guides/smart-locks/lock-and-unlock.md) -* [Programming access codes](../capability-guides/smart-locks/access-codes/) on locks and openers that have an installed Nuki Keypad +* [Triggering web lock and unlock actions](https://docs.seam.co/latest/capability-guides/smart-locks/lock-and-unlock) +* [Programming access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) on locks and openers that have an installed Nuki Keypad {% hint style="info" %} Nuki does not allow the use of zeros in PIN codes. @@ -45,7 +45,7 @@ Nuki does not allow the use of zeros in PIN codes. ### Device Provider Key -To create a [Connect Webview](../core-concepts/connect-webviews/) that enables your users to connect their Nuki devices to Seam, include the `nuki` 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](https://docs.seam.co/latest/core-concepts/connect-webviews) that enables your users to connect their Nuki devices to Seam, include the `nuki` device provider key in the `accepted_providers` list. For more information, see [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). *** @@ -71,7 +71,7 @@ To control Nuki devices using Seam, you must prompt owners of these devices to p
Select the devices for which you want to be able to program access codes and then click Buy Smart Hosting.
8. In the Nuki online store, complete your Nuki Smart Hosting purchase. -5. Use your credentials for the Nuki app to log in to the [Seam Connect Webview](../core-concepts/connect-webviews/) to add your devices to Seam. +5. Use your credentials for the Nuki app to log in to the [Seam Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) to add your devices to Seam. *** diff --git a/docs/brand-guides/pti-storlogix-cloud.md b/docs/brand-guides/pti-storlogix-cloud.md index c176c40dc..e7f576cff 100644 --- a/docs/brand-guides/pti-storlogix-cloud.md +++ b/docs/brand-guides/pti-storlogix-cloud.md @@ -6,7 +6,7 @@ description: Guide for using the PTI Storlogix Cloud with Seam ## Overview -This integration uses [Storlogix Cloud](https://ptisecurity.com/products/storlogixcloudplatform/) to create [users](../capability-guides/access-systems/#what-is-a-user), [generate PIN codes](../capability-guides/access-systems/managing-credentials.md#create-a-pin-code-based-credential), and [grant users access](../capability-guides/access-systems/#what-is-an-access-group) to different access areas within storage rental unit facilities. +This integration uses [Storlogix Cloud](https://ptisecurity.com/products/storlogixcloudplatform/) to create [users](https://docs.seam.co/latest/capability-guides/access-systems#what-is-a-user), [generate PIN codes](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#create-a-pin-code-based-credential), and [grant users access](https://docs.seam.co/latest/capability-guides/access-systems#what-is-an-access-group) to different access areas within storage rental unit facilities. *** @@ -22,12 +22,12 @@ For detailed information about the PTI devices that Seam supports, see our [PTI We support the following features: -* [**User Management**](../capability-guides/access-systems/user-management.md) +* [**User Management**](https://docs.seam.co/latest/capability-guides/access-systems/user-management) - You can administer individual [users](../capability-guides/access-systems/#what-is-a-user) and add them to [access groups](../capability-guides/access-systems/#what-is-an-access-group) as needed. + You can administer individual [users](https://docs.seam.co/latest/capability-guides/access-systems#what-is-a-user) and add them to [access groups](https://docs.seam.co/latest/capability-guides/access-systems#what-is-an-access-group) as needed. - To authorize a user, [add the user to a `pti_access_level` access group](../capability-guides/access-systems/user-management/assigning-users-to-access-groups.md). If you wish to document that a user has rented a specific unit, include them in a `pti_unit` access group using the same endpoint. Note that certain access levels mandate a user be part of a `pti_unit` linked to that access area before they can enter those zones. -* [**Manage ACS Credentials**](../capability-guides/access-systems/managing-credentials.md) + To authorize a user, [add the user to a `pti_access_level` access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups). If you wish to document that a user has rented a specific unit, include them in a `pti_unit` access group using the same endpoint. Note that certain access levels mandate a user be part of a `pti_unit` linked to that access area before they can enter those zones. +* [**Manage ACS Credentials**](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) You can create PIN code-based and key card-based ACS credentials. Note that you can assign a unique PIN code to each user, thereby facilitating secure site access. @@ -35,7 +35,7 @@ We support the following features: ### Device Provider Key -To create a [Connect Webview](../core-concepts/connect-webviews/) that enables you to connect your PTI Storlogix Cloud to Seam, include the `pti` 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](https://docs.seam.co/latest/core-concepts/connect-webviews) that enables you to connect your PTI Storlogix Cloud to Seam, include the `pti` device provider key in the `accepted_providers` list. For more information, see [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). *** @@ -57,7 +57,7 @@ To obtain this necessary information: 4. Click **Operations > Company Info**. 5. Click the **Device Settings** tab. 6. Note the **SiteKey** and **SiteCode** values. -7. Log in to the [Seam Connect Webview](../core-concepts/connect-webviews/) and specify these noted values to connect your PTI system to Seam. +7. Log in to the [Seam Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) and specify these noted values to connect your PTI system to Seam. {% hint style="info" %} If you do not have access to your Storlogix Cloud dashboard—that is, if you are unsure of your Storlogix Cloud login credentials or the dashboard URL—contact the [PTI Security Systems Customer Support team](https://ptisecurity.my.salesforce-sites.com/apex/Support). They can assist you in retrieving your login details. @@ -79,9 +79,9 @@ The PIN code value must be an integer in the range 1-4294967296. ## Assigning Access Permissions to Users -For PTI Storlogix Cloud, you must add the [users](../capability-guides/access-systems/#what-is-a-user) to `pti_access_level` and `pti_unit` [access groups](../capability-guides/access-systems/#what-is-an-access-group) to give them access to their storage unit. +For PTI Storlogix Cloud, you must add the [users](https://docs.seam.co/latest/capability-guides/access-systems#what-is-a-user) to `pti_access_level` and `pti_unit` [access groups](https://docs.seam.co/latest/capability-guides/access-systems#what-is-an-access-group) to give them access to their storage unit. -For example, you could assign them to the "Building A - 3/F" access level and give them access to the "A301" unit. For details, see [Assigning Users to Access Groups](../capability-guides/access-systems/user-management/assigning-users-to-access-groups.md). +For example, you could assign them to the "Building A - 3/F" access level and give them access to the "A301" unit. For details, see [Assigning Users to Access Groups](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups). *** diff --git a/docs/brand-guides/salto-ks-access-control-system/README.md b/docs/brand-guides/salto-ks-access-control-system/README.md index 497039f60..f610fd78b 100644 --- a/docs/brand-guides/salto-ks-access-control-system/README.md +++ b/docs/brand-guides/salto-ks-access-control-system/README.md @@ -16,7 +16,7 @@ The Seam integration for Salto KS enables you to create ACS users and assign acc ## Salto KS Resources -The Seam ACS schema consists of a series of resources that interact intuitively, enabling you to use the Seam API to manage your Salto KS ACS in a logical, efficient manner. Salto KS is an [access group-based ACS](../../capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md#access-group-based-access-control-systems), so you [create ACS users](../../capability-guides/access-systems/user-management.md#create-an-acs-user) and then assign them to access groups to specify the entrances to which these users have access. You can also configure access schedules for ACS users. +The Seam ACS schema consists of a series of resources that interact intuitively, enabling you to use the Seam API to manage your Salto KS ACS in a logical, efficient manner. Salto KS is an [access group-based ACS](https://docs.seam.co/latest/capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences#access-group-based-access-control-systems), so you [create ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management#create-an-acs-user) and then assign them to access groups to specify the entrances to which these users have access. You can also configure access schedules for ACS users. The following diagram shows the Seam resources for a Salto KS ACS and the relationships between these resources: @@ -30,9 +30,9 @@ For more information about managing your Salto KS ACS through Seam, see the foll * [Programming Salto KS PIN Code Credentials](programming-code-based-salto-ks-credentials.md) * [Programming Salto KS Mobile Credentials](programming-salto-ks-mobile-credentials.md) -* [Access Group-Based Access Control Systems](../../capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md#access-group-based-access-control-systems) -* [Access Control Systems](../../capability-guides/access-systems/) -* [Mobile Access](../../capability-guides/mobile-access/) +* [Access Group-Based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences#access-group-based-access-control-systems) +* [Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems) +* [Mobile Access](https://docs.seam.co/latest/capability-guides/mobile-access) *** @@ -46,15 +46,15 @@ This integration supports all Salto locks connected to the Salto KS ACS. We support the following features: -* [Managing access systems](../../capability-guides/access-systems/) +* [Managing access systems](https://docs.seam.co/latest/capability-guides/access-systems) * [Issuing code-based credentials](programming-code-based-salto-ks-credentials.md) -* [Issuing mobile access credentials](../../capability-guides/mobile-access/) +* [Issuing mobile access credentials](https://docs.seam.co/latest/capability-guides/mobile-access) *** ### Device Provider Key -To create a [Connect Webview](../../core-concepts/connect-webviews/) that enables you to connect your Salto KS ACS to Seam, include the `salto_ks` 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](https://docs.seam.co/latest/core-concepts/connect-webviews) that enables you to connect your Salto KS ACS to Seam, include the `salto_ks` device provider key in the `accepted_providers` list. For more information, see [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). *** @@ -113,7 +113,7 @@ Unit door locks within a Salto KS access system must first be woken up, and then ## Troubleshooting -For information about Salto KS ACS-related errors, see [Troubleshooting Your ACS](../../capability-guides/access-systems/troubleshooting-your-access-control-system.md). +For information about Salto KS ACS-related errors, see [Troubleshooting Your ACS](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system). *** diff --git a/docs/brand-guides/salto-ks-access-control-system/programming-code-based-salto-ks-credentials.md b/docs/brand-guides/salto-ks-access-control-system/programming-code-based-salto-ks-credentials.md index a4929c1b6..2c29649f1 100644 --- a/docs/brand-guides/salto-ks-access-control-system/programming-code-based-salto-ks-credentials.md +++ b/docs/brand-guides/salto-ks-access-control-system/programming-code-based-salto-ks-credentials.md @@ -6,11 +6,11 @@ description: Learn how to create Salto KS PIN codes. To use the Seam API to program codes for users in a [Salto KS ACS](./): -1. Create an [ACS user](../../capability-guides/access-systems/user-management.md). +1. Create an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). * For Salto KS, you can specify the `access_schedule` for the new ACS user. An `access_schedule` consists of `starts_at` and `ends_at` times. In this case, a Salto KS ACS user appears as "unsubscribed" in the ACS until the `starts_at` time. Once the start time arrives, Seam switches the ACS user to "subscribed," which activates their access. -2. Assign access permissions to the ACS user by assigning them to one or more [access groups](../../capability-guides/access-systems/user-management/assigning-users-to-access-groups.md). +2. Assign access permissions to the ACS user by assigning them to one or more [access groups](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups). * Each access group is preconfigured with specific entrances and schedules. -3. Create an [ACS credential](../../capability-guides/access-systems/managing-credentials.md). +3. Create an [ACS credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). * Specify the ID of the ACS user. * Set the `access_method` to `code`. @@ -317,10 +317,10 @@ echo json_encode($pin_code, JSON_PRETTY_PRINT); To learn more about using the Seam API with your Salto KS ACS, see the following topics: -* [Access Control Systems](../../capability-guides/access-systems/) -* [Access Group-Based Access Control Systems](../../capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md#access-group-based-access-control-systems) -* [Managing ACS Users](../../capability-guides/access-systems/user-management.md) -* [Managing Credentials](../../capability-guides/access-systems/managing-credentials.md) -* [Mobile Access](../../capability-guides/mobile-access/) +* [Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems) +* [Access Group-Based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences#access-group-based-access-control-systems) +* [Managing ACS Users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) +* [Managing Credentials](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) +* [Mobile Access](https://docs.seam.co/latest/capability-guides/mobile-access) * [Access Control Systems](https://docs.seam.co/latest/api/acs/) in the Seam API reference * [User Identities](https://docs.seam.co/latest/api/user_identities/) in the Seam API reference diff --git a/docs/brand-guides/salto-ks-access-control-system/programming-salto-ks-mobile-credentials.md b/docs/brand-guides/salto-ks-access-control-system/programming-salto-ks-mobile-credentials.md index 6673e2c88..21d9b5b0e 100644 --- a/docs/brand-guides/salto-ks-access-control-system/programming-salto-ks-mobile-credentials.md +++ b/docs/brand-guides/salto-ks-access-control-system/programming-salto-ks-mobile-credentials.md @@ -4,21 +4,21 @@ description: Learn how to create mobile credentials in the Salto KS ACS. # Programming Salto KS Mobile Credentials -You can create mobile credentials that enable your mobile app users to unlock entrances in your [Salto KS ACS](./). For more information about Seam mobile keys, see [Mobile Access](../../capability-guides/mobile-access/). +You can create mobile credentials that enable your mobile app users to unlock entrances in your [Salto KS ACS](./). For more information about Seam mobile keys, see [Mobile Access](https://docs.seam.co/latest/capability-guides/mobile-access). To use the Seam API to create mobile credentials for mobile app users in a Salto KS ACS: 1. Create a [user identity](https://docs.seam.co/latest/api/user_identities/). Seam user identities enable you to match your own mobile app users to ACS users that you create using the Seam API. -2. Create an [ACS user](../../capability-guides/access-systems/user-management.md) on the Salto KS ACS or assign an existing ACS user to the user identity.\ +2. Create an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) on the Salto KS ACS or assign an existing ACS user to the user identity.\ The resources that you create for the ACS user are available under the associated user identity. * For Salto KS, you can specify the `access_schedule` for the ACS user. The `access_schedule` consists of `starts_at` and `ends_at` times. In this case, a Salto KS ACS user appears as "unsubscribed" in the ACS until the `starts_at` time. Once the start time arrives, Seam switches the ACS user to "subscribed," which activates their access. -3. Assign the ACS user to one or more [access groups](../../capability-guides/access-systems/user-management/assigning-users-to-access-groups.md). +3. Assign the ACS user to one or more [access groups](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups). * Each access group is preconfigured with the allowed entrances. -4. Create an [ACS credential](../../capability-guides/access-systems/managing-credentials.md) to represent the mobile key. +4. Create an [ACS credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) to represent the mobile key. * Specify the ID of the ACS user. - * Set [`is_multi_phone_sync_credential`](../../capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system.md#what-are-multi-phone-sync-credentials) to `true`. + * Set [`is_multi_phone_sync_credential`](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials) to `true`. * Set the `access_method` to `mobile_key`. The following example walks you through this process: @@ -472,10 +472,10 @@ echo json_encode($reservation_mobile_key, JSON_PRETTY_PRINT); To learn more about using the Seam API with your Salto KS ACS, see the following topics: * [Programming Code-Based Salto KS Credentials](programming-code-based-salto-ks-credentials.md) -* [Access Control Systems](../../capability-guides/access-systems/) -* [Credential-based ACS](../../capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md#credential-based-acs) -* [Managing ACS Users](../../capability-guides/access-systems/user-management.md) -* [Managing Credentials](../../capability-guides/access-systems/managing-credentials.md) -* [Mobile Access](../../capability-guides/mobile-access/) +* [Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems) +* [Credential-based ACS](https://docs.seam.co/latest/capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences#credential-based-acs) +* [Managing ACS Users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) +* [Managing Credentials](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) +* [Mobile Access](https://docs.seam.co/latest/capability-guides/mobile-access) * [Access Control Systems](https://docs.seam.co/latest/api/acs/) in the Seam API reference * [User Identities](https://docs.seam.co/latest/api/user_identities/) in the Seam API reference diff --git a/docs/brand-guides/salto-ks-access-control-system/salto-ks-setup-instructions.md b/docs/brand-guides/salto-ks-access-control-system/salto-ks-setup-instructions.md index 2573b5dbe..3c9f7631a 100644 --- a/docs/brand-guides/salto-ks-access-control-system/salto-ks-setup-instructions.md +++ b/docs/brand-guides/salto-ks-access-control-system/salto-ks-setup-instructions.md @@ -32,7 +32,7 @@ Make sure that your installer has released your Salto KS sites. Seam cannot perf To connect the Salto KS ACS to Seam: -1. Create a [Connect Webview](../../core-concepts/connect-webviews/), including `salto_ks` in the set of [`accepted_providers`](https://docs.seam.co/latest/api/connect_webviews/). +1. Create a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews), including `salto_ks` in the set of [`accepted_providers`](https://docs.seam.co/latest/api/connect_webviews/). 2. Display the Connect Webview and perform the following steps: 1. If the Connect Webview displays multiple brand options, select **Salto KS**. 2. In the **Enter your credentials** dialog, type your username and password for the Salto KS web app. diff --git a/docs/brand-guides/salto-locks.md b/docs/brand-guides/salto-locks.md index 9549c35ef..35e7cf92d 100644 --- a/docs/brand-guides/salto-locks.md +++ b/docs/brand-guides/salto-locks.md @@ -11,7 +11,7 @@ description: Guide for using Salto KS door locks with Seam Salto Systems produces world-class electronic access control solutions. Their locks work with a vast array of entrance types, from traditional doors and elevators, to key cylinders and parking stiles. They also support a versatile range of key credentials; their locks work with RFID tags, mobile keys, and PIN codes. Using their mobile app and app dashboard, businesses can easily assign, monitor, and revoke access rights. {% hint style="info" %} -Seam supports two integrations for Salto KS. We recommend using the [Salto KS access control system integration](../device-and-system-integration-guides/salto-ks-access-control-system/) because it provides more robust functionality, such as managing ACS users and credentials. However, if you want to connect a single or just a few Salto KS locks, you can choose the Salto KS lock integration that this topic describes. +Seam supports two integrations for Salto KS. We recommend using the [Salto KS access control system integration](https://docs.seam.co/latest/device-and-system-integration-guides/salto-ks-access-control-system) because it provides more robust functionality, such as managing ACS users and credentials. However, if you want to connect a single or just a few Salto KS locks, you can choose the Salto KS lock integration that this topic describes. {% endhint %} *** @@ -29,13 +29,13 @@ For detailed information about the Salto devices that Seam supports, see our [Sa We support the following features: * [Triggering web unlock actions](https://docs.seam.co/latest/api/locks/unlock_door) -* [Programming access codes](../capability-guides/smart-locks/access-codes/) on door locks and card readers that have a PIN pad +* [Programming access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) on door locks and card readers that have a PIN pad *** ### Device Provider Key -To create a [Connect Webview](../core-concepts/connect-webviews/) that enables your users to connect their Salto devices to Seam, include the `salto_ks` 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](https://docs.seam.co/latest/core-concepts/connect-webviews) that enables your users to connect their Salto devices to Seam, include the `salto_ks` device provider key in the `accepted_providers` list. For more information, see [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). *** @@ -71,7 +71,7 @@ To control Salto KS devices using Seam, you must prompt owners of these devices 1. Create an account in the [Salto KS app](https://app.saltoks.com/) if you have not done so already. 2. In the Salto KS app, add your Salto KS devices. -3. Note your login credentials for the Salto KS app, and use these credentials to log in to the [Seam Connect Webview](../core-concepts/connect-webviews/) to add your devices to Seam. +3. Note your login credentials for the Salto KS app, and use these credentials to log in to the [Seam Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) to add your devices to Seam. 1. If the Connect Webview displays multiple brand options, select **Salto KS**. 2. In the **Enter your credentials** dialog, type your username and password for the Salto KS web app and then click **Log In**. 3. Select **Full Access** and then click **Yes, Allow**. diff --git a/docs/brand-guides/salto-proaccess-space-access-system/README.md b/docs/brand-guides/salto-proaccess-space-access-system/README.md index 0149c1955..50b9bd741 100644 --- a/docs/brand-guides/salto-proaccess-space-access-system/README.md +++ b/docs/brand-guides/salto-proaccess-space-access-system/README.md @@ -12,13 +12,13 @@ description: Guide for using the Salto ProAccess Space Access System with Seam The Seam integration for Salto Space enables you to create access system users and assign access permissions to them. In the Salto Space model, you assign users to access groups that grant access to specific sets of entrances. Then, you create credentials to define the access mechanisms for the users' access grants. -This integration requires [Seam Bridge](../../capability-guides/seam-bridge.md) to connect the on-premises Salto Space access system with Seam. +This integration requires [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) to connect the on-premises Salto Space access system with Seam. *** ## Salto Space Resources -The Seam access system schema consists of a series of resources that interact intuitively, enabling you to use the Seam API to manage your Salto Space access system in a logical, efficient manner. Salto Space is an [access group-based access system](../../capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md#access-group-based-access-control-systems), so you [create access system users](../../capability-guides/access-systems/user-management.md#create-an-acs-user) and then assign them to access groups to specify the entrances to which these users have access. +The Seam access system schema consists of a series of resources that interact intuitively, enabling you to use the Seam API to manage your Salto Space access system in a logical, efficient manner. Salto Space is an [access group-based access system](https://docs.seam.co/latest/capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences#access-group-based-access-control-systems), so you [create access system users](https://docs.seam.co/latest/capability-guides/access-systems/user-management#create-an-acs-user) and then assign them to access groups to specify the entrances to which these users have access. The following diagram shows the Seam resources for a Salto Space access system and the relationships between these resources: @@ -32,9 +32,9 @@ For more information about managing your Salto Space access system through Seam, * [Programming Salto Space Card-based Credentials](programming-salto-space-card-based-credentials.md) * [Programming Salto Space Mobile Credentials](programming-salto-space-mobile-credentials.md) -* [Access Group-Based Access Systems](../../capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md#access-group-based-access-control-systems) -* [Access Systems](../../capability-guides/access-systems/) -* [Mobile Access](../../capability-guides/mobile-access/) +* [Access Group-Based Access Systems](https://docs.seam.co/latest/capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences#access-group-based-access-control-systems) +* [Access Systems](https://docs.seam.co/latest/capability-guides/access-systems) +* [Mobile Access](https://docs.seam.co/latest/capability-guides/mobile-access) *** @@ -48,15 +48,15 @@ This integration supports all Salto locks connected to the Salto Space ACS. We support the following features: -* [Managing access systems](../../capability-guides/access-systems/) +* [Managing access systems](https://docs.seam.co/latest/capability-guides/access-systems) * [Issuing card-based credentials](programming-salto-space-card-based-credentials.md) -* [Issuing mobile access credentials](../../capability-guides/mobile-access/) +* [Issuing mobile access credentials](https://docs.seam.co/latest/capability-guides/mobile-access) *** ### Device Provider Key -To create a [Connect Webview](../../core-concepts/connect-webviews/) that enables you to connect your Salto Space access system to Seam, include the `salto_space` 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](https://docs.seam.co/latest/core-concepts/connect-webviews) that enables you to connect your Salto Space access system to Seam, include the `salto_space` device provider key in the `accepted_providers` list. For more information, see [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). *** @@ -85,7 +85,7 @@ To enable or disable far opening: ## Troubleshooting -For information about Salto Space access system-related errors, see [Troubleshooting Your Access System](../../capability-guides/access-systems/troubleshooting-your-access-control-system.md). +For information about Salto Space access system-related errors, see [Troubleshooting Your Access System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system). *** diff --git a/docs/brand-guides/salto-proaccess-space-access-system/programming-salto-space-card-based-credentials.md b/docs/brand-guides/salto-proaccess-space-access-system/programming-salto-space-card-based-credentials.md index 04f1aa478..9374cedb7 100644 --- a/docs/brand-guides/salto-proaccess-space-access-system/programming-salto-space-card-based-credentials.md +++ b/docs/brand-guides/salto-proaccess-space-access-system/programming-salto-space-card-based-credentials.md @@ -8,10 +8,10 @@ For each access system user in a [Salto Space access system](./), you can create To use the Seam API to create card credentials for a Salto Space access system: -1. Create an [access system user](../../capability-guides/access-systems/user-management.md). -2. Assign access permissions to the user by assigning them to one or more [access groups](../../capability-guides/access-systems/user-management/assigning-users-to-access-groups.md). +1. Create an [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). +2. Assign access permissions to the user by assigning them to one or more [access groups](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups). * Each access group is preconfigured with specific entrances. -3. Create a [credential](../../capability-guides/access-systems/managing-credentials.md). +3. Create a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). * Specify the ID of the access system user. * Set the `access_method` to `card`. * Choose whether to assign a new card to the user or update the user's existing card. Use the Boolean `salto_space_metadata.assign_new_key` parameter when creating the credential. @@ -26,11 +26,11 @@ To use the Seam API to create card credentials for a Salto Space access system: \{% hint style="info" %\} Make sure that each of your Salto Space sites is equipped with a supported card encoder. The [NCoder card encoder](https://saltosystems.com/en-us/products/ncoder/) is compatible with the Seam integration. \{% endhint %\} 1. Use the `/acs/encoders/list` endpoint to retrieve a list of available encoders. Then, choose the encoder that you want to use to write the credential to the card.\ - See [Retrieve Encoders](../../capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials.md#id-2.-retrieve-encoders). + See [Retrieve Encoders](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials#id-2.-retrieve-encoders). 2. Use the `/acs/encoders/encode_credential` endpoint to encode the credential onto the card, using the encoder that you have chosen.\ - See [Encode the Card](../../capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials.md#id-3.-encode-the-card). - 3. Confirm that the card was encoded successfully using polling or a [webhook](../../developer-tools/webhooks.md).\ - See [Confirm Successful Encoding](../../capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials.md#id-4.-confirm-successful-encoding). Also, see a list of [common encoding errors](../../capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials.md#common-encoding-errors). + See [Encode the Card](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials#id-3.-encode-the-card). + 3. Confirm that the card was encoded successfully using polling or a [webhook](https://docs.seam.co/latest/developer-tools/webhooks).\ + See [Confirm Successful Encoding](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials#id-4.-confirm-successful-encoding). Also, see a list of [common encoding errors](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials#common-encoding-errors). The following example walks you through this process: @@ -542,7 +542,7 @@ $seam->action_attempts->get( ## Next Steps -You can use an encoder to scan a plastic key card to read its encoded parameters. The scan result includes the card's properties, such as its card number, serial number, and other useful details. For more information, see [Scanning Encoded Cards](../../capability-guides/access-systems/working-with-card-encoders-and-scanners/scanning-encoded-cards.md). +You can use an encoder to scan a plastic key card to read its encoded parameters. The scan result includes the card's properties, such as its card number, serial number, and other useful details. For more information, see [Scanning Encoded Cards](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/scanning-encoded-cards). *** @@ -550,9 +550,9 @@ You can use an encoder to scan a plastic key card to read its encoded parameters To find out more about using the Seam API with your Salto Space access system, see the following topics: -* [Access Systems](../../capability-guides/access-systems/) -* [Access Group-Based Access Systems](../../capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md#access-group-based-access-control-systems) -* [Managing Access System Users](../../capability-guides/access-systems/user-management.md) -* [Managing Credentials](../../capability-guides/access-systems/managing-credentials.md) -* [Working with Card Encoders and Scanners](../../capability-guides/access-systems/working-with-card-encoders-and-scanners/) +* [Access Systems](https://docs.seam.co/latest/capability-guides/access-systems) +* [Access Group-Based Access Systems](https://docs.seam.co/latest/capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences#access-group-based-access-control-systems) +* [Managing Access System Users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) +* [Managing Credentials](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) +* [Working with Card Encoders and Scanners](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) * [Access Systems](https://docs.seam.co/latest/api/acs/) in the Seam API reference diff --git a/docs/brand-guides/salto-proaccess-space-access-system/programming-salto-space-mobile-credentials.md b/docs/brand-guides/salto-proaccess-space-access-system/programming-salto-space-mobile-credentials.md index 8655a3824..f962c2e61 100644 --- a/docs/brand-guides/salto-proaccess-space-access-system/programming-salto-space-mobile-credentials.md +++ b/docs/brand-guides/salto-proaccess-space-access-system/programming-salto-space-mobile-credentials.md @@ -4,20 +4,20 @@ description: Learn how to create mobile credentials in the Salto Space access sy # Programming Salto Space Mobile Credentials -You can create mobile credentials that enable your mobile app users to unlock entrances in your [Salto Space access system](./). For each Salto Space user, you can create a maximum of one [key card credential](programming-salto-space-card-based-credentials.md) and one mobile key credential. For more information about Seam mobile keys, see [Mobile Access](../../capability-guides/mobile-access/). +You can create mobile credentials that enable your mobile app users to unlock entrances in your [Salto Space access system](./). For each Salto Space user, you can create a maximum of one [key card credential](programming-salto-space-card-based-credentials.md) and one mobile key credential. For more information about Seam mobile keys, see [Mobile Access](https://docs.seam.co/latest/capability-guides/mobile-access). To use the Seam API to create mobile credentials for mobile app users in a Salto Space access system: 1. Create a [user identity](https://docs.seam.co/latest/api/user_identities/). Seam user identities enable you to match your own mobile app users to access system users that you create using the Seam API. -2. Create an [access system user](../../capability-guides/access-systems/user-management.md) on the Salto Space access system or assign an existing access system user to the user identity.\ +2. Create an [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) on the Salto Space access system or assign an existing access system user to the user identity.\ The resources that you create for the access system user are available under the associated user identity. -3. Assign the access system user to one or more [access groups](../../capability-guides/access-systems/user-management/assigning-users-to-access-groups.md). +3. Assign the access system user to one or more [access groups](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups). * Each access group is preconfigured with the allowed entrances. -4. Create a [credential](../../capability-guides/access-systems/managing-credentials.md) to represent the mobile key. +4. Create a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) to represent the mobile key. * Specify the ID of the access system user. - * Set [`is_multi_phone_sync_credential`](../../capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system.md#what-are-multi-phone-sync-credentials) to `true`. + * Set [`is_multi_phone_sync_credential`](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials) to `true`. * Set the `access_method` to `mobile_key`. The following example walks you through this process: @@ -359,10 +359,10 @@ $mobile_key = $seam->acs->credentials->create( To find out more about using the Seam API with your Salto Space access system, see the following topics: * [Programming Salto Space Card-based Credentials](programming-salto-space-card-based-credentials.md) -* [Access Systems](../../capability-guides/access-systems/) -* [Access Group-Based Access Systems](../../capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md#access-group-based-access-control-systems) -* [Managing Access System Users](../../capability-guides/access-systems/user-management.md) -* [Managing Credentials](../../capability-guides/access-systems/managing-credentials.md) -* [Mobile Access](../../capability-guides/mobile-access/) +* [Access Systems](https://docs.seam.co/latest/capability-guides/access-systems) +* [Access Group-Based Access Systems](https://docs.seam.co/latest/capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences#access-group-based-access-control-systems) +* [Managing Access System Users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) +* [Managing Credentials](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) +* [Mobile Access](https://docs.seam.co/latest/capability-guides/mobile-access) * [Access Systems](https://docs.seam.co/latest/api/acs/) in the Seam API reference * [User Identities](https://docs.seam.co/latest/api/user_identities/) in the Seam API reference diff --git a/docs/brand-guides/salto-proaccess-space-access-system/salto-space-setup-instructions.md b/docs/brand-guides/salto-proaccess-space-access-system/salto-space-setup-instructions.md index 50c5f51a3..295e4fd20 100644 --- a/docs/brand-guides/salto-proaccess-space-access-system/salto-space-setup-instructions.md +++ b/docs/brand-guides/salto-proaccess-space-access-system/salto-space-setup-instructions.md @@ -80,10 +80,10 @@ Perform the following process for each Salto Space site that you want to integra 4. If the Connect Webview displays multiple brand options, click **Salto Space**. 5. On the **Set up your Seam Bridge** page, click [**latest Seam Bridge**](https://www.seam.co/seam-bridge/releases/latest). - [Seam Bridge](../../capability-guides/seam-bridge.md) is a software-only component that enables you to connect on-premises software systems to the Seam platform. Because Salto Space is an on-premises access system, Seam Bridge is required for Salto Space systems. + [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) is a software-only component that enables you to connect on-premises software systems to the Seam platform. Because Salto Space is an on-premises access system, Seam Bridge is required for Salto Space systems. 6. Download the Seam Bridge executable onto the on-premises computer that is running Salto Space or onto a computer on the same network. - For systems requirements, see [Seam Bridge](../../capability-guides/seam-bridge.md). + For systems requirements, see [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). 7. Run the downloaded Seam Bridge app. 8. In the **Welcome to Seam Bridge** window, type a name for the site that you are connecting using Seam Bridge and then click **Start pairing**. 9. Copy the pairing code. diff --git a/docs/brand-guides/schlage-locks/README.md b/docs/brand-guides/schlage-locks/README.md index 8afe27e7c..1789694cc 100644 --- a/docs/brand-guides/schlage-locks/README.md +++ b/docs/brand-guides/schlage-locks/README.md @@ -28,14 +28,14 @@ For detailed information about the Schlage devices that Seam supports, see our [ We support the following features: -* [Triggering web lock and unlock actions](../../capability-guides/smart-locks/lock-and-unlock.md) -* [Programming online access codes](../../capability-guides/smart-locks/access-codes/) on locks that have a connected keypad +* [Triggering web lock and unlock actions](https://docs.seam.co/latest/capability-guides/smart-locks/lock-and-unlock) +* [Programming online access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) on locks that have a connected keypad *** ### Device Provider Key -To create a [Connect Webview](../../core-concepts/connect-webviews/) that enables your users to connect their Schlage devices to Seam, include the `schlage` 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](https://docs.seam.co/latest/core-concepts/connect-webviews) that enables your users to connect their Schlage devices to Seam, include the `schlage` device provider key in the `accepted_providers` list. For more information, see [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). *** diff --git a/docs/brand-guides/schlage-locks/get-started-with-schlage-locks.md b/docs/brand-guides/schlage-locks/get-started-with-schlage-locks.md index e090ae7d7..8e03f79a8 100644 --- a/docs/brand-guides/schlage-locks/get-started-with-schlage-locks.md +++ b/docs/brand-guides/schlage-locks/get-started-with-schlage-locks.md @@ -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](https://docs.seam.co/latest/core-concepts/connect-webviews): pre-built UX flows that walk you through authorizing your application to control your Schlage lock. #### Request a Connect Webview @@ -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.](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes)
@@ -474,8 +474,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) * [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) +* [Receiving webhook](https://docs.seam.co/latest/developer-tools/webhooks) for [device events](https://docs.seam.co/latest/api/events/list) +* [Core Concepts](https://docs.seam.co/latest/core-concepts/overview) 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/brand-guides/schlage-locks/schlage-locks-setup-instructions.md b/docs/brand-guides/schlage-locks/schlage-locks-setup-instructions.md index c64426b21..9456e0ed5 100644 --- a/docs/brand-guides/schlage-locks/schlage-locks-setup-instructions.md +++ b/docs/brand-guides/schlage-locks/schlage-locks-setup-instructions.md @@ -12,7 +12,7 @@ To control Schlage Encode locks using Seam, you must prompt owners of these devi 1. Create an account in the [Schlage Home App](https://www.schlage.com/en/home/smart-locks/schlage-app.html) if you have not done so already. 2. In the Schlage Home App, add your Schlage Encode devices. -3. Note your login credentials for the Schlage Home App, and use these credentials to log in to the [Seam Connect Webview](../../core-concepts/connect-webviews/) to add your devices to Seam. +3. Note your login credentials for the Schlage Home App, and use these credentials to log in to the [Seam Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) to add your devices to Seam. *** @@ -26,5 +26,5 @@ To control Schlage Connect or Connected Keypad locks with Z-Wave technology usin 2. Connect your lock to a Z-Wave hub.\ Before connecting your Schlage locks to the internet, you must first connect them to a Z-Wave hub. Follow the hub's setup process to link your locks to it. 3. Note your login credentials for SmartThings, that is, the hub to which you have connected your lock. -4. In the [Seam Connect Webview](../../core-concepts/connect-webviews/), select SmartThings. +4. In the [Seam Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews), select SmartThings. 5. In the Connect Webview, type the appropriate SmartThings credentials to add your devices to Seam. diff --git a/docs/brand-guides/sensi-thermostats/README.md b/docs/brand-guides/sensi-thermostats/README.md index 33ad7fd27..1ea0d1b27 100644 --- a/docs/brand-guides/sensi-thermostats/README.md +++ b/docs/brand-guides/sensi-thermostats/README.md @@ -24,17 +24,17 @@ For detailed information about the Sensi devices that Seam supports, see our [Se We support the following features: -* [Configuring current thermostat settings](../../capability-guides/thermostats/configure-current-climate-settings.md) -* [Creating and managing climate presets](../../capability-guides/thermostats/creating-and-managing-climate-presets/) -* [Creating and managing thermostat schedules](../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) -* [Creating and managing thermostat weekly programs](../../capability-guides/thermostats/creating-and-managing-thermostat-programs.md) -* [Setting and monitoring temperature thresholds](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md) +* [Configuring current thermostat settings](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings) +* [Creating and managing climate presets](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) +* [Creating and managing thermostat schedules](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) +* [Creating and managing thermostat weekly programs](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-programs) +* [Setting and monitoring temperature thresholds](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) *** ### Device Provider Key -To create a [Connect Webview](../../core-concepts/connect-webviews/) that enables your users to connect their Sensi devices to Seam, include the `sensi` 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](https://docs.seam.co/latest/core-concepts/connect-webviews) that enables your users to connect their Sensi devices to Seam, include the `sensi` device provider key in the `accepted_providers` list. For more information, see [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). *** @@ -46,7 +46,7 @@ To control Sensi devices using Seam, you must prompt owners of these devices to 2. In the Sensi app, add your Sensi thermostats. The Sensi app walks you through the process of installing your Sensi thermostats and connecting them to Wi-Fi. For details, see the [Sensi installation manual](https://sensi.copeland.com/en-us/support/sensi-manuals) for your thermostat. -3. Note your login credentials for the Sensi app, and use these credentials to log in to the [Seam Connect Webview](../../core-concepts/connect-webviews/) to add your devices to Seam. +3. Note your login credentials for the Sensi app, and use these credentials to log in to the [Seam Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) to add your devices to Seam. {% hint style="info" %} Make sure that you're authenticating with the user to whom the devices are registered. Sensi devices can only be registered to a single user. @@ -64,7 +64,7 @@ The Sensi API does not communicate the battery state of Sensi devices, so Seam c ### Heat-Cool Mode -Some Sensi models do not support heat-cool mode, such as the Sensi Classic and Sensi One Touch thermostats. To check whether a thermostat supports heat-cool mode, [get the device](../../capability-guides/thermostats/retrieving-thermostats.md) and look for a `device.can_hvac_heat_cool` capability flag. For more information about thermostat-related capability flags, see [Thermostat Capabilities](../../capability-guides/thermostats/#thermostat-capabilities). +Some Sensi models do not support heat-cool mode, such as the Sensi Classic and Sensi One Touch thermostats. To check whether a thermostat supports heat-cool mode, [get the device](https://docs.seam.co/latest/capability-guides/thermostats/retrieving-thermostats) and look for a `device.can_hvac_heat_cool` capability flag. For more information about thermostat-related capability flags, see [Thermostat Capabilities](https://docs.seam.co/latest/capability-guides/thermostats#thermostat-capabilities). *** diff --git a/docs/brand-guides/sensi-thermostats/get-started-with-sensi-thermostats.md b/docs/brand-guides/sensi-thermostats/get-started-with-sensi-thermostats.md index f5618d1f0..b04723060 100644 --- a/docs/brand-guides/sensi-thermostats/get-started-with-sensi-thermostats.md +++ b/docs/brand-guides/sensi-thermostats/get-started-with-sensi-thermostats.md @@ -19,7 +19,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 Sensi thermostat 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](https://docs.seam.co/latest/core-concepts/seam-console/seam-online-cli), which you can access from directly within the [Seam Console](https://docs.seam.co/latest/core-concepts/seam-console). :arrow\_forward: [Go to the Seam Console!](https://console.seam.co/) {% endhint %} @@ -69,7 +69,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](https://docs.seam.co/latest/core-concepts/seam-console#create-a-seam-account) to get your [API key](https://docs.seam.co/latest/core-concepts/authentication/api-keys). Then, export your API key as an environment variable. @@ -78,21 +78,21 @@ $ 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 Sensi thermostat, use a [non-sandbox workspace](../../core-concepts/workspaces/#production-workspaces) and API key. +This guide uses a [sandbox workspace](https://docs.seam.co/latest/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 Sensi thermostat, use a [non-sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#production-workspaces) and API key. {% endhint %} *** ## Step 2: Link your Sensi account with Seam -To control your Sensi thermostat using the Seam API, you must first authorize your Seam workspace to connect to your Sensi account. If your application needs to connect to your users' Sensi 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 Sensi thermostats. The Connect Webview presents a flow that prompts your users to enter their credentials for their Sensi account. +To control your Sensi thermostat using the Seam API, you must first authorize your Seam workspace to connect to your Sensi account. If your application needs to connect to your users' Sensi accounts, Seam provides fully-embedded, [customizable](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews) client-side [Connect Webviews](https://docs.seam.co/latest/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 Sensi thermostats. The Connect Webview presents a flow that prompts your users to enter their credentials for their Sensi 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 Sensi 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](https://docs.seam.co/latest/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-sensi-thermostats.md#authorize-your-workspace) in this guide to complete the Connect Webview authorization flow. @@ -269,13 +269,13 @@ 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](https://docs.seam.co/latest/ui-components/overview/react-components/connect-account-button) within our suite of [Seam Components](https://docs.seam.co/latest/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](../../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. +Because you're using a sandbox workspace, you can connect Seam's test Sensi account. We provide [virtual devices](https://docs.seam.co/latest/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: +Complete the Connect Webview authorization flow by entering the following [Sensi sandbox account](https://docs.seam.co/latest/developer-tools/sandbox-and-sample-data/sandbox-sensi-thermostats) credentials: * **Email:** jane@example.com * **Password:** 1234 @@ -715,7 +715,7 @@ Fan running: false Next, you can use the Seam API to control your Sensi thermostat. -Each device that you connect to Seam has a specific set of capabilities. These capabilities define the Seam API actions that you can use. For thermostats, device-specific capabilities include whether you can [set the HVAC mode](../../capability-guides/thermostats/configure-current-climate-settings.md) to `heat`, `cool`, or `heat_cool`. 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. For thermostats, device-specific capabilities include whether you can [set the HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings) to `heat`, `cool`, or `heat_cool`. Seam's intuitive and granular [capability flags](https://docs.seam.co/latest/capability-guides/device-and-system-capabilities#capability-flags) inform your application about what features and behaviors each device supports. Notice the capability flags within the code samples in this guide. Seam provides additional actions for thermostats, such as setting the fan mode, creating and scheduling climate presets, setting temperature thresholds, and configuring weekly thermostat programs. You can also monitor for Seam thermostat-related events, such as reported temperatures outside your set thresholds. @@ -737,11 +737,11 @@ To set the HVAC mode, use any of the following endpoints or their equivalents in This endpoint is a consolidated version of the other four endpoints. -Specify the thermostat that you want to control by including the `device_id` in the request body. Also, include the desired temperature [set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md). +Specify the thermostat that you want to control by including the `device_id` in the request body. Also, include the desired temperature [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). In this example, set the HVAC mode to `heat` and the desired heating set point to 68 °F. -Each of these HVAC mode endpoints returns an [action attempt](../../core-concepts/action-attempts.md) to track the progress of the operation. +Each of these HVAC mode endpoints returns an [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) to track the progress of the operation. {% tabs %} {% tab title="Python" %} @@ -1825,7 +1825,7 @@ $seam->thermostats->update_weekly_program( ## Step 5: Connect a real Sensi thermostat -Now that you have learned the basics of using the Seam API, you can connect and control a real Sensi 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 Sensi device. To do so, make sure to switch to a [non-sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#production-workspaces) and [API key](https://docs.seam.co/latest/core-concepts/authentication/api-keys). For more details about setting up your real Sensi thermostat, see the [Sensi thermostats integration guide](./). @@ -1842,17 +1842,17 @@ Seam makes it easy to develop your application. The robust Seam API and Seam SDK Now that you've completed this getting started guide for Sensi devices, you can learn more about what you can do with the Seam API. * [ ] **Explore**\ - See the [other devices and system integrations](../overview.md) that Seam supports. + See the [other devices and system integrations](https://docs.seam.co/latest/device-and-system-integration-guides) 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](https://docs.seam.co/latest/core-concepts/overview) and the [device and system capabilities ](https://docs.seam.co/latest/capability-guides/device-and-system-capabilities)that Seam supports. * [ ] **Expand your abilities**\ - Find out what other [thermostat actions](../../capability-guides/thermostats/) you can perform using the Seam API. + Find out what other [thermostat actions](https://docs.seam.co/latest/capability-guides/thermostats) you can perform using the Seam API. * [ ] **Use webhooks**\ - Learn how to use [webhooks](../../developer-tools/webhooks.md) as an efficient way to receive device events. + Learn how to use [webhooks](https://docs.seam.co/latest/developer-tools/webhooks) 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 [smart locks](../../capability-guides/smart-locks/), [access control systems](../../capability-guides/access-systems/), and [noise sensors](../../capability-guides/noise-sensors/). + Explore the other types of devices and systems that you can control with Seam, including [smart locks](https://docs.seam.co/latest/capability-guides/smart-locks), [access control systems](https://docs.seam.co/latest/capability-guides/access-systems), and [noise sensors](https://docs.seam.co/latest/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](https://docs.seam.co/latest/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). diff --git a/docs/brand-guides/smartthings-hubs-+-devices/README.md b/docs/brand-guides/smartthings-hubs-+-devices/README.md index 2a2ab8efe..69d77511a 100644 --- a/docs/brand-guides/smartthings-hubs-+-devices/README.md +++ b/docs/brand-guides/smartthings-hubs-+-devices/README.md @@ -24,19 +24,19 @@ For detailed information about the SmartThings devices that Seam supports, see o We support the following features: -* [Triggering web lock and unlock actions](../../capability-guides/smart-locks/lock-and-unlock.md) on smart locks -* [Programming online access codes](../../capability-guides/smart-locks/access-codes/) on smart locks that have a connected keypad -* [Configuring current thermostat settings](../../capability-guides/thermostats/configure-current-climate-settings.md) on thermostats -* [Creating and managing climate presets](../../capability-guides/thermostats/creating-and-managing-climate-presets/) on thermostats -* [Creating and managing thermostat schedules](../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) on thermostats -* [Creating and managing thermostat weekly programs](../../capability-guides/thermostats/creating-and-managing-thermostat-programs.md) on thermostats -* [Setting and monitoring temperature thresholds](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md) on thermostats +* [Triggering web lock and unlock actions](https://docs.seam.co/latest/capability-guides/smart-locks/lock-and-unlock) on smart locks +* [Programming online access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) on smart locks that have a connected keypad +* [Configuring current thermostat settings](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings) on thermostats +* [Creating and managing climate presets](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) on thermostats +* [Creating and managing thermostat schedules](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) on thermostats +* [Creating and managing thermostat weekly programs](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-programs) on thermostats +* [Setting and monitoring temperature thresholds](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) on thermostats *** ### Device Provider Key -To create a [Connect Webview](../../core-concepts/connect-webviews/) that enables your users to connect their SmartThings-connected devices to Seam, include the `smartthings` 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](https://docs.seam.co/latest/core-concepts/connect-webviews) that enables your users to connect their SmartThings-connected devices to Seam, include the `smartthings` device provider key in the `accepted_providers` list. For more information, see [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). *** @@ -47,7 +47,7 @@ To control SmartThings-connected devices using Seam, you must prompt owners of t 1. Install and create an account in the [SmartThings app](https://www.samsung.com/us/support/owners/app/smartthings) if you have not done so already. 2. In the SmartThings app, add your devices. 3. Follow [these instructions](https://www.samsung.com/ca/support/mobile-devices/smartthings-how-to-set-up-your-hub/) to pair your devices to the SmartThings hub, . -4. Note your login credentials for the SmartThings 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 SmartThings app, and use these credentials to log in to the [Seam Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) to add your devices to Seam. *** @@ -57,7 +57,7 @@ Note the following SmartThings-specific restrictions: ### Limiting Device Types to Connect -Because SmartThings supports multiple device types, you can choose which types of devices your users can connect to Seam. By default, Seam connects SmartThings locks. If you want your users to be able to connect SmartThings thermostats, use the `accepted_capabilities` parameter when creating a Connect Webview. Set this parameter to an array containing one or more of `thermostat` and `lock`. For details, see [Customize the Types of Devices to Connect](../../core-concepts/connect-webviews/customizing-connect-webviews.md#customize-the-types-of-devices-to-connect). +Because SmartThings supports multiple device types, you can choose which types of devices your users can connect to Seam. By default, Seam connects SmartThings locks. If you want your users to be able to connect SmartThings thermostats, use the `accepted_capabilities` parameter when creating a Connect Webview. Set this parameter to an array containing one or more of `thermostat` and `lock`. For details, see [Customize the Types of Devices to Connect](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-types-of-devices-to-connect). ### Device Status Reporting diff --git a/docs/brand-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md b/docs/brand-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md index 2738b2e98..bd8c03962 100644 --- a/docs/brand-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md +++ b/docs/brand-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md @@ -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](https://docs.seam.co/latest/core-concepts/seam-console/seam-online-cli), which you can access from directly within the [Seam Console](https://docs.seam.co/latest/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](https://docs.seam.co/latest/core-concepts/seam-console#create-a-seam-account) to get your [API key](https://docs.seam.co/latest/core-concepts/authentication/api-keys). Then, export your API key as an environment variable. @@ -80,21 +80,21 @@ $ 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](https://docs.seam.co/latest/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](https://docs.seam.co/latest/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](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews) client-side [Connect Webviews](https://docs.seam.co/latest/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](https://docs.seam.co/latest/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. @@ -273,13 +273,13 @@ 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](https://docs.seam.co/latest/ui-components/overview/react-components/connect-account-button) within our suite of [Seam Components](https://docs.seam.co/latest/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](../../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. +Because you're using a sandbox workspace, you can connect Seam's test SmartThings account. We provide [virtual devices](https://docs.seam.co/latest/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](../../developer-tools/sandbox-and-sample-data/smartthings-sample-data.md) credentials: +Complete the Connect Webview authorization flow by entering the following [SmartThings sandbox account](https://docs.seam.co/latest/developer-tools/sandbox-and-sample-data/smartthings-sample-data) credentials: * **Email:** jane@example.com * **Password:** 1234 @@ -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](https://docs.seam.co/latest/capability-guides/smart-locks/lock-and-unlock), [programming access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes), and so on. Seam's intuitive and granular [capability flags](https://docs.seam.co/latest/capability-guides/device-and-system-capabilities#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](https://docs.seam.co/latest/core-concepts/action-attempts) 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](https://docs.seam.co/latest/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](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes) online access codes. {% tabs %} {% tab title="Python" %} @@ -1376,7 +1376,7 @@ 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](https://docs.seam.co/latest/core-concepts/workspaces#production-workspaces) and [API key](https://docs.seam.co/latest/core-concepts/authentication/api-keys). For more details about setting up your real SmartThings-connected lock, see the [SmartThings Hubs + devices integration guide](../smartthings-hubs-+-devices/). @@ -1384,15 +1384,15 @@ For more details about setting up your real SmartThings-connected lock, see the ## 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](https://docs.seam.co/latest/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!

-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](https://docs.seam.co/latest/ui-components/overview/react-components/device-table) to display a list of devices and to identify all devices with issues. You can use the [Device Details Seam Component](https://docs.seam.co/latest/ui-components/overview/react-components/device-details) 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](https://docs.seam.co/latest/ui-components/overview/react-components/access-code-details) 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](https://docs.seam.co/latest/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](../overview.md) that Seam supports. + See the [other devices and system integrations](https://docs.seam.co/latest/device-and-system-integration-guides) 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](https://docs.seam.co/latest/core-concepts/overview) and the [device and system capabilities ](https://docs.seam.co/latest/capability-guides/device-and-system-capabilities)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](https://docs.seam.co/latest/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](https://docs.seam.co/latest/developer-tools/webhooks) 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](https://docs.seam.co/latest/capability-guides/access-systems), [thermostats](https://docs.seam.co/latest/capability-guides/thermostats), and [noise sensors](https://docs.seam.co/latest/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](https://docs.seam.co/latest/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). diff --git a/docs/brand-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-thermostats.md b/docs/brand-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-thermostats.md index 97d94543b..e6710e4d5 100644 --- a/docs/brand-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-thermostats.md +++ b/docs/brand-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-thermostats.md @@ -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 thermostat 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](https://docs.seam.co/latest/core-concepts/seam-console/seam-online-cli), which you can access from directly within the [Seam Console](https://docs.seam.co/latest/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](https://docs.seam.co/latest/core-concepts/seam-console#create-a-seam-account) to get your [API key](https://docs.seam.co/latest/core-concepts/authentication/api-keys). Then, export your API key as an environment variable. @@ -80,21 +80,21 @@ $ 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 thermostat, use a [non-sandbox workspace](../../core-concepts/workspaces/#production-workspaces) and API key. +This guide uses a [sandbox workspace](https://docs.seam.co/latest/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 thermostat, use a [non-sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#production-workspaces) and API key. {% endhint %} *** ## Step 2: Link your SmartThings account with Seam -To control your SmartThings-connected thermostat 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 thermostats. The Connect Webview presents a flow that prompts your users to enter their credentials for their SmartThings account. +To control your SmartThings-connected thermostat 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](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews) client-side [Connect Webviews](https://docs.seam.co/latest/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 thermostats. 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](https://docs.seam.co/latest/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-+-thermostats.md#authorize-your-workspace) in this guide to complete the Connect Webview authorization flow. @@ -279,13 +279,13 @@ 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](https://docs.seam.co/latest/ui-components/overview/react-components/connect-account-button) within our suite of [Seam Components](https://docs.seam.co/latest/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](../../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. +Because you're using a sandbox workspace, you can connect Seam's test SmartThings account. We provide [virtual devices](https://docs.seam.co/latest/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](../../developer-tools/sandbox-and-sample-data/smartthings-sample-data.md) credentials: +Complete the Connect Webview authorization flow by entering the following [SmartThings sandbox account](https://docs.seam.co/latest/developer-tools/sandbox-and-sample-data/smartthings-sample-data) credentials: * **Email:** jane@example.com * **Password:** 1234 @@ -725,7 +725,7 @@ Fan running: false Next, you can use the Seam API to control your SmartThings-connected thermostat. -Each device that you connect to Seam has a specific set of capabilities. These capabilities define the Seam API actions that you can use. For thermostats, device-specific capabilities include whether you can [set the HVAC mode](../../capability-guides/thermostats/configure-current-climate-settings.md) to `heat`, `cool`, or `heat_cool`. 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. For thermostats, device-specific capabilities include whether you can [set the HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings) to `heat`, `cool`, or `heat_cool`. Seam's intuitive and granular [capability flags](https://docs.seam.co/latest/capability-guides/device-and-system-capabilities#capability-flags) inform your application about what features and behaviors each device supports. Notice the capability flags within the code samples in this guide. Seam provides additional actions for thermostats, such as setting the fan mode, creating and scheduling climate presets, setting temperature thresholds, and configuring weekly thermostat programs. You can also monitor for Seam thermostat-related events, such as reported temperatures outside your set thresholds. @@ -747,11 +747,11 @@ To set the HVAC mode, use any of the following endpoints or their equivalents in This endpoint is a consolidated version of the other four endpoints. -Specify the thermostat that you want to control by including the `device_id` in the request body. Also, include the desired temperature [set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md). +Specify the thermostat that you want to control by including the `device_id` in the request body. Also, include the desired temperature [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). In this example, set the HVAC mode to `heat` and the desired heating set point to 68 °F. -Each of these HVAC mode endpoints returns an [action attempt](../../core-concepts/action-attempts.md) to track the progress of the operation. +Each of these HVAC mode endpoints returns an [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) to track the progress of the operation. {% tabs %} {% tab title="Python" %} @@ -1835,7 +1835,7 @@ $seam->thermostats->update_weekly_program( ## Step 5: Connect a real SmartThings-connected thermostat -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](https://docs.seam.co/latest/core-concepts/workspaces#production-workspaces) and [API key](https://docs.seam.co/latest/core-concepts/authentication/api-keys). For more details about setting up your real SmartThings-connected thermostat, see the [SmartThings Hubs + devices integration guide](./). @@ -1852,17 +1852,17 @@ Seam makes it easy to develop your application. The robust Seam API and Seam SDK 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](../overview.md) that Seam supports. + See the [other devices and system integrations](https://docs.seam.co/latest/device-and-system-integration-guides) 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](https://docs.seam.co/latest/core-concepts/overview) and the [device and system capabilities ](https://docs.seam.co/latest/capability-guides/device-and-system-capabilities)that Seam supports. * [ ] **Expand your abilities**\ - Find out what other [thermostat actions](../../capability-guides/thermostats/) you can perform using the Seam API. + Find out what other [thermostat actions](https://docs.seam.co/latest/capability-guides/thermostats) you can perform using the Seam API. * [ ] **Use webhooks**\ - Learn how to use [webhooks](../../developer-tools/webhooks.md) as an efficient way to receive device events. + Learn how to use [webhooks](https://docs.seam.co/latest/developer-tools/webhooks) 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 [smart locks](../../capability-guides/smart-locks/), [access control systems](../../capability-guides/access-systems/), and [noise sensors](../../capability-guides/noise-sensors/). + Explore the other types of devices and systems that you can control with Seam, including [smart locks](https://docs.seam.co/latest/capability-guides/smart-locks), [access control systems](https://docs.seam.co/latest/capability-guides/access-systems), and [noise sensors](https://docs.seam.co/latest/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](https://docs.seam.co/latest/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). diff --git a/docs/brand-guides/smartthings-hubs-+-smart-locks.md b/docs/brand-guides/smartthings-hubs-+-smart-locks.md index ef6185278..b1b8647e3 100644 --- a/docs/brand-guides/smartthings-hubs-+-smart-locks.md +++ b/docs/brand-guides/smartthings-hubs-+-smart-locks.md @@ -22,14 +22,14 @@ For detailed information about the SmartThings hubs that Seam supports, see our We support the following features: -* [Triggering web lock and unlock actions](../capability-guides/smart-locks/lock-and-unlock.md) on paired smart locks that support this feature -* [Programming access codes](../capability-guides/smart-locks/access-codes/) on paired smart locks that support this feature +* [Triggering web lock and unlock actions](https://docs.seam.co/latest/capability-guides/smart-locks/lock-and-unlock) on paired smart locks that support this feature +* [Programming access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) on paired smart locks that support this feature *** ### Device Provider Key -To create a [Connect Webview](../core-concepts/connect-webviews/) that enables your users to connect their August devices to Seam, include the `smartthings` 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](https://docs.seam.co/latest/core-concepts/connect-webviews) that enables your users to connect their August devices to Seam, include the `smartthings` device provider key in the `accepted_providers` list. For more information, see [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). *** @@ -39,7 +39,7 @@ To control SmartThings-connected devices using Seam, you must prompt owners of t 1. Create an account in the [SmartThings app](https://www.samsung.com/us/support/owners/app/smartthings) if you have not done so already. 2. Follow [these instructions](https://www.samsung.com/ca/support/mobile-devices/smartthings-how-to-set-up-your-hub/) to pair your devices to the SmartThings hub. -3. Note your login credentials for the SmartThings app, and use these credentials to log in to the [Seam Connect Webview](../core-concepts/connect-webviews/) to add your devices to Seam. +3. Note your login credentials for the SmartThings app, and use these credentials to log in to the [Seam Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) to add your devices to Seam. *** diff --git a/docs/brand-guides/tedee-locks/README.md b/docs/brand-guides/tedee-locks/README.md index efb488db4..20b12730b 100644 --- a/docs/brand-guides/tedee-locks/README.md +++ b/docs/brand-guides/tedee-locks/README.md @@ -28,14 +28,14 @@ For detailed information about the Tedee devices that Seam supports, see our [Te We support the following features: -* [Triggering web lock and unlock actions](../../capability-guides/smart-locks/lock-and-unlock.md) -* [Programming access codes](../../capability-guides/smart-locks/access-codes/) on locks and openers that have an installed Tedee keypad +* [Triggering web lock and unlock actions](https://docs.seam.co/latest/capability-guides/smart-locks/lock-and-unlock) +* [Programming access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) on locks and openers that have an installed Tedee keypad *** ### Device Provider Key -To create a [Connect Webview](../../core-concepts/connect-webviews/) that enables your users to connect their Tedee devices to Seam, include the `tedee` 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](https://docs.seam.co/latest/core-concepts/connect-webviews) that enables your users to connect their Tedee devices to Seam, include the `tedee` device provider key in the `accepted_providers` list. For more information, see [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). *** @@ -51,7 +51,7 @@ You must add your Tedee devices through the Tedee mobile app. You cannot add dev {% endhint %} 3. Note your login credentials for the Tedee app. -4. Use your credentials for the Tedee app to log in to the [Seam Connect Webview](../../core-concepts/connect-webviews/) to add your devices to Seam. +4. Use your credentials for the Tedee app to log in to the [Seam Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) to add your devices to Seam. *** diff --git a/docs/brand-guides/tedee-locks/get-started-with-tedee-locks.md b/docs/brand-guides/tedee-locks/get-started-with-tedee-locks.md index 3a66063bb..9500e0237 100644 --- a/docs/brand-guides/tedee-locks/get-started-with-tedee-locks.md +++ b/docs/brand-guides/tedee-locks/get-started-with-tedee-locks.md @@ -53,19 +53,19 @@ Install using [nuget](https://www.nuget.org/packages/Seam). {% endtab %} {% endtabs %} -Once installed, [sign up for Seam](https://console.seam.co/) to get your [API key](../../core-concepts/authentication/api-keys.md) and export it as an environment variable. +Once installed, [sign up for Seam](https://console.seam.co/) to get your [API key](https://docs.seam.co/latest/core-concepts/authentication/api-keys) and export it as an environment variable. ``` $ export SEAM_API_KEY=seam_test2ZTo_0mEYQW2TvNDCxG5Atpj85Ffw ``` {% hint style="info" %} -This guide uses a [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces). You can only connect virtual devices in a sandbox workspace. If you need to connect a real Tedee device, use a non-sandbox workspace and API key. +This guide uses a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces). You can only connect virtual devices in a sandbox workspace. If you need to connect a real Tedee device, use a non-sandbox workspace and API key. {% endhint %} ## 2 — Link Your Tedee Account with Seam -To control your Tedee locks using the Seam API, you must first authorize your Seam workspace against your Tedee 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 Tedee sites. +To control your Tedee locks using the Seam API, you must first authorize your Seam workspace against your Tedee account. To do so, Seam provides[ Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews): pre-built UX flows that walk you through authorizing your application to control your Tedee sites. ### Request a Connect Webview @@ -131,7 +131,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 Tedee [sandbox test accounts ](../../developer-tools/sandbox-and-sample-data/sandbox-tedee-locks.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 Tedee [sandbox test accounts ](https://docs.seam.co/latest/developer-tools/sandbox-and-sample-data/sandbox-tedee-locks)credentials below: * **email:** jane@example.com * **password:** 1234 @@ -375,7 +375,7 @@ $seam->locks->lock_door($lock->device_id); Some Tedee locks also have a keypad paired to them to program access codes. These codes can then be entered to unlock a Tedee lock. -The Seam API makes it easy to program both `ongoing` codes and `timebound` codes on a Tedee lock. You can find out more about Tedee 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 Tedee lock. You can find out more about Tedee lock access code in our [core concept section on access codes.](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) {% hint style="info" %} For Tedee-specific access code restrictions, see [Access (PIN) Code Requirements](./#access-pin-code-requirements). @@ -480,7 +480,7 @@ In addition, if you'd like to explore other aspects of Seam, here is a list of h * [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) +* [Receiving webhook](https://docs.seam.co/latest/developer-tools/webhooks) for [device events](https://docs.seam.co/latest/api/events/list) +* [Core Concepts](https://docs.seam.co/latest/core-concepts/overview) If you have any questions or want to report an issue, email us at support@seam.co. diff --git a/docs/brand-guides/ttlock-locks.md b/docs/brand-guides/ttlock-locks.md index 980eef271..f5ffdd0a7 100644 --- a/docs/brand-guides/ttlock-locks.md +++ b/docs/brand-guides/ttlock-locks.md @@ -18,14 +18,14 @@ For detailed information about the TTLock devices that Seam supports, see our [T We support the following features: -* [Triggering web lock and unlock actions](../capability-guides/smart-locks/lock-and-unlock.md) -* [Programming access codes](../capability-guides/smart-locks/access-codes/) on door locks and card readers that have a PIN pad +* [Triggering web lock and unlock actions](https://docs.seam.co/latest/capability-guides/smart-locks/lock-and-unlock) +* [Programming access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) on door locks and card readers that have a PIN pad *** ### Device Provider Key -To create a [Connect Webview](../core-concepts/connect-webviews/) that enables your users to connect their TTLock devices to Seam, include the `ttlock` 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](https://docs.seam.co/latest/core-concepts/connect-webviews) that enables your users to connect their TTLock devices to Seam, include the `ttlock` device provider key in the `accepted_providers` list. For more information, see [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). *** @@ -44,7 +44,7 @@ To control TTLock devices using Seam, you must prompt owners of these devices to This feature must be enabled to unlock a TTLock device. Note that if Seam detects that this feature is disabled, a warning is added to the device.\ Follow [the instructions in this video](https://www.youtube.com/watch?v=ni-38QpoNA4) to turn on the Remote Unlock setting for each TTLock lock. 5. Note your login credentials for the TTLock app. -6. Use your credentials for the TTLock app to log in to the [Seam Connect Webview](../core-concepts/connect-webviews/) to add your devices to Seam. +6. Use your credentials for the TTLock app to log in to the [Seam Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) to add your devices to Seam. *** @@ -52,7 +52,7 @@ To control TTLock devices using Seam, you must prompt owners of these devices to ### Lock Not Appearing in Seam -Your users must be the top administrator for each TTLock that they want to connect to Seam. That is, they must supply the credentials for the top administrator account when completing the [Connect Webview](../core-concepts/connect-webviews/) to connect their TTLocks to Seam. +Your users must be the top administrator for each TTLock that they want to connect to Seam. That is, they must supply the credentials for the top administrator account when completing the [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) to connect their TTLocks to Seam. ### Lock Not Paired to Gateway Error diff --git a/docs/brand-guides/ultraloq-locks/README.md b/docs/brand-guides/ultraloq-locks/README.md index ac0d1fe93..99f8d3542 100644 --- a/docs/brand-guides/ultraloq-locks/README.md +++ b/docs/brand-guides/ultraloq-locks/README.md @@ -69,7 +69,7 @@ For complete instructions, see [Configuring Ultraloq Device Timezones](configuri ## Connecting Ultraloq to Seam -To enable your users to [connect Ultraloq devices through Connect Webviews](../../core-concepts/connect-webviews/customizing-connect-webviews.md#customize-the-brands-to-display-in-your-connect-webviews), include the Ultraloq provider: +To enable your users to [connect Ultraloq devices through Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews), include the Ultraloq provider: ```json { diff --git a/docs/brand-guides/ultraloq-locks/configuring-ultraloq-device-timezones.md b/docs/brand-guides/ultraloq-locks/configuring-ultraloq-device-timezones.md index 2cadd6870..b712c74a1 100644 --- a/docs/brand-guides/ultraloq-locks/configuring-ultraloq-device-timezones.md +++ b/docs/brand-guides/ultraloq-locks/configuring-ultraloq-device-timezones.md @@ -1194,6 +1194,6 @@ Now that you understand timezone configuration, you can: * **Create time-bound access codes:** See [Creating Ultraloq Access Codes](creating-ultraloq-access-codes.md) * **Review the setup guide:** See [Ultraloq Setup Guide](ultraloq-setup-guide.md) -* **Learn about access code constraints:** See [Understanding Code Constraints](../../capability-guides/smart-locks/access-codes/creating-access-codes/understanding-code-constraints.md) +* **Learn about access code constraints:** See [Understanding Code Constraints](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/creating-access-codes/understanding-code-constraints) *** diff --git a/docs/brand-guides/ultraloq-locks/creating-ultraloq-access-codes.md b/docs/brand-guides/ultraloq-locks/creating-ultraloq-access-codes.md index 5c973c42b..7851e9349 100644 --- a/docs/brand-guides/ultraloq-locks/creating-ultraloq-access-codes.md +++ b/docs/brand-guides/ultraloq-locks/creating-ultraloq-access-codes.md @@ -851,8 +851,8 @@ For complete API documentation, see: ## Next Steps * **Learn about timezone configuration:** See [Configuring Ultraloq Device Timezones](configuring-ultraloq-device-timezones.md) -* **Understand code constraints:** See [Understanding Code Constraints](../../capability-guides/smart-locks/access-codes/creating-access-codes/understanding-code-constraints.md) +* **Understand code constraints:** See [Understanding Code Constraints](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/creating-access-codes/understanding-code-constraints) * **Review the setup guide:** See [Ultraloq Setup Guide](ultraloq-setup-guide.md) -* **Explore access code webhooks:** See [Webhooks](../../developer-tools/webhooks.md) +* **Explore access code webhooks:** See [Webhooks](https://docs.seam.co/latest/developer-tools/webhooks) *** diff --git a/docs/brand-guides/ultraloq-locks/ultraloq-setup-guide.md b/docs/brand-guides/ultraloq-locks/ultraloq-setup-guide.md index 9258f2eeb..27d2f6754 100644 --- a/docs/brand-guides/ultraloq-locks/ultraloq-setup-guide.md +++ b/docs/brand-guides/ultraloq-locks/ultraloq-setup-guide.md @@ -15,14 +15,14 @@ To follow this guide, you need: * An Ultraloq account with at least one lock configured {% hint style="info" %} -If you're testing the integration, you can use a [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces) with test Ultraloq devices. +If you're testing the integration, you can use a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces) with test Ultraloq devices. {% endhint %} *** ## Step 1: Create a Connect Webview -Create a [Connect Webview](../../core-concepts/connect-webviews/) to enable the Ultraloq device owner to authorize Seam to access their Ultraloq account. +Create a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) to enable the Ultraloq device owner to authorize Seam to access their Ultraloq account. {% tabs %} {% tab title="Python" %} @@ -151,7 +151,7 @@ After authorization, the user is redirected to your `custom_redirect_url` with t ## Step 3: Verify Connection -Wait for the Connect Webview status to change to `authorized`, indicating that the connection was successful. You can either poll the Connect Webview or use [webhooks](../../developer-tools/webhooks.md) to be notified when the status changes. +Wait for the Connect Webview status to change to `authorized`, indicating that the connection was successful. You can either poll the Connect Webview or use [webhooks](https://docs.seam.co/latest/developer-tools/webhooks) to be notified when the status changes. {% tabs %} {% tab title="Python" %} @@ -1436,8 +1436,8 @@ echo $device | jq '.device.warnings' * **[Creating Ultraloq Access Codes](creating-ultraloq-access-codes.md)** - Detailed guide on permanent and time-bound access codes * **[Configuring Ultraloq Device Timezones](configuring-ultraloq-device-timezones.md)** - Complete timezone configuration reference -* **[Lock and Unlock Operations](../../capability-guides/smart-locks/lock-and-unlock.md)** - General smart lock control documentation -* **[Access Codes Overview](../../capability-guides/smart-locks/access-codes/)** - Understanding access code management +* **[Lock and Unlock Operations](https://docs.seam.co/latest/capability-guides/smart-locks/lock-and-unlock)** - General smart lock control documentation +* **[Access Codes Overview](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes)** - Understanding access code management *** diff --git a/docs/brand-guides/wyze-locks.md b/docs/brand-guides/wyze-locks.md index 761227199..3d226fc0d 100644 --- a/docs/brand-guides/wyze-locks.md +++ b/docs/brand-guides/wyze-locks.md @@ -30,8 +30,8 @@ For detailed information about the Wyze devices that Seam supports, see our [Wyz We support the following features: -* [Triggering web lock and unlock actions](../capability-guides/smart-locks/lock-and-unlock.md) -* [Programming access codes](../capability-guides/smart-locks/access-codes/) on locks that have an installed Wyze Lock Keypad +* [Triggering web lock and unlock actions](https://docs.seam.co/latest/capability-guides/smart-locks/lock-and-unlock) +* [Programming access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) on locks that have an installed Wyze Lock Keypad {% hint style="info" %} The Seam platform cannot determine the PIN codes for access codes that were created outside of the Seam platform. @@ -41,7 +41,7 @@ The Seam platform cannot determine the PIN codes for access codes that were crea ### Device Provider Key -To create a [Connect Webview](../core-concepts/connect-webviews/) that enables your users to connect their Wyze devices to Seam, include the `wyze` 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](https://docs.seam.co/latest/core-concepts/connect-webviews) that enables your users to connect their Wyze devices to Seam, include the `wyze` device provider key in the `accepted_providers` list. For more information, see [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). *** @@ -54,7 +54,7 @@ To control Wyze devices using Seam, you must prompt owners of these devices to p 3. Log in to the [Wyze online portal](https://developer-api-console.wyze.com/#/apikey/view). 4. In the Wyze online portal, click **Create an API key**. 5. Click **view** and note the API key. -6. Use your credentials for the Wyze app and the noted API key to log in to the [Seam Connect Webview](../core-concepts/connect-webviews/) to add your Wyze devices to Seam. +6. Use your credentials for the Wyze app and the noted API key to log in to the [Seam Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) to add your Wyze devices to Seam. *** diff --git a/docs/brand-guides/yale-locks.md b/docs/brand-guides/yale-locks.md index dd7c4c163..3a907a5c2 100644 --- a/docs/brand-guides/yale-locks.md +++ b/docs/brand-guides/yale-locks.md @@ -37,13 +37,13 @@ For detailed information about the Yale devices that Seam supports, see our [Yal We support the following features: * [Triggering web unlock actions](https://docs.seam.co/latest/api/locks/unlock_door) -* [Programming access codes](../capability-guides/smart-locks/access-codes/) on door locks that have a keypad +* [Programming access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) on door locks that have a keypad *** ### Device Provider Key -To create a [Connect Webview](../core-concepts/connect-webviews/) that enables your users to connect their Yale devices to Seam, include the `yale` 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](https://docs.seam.co/latest/core-concepts/connect-webviews) that enables your users to connect their Yale devices to Seam, include the `yale` device provider key in the `accepted_providers` list. For more information, see [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). *** diff --git a/docs/guides/capability-guides/access-grants/README.md b/docs/guides/capability-guides/access-grants/README.md index d8f7e80a9..b882c5447 100644 --- a/docs/guides/capability-guides/access-grants/README.md +++ b/docs/guides/capability-guides/access-grants/README.md @@ -24,7 +24,7 @@ An Access Grant includes the following characteristics: The Access Grant process consists of the following steps: -
StepDescription
  1. Set up your site for Access Grants.
This step includes confirming hardware capabilities and making sure that you have the required licenses. For example, if you plan to use mobile keys or Instant Keys, your lock hardware must support Bluetooth Low Energy (BLE) keys. Also, to use mobile keys with your access system, you may need to purchase licenses or subscriptions to activate certain software features. These requirements vary by access system. For details, see Setting Up Your Site for Instant Keys and the system integration guide for your access system.
  1. Connect your access system to Seam.
To connect your access system to Seam, we recommend embedding a Connect Webview in your application. The Connect Webview flow guides the property manager through each step of the connection process. For on-premises access systems, use Seam Bridge to connect the access system securely to Seam.
For details, see Connect an Access System to Seam.
  1. (Optional) Set up spaces to organize entrances into logical groups.
You can use spaces to create groups of entrances for efficiency. For example, a user staying in Room 101 may need access to both the Room 101 door, the main entrance door, and the nearest elevator. You could create a space that includes these three access points and then use this space when creating an Access Grant.
For details, see spaces.
Note: Spaces are currently in Alpha. We're actively developing this feature and seeking early feedback at support@seam.co. Expect breaking changes as we refine the design.
  1. Create a user identity.
User identities represent your users—the people to whom you want to grant access. You can create a user identity before creating an Access Grant, or you can create a user identity as part of creating the Access Grant.
See Managing Mobile App User Accounts with User Identities.
  1. Create an Access Grant.
When you create an Access Grant, you specify the user identity to whom you want to grant access, the access schedule, the set of entrances or spaces, and one or more access methods that you want to request.
See Creating an Access Grant Using Entrances and Creating an Access Grant Using Spaces.
You can poll for access method status changes or watch for Access Grant and access method lifecycle events that alert you to next steps, such as how and when to deliver each created access method to your user.
  1. Deliver the access method to the user.

Once Seam alerts you that your access methods are ready, deliver them to your user. Delivery steps depend on the mode of access, such as plastic key card, PIN code, or mobile key.

  • If you have created an access grant that includes a card access method, you may need to encode the card using the Seam encoders API.
  • If you have created an Access Grant that includes a mobile key, you can use the Seam mobile SDKs to develop your mobile app that delivers these mobile keys to your users.
  • Each mobile key also includes an Instant Key URL. To share this Instant Key with your user, send it through text or email or embed it in your own app.

See Delivering Access Methods.

+
StepDescription
  1. Set up your site for Access Grants.
This step includes confirming hardware capabilities and making sure that you have the required licenses. For example, if you plan to use mobile keys or Instant Keys, your lock hardware must support Bluetooth Low Energy (BLE) keys. Also, to use mobile keys with your access system, you may need to purchase licenses or subscriptions to activate certain software features. These requirements vary by access system. For details, see Setting Up Your Site for Instant Keys and the system integration guide for your access system.
  1. Connect your access system to Seam.
To connect your access system to Seam, we recommend embedding a Connect Webview in your application. The Connect Webview flow guides the property manager through each step of the connection process. For on-premises access systems, use Seam Bridge to connect the access system securely to Seam.
For details, see Connect an Access System to Seam.
  1. (Optional) Set up spaces to organize entrances into logical groups.
You can use spaces to create groups of entrances for efficiency. For example, a user staying in Room 101 may need access to both the Room 101 door, the main entrance door, and the nearest elevator. You could create a space that includes these three access points and then use this space when creating an Access Grant.
For details, see spaces.
Note: Spaces are currently in Alpha. We're actively developing this feature and seeking early feedback at support@seam.co. Expect breaking changes as we refine the design.
  1. Create a user identity.
User identities represent your users—the people to whom you want to grant access. You can create a user identity before creating an Access Grant, or you can create a user identity as part of creating the Access Grant.
See Managing Mobile App User Accounts with User Identities.
  1. Create an Access Grant.
When you create an Access Grant, you specify the user identity to whom you want to grant access, the access schedule, the set of entrances or spaces, and one or more access methods that you want to request.
See Creating an Access Grant Using Entrances and Creating an Access Grant Using Spaces.
You can poll for access method status changes or watch for Access Grant and access method lifecycle events that alert you to next steps, such as how and when to deliver each created access method to your user.
  1. Deliver the access method to the user.

Once Seam alerts you that your access methods are ready, deliver them to your user. Delivery steps depend on the mode of access, such as plastic key card, PIN code, or mobile key.

  • If you have created an access grant that includes a card access method, you may need to encode the card using the Seam encoders API.
  • If you have created an Access Grant that includes a mobile key, you can use the Seam mobile SDKs to develop your mobile app that delivers these mobile keys to your users.
  • Each mobile key also includes an Instant Key URL. To share this Instant Key with your user, send it through text or email or embed it in your own app.

See Delivering Access Methods.

*** diff --git a/docs/guides/capability-guides/access-grants/creating-an-access-grant-using-entrances.md b/docs/guides/capability-guides/access-grants/creating-an-access-grant-using-entrances.md index e59a50d03..3ccf6e401 100644 --- a/docs/guides/capability-guides/access-grants/creating-an-access-grant-using-entrances.md +++ b/docs/guides/capability-guides/access-grants/creating-an-access-grant-using-entrances.md @@ -42,7 +42,7 @@ If you've created an Access Grant that includes an mobile key, the returned Acce ## Before You Begin -To create an Access Grant, first [connect](../../core-concepts/workspaces/#connecting-virtual-devices) an access system to Seam. You may also need to set up your access system and confirm that it has the required licenses. For details, see [Setting Up Your Site for Instant Keys](../instant-keys/setting-up-your-site-for-instant-keys.md) and the [system integration guide](../../device-and-system-integration-guides/overview.md#access-control-systems) for your access system. +To create an Access Grant, first [connect](../../core-concepts/workspaces/#connecting-virtual-devices) an access system to Seam. You may also need to set up your access system and confirm that it has the required licenses. For details, see [Setting Up Your Site for Instant Keys](../instant-keys/setting-up-your-site-for-instant-keys.md) and the [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems) for your access system. *** diff --git a/docs/guides/capability-guides/access-grants/creating-an-access-grant-using-spaces.md b/docs/guides/capability-guides/access-grants/creating-an-access-grant-using-spaces.md index c913747fd..e3837ca5d 100644 --- a/docs/guides/capability-guides/access-grants/creating-an-access-grant-using-spaces.md +++ b/docs/guides/capability-guides/access-grants/creating-an-access-grant-using-spaces.md @@ -42,7 +42,7 @@ If you've created an Access Grant that includes an mobile key, the returned Acce ## Before You Begin -To create an Access Grant, first [connect](../../core-concepts/workspaces/#connecting-virtual-devices) an access system to Seam. You may also need to set up your access system and confirm that it has the required licenses. For details, see [Setting Up Your Site for Instant Keys](../instant-keys/setting-up-your-site-for-instant-keys.md) and the [system integration guide](../../device-and-system-integration-guides/overview.md#access-control-systems) for your access system. +To create an Access Grant, first [connect](../../core-concepts/workspaces/#connecting-virtual-devices) an access system to Seam. You may also need to set up your access system and confirm that it has the required licenses. For details, see [Setting Up Your Site for Instant Keys](../instant-keys/setting-up-your-site-for-instant-keys.md) and the [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems) for your access system. Create one or more spaces to group the entrances to which you want to grant access. For details, see [Spaces](https://docs.seam.co/latest/api/spaces/) and [Create a Space](https://docs.seam.co/latest/api/spaces/create). diff --git a/docs/guides/capability-guides/access-systems/README.md b/docs/guides/capability-guides/access-systems/README.md index 4037d8974..cd65fac61 100644 --- a/docs/guides/capability-guides/access-systems/README.md +++ b/docs/guides/capability-guides/access-systems/README.md @@ -40,7 +40,7 @@ Seam enables you to manage your ACS in a logical, efficient manner. Seam's universal API provides the flexibility to manage a variety of [access control systems](../../capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md), each of which may have manufacturer-specific differences. For example, depending on your ACS, you configure access permissions by [assigning ACS users to access groups](../../capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md#access-group-based-access-control-systems) or by [specifying access permissions for each ACS user or credential](../../capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md#credential-based-access-control-systems). -For details specific to your access control system, see the [system integration guide](../../device-and-system-integration-guides/overview.md#access-control-systems) for your ACS. +For details specific to your access control system, see the [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems) for your ACS. *** diff --git a/docs/guides/capability-guides/access-systems/acs-quick-starts/README.md b/docs/guides/capability-guides/access-systems/acs-quick-starts/README.md index 1b5123909..fb8bdab2c 100644 --- a/docs/guides/capability-guides/access-systems/acs-quick-starts/README.md +++ b/docs/guides/capability-guides/access-systems/acs-quick-starts/README.md @@ -15,6 +15,6 @@ description: >- Create your first mobile key credential to grant an access system user scheduled access to a virtual entrance that accepts Bluetooth low energy (BLE)-powered keys within mobile apps. {% hint style="info" %} -These quick starts introduce you to the Seam access system resources and processes using specific supported access control systems as examples. Note that there are often differences between access control systems. Once you've completed the quick starts, learn how to work with your access system using Seam, by reading the [system integration guide](../../../device-and-system-integration-guides/overview.md#access-control-systems) for your access system. +These quick starts introduce you to the Seam access system resources and processes using specific supported access control systems as examples. Note that there are often differences between access control systems. Once you've completed the quick starts, learn how to work with your access system using Seam, by reading the [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems) for your access system. {% endhint %} diff --git a/docs/guides/capability-guides/access-systems/acs-quick-starts/encodable-key-card-quick-start.md b/docs/guides/capability-guides/access-systems/acs-quick-starts/encodable-key-card-quick-start.md index 1edd7def5..e6ea5efbb 100644 --- a/docs/guides/capability-guides/access-systems/acs-quick-starts/encodable-key-card-quick-start.md +++ b/docs/guides/capability-guides/access-systems/acs-quick-starts/encodable-key-card-quick-start.md @@ -6,12 +6,12 @@ description: >- # Encodable Key Card Quick Start -In this quick start, create an ACS user for a virtual [ASSA ABLOY Visionline](../../../device-and-system-integration-guides/assa-abloy-visionline-access-control-system/) access control system. Then, grant the user access to an entrance using a encodable key card credential. +In this quick start, create an ACS user for a virtual [ASSA ABLOY Visionline](https://docs.seam.co/latest/device-and-system-integration-guides/assa-abloy-visionline-access-control-system) access control system. Then, grant the user access to an entrance using a encodable key card credential. {% hint style="info" %} This quick start walks you through the process that applies specifically to the Visionline ACS. There are often differences between access control systems. For example, for some access control systems, you encode credentials onto cards. For others, you do not encode data onto cards, but, rather, assign cards to users. -Once you've completed this quick start, learn how to work with your ACS using Seam, by reading the [system integration guide](../../../device-and-system-integration-guides/overview.md#access-control-systems) for your ACS. +Once you've completed this quick start, learn how to work with your ACS using Seam, by reading the [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems) for your ACS. {% endhint %} ## Overview @@ -287,7 +287,7 @@ $acs_user = $seam->acs->users->create( ## Step 4: Create an Encodable Key Card Credential -Create an encodable key card credential for the ACS user. In this credential, specify the set of allowed entrances and the access schedule. For Visionline, you must also specify some system-specific metadata, such as the card format and whether the credential is an [override credential](../../../device-and-system-integration-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/#credential-types-for-visionline). +Create an encodable key card credential for the ACS user. In this credential, specify the set of allowed entrances and the access schedule. For Visionline, you must also specify some system-specific metadata, such as the card format and whether the credential is an [override credential](https://docs.seam.co/latest/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials#credential-types-for-visionline). If this credential were intended for a real Visionline card, you'd need to create the credential and then encode this data onto the key card. Other access control systems do not use encodable cards, but, rather, assign cards to users. diff --git a/docs/guides/capability-guides/access-systems/acs-quick-starts/mobile-key-quick-start.md b/docs/guides/capability-guides/access-systems/acs-quick-starts/mobile-key-quick-start.md index 087ced564..f8bab6519 100644 --- a/docs/guides/capability-guides/access-systems/acs-quick-starts/mobile-key-quick-start.md +++ b/docs/guides/capability-guides/access-systems/acs-quick-starts/mobile-key-quick-start.md @@ -6,10 +6,10 @@ description: >- # Mobile Key Quick Start -In this quick start, create a user identity for a virtual [Salto KS](../../../device-and-system-integration-guides/salto-ks-access-control-system/) access control system. Then, grant the user access to an entrance using a mobile key credential. With mobile keys, developers can create mobile apps that download users' credentials and then use Bluetooth low energy (BLE) or similar communications technologies to unlock granted nearby entrances. For more information about Seam's mobile access solution, see [Mobile Access](../../mobile-access/). +In this quick start, create a user identity for a virtual [Salto KS](https://docs.seam.co/latest/device-and-system-integration-guides/salto-ks-access-control-system) access control system. Then, grant the user access to an entrance using a mobile key credential. With mobile keys, developers can create mobile apps that download users' credentials and then use Bluetooth low energy (BLE) or similar communications technologies to unlock granted nearby entrances. For more information about Seam's mobile access solution, see [Mobile Access](../../mobile-access/). {% hint style="info" %} -This quick start walks you through the process that applies specifically to the Salto KS ACS. There are often differences between access control systems. Once you've completed this quick start, learn how to work with your ACS using Seam, by reading the [system integration guide](../../../device-and-system-integration-guides/overview.md#access-control-systems) for your ACS. +This quick start walks you through the process that applies specifically to the Salto KS ACS. There are often differences between access control systems. Once you've completed this quick start, learn how to work with your ACS using Seam, by reading the [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems) for your ACS. {% endhint %} ## Overview diff --git a/docs/guides/capability-guides/access-systems/acs-quick-starts/pin-code-quick-start.md b/docs/guides/capability-guides/access-systems/acs-quick-starts/pin-code-quick-start.md index c012739e2..54c4184ce 100644 --- a/docs/guides/capability-guides/access-systems/acs-quick-starts/pin-code-quick-start.md +++ b/docs/guides/capability-guides/access-systems/acs-quick-starts/pin-code-quick-start.md @@ -6,10 +6,10 @@ description: >- # PIN Code Quick Start -In this quick start, create an ACS user for a virtual [Salto KS](../../../device-and-system-integration-guides/salto-ks-access-control-system/) access control system. Then, grant the user access to an entrance using a PIN code credential. +In this quick start, create an ACS user for a virtual [Salto KS](https://docs.seam.co/latest/device-and-system-integration-guides/salto-ks-access-control-system) access control system. Then, grant the user access to an entrance using a PIN code credential. {% hint style="info" %} -This quick start walks you through the process that applies specifically to the Salto KS ACS. There are often differences between access control systems. Once you've completed this quick start, learn how to work with your ACS using Seam, by reading the [system integration guide](../../../device-and-system-integration-guides/overview.md#access-control-systems) for your ACS. +This quick start walks you through the process that applies specifically to the Salto KS ACS. There are often differences between access control systems. Once you've completed this quick start, learn how to work with your ACS using Seam, by reading the [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems) for your ACS. {% endhint %} ## Overview diff --git a/docs/guides/capability-guides/access-systems/assigning-credentials-to-users.md b/docs/guides/capability-guides/access-systems/assigning-credentials-to-users.md index c684c825f..62ebad101 100644 --- a/docs/guides/capability-guides/access-systems/assigning-credentials-to-users.md +++ b/docs/guides/capability-guides/access-systems/assigning-credentials-to-users.md @@ -28,7 +28,7 @@ seam.acs.credentials.assign( **Response:** {% hint style="info" %} -This response contains manufacturer-specific metadata that may vary by [manufacturer](../../device-and-system-integration-guides/overview.md#access-control-systems). +This response contains manufacturer-specific metadata that may vary by [manufacturer](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). {% endhint %} ``` @@ -64,7 +64,7 @@ curl -X 'POST' \ **Response:** {% hint style="info" %} -This response contains manufacturer-specific metadata that may vary by [manufacturer](../../device-and-system-integration-guides/overview.md#access-control-systems). +This response contains manufacturer-specific metadata that may vary by [manufacturer](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). {% endhint %} ```json @@ -99,7 +99,7 @@ await seam.acs.credentials.assign({ **Response:** {% hint style="info" %} -This response contains manufacturer-specific metadata that may vary by [manufacturer](../../device-and-system-integration-guides/overview.md#access-control-systems). +This response contains manufacturer-specific metadata that may vary by [manufacturer](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). {% endhint %} ```json @@ -145,7 +145,7 @@ $seam->acs->credentials->assign( **Response:** {% hint style="info" %} -This response contains manufacturer-specific metadata that may vary by [manufacturer](../../device-and-system-integration-guides/overview.md#access-control-systems). +This response contains manufacturer-specific metadata that may vary by [manufacturer](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). {% endhint %} ```json @@ -177,7 +177,7 @@ seam.CredentialsAcs.Assign( **Response:** {% hint style="info" %} -This response contains manufacturer-specific metadata that may vary by [manufacturer](../../device-and-system-integration-guides/overview.md#access-control-systems). +This response contains manufacturer-specific metadata that may vary by [manufacturer](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). {% endhint %} ```json @@ -220,7 +220,7 @@ seam.acs.credentials.unassign( **Response:** {% hint style="info" %} -This response contains manufacturer-specific metadata that may vary by [manufacturer](../../device-and-system-integration-guides/overview.md#access-control-systems). +This response contains manufacturer-specific metadata that may vary by [manufacturer](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). {% endhint %} ``` @@ -256,7 +256,7 @@ curl -X 'POST' \ **Response:** {% hint style="info" %} -This response contains manufacturer-specific metadata that may vary by [manufacturer](../../device-and-system-integration-guides/overview.md#access-control-systems). +This response contains manufacturer-specific metadata that may vary by [manufacturer](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). {% endhint %} ```json @@ -291,7 +291,7 @@ await seam.acs.credentials.unassign({ **Response:** {% hint style="info" %} -This response contains manufacturer-specific metadata that may vary by [manufacturer](../../device-and-system-integration-guides/overview.md#access-control-systems). +This response contains manufacturer-specific metadata that may vary by [manufacturer](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). {% endhint %} ```json @@ -337,7 +337,7 @@ $seam->acs->credentials->unassign( **Response:** {% hint style="info" %} -This response contains manufacturer-specific metadata that may vary by [manufacturer](../../device-and-system-integration-guides/overview.md#access-control-systems). +This response contains manufacturer-specific metadata that may vary by [manufacturer](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). {% endhint %} ```json @@ -369,7 +369,7 @@ seam.CredentialsAcs.Unassign( **Response:** {% hint style="info" %} -This response contains manufacturer-specific metadata that may vary by [manufacturer](../../device-and-system-integration-guides/overview.md#access-control-systems). +This response contains manufacturer-specific metadata that may vary by [manufacturer](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). {% endhint %} ```json 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 50093c32b..371c550ac 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 @@ -24,7 +24,7 @@ You can use [Seam Console](../../../core-concepts/seam-console/) or the [Seam AP 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. + To connect a real access system, see the [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems) for your ACS to learn any brand- or system-specific prerequisites, requirements, and restrictions. The **Access Systems** page now displays the newly-connected access control system. diff --git a/docs/guides/capability-guides/access-systems/connect-an-acs-to-seam/access-control-system-resources.md b/docs/guides/capability-guides/access-systems/connect-an-acs-to-seam/access-control-system-resources.md index 51d43acfc..fa32acbde 100644 --- a/docs/guides/capability-guides/access-systems/connect-an-acs-to-seam/access-control-system-resources.md +++ b/docs/guides/capability-guides/access-systems/connect-an-acs-to-seam/access-control-system-resources.md @@ -4,7 +4,7 @@ description: Learn about the Seam resources that you use to manage your ACS. # Access Control System Resources -The Seam ACS schema consists of a series of resources. These resources interact intuitively, enabling you to manage your ACS in a logical, efficient manner. Seam's universal API provides the flexibility to manage a variety of [ACSs](understanding-access-control-system-differences.md), each of which may have manufacturer-specific differences. For details about your ACS, see the corresponding [system integration guide](../../../device-and-system-integration-guides/overview.md#access-control-systems). +The Seam ACS schema consists of a series of resources. These resources interact intuitively, enabling you to manage your ACS in a logical, efficient manner. Seam's universal API provides the flexibility to manage a variety of [ACSs](understanding-access-control-system-differences.md), each of which may have manufacturer-specific differences. For details about your ACS, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). The following diagram shows an example of one ACS, including the ACS resources and the relationships between them: diff --git a/docs/guides/capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md b/docs/guides/capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md index 51e9278e2..aafec2762 100644 --- a/docs/guides/capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md +++ b/docs/guides/capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md @@ -12,7 +12,7 @@ Seam's universal API provides the flexibility to manage a variety of [ACSs](../. * The specific licenses, if any, that each ACS manufacturer requires you to purchase * The manufacturer-specific ACS properties and metadata that you must configure to create and assign credentials to ACS users -To understand the manufacturer-specific nuances of your ACS, see the relevant [system integration guide](../../../device-and-system-integration-guides/overview.md#access-control-systems). +To understand the manufacturer-specific nuances of your ACS, see the relevant [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). *** @@ -56,7 +56,7 @@ The following process describes the configuration steps for your application to * ID of the `acs_user` to associate with this credential * Access method for the credential, such as `code`, `card`, or `mobile_key` - Depending on the access method and specific ACS, your application can also configure additional credential properties. For more information about manufacturer-specific variations, see the [system integration guide](../../../device-and-system-integration-guides/overview.md#access-control-systems) for your ACS. + Depending on the access method and specific ACS, your application can also configure additional credential properties. For more information about manufacturer-specific variations, see the [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems) for your ACS. You can also perform other management actions, as needed, such as [adding ACS users to](../user-management/assigning-users-to-access-groups.md#add-an-acs-user-to-an-access-group) and [removing ACS users from access groups](../user-management/assigning-users-to-access-groups.md#remove-an-acs-user-from-an-access-group), [assigning](../assigning-credentials-to-users.md#assign-a-credential-to-a-user) and [unassigning](../assigning-credentials-to-users.md#unassign-a-credential-from-a-user) existing credentials, [suspending](../../../capability-guides/access-systems/user-management/suspending-and-unsuspending-users.md#suspend-an-acs-user) and [unsuspending](../../../capability-guides/access-systems/user-management/suspending-and-unsuspending-users.md#unsuspend-an-acs-user) ACS users, [updating ACS users](../../../capability-guides/access-systems/user-management.md#update-a-user) and [credentials](https://docs.seam.co/latest/api/acs/credentials/update), and [deleting ACS users](../../../capability-guides/access-systems/user-management.md#delete-a-user) and [credentials](../managing-credentials.md#delete-a-credential). @@ -81,7 +81,7 @@ The following process describes the configuration steps for your application to * Set of entrances to which this credential grants access * Start and end date and time during which this credential grants access - Depending on the access method and specific ACS, your application can also configure additional credential properties. For more information about manufacturer-specific variations, see the [system integration guide](../../../device-and-system-integration-guides/overview.md#access-control-systems) for your ACS. + Depending on the access method and specific ACS, your application can also configure additional credential properties. For more information about manufacturer-specific variations, see the [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems) for your ACS. You can also perform other management actions, as needed, such as [assigning](../assigning-credentials-to-users.md#assign-a-credential-to-a-user) and [unassigning](../assigning-credentials-to-users.md#unassign-a-credential-from-a-user) existing credentials, [suspending](../../../capability-guides/access-systems/user-management/suspending-and-unsuspending-users.md#suspend-an-acs-user) and [unsuspending](../../../capability-guides/access-systems/user-management/suspending-and-unsuspending-users.md#unsuspend-an-acs-user) ACS users, [updating ACS users](../../../capability-guides/access-systems/user-management.md#update-a-user) and [credentials](https://docs.seam.co/latest/api/acs/credentials/update), and [deleting ACS users](../../../capability-guides/access-systems/user-management.md#delete-a-user) and [credentials](../managing-credentials.md#delete-a-credential). @@ -89,4 +89,4 @@ You can also perform other management actions, as needed, such as [assigning](.. ## Next Steps -To learn about the manufacturer-specific variations for ACSs, see the corresponding [system integration guides](../../../device-and-system-integration-guides/overview.md#access-control-systems). +To learn about the manufacturer-specific variations for ACSs, see the corresponding [system integration guides](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). diff --git a/docs/guides/capability-guides/access-systems/managing-credentials.md b/docs/guides/capability-guides/access-systems/managing-credentials.md index 2cdece4fb..ac62c2d86 100644 --- a/docs/guides/capability-guides/access-systems/managing-credentials.md +++ b/docs/guides/capability-guides/access-systems/managing-credentials.md @@ -33,7 +33,7 @@ Depending on the ACS and the type of credential you are issuing, you can also sp * Manufacturer-specific data. {% hint style="info" %} -Make sure to note any manufacturer-specific metadata and restrictions. For details, see the applicable [device or system integration guide](../../device-and-system-integration-guides/overview.md). +Make sure to note any manufacturer-specific metadata and restrictions. For details, see the applicable [device or system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides). {% endhint %} The response includes the `acs_credential_id` of the newly-created credential, the `acs_user_id` associated with the credential, and additional attributes of the credential. @@ -197,7 +197,7 @@ seam.CredentialsAcs.Create( ### Create a Card-based Credential -To create a plastic key card-based credential, set the `access_method` to `card`. Once you've created a credential, some access control systems require you to encode the card with the credential. To learn whether your ACS requires card encoding, see the [system integration guide](../../device-and-system-integration-guides/overview.md#access-control-systems) for your ACS. For card encoding instructions, see [Creating and Encoding Card-based Credentials](working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials.md). +To create a plastic key card-based credential, set the `access_method` to `card`. Once you've created a credential, some access control systems require you to encode the card with the credential. To learn whether your ACS requires card encoding, see the [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems) for your ACS. For card encoding instructions, see [Creating and Encoding Card-based Credentials](working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials.md). {% tabs %} {% tab title="Python" %} @@ -345,14 +345,14 @@ seam.CredentialsAcs.Create( ### Create a Seam Mobile Key -Depending on the ACS for which you want to create a credential, you may also need to include system-specific metadata. See the [system integration guide](../../device-and-system-integration-guides/overview.md#access-control-systems) for your ACS. For more information about mobile access and issuing mobile credentials, see [Mobile Access](../mobile-access/) and [Issuing Mobile Credentials from an Access Control System](../mobile-access/issuing-mobile-credentials-from-an-access-control-system.md). +Depending on the ACS for which you want to create a credential, you may also need to include system-specific metadata. See the [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems) for your ACS. For more information about mobile access and issuing mobile credentials, see [Mobile Access](../mobile-access/) and [Issuing Mobile Credentials from an Access Control System](../mobile-access/issuing-mobile-credentials-from-an-access-control-system.md). {% tabs %} {% tab title="Python" %} **Request:** {% hint style="info" %} -This request contains manufacturer-specific metadata that may vary by [manufacturer](../../device-and-system-integration-guides/overview.md#access-control-systems). +This request contains manufacturer-specific metadata that may vary by [manufacturer](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). {% endhint %} ```python @@ -374,7 +374,7 @@ seam.acs.credentials.create( **Response:** {% hint style="info" %} -This response contains manufacturer-specific metadata that may vary by [manufacturer](../../device-and-system-integration-guides/overview.md#access-control-systems). +This response contains manufacturer-specific metadata that may vary by [manufacturer](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). {% endhint %} ``` @@ -392,7 +392,7 @@ AcsCredential( **Request:** {% hint style="info" %} -This request contains manufacturer-specific metadata that may vary by [manufacturer](../../device-and-system-integration-guides/overview.md#access-control-systems). +This request contains manufacturer-specific metadata that may vary by [manufacturer](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). {% endhint %} ```bash @@ -419,7 +419,7 @@ curl -X 'POST' \ **Response:** {% hint style="info" %} -This response contains manufacturer-specific metadata that may vary by [manufacturer](../../device-and-system-integration-guides/overview.md#access-control-systems). +This response contains manufacturer-specific metadata that may vary by [manufacturer](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). {% endhint %} ```json @@ -440,7 +440,7 @@ This response contains manufacturer-specific metadata that may vary by [manufact **Request:** {% hint style="info" %} -This request contains manufacturer-specific metadata that may vary by [manufacturer](../../device-and-system-integration-guides/overview.md#access-control-systems). +This request contains manufacturer-specific metadata that may vary by [manufacturer](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). {% endhint %} ```javascript @@ -462,7 +462,7 @@ await seam.acs.credentials.create({ **Response:** {% hint style="info" %} -This response contains manufacturer-specific metadata that may vary by [manufacturer](../../device-and-system-integration-guides/overview.md#access-control-systems). +This response contains manufacturer-specific metadata that may vary by [manufacturer](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). {% endhint %} ```json @@ -494,7 +494,7 @@ This response contains manufacturer-specific metadata that may vary by [manufact **Request:** {% hint style="info" %} -This request contains manufacturer-specific metadata that may vary by [manufacturer](../../device-and-system-integration-guides/overview.md#access-control-systems). +This request contains manufacturer-specific metadata that may vary by [manufacturer](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). {% endhint %} ```php @@ -516,7 +516,7 @@ $seam->acs->credentials->create( **Response:** {% hint style="info" %} -This response contains manufacturer-specific metadata that may vary by [manufacturer](../../device-and-system-integration-guides/overview.md#access-control-systems). +This response contains manufacturer-specific metadata that may vary by [manufacturer](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). {% endhint %} ```json @@ -534,7 +534,7 @@ This response contains manufacturer-specific metadata that may vary by [manufact **Request:** {% hint style="info" %} -This request contains manufacturer-specific metadata that may vary by [manufacturer](../../device-and-system-integration-guides/overview.md#access-control-systems). +This request contains manufacturer-specific metadata that may vary by [manufacturer](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). {% endhint %} ```csharp @@ -557,7 +557,7 @@ seam.CredentialsAcs.Create( **Response:** {% hint style="info" %} -This response contains manufacturer-specific metadata that may vary by [manufacturer](../../device-and-system-integration-guides/overview.md#access-control-systems). +This response contains manufacturer-specific metadata that may vary by [manufacturer](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). {% endhint %} ```json @@ -598,7 +598,7 @@ seam.acs.credentials.list( **Response:** {% hint style="info" %} -This response contains manufacturer-specific metadata that may vary by [manufacturer](../../device-and-system-integration-guides/overview.md#access-control-systems). +This response contains manufacturer-specific metadata that may vary by [manufacturer](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). {% endhint %} ``` @@ -631,7 +631,7 @@ curl -X 'GET' \ **Response:** {% hint style="info" %} -This response contains manufacturer-specific metadata that may vary by [manufacturer](../../device-and-system-integration-guides/overview.md#access-control-systems). +This response contains manufacturer-specific metadata that may vary by [manufacturer](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). {% endhint %} ```json @@ -661,7 +661,7 @@ await seam.acs.credentials.list({ **Response:** {% hint style="info" %} -This response contains manufacturer-specific metadata that may vary by [manufacturer](../../device-and-system-integration-guides/overview.md#access-control-systems). +This response contains manufacturer-specific metadata that may vary by [manufacturer](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). {% endhint %} ```json @@ -702,7 +702,7 @@ $seam->acs->credentials->list( **Response:** {% hint style="info" %} -This response contains manufacturer-specific metadata that may vary by [manufacturer](../../device-and-system-integration-guides/overview.md#access-control-systems). +This response contains manufacturer-specific metadata that may vary by [manufacturer](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). {% endhint %} ```json @@ -729,7 +729,7 @@ seam.CredentialsAcs.List( **Response:** {% hint style="info" %} -This response contains manufacturer-specific metadata that may vary by [manufacturer](../../device-and-system-integration-guides/overview.md#access-control-systems). +This response contains manufacturer-specific metadata that may vary by [manufacturer](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). {% endhint %} ```json @@ -763,7 +763,7 @@ seam.acs.credentials.list( **Response:** {% hint style="info" %} -This response contains manufacturer-specific metadata that may vary by [manufacturer](../../device-and-system-integration-guides/overview.md#access-control-systems). +This response contains manufacturer-specific metadata that may vary by [manufacturer](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). {% endhint %} ``` @@ -796,7 +796,7 @@ curl -X 'GET' \ **Response:** {% hint style="info" %} -This response contains manufacturer-specific metadata that may vary by [manufacturer](../../device-and-system-integration-guides/overview.md#access-control-systems). +This response contains manufacturer-specific metadata that may vary by [manufacturer](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). {% endhint %} ```json @@ -826,7 +826,7 @@ await seam.acs.credentials.list({ **Response:** {% hint style="info" %} -This response contains manufacturer-specific metadata that may vary by [manufacturer](../../device-and-system-integration-guides/overview.md#access-control-systems). +This response contains manufacturer-specific metadata that may vary by [manufacturer](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). {% endhint %} ```json @@ -867,7 +867,7 @@ $seam->acs->credentials->list( **Response:** {% hint style="info" %} -This response contains manufacturer-specific metadata that may vary by [manufacturer](../../device-and-system-integration-guides/overview.md#access-control-systems). +This response contains manufacturer-specific metadata that may vary by [manufacturer](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). {% endhint %} ```json @@ -894,7 +894,7 @@ seam.CredentialsAcs.List( **Response:** {% hint style="info" %} -This response contains manufacturer-specific metadata that may vary by [manufacturer](../../device-and-system-integration-guides/overview.md#access-control-systems). +This response contains manufacturer-specific metadata that may vary by [manufacturer](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). {% endhint %} ```json @@ -930,7 +930,7 @@ seam.acs.credentials.get( **Response:** {% hint style="info" %} -This response contains manufacturer-specific metadata that may vary by [manufacturer](../../device-and-system-integration-guides/overview.md#access-control-systems). +This response contains manufacturer-specific metadata that may vary by [manufacturer](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). {% endhint %} ``` @@ -960,7 +960,7 @@ curl -X 'POST' \ **Response:** {% hint style="info" %} -This response contains manufacturer-specific metadata that may vary by [manufacturer](../../device-and-system-integration-guides/overview.md#access-control-systems). +This response contains manufacturer-specific metadata that may vary by [manufacturer](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). {% endhint %} ```json @@ -989,7 +989,7 @@ await seam.acs.credentials.get({ **Response:** {% hint style="info" %} -This response contains manufacturer-specific metadata that may vary by [manufacturer](../../device-and-system-integration-guides/overview.md#access-control-systems). +This response contains manufacturer-specific metadata that may vary by [manufacturer](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). {% endhint %} ```json @@ -1029,7 +1029,7 @@ $seam->acs->credentials->get( **Response:** {% hint style="info" %} -This response contains manufacturer-specific metadata that may vary by [manufacturer](../../device-and-system-integration-guides/overview.md#access-control-systems). +This response contains manufacturer-specific metadata that may vary by [manufacturer](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). {% endhint %} ``` @@ -1055,7 +1055,7 @@ seam.CredentialsAcs.Get( **Response:** {% hint style="info" %} -This response contains manufacturer-specific metadata that may vary by [manufacturer](../../device-and-system-integration-guides/overview.md#access-control-systems). +This response contains manufacturer-specific metadata that may vary by [manufacturer](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). {% endhint %} ``` diff --git a/docs/guides/capability-guides/access-systems/managing-credentials/listing-credentials-and-associated-entrances.md b/docs/guides/capability-guides/access-systems/managing-credentials/listing-credentials-and-associated-entrances.md index f3c600712..b285828a1 100644 --- a/docs/guides/capability-guides/access-systems/managing-credentials/listing-credentials-and-associated-entrances.md +++ b/docs/guides/capability-guides/access-systems/managing-credentials/listing-credentials-and-associated-entrances.md @@ -25,7 +25,7 @@ seam.acs.credentials.list_accessible_entrances( **Response:** {% hint style="info" %} -This response contains manufacturer-specific metadata that may vary by [manufacturer](../../../device-and-system-integration-guides/overview.md#access-control-systems). +This response contains manufacturer-specific metadata that may vary by [manufacturer](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). {% endhint %} ``` @@ -59,7 +59,7 @@ curl -X 'GET' \ **Response:** {% hint style="info" %} -This response contains manufacturer-specific metadata that may vary by [manufacturer](../../../device-and-system-integration-guides/overview.md#access-control-systems). +This response contains manufacturer-specific metadata that may vary by [manufacturer](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). {% endhint %} ```json @@ -90,7 +90,7 @@ await seam.acs.credentials.listAccessibleEntrances({ **Response:** {% hint style="info" %} -This response contains manufacturer-specific metadata that may vary by [manufacturer](../../../device-and-system-integration-guides/overview.md#access-control-systems). +This response contains manufacturer-specific metadata that may vary by [manufacturer](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). {% endhint %} ```json @@ -132,7 +132,7 @@ $seam->acs->credentials->list_accessible_entrances( **Response:** {% hint style="info" %} -This response contains manufacturer-specific metadata that may vary by [manufacturer](../../../device-and-system-integration-guides/overview.md#access-control-systems). +This response contains manufacturer-specific metadata that may vary by [manufacturer](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). {% endhint %} ```json @@ -160,7 +160,7 @@ seam.CredentialsAcs.ListAccessibleEntrances( **Response:** {% hint style="info" %} -This response contains manufacturer-specific metadata that may vary by [manufacturer](../../../device-and-system-integration-guides/overview.md#access-control-systems). +This response contains manufacturer-specific metadata that may vary by [manufacturer](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). {% endhint %} ```json diff --git a/docs/guides/capability-guides/access-systems/retrieving-entrance-details.md b/docs/guides/capability-guides/access-systems/retrieving-entrance-details.md index bcd8bed5a..78a7fce74 100644 --- a/docs/guides/capability-guides/access-systems/retrieving-entrance-details.md +++ b/docs/guides/capability-guides/access-systems/retrieving-entrance-details.md @@ -12,7 +12,7 @@ In an ACS, an entrance is a secured door, gate, zone, or other method of entry. ## List All Entrances -You can [list all `acs_entrance` resources](https://docs.seam.co/latest/api/acs/entrances/list) in your workspace. Note that entrance details include manufacturer-specific metadata that may vary by [manufacturer](../../device-and-system-integration-guides/overview.md#access-control-systems). +You can [list all `acs_entrance` resources](https://docs.seam.co/latest/api/acs/entrances/list) in your workspace. Note that entrance details include manufacturer-specific metadata that may vary by [manufacturer](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). {% tabs %} {% tab title="Python" %} @@ -159,7 +159,7 @@ seam.EntrancesAcs.List(); ## List Entrances in an ACS -To list all `acs_entrance`s in a specific ACS, include the `acs_system_id` filter in the [List Entrances](https://docs.seam.co/latest/api/acs/entrances/list) request. Note that entrance details include manufacturer-specific metadata that may vary by [manufacturer](../../device-and-system-integration-guides/overview.md#access-control-systems). +To list all `acs_entrance`s in a specific ACS, include the `acs_system_id` filter in the [List Entrances](https://docs.seam.co/latest/api/acs/entrances/list) request. Note that entrance details include manufacturer-specific metadata that may vary by [manufacturer](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). {% tabs %} {% tab title="Python" %} @@ -331,7 +331,7 @@ seam.acs.entrances.list_credentials_with_access( **Response:** {% hint style="info" %} -This response contains manufacturer-specific metadata that may vary by [manufacturer](../../device-and-system-integration-guides/overview.md#access-control-systems). +This response contains manufacturer-specific metadata that may vary by [manufacturer](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). {% endhint %} ``` @@ -368,7 +368,7 @@ curl -X 'GET' \ **Response:** {% hint style="info" %} -This response contains manufacturer-specific metadata that may vary by [manufacturer](../../device-and-system-integration-guides/overview.md#access-control-systems). +This response contains manufacturer-specific metadata that may vary by [manufacturer](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). {% endhint %} ```json @@ -402,7 +402,7 @@ await seam.acs.entrances.list_credentials_with_access({ **Response:** {% hint style="info" %} -This response contains manufacturer-specific metadata that may vary by [manufacturer](../../device-and-system-integration-guides/overview.md#access-control-systems). +This response contains manufacturer-specific metadata that may vary by [manufacturer](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). {% endhint %} ```json @@ -447,7 +447,7 @@ $seam->acs->entrances->list_credentials_with_access( **Response:** {% hint style="info" %} -This response contains manufacturer-specific metadata that may vary by [manufacturer](../../device-and-system-integration-guides/overview.md#access-control-systems). +This response contains manufacturer-specific metadata that may vary by [manufacturer](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). {% endhint %} ```json @@ -478,7 +478,7 @@ seam.EntrancesAcs.ListCredentialsWithAccess( **Response:** {% hint style="info" %} -This response contains manufacturer-specific metadata that may vary by [manufacturer](../../device-and-system-integration-guides/overview.md#access-control-systems). +This response contains manufacturer-specific metadata that may vary by [manufacturer](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). {% endhint %} ```json @@ -509,7 +509,7 @@ To [list the entrances to which a specific credential grants access](https://doc ## Get an Entrance -You can [get the details of a specific `acs_entrance`](https://docs.seam.co/latest/api/acs/entrances/get). Note that entrance details include manufacturer-specific metadata that may vary by [manufacturer](../../device-and-system-integration-guides/overview.md#access-control-systems). +You can [get the details of a specific `acs_entrance`](https://docs.seam.co/latest/api/acs/entrances/get). Note that entrance details include manufacturer-specific metadata that may vary by [manufacturer](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). {% tabs %} {% tab title="Python" %} diff --git a/docs/guides/capability-guides/access-systems/troubleshooting-your-access-control-system.md b/docs/guides/capability-guides/access-systems/troubleshooting-your-access-control-system.md index 6088c04e9..3230cdd68 100644 --- a/docs/guides/capability-guides/access-systems/troubleshooting-your-access-control-system.md +++ b/docs/guides/capability-guides/access-systems/troubleshooting-your-access-control-system.md @@ -24,11 +24,11 @@ To troubleshoot this error: ### `acs_system.errors.visionline_instance_unreachable` -This error indicates that your Seam Bridge is functioning correctly and the Seam API can communicate with your Seam Bridge, but the Seam API cannot connect to your on-premises [Visionline ACS](../../device-and-system-integration-guides/assa-abloy-visionline-access-control-system/). For example, the IP address of the on-premises ACS may be set incorrectly within your Seam workspace. +This error indicates that your Seam Bridge is functioning correctly and the Seam API can communicate with your Seam Bridge, but the Seam API cannot connect to your on-premises [Visionline ACS](https://docs.seam.co/latest/device-and-system-integration-guides/assa-abloy-visionline-access-control-system). For example, the IP address of the on-premises ACS may be set incorrectly within your Seam workspace. To troubleshoot this error: -* Reconnect your on-premises ACS to correct the IP address configuration. To reconnect, you can go to **Access Systems** in the [Seam Console](https://console.seam.co/) or use a [Connect Webview](https://docs.seam.co/latest/api/connect_webviews/). See the setup instructions within the [system integration guide](../../device-and-system-integration-guides/overview.md#access-control-systems) for your on-premises ACS. +* Reconnect your on-premises ACS to correct the IP address configuration. To reconnect, you can go to **Access Systems** in the [Seam Console](https://console.seam.co/) or use a [Connect Webview](https://docs.seam.co/latest/api/connect_webviews/). See the setup instructions within the [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems) for your on-premises ACS. * Make sure that your on-premises ACS is running correctly. *** diff --git a/docs/guides/capability-guides/access-systems/user-management.md b/docs/guides/capability-guides/access-systems/user-management.md index 43b9c7544..1a9716ef3 100644 --- a/docs/guides/capability-guides/access-systems/user-management.md +++ b/docs/guides/capability-guides/access-systems/user-management.md @@ -6,7 +6,7 @@ description: >- # Managing ACS Users -An ACS user typically refers to an individual who requires access, like an employee or resident. Each user can possess multiple credentials that serve as their keys or identifiers for access. The type of credential can vary widely. For example, in the [Salto](../../device-and-system-integration-guides/salto-locks.md) system, a user can have a PIN code, a mobile app account, and a fob. In other platforms, it is not uncommon for a user to have more than one of the same credential type, such as multiple key cards. Additionally, these credentials can have a schedule or validity period. +An ACS user typically refers to an individual who requires access, like an employee or resident. Each user can possess multiple credentials that serve as their keys or identifiers for access. The type of credential can vary widely. For example, in the [Salto](https://docs.seam.co/latest/device-and-system-integration-guides/salto-locks) system, a user can have a PIN code, a mobile app account, and a fob. In other platforms, it is not uncommon for a user to have more than one of the same credential type, such as multiple key cards. Additionally, these credentials can have a schedule or validity period. This guide explains how to create and manage ACS users. Using the [Access Control Systems API](https://docs.seam.co/latest/api/acs/), you can automate issuing access to long-term tenants or visitors. diff --git a/docs/guides/capability-guides/access-systems/user-management/assigning-users-to-access-groups.md b/docs/guides/capability-guides/access-systems/user-management/assigning-users-to-access-groups.md index 38993a20b..13ec15f53 100644 --- a/docs/guides/capability-guides/access-systems/user-management/assigning-users-to-access-groups.md +++ b/docs/guides/capability-guides/access-systems/user-management/assigning-users-to-access-groups.md @@ -9,7 +9,7 @@ description: >- Some ACSs use access groups, which are sets of ACS users, combined with sets of permissions. These permissions include both the set of areas or assets that the ACS users can access and the schedule during which the users can access these areas or assets. Instead of assigning access rights individually to each ACS user, which can be time-consuming and error-prone, administrators can assign users to an access group, thereby ensuring that the users inherit all the permissions associated with the access group. Using access groups streamlines the process of managing large numbers of ACS users, especially in bigger organizations or complexes. {% hint style="info" %} -To learn whether your ACS supports access groups, see the [system integration guide](../../../device-and-system-integration-guides/overview.md#access-control-systems) for your ACS. +To learn whether your ACS supports access groups, see the [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems) for your ACS. {% endhint %} This guide explains how to grant access permissions to ACS users by adding them to the appropriate access groups. diff --git a/docs/guides/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials.md b/docs/guides/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials.md index e60b6126d..c70d1cb5c 100644 --- a/docs/guides/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials.md +++ b/docs/guides/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials.md @@ -13,7 +13,7 @@ Some access control systems require encoding a plastic card with the data necess This process consists of the following basic steps: 1. Set up an [access system user](../../../capability-guides/access-systems/user-management.md) and create a [credential](../managing-credentials.md#create-a-card-based-credential) with the `access_method` set to `card`.\ - See the [system integration guide](../../../device-and-system-integration-guides/overview.md#access-control-systems) for your access system provider to learn specific requirements, such as configuring entrances and access schedules.\ + See the [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems) for your access system provider to learn specific requirements, such as configuring entrances and access schedules.\ See [Set Up an Access System User and Card Credential](creating-and-encoding-card-based-credentials.md#id-1.-set-up-an-access-syseuser-and-card-credential). 2. Use the `/acs/encoders/list` endpoint to retrieve a list of available encoders. Then, choose the encoder that you want to use to write the credential onto the card.\ See [Retrieve Encoders](creating-and-encoding-card-based-credentials.md#id-2.-retrieve-encoders). @@ -31,7 +31,7 @@ Once you have written a credential to a card, you cannot reuse the credential fo This example shows how to create an access system user and card-based credential. Note that the `is_issued` property of the resulting credential is `false`, which means that the credential is ready to be written to a card and has not yet been used to encode a card. {% hint style="info" %} -Depending on your specific access control system, creating an access system user or credential may require additional parameters. For details, see the [system integration guide](../../../device-and-system-integration-guides/overview.md#access-control-systems) for your access system. +Depending on your specific access control system, creating an access system user or credential may require additional parameters. For details, see the [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems) for your access system. {% endhint %} {% tabs %} diff --git a/docs/guides/capability-guides/instant-keys/setting-up-your-site-for-instant-keys.md b/docs/guides/capability-guides/instant-keys/setting-up-your-site-for-instant-keys.md index e17cbab4d..07a2789a1 100644 --- a/docs/guides/capability-guides/instant-keys/setting-up-your-site-for-instant-keys.md +++ b/docs/guides/capability-guides/instant-keys/setting-up-your-site-for-instant-keys.md @@ -98,4 +98,4 @@ For on-premises access systems, such as Salto Space and Visionline, Seam offers
Seam Bridge

Seam Bridge

-For detailed connection instructions, see the [system integration guide](../../device-and-system-integration-guides/overview.md#access-control-systems) for your access system. +For detailed connection instructions, see the [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems) for your access system. diff --git a/docs/guides/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system.md b/docs/guides/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system.md index 488217e76..14d000fa3 100644 --- a/docs/guides/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system.md +++ b/docs/guides/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system.md @@ -29,7 +29,7 @@ To issue mobile credentials, you must configure a multi-phone sync credential. T Seam configures the card details that you include in the request across all the credentials that it creates for each phone. Include only common card details, such as the [facility code](https://www.idwholesaler.com/learning-center/26-bit-proximity-card/), and omit any unique card details, such as the card number. For more information about specific card properties, see the user guide for the access control system or credential manager. {% hint style="info" %} -The code samples in this section contain manufacturer-specific metadata that may vary by ACS. For details, see the [system integration guide](../../device-and-system-integration-guides/overview.md#access-control-systems) for your ACS. +The code samples in this section contain manufacturer-specific metadata that may vary by ACS. For details, see the [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems) for your ACS. {% endhint %} {% tabs %} diff --git a/docs/guides/capability-guides/mobile-access/mobile-access-setup.md b/docs/guides/capability-guides/mobile-access/mobile-access-setup.md index 743d24c8d..53d595a1d 100644 --- a/docs/guides/capability-guides/mobile-access/mobile-access-setup.md +++ b/docs/guides/capability-guides/mobile-access/mobile-access-setup.md @@ -9,11 +9,11 @@ description: >- To use the [Seam mobile access](./) solution, you must first set up the following components: * **An access control system that is compatible with your chosen mobile access solution**\ - Obtain the account login information for your access control system (ACS). See the [brand-specific ACS guide](../../device-and-system-integration-guides/overview.md#access-control-systems) for instructions on where to find this information. In addition, verify that your ACS is compatible with the mobile technology that you intend to implement, such as Apple Wallet. It may be necessary to upgrade your system to support these technologies. Further, you may need to register for developer access with the ACS that you have chosen to use. + Obtain the account login information for your access control system (ACS). See the [brand-specific ACS guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems) for instructions on where to find this information. In addition, verify that your ACS is compatible with the mobile technology that you intend to implement, such as Apple Wallet. It may be necessary to upgrade your system to support these technologies. Further, you may need to register for developer access with the ACS that you have chosen to use. * **A credential manager account that is appropriate for the installed access hardware**\ Depending on the make and model of your lock or access hardware, you may need to set up a credential manager account for issuing mobile credentials for your brand of lock. The credential manager is responsible for issuing mobile credentials and keeping track of which mobile credentials have been issued to which mobile devices. Often, the mobile credentials that the credential manager generates need to be imported into the access control system, before they can be used to grant access. * **Access hardware that is configured with the appropriate settings**\ - Certain makes and models of lock hardware may require you to configure specific encryption keys on the access hardware to enable mobile access. See the appropriate [device guides](../../device-and-system-integration-guides/overview.md#smart-locks) for detailed instructions related to these requirements. + Certain makes and models of lock hardware may require you to configure specific encryption keys on the access hardware to enable mobile access. See the appropriate [device guides](https://docs.seam.co/latest/device-and-system-integration-guides#smart-locks) for detailed instructions related to these requirements. *** @@ -23,8 +23,8 @@ To set up your Seam workspace to use the Seam mobile access solution: 1. **Connect your ACS account to Seam using a** [**Connect Webview**](../../core-concepts/connect-webviews/) - This step requires the account information for your ACS account. For more information, see the [guide](../../device-and-system-integration-guides/overview.md#access-control-systems) for your specific ACS brand. + This step requires the account information for your ACS account. For more information, see the [guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems) for your specific ACS brand. 2. **Connect your credential manager account to Seam using a Connect Webview**\ - This step requires the account information for your credential manager account. For more information, see the corresponding [guide](../../device-and-system-integration-guides/overview.md#access-control-systems) for your credential manager type. + This step requires the account information for your credential manager account. For more information, see the corresponding [guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems) for your credential manager type. 3. **Configure any workspace settings required**\ - Some integrations require certain workspace-wide settings to be configured. For more information, see the [guide](../../device-and-system-integration-guides/overview.md#access-control-systems) for your specific ACS brand. + Some integrations require certain workspace-wide settings to be configured. For more information, see the [guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems) for your specific ACS brand. diff --git a/docs/guides/capability-guides/mobile-access/mobile-device-sdks/initializing-the-seam-mobile-sdk.md b/docs/guides/capability-guides/mobile-access/mobile-device-sdks/initializing-the-seam-mobile-sdk.md index 187c5ede8..b069ac5ca 100644 --- a/docs/guides/capability-guides/mobile-access/mobile-device-sdks/initializing-the-seam-mobile-sdk.md +++ b/docs/guides/capability-guides/mobile-access/mobile-device-sdks/initializing-the-seam-mobile-sdk.md @@ -211,7 +211,7 @@ Note the following manufacturer- and OS-specific requirements: ### Manufacturer-Specific Requirements -See the [device or system integration guide](../../../device-and-system-integration-guides/overview.md#access-control-systems) for the access control system or device for which you are planning to develop. Further, you may need to register for developer access with the ACS that you have chosen to use. +See the [device or system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems) for the access control system or device for which you are planning to develop. Further, you may need to register for developer access with the ACS that you have chosen to use. *** diff --git a/docs/guides/capability-guides/seam-bridge.md b/docs/guides/capability-guides/seam-bridge.md index f4ddf4bfb..3102edd43 100644 --- a/docs/guides/capability-guides/seam-bridge.md +++ b/docs/guides/capability-guides/seam-bridge.md @@ -22,7 +22,7 @@ It is important to understand the difference between Seam Bridge and smart lock Download the Seam Bridge application onto an on-premises computer. Then, pair Seam Bridge with your Seam [workspace](../core-concepts/workspaces/) and connect the on-premises access system to Seam. You install and pair Seam Bridge while you are connecting your on-premises access system to Seam. That is, the [Connect Webview](../core-concepts/connect-webviews/) that you use to connect your on-premises access system to Seam walks you through the process of downloading and pairing Seam Bridge. -For detailed information, see the setup instructions within the [system integration guide](../device-and-system-integration-guides/overview.md#access-control-systems) for your on-premises access system. +For detailed information, see the setup instructions within the [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems) for your on-premises access system. *** @@ -56,4 +56,4 @@ The Seam Bridge app also displays communication errors at the top of the window. ## Next Steps -Go to the setup instructions within the [system integration guide](../device-and-system-integration-guides/overview.md#access-control-systems) for your on-premises access system. These instructions describe how to pair Seam Bridge with your workspace and then connect your on-premises access system to Seam through Seam Bridge. +Go to the setup instructions within the [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems) for your on-premises access system. These instructions describe how to pair Seam Bridge with your workspace and then connect your on-premises access system to Seam through Seam Bridge. 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 3573cafe0..28eb7e1d6 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-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. +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](https://docs.seam.co/latest/device-and-system-integration-guides/igloohome-locks), [dormakaba Oracode locks](https://docs.seam.co/latest/device-and-system-integration-guides/dormakaba-oracode-locks), and [Lockly locks](https://docs.seam.co/latest/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-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/) +* [igloohome Locks device guide](https://docs.seam.co/latest/device-and-system-integration-guides/igloohome-locks) +* [dormakaba Oracode Locks device guide](https://docs.seam.co/latest/device-and-system-integration-guides/dormakaba-oracode-locks) +* [Lockly Locks device guide](https://docs.seam.co/latest/device-and-system-integration-guides/lockly-locks) #### Time-Bound Offline Access 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. +For [igloohome locks](https://docs.seam.co/latest/device-and-system-integration-guides/igloohome-locks) and [dormakaba Oracode locks](https://docs.seam.co/latest/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](https://docs.seam.co/latest/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-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. +For [igloohome locks](https://docs.seam.co/latest/device-and-system-integration-guides/igloohome-locks) and [Lockly locks](https://docs.seam.co/latest/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/creating-access-codes/understanding-code-constraints.md b/docs/guides/capability-guides/smart-locks/access-codes/creating-access-codes/understanding-code-constraints.md index c585302f2..11403c989 100644 --- a/docs/guides/capability-guides/smart-locks/access-codes/creating-access-codes/understanding-code-constraints.md +++ b/docs/guides/capability-guides/smart-locks/access-codes/creating-access-codes/understanding-code-constraints.md @@ -22,7 +22,7 @@ Some device providers require you to configure the device's timezone before crea **Providers requiring timezone configuration:** -* **Ultraloq** — Must configure timezone using `/devices/report_provider_metadata` before creating time-bound access codes. See [Configuring Ultraloq Device Timezones](../../../../device-and-system-integration-guides/ultraloq-locks/configuring-ultraloq-device-timezones.md). +* **Ultraloq** — Must configure timezone using `/devices/report_provider_metadata` before creating time-bound access codes. See [Configuring Ultraloq Device Timezones](https://docs.seam.co/latest/device-and-system-integration-guides/ultraloq-locks/configuring-ultraloq-device-timezones). {% hint style="info" %} Permanent access codes (codes without `starts_at` and `ends_at`) do not require timezone configuration, even on providers that require it for time-bound codes. 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 4fece4bf7..039c76026 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-and-system-integration-guides/igloohome-locks/) -* [Kwikset](../../../device-and-system-integration-guides/kwikset-locks.md) -* [SmartThings](../../../device-and-system-integration-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md) +* [igloohome](https://docs.seam.co/latest/device-and-system-integration-guides/igloohome-locks) +* [Kwikset](https://docs.seam.co/latest/device-and-system-integration-guides/kwikset-locks) +* [SmartThings](https://docs.seam.co/latest/device-and-system-integration-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks) 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/smart-locks/access-codes/offline-access-codes.md b/docs/guides/capability-guides/smart-locks/access-codes/offline-access-codes.md index f1be8811f..7d1db083f 100644 --- a/docs/guides/capability-guides/smart-locks/access-codes/offline-access-codes.md +++ b/docs/guides/capability-guides/smart-locks/access-codes/offline-access-codes.md @@ -10,9 +10,9 @@ description: >- This guide explains how to create [offline access (PIN) codes](./#offline-access-codes) for smart locks that support these types of codes. Use the [Access Codes](https://docs.seam.co/latest/api/access_codes/) API to generate a [time-bound](./#time-bound-offline-access-codes) or [one-time-use](./#one-time-use-offline-access-codes) offline access code. Note that Seam support for offline access code functions varies depending on the device manufacturer. For details, see the corresponding device guide. -* [igloohome Locks device guide](../../../device-and-system-integration-guides/igloohome-locks/creating-igloohome-offline-access-codes.md) -* [dormakaba Oracode Locks device guide](../../../device-and-system-integration-guides/dormakaba-oracode-locks/creating-dormakaba-oracode-offline-access-codes.md) -* [Lockly Locks device guide](../../../device-and-system-integration-guides/lockly-locks/creating-lockly-offline-access-codes.md) +* [igloohome Locks device guide](https://docs.seam.co/latest/device-and-system-integration-guides/igloohome-locks/creating-igloohome-offline-access-codes) +* [dormakaba Oracode Locks device guide](https://docs.seam.co/latest/device-and-system-integration-guides/dormakaba-oracode-locks/creating-dormakaba-oracode-offline-access-codes) +* [Lockly Locks device guide](https://docs.seam.co/latest/device-and-system-integration-guides/lockly-locks/creating-lockly-offline-access-codes) {% hint style="info" %} For information about online access codes, see [Managing Access Codes](./). @@ -35,9 +35,9 @@ It is imperative to understand all manufacturer- and device-specific behaviors a For details, see the corresponding device guide. Also, [get the lock](https://docs.seam.co/latest/api/devices/get) and view any manufacturer-specific properties. -* [igloohome Locks device guide](../../../device-and-system-integration-guides/igloohome-locks/creating-igloohome-offline-access-codes.md) -* [dormakaba Oracode Locks device guide](../../../device-and-system-integration-guides/dormakaba-oracode-locks/creating-dormakaba-oracode-offline-access-codes.md) -* [Lockly Locks device guide](../../../device-and-system-integration-guides/lockly-locks/creating-lockly-offline-access-codes.md) +* [igloohome Locks device guide](https://docs.seam.co/latest/device-and-system-integration-guides/igloohome-locks/creating-igloohome-offline-access-codes) +* [dormakaba Oracode Locks device guide](https://docs.seam.co/latest/device-and-system-integration-guides/dormakaba-oracode-locks/creating-dormakaba-oracode-offline-access-codes) +* [Lockly Locks device guide](https://docs.seam.co/latest/device-and-system-integration-guides/lockly-locks/creating-lockly-offline-access-codes) *** @@ -177,10 +177,10 @@ seam.Devices.Get(deviceId: "11111111-1111-1111-1111-444444444444"); ## Creating Time-Bound Offline Access Codes -For [Lockly locks](../../../device-and-system-integration-guides/lockly-locks/creating-lockly-offline-access-codes.md), you can create time-bound offline access codes that define a validity period using `starts_at` and `ends_at` timestamps. For [igloohome locks](../../../device-and-system-integration-guides/igloohome-locks/creating-igloohome-offline-access-codes.md) and [dormakaba Oracode locks](../../../device-and-system-integration-guides/dormakaba-oracode-locks/creating-dormakaba-oracode-offline-access-codes.md), you can create time-bound offline access codes with validity durations at either the hour level or the day level. +For [Lockly locks](https://docs.seam.co/latest/device-and-system-integration-guides/lockly-locks/creating-lockly-offline-access-codes), you can create time-bound offline access codes that define a validity period using `starts_at` and `ends_at` timestamps. For [igloohome locks](https://docs.seam.co/latest/device-and-system-integration-guides/igloohome-locks/creating-igloohome-offline-access-codes) and [dormakaba Oracode locks](https://docs.seam.co/latest/device-and-system-integration-guides/dormakaba-oracode-locks/creating-dormakaba-oracode-offline-access-codes), you can create time-bound offline access codes with validity durations at either the hour level or the day level. {% hint style="info" %} -Make sure to learn any manufacturer-specific behavior and restrictions regarding time-bound offline access codes. For details, see the corresponding [device guide](../../../device-and-system-integration-guides/overview.md#smart-locks). +Make sure to learn any manufacturer-specific behavior and restrictions regarding time-bound offline access codes. For details, see the corresponding [device guide](https://docs.seam.co/latest/device-and-system-integration-guides#smart-locks). {% endhint %} To create a time-bound offline access code, first issue a creation request. Then, poll or use a webhook to confirm that the code was registered successfully in the device manufacturer's offline access code server. @@ -472,7 +472,7 @@ There are two methods to verify that an time-bound offline access code has been ## Creating One-Time-Use Offline Access Codes -For [igloohome locks](../../../device-and-system-integration-guides/igloohome-locks/creating-igloohome-offline-access-codes.md) and [Lockly locks](../../../device-and-system-integration-guides/lockly-locks/creating-lockly-offline-access-codes.md), you can create one-time-use offline access codes. These codes expire after a single use. To confirm whether your device supports one-time-use offline access codes and to learn any manufacturer- and device-specific restrictions, see the corresponding [device guide](../../../device-and-system-integration-guides/overview.md#smart-locks). +For [igloohome locks](https://docs.seam.co/latest/device-and-system-integration-guides/igloohome-locks/creating-igloohome-offline-access-codes) and [Lockly locks](https://docs.seam.co/latest/device-and-system-integration-guides/lockly-locks/creating-lockly-offline-access-codes), you can create one-time-use offline access codes. These codes expire after a single use. To confirm whether your device supports one-time-use offline access codes and to learn any manufacturer- and device-specific restrictions, see the corresponding [device guide](https://docs.seam.co/latest/device-and-system-integration-guides#smart-locks). To create a one-time-use offline access code, first issue a creation request. In this request, set `is_offline_access_code` and `is_one_time_use` to `true`, and specify the desired `starts_at` and `ends_at` timestamps, as applicable for your device. Then, poll or use a webhook to confirm that the code was registered successfully in the offline access code server that the device manufacturer maintains. 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 eb8b58f3a..4240c521c 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-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` | +| [2N](https://docs.seam.co/latest/device-and-system-integration-guides/2n-intercom-systems) | `my_2n` | +| [4SUITES](https://docs.seam.co/latest/device-and-system-integration-guides/4suites-locks) | `four_suites` | +| [Akiles](https://docs.seam.co/latest/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-and-system-integration-guides/avigilon-alta-access-system.md) | `avigilon_alta` | -| [Brivo](../../device-and-system-integration-guides/brivo-access/) | `brivo` | -| [ControlByWeb](../../device-and-system-integration-guides/get-started-with-controlbyweb-devices.md) | `controlbyweb` | +| [ASSA ABLOY Credential Service](https://docs.seam.co/latest/device-and-system-integration-guides/assa-abloy-vingcard-credential-services) | `assa_abloy_credential_service` | +| [ASSA ABLOY Visionline Access Control System](https://docs.seam.co/latest/device-and-system-integration-guides/assa-abloy-visionline-access-control-system) | `visionline` | +| [August Home](https://docs.seam.co/latest/device-and-system-integration-guides/august-locks) | `august` | +| [Avigilon Alta](https://docs.seam.co/latest/device-and-system-integration-guides/avigilon-alta-access-system) | `avigilon_alta` | +| [Brivo](https://docs.seam.co/latest/device-and-system-integration-guides/brivo-access) | `brivo` | +| [ControlByWeb](https://docs.seam.co/latest/device-and-system-integration-guides/get-started-with-controlbyweb-devices) | `controlbyweb` | | [DoorKing](https://www.doorking.com/) | `doorking` | -| [Dormakaba Community](../../device-and-system-integration-guides/dormakaba-community-access-control-system/) | `dormakaba_community` | -| [Dormakaba Oracode](../../device-and-system-integration-guides/dormakaba-oracode-locks/) | `dormakaba_oracode` | -| [ecobee](../../device-and-system-integration-guides/ecobee-thermostats.md) | `ecobee` | +| [Dormakaba Community](https://docs.seam.co/latest/device-and-system-integration-guides/dormakaba-community-access-control-system) | `dormakaba_community` | +| [Dormakaba Oracode](https://docs.seam.co/latest/device-and-system-integration-guides/dormakaba-oracode-locks) | `dormakaba_oracode` | +| [ecobee](https://docs.seam.co/latest/device-and-system-integration-guides/ecobee-thermostats) | `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-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` | +| [Honeywell Resideo](https://docs.seam.co/latest/device-and-system-integration-guides/honeywell-thermostats) | `honeywell_resideo` | +| [igloohome](https://docs.seam.co/latest/device-and-system-integration-guides/igloohome-locks) | `igloohome` | +| [Kwikset](https://docs.seam.co/latest/device-and-system-integration-guides/kwikset-locks) | `kwikset` | +| [Latch](https://docs.seam.co/latest/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-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-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-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-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` | +| [Lockly](https://docs.seam.co/latest/device-and-system-integration-guides/lockly-locks) | `lockly` | +| [Minut](https://docs.seam.co/latest/device-and-system-integration-guides/minut-sensors) | `minut` | +| [Nest](https://docs.seam.co/latest/device-and-system-integration-guides/google-nest-thermostats) | `google_nest` | +| [NoiseAware](https://docs.seam.co/latest/device-and-system-integration-guides/noiseaware-sensors) | `noiseaware` | +| [Nuki](https://docs.seam.co/latest/device-and-system-integration-guides/nuki-locks) | `nuki` | +| [PTI Storlogix Cloud](https://docs.seam.co/latest/device-and-system-integration-guides/pti-storlogix-cloud) | `pti` | +| [Salto KS Access System](https://docs.seam.co/latest/device-and-system-integration-guides/salto-ks-access-control-system) | `salto_ks` | +| [Salto KS Locks](https://docs.seam.co/latest/device-and-system-integration-guides/salto-locks) | `salto_ks` | +| [Salto ProAccess Space Access System](https://docs.seam.co/latest/device-and-system-integration-guides/salto-proaccess-space-access-system) | `salto_space` | +| [Schlage](https://docs.seam.co/latest/device-and-system-integration-guides/schlage-locks) | `schlage` | +| [Sensi](https://docs.seam.co/latest/device-and-system-integration-guides/sensi-thermostats) | `sensi` | +| [SmartThings](https://docs.seam.co/latest/device-and-system-integration-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks) | `smartthings` | +| [Tedee](https://docs.seam.co/latest/device-and-system-integration-guides/tedee-locks) | `tedee` | +| [TTLock](https://docs.seam.co/latest/device-and-system-integration-guides/ttlock-locks) | `ttlock` | +| [Wyze](https://docs.seam.co/latest/device-and-system-integration-guides/wyze-locks) | `wyze` | +| [Yale](https://docs.seam.co/latest/device-and-system-integration-guides/yale-locks) | `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/developer-tools/mobile-sdks/README.md b/docs/guides/developer-tools/mobile-sdks/README.md index 373a52b58..cea39ba8b 100644 --- a/docs/guides/developer-tools/mobile-sdks/README.md +++ b/docs/guides/developer-tools/mobile-sdks/README.md @@ -1,6 +1,6 @@ # Mobile SDKs -Our mobile device helper libraries (also known as Mobile device SDKs) help you create native applications for Apple’s and Android’s devices and platforms. These SDKs simplify integration with various mobile access providers and streamline your development process through a single unified interface. With a broad range of functionalities, they allow you to build a fully custom experience for your users. Further, these universal mobile SDKs are compatible with a [wide variety of IoT devices and access systems](../../device-and-system-integration-guides/overview.md). +Our mobile device helper libraries (also known as Mobile device SDKs) help you create native applications for Apple’s and Android’s devices and platforms. These SDKs simplify integration with various mobile access providers and streamline your development process through a single unified interface. With a broad range of functionalities, they allow you to build a fully custom experience for your users. Further, these universal mobile SDKs are compatible with a [wide variety of IoT devices and access systems](https://docs.seam.co/latest/device-and-system-integration-guides).
Seam Android SDKAndroid SDK
Seam iOS SDKiOS SDK
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 115b166ed..165ea67ce 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](../../device-and-system-integration-guides/2n-intercom-systems/README.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](https://docs.seam.co/latest/device-and-system-integration-guides/2n-intercom-systems) to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): ## Account Credentials diff --git a/docs/guides/developer-tools/sandbox-and-sample-data/4suites-locks-sample-data.md b/docs/guides/developer-tools/sandbox-and-sample-data/4suites-locks-sample-data.md index 8ce5592f5..0e7e5e397 100644 --- a/docs/guides/developer-tools/sandbox-and-sample-data/4suites-locks-sample-data.md +++ b/docs/guides/developer-tools/sandbox-and-sample-data/4suites-locks-sample-data.md @@ -1,6 +1,6 @@ # Sandbox 4SUITES Locks -Use either of the following sets of credentials to add virtual [4SUITES locks](../../device-and-system-integration-guides/4suites-locks/) to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): +Use either of the following sets of credentials to add virtual [4SUITES locks](https://docs.seam.co/latest/device-and-system-integration-guides/4suites-locks) to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): | Email Address | Password | | --------------------------------------------------------------- | -------- | diff --git a/docs/guides/developer-tools/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 index fbfb2bbeb..e6c8bb77d 100644 --- a/docs/guides/developer-tools/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 @@ -1,9 +1,9 @@ # Sandbox Assa Abloy Visionline Access Control System -Use the following set of credentials to add virtual [ASSA ABLOY Visionline Access Control System](../../device-and-system-integration-guides/assa-abloy-visionline-access-control-system/)-connected devices to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): +Use the following set of credentials to add virtual [ASSA ABLOY Visionline Access Control System](https://docs.seam.co/latest/device-and-system-integration-guides/assa-abloy-visionline-access-control-system)-connected devices to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): {% hint style="info" %} -To use the virtual Vostio Access System to issue mobile keys in a sandbox workspace, you must also connect a [virtual ASSA ABLOY Credential Services](../../device-and-system-integration-guides/assa-abloy-vingcard-credential-services.md). +To use the virtual Vostio Access System to issue mobile keys in a sandbox workspace, you must also connect a [virtual ASSA ABLOY Credential Services](https://docs.seam.co/latest/device-and-system-integration-guides/assa-abloy-vingcard-credential-services). {% endhint %} ## Sandbox Seam Bridge Connection Credentials diff --git a/docs/guides/developer-tools/sandbox-and-sample-data/august-locks-sample-data.md b/docs/guides/developer-tools/sandbox-and-sample-data/august-locks-sample-data.md index 8ee87d9b5..0c772201f 100644 --- a/docs/guides/developer-tools/sandbox-and-sample-data/august-locks-sample-data.md +++ b/docs/guides/developer-tools/sandbox-and-sample-data/august-locks-sample-data.md @@ -1,6 +1,6 @@ # Sandbox August Locks -Use any of the following sets of credentials to add virtual [August locks](../../device-and-system-integration-guides/august-locks.md) to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): +Use any of the following sets of credentials to add virtual [August locks](https://docs.seam.co/latest/device-and-system-integration-guides/august-locks) to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces):
Device RegionEmail AddressPasswordTwo Factor or Verification Code
North America or Othersjane@example.com1234123456
North America or Othersjohn@example.com1234123456
North America or Otherssam@example.com1234123456
North America or Othersfrodo@example.com1234123456
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 edf032686..a76aba525 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](../../device-and-system-integration-guides/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](https://docs.seam.co/latest/device-and-system-integration-guides/avigilon-alta-access-system)-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/brivo-access-sample-data.md b/docs/guides/developer-tools/sandbox-and-sample-data/brivo-access-sample-data.md index ed0c9e463..6485412e7 100644 --- a/docs/guides/developer-tools/sandbox-and-sample-data/brivo-access-sample-data.md +++ b/docs/guides/developer-tools/sandbox-and-sample-data/brivo-access-sample-data.md @@ -1,6 +1,6 @@ # Sandbox Brivo Access -Use the following set of credentials to add virtual [Brivo Access](../../device-and-system-integration-guides/brivo-access/)-connected devices to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): +Use the following set of credentials to add virtual [Brivo Access](https://docs.seam.co/latest/device-and-system-integration-guides/brivo-access)-connected devices to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): | Brivo Access API Key | Username | 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 491221039..df556c9a2 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](../../device-and-system-integration-guides/dormakaba-oracode-locks/README.md) to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): +Use the following set of credentials to add virtual [Dormakaba Oracode locks](https://docs.seam.co/latest/device-and-system-integration-guides/dormakaba-oracode-locks) 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 7792ae3c8..60e9ef49e 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](../../device-and-system-integration-guides/ecobee-thermostats.md) to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): +Use the following set of credentials to add virtual [ecobee thermostats](https://docs.seam.co/latest/device-and-system-integration-guides/ecobee-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/google-nest-thermostats-sample-data.md b/docs/guides/developer-tools/sandbox-and-sample-data/google-nest-thermostats-sample-data.md index 7ca427334..8b16ebb6f 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](../../device-and-system-integration-guides/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](https://docs.seam.co/latest/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/igloohome-sample-data.md b/docs/guides/developer-tools/sandbox-and-sample-data/igloohome-sample-data.md index 979afc901..b3048c7c5 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](../../device-and-system-integration-guides/igloohome-locks/README.md) to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): +Use the following set of credentials to add virtual [igloohome locks](https://docs.seam.co/latest/device-and-system-integration-guides/igloohome-locks) to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): | Email Address | Password | | --------------------------------------------------------------- | -------- | diff --git a/docs/guides/developer-tools/sandbox-and-sample-data/kwikset-locks-sample-data.md b/docs/guides/developer-tools/sandbox-and-sample-data/kwikset-locks-sample-data.md index 328d2fa38..33fd3ab40 100644 --- a/docs/guides/developer-tools/sandbox-and-sample-data/kwikset-locks-sample-data.md +++ b/docs/guides/developer-tools/sandbox-and-sample-data/kwikset-locks-sample-data.md @@ -1,6 +1,6 @@ # Sandbox Kwikset Locks -Use the following set of credentials to add virtual [Kwikset locks](../../device-and-system-integration-guides/kwikset-locks.md) to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): +Use the following set of credentials to add virtual [Kwikset locks](https://docs.seam.co/latest/device-and-system-integration-guides/kwikset-locks) to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): | Email Address | Password | | --------------------------------------------------------------- | -------- | diff --git a/docs/guides/developer-tools/sandbox-and-sample-data/lockly-lock-sample-data.md b/docs/guides/developer-tools/sandbox-and-sample-data/lockly-lock-sample-data.md index ad6c76e25..1b1f3f856 100644 --- a/docs/guides/developer-tools/sandbox-and-sample-data/lockly-lock-sample-data.md +++ b/docs/guides/developer-tools/sandbox-and-sample-data/lockly-lock-sample-data.md @@ -1,6 +1,6 @@ # Sandbox Lockly Locks -Use the following set of credentials to add virtual [Lockly locks](../../device-and-system-integration-guides/lockly-locks/) to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): +Use the following set of credentials to add virtual [Lockly locks](https://docs.seam.co/latest/device-and-system-integration-guides/lockly-locks) to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): | Field | Value | | ---------------------- | ---------------- | 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 6fb7fd2b3..f6ce9d63b 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](../../device-and-system-integration-guides/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](https://docs.seam.co/latest/device-and-system-integration-guides/minut-sensors) to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): | Email Address | Password | | --------------------------------------------------------------- | -------- | diff --git a/docs/guides/developer-tools/sandbox-and-sample-data/noiseaware-sample-data.md b/docs/guides/developer-tools/sandbox-and-sample-data/noiseaware-sample-data.md index 738193d5e..502f7b344 100644 --- a/docs/guides/developer-tools/sandbox-and-sample-data/noiseaware-sample-data.md +++ b/docs/guides/developer-tools/sandbox-and-sample-data/noiseaware-sample-data.md @@ -1,6 +1,6 @@ # NoiseAware Sensors Sample Data -Use either of the following sets of credentials to add virtual [NoiseAware sensors](../../device-and-system-integration-guides/noiseaware-sensors.md) to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): +Use either of the following sets of credentials to add virtual [NoiseAware sensors](https://docs.seam.co/latest/device-and-system-integration-guides/noiseaware-sensors) 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 1d51eef38..dba57d924 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](../../device-and-system-integration-guides/nuki-locks.md) to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): +Use the following set of credentials to add virtual [Nuki locks](https://docs.seam.co/latest/device-and-system-integration-guides/nuki-locks) 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 a5d82fcce..adbb7eeee 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](../../device-and-system-integration-guides/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](https://docs.seam.co/latest/device-and-system-integration-guides/pti-storlogix-cloud)-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/sandbox-akiles-locks.md b/docs/guides/developer-tools/sandbox-and-sample-data/sandbox-akiles-locks.md index a5bafa69c..b383673c3 100644 --- a/docs/guides/developer-tools/sandbox-and-sample-data/sandbox-akiles-locks.md +++ b/docs/guides/developer-tools/sandbox-and-sample-data/sandbox-akiles-locks.md @@ -1,6 +1,6 @@ # Sandbox Akiles Locks -Use the following set of credentials to add virtual [Akiles locks](../../device-and-system-integration-guides/akiles-locks/) to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): +Use the following set of credentials to add virtual [Akiles locks](https://docs.seam.co/latest/device-and-system-integration-guides/akiles-locks) to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): | Email Address | Password | | ---------------- | -------- | 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 37a3dfd92..7aabd7576 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 @@ -5,7 +5,7 @@ noIndex: true # Sandbox ASSA ABLOY Vingcard Credential Services -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): +Use the following set of credentials to add virtual [ASSA ABLOY Credential Services](https://docs.seam.co/latest/device-and-system-integration-guides/assa-abloy-vingcard-credential-services) 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](assa-abloy-visionline-access-management-system-sample-data.md) to issue mobile keys in a sandbox workspace. diff --git a/docs/guides/developer-tools/sandbox-and-sample-data/sandbox-assa-abloy-vostio-access-control-system.md b/docs/guides/developer-tools/sandbox-and-sample-data/sandbox-assa-abloy-vostio-access-control-system.md index 67aa0b690..0d27312d9 100644 --- a/docs/guides/developer-tools/sandbox-and-sample-data/sandbox-assa-abloy-vostio-access-control-system.md +++ b/docs/guides/developer-tools/sandbox-and-sample-data/sandbox-assa-abloy-vostio-access-control-system.md @@ -3,7 +3,7 @@ Use the following set of credentials to add virtual Assa Abloy Vingcard Vostio locks to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): {% hint style="info" %} -To use the virtual Visionline Access Control System (ACS) to issue mobile keys in a sandbox workspace, you must also connect the [virtual ASSA ABLOY Credential Services](../../device-and-system-integration-guides/assa-abloy-vingcard-credential-services.md). +To use the virtual Visionline Access Control System (ACS) to issue mobile keys in a sandbox workspace, you must also connect the [virtual ASSA ABLOY Credential Services](https://docs.seam.co/latest/device-and-system-integration-guides/assa-abloy-vingcard-credential-services). {% endhint %} ## Vostio Credentials diff --git a/docs/guides/developer-tools/sandbox-and-sample-data/sandbox-dormakaba-ambiance-access-control-system.md b/docs/guides/developer-tools/sandbox-and-sample-data/sandbox-dormakaba-ambiance-access-control-system.md index c84b49754..e282fb73c 100644 --- a/docs/guides/developer-tools/sandbox-and-sample-data/sandbox-dormakaba-ambiance-access-control-system.md +++ b/docs/guides/developer-tools/sandbox-and-sample-data/sandbox-dormakaba-ambiance-access-control-system.md @@ -1,6 +1,6 @@ # Sandbox Dormakaba Ambiance Access Control System -Use the following set of credentials to add virtual [Dormakaba Ambiance Access Control System](../../device-and-system-integration-guides/dormakaba-ambiance-access-control-system/)-connected devices to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): +Use the following set of credentials to add virtual [Dormakaba Ambiance Access Control System](https://docs.seam.co/latest/device-and-system-integration-guides/dormakaba-ambiance-access-control-system)-connected devices to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): {% hint style="info" %} To use the virtual Ambiance Access Control System (ACS) to issue mobile keys in a sandbox workspace, you must also connect a LEGIC Connect account. diff --git a/docs/guides/developer-tools/sandbox-and-sample-data/sandbox-dormakaba-community-access-control-system.md b/docs/guides/developer-tools/sandbox-and-sample-data/sandbox-dormakaba-community-access-control-system.md index 225db030e..3ec2e6f4c 100644 --- a/docs/guides/developer-tools/sandbox-and-sample-data/sandbox-dormakaba-community-access-control-system.md +++ b/docs/guides/developer-tools/sandbox-and-sample-data/sandbox-dormakaba-community-access-control-system.md @@ -1,6 +1,6 @@ # Sandbox Dormakaba Community Access Control System -Use the following set of credentials to add virtual [Dormakaba Community Access Control System](../../device-and-system-integration-guides/dormakaba-community-access-control-system/)-connected devices to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): +Use the following set of credentials to add virtual [Dormakaba Community Access Control System](https://docs.seam.co/latest/device-and-system-integration-guides/dormakaba-community-access-control-system)-connected devices to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): {% hint style="info" %} To use the virtual Community Access Control System (ACS) to issue mobile keys in a sandbox workspace, you must also connect a LEGIC Connect account. diff --git a/docs/guides/developer-tools/sandbox-and-sample-data/sandbox-honeywell-thermostats.md b/docs/guides/developer-tools/sandbox-and-sample-data/sandbox-honeywell-thermostats.md index 101d137f1..287f39cf1 100644 --- a/docs/guides/developer-tools/sandbox-and-sample-data/sandbox-honeywell-thermostats.md +++ b/docs/guides/developer-tools/sandbox-and-sample-data/sandbox-honeywell-thermostats.md @@ -1,6 +1,6 @@ # Sandbox Honeywell Resideo Thermostats -Use the following set of credentials to add virtual [Honeywell Resideo thermostats](../../device-and-system-integration-guides/honeywell-thermostats/) to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): +Use the following set of credentials to add virtual [Honeywell Resideo thermostats](https://docs.seam.co/latest/device-and-system-integration-guides/honeywell-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/sandbox-latch-access-control-system.md b/docs/guides/developer-tools/sandbox-and-sample-data/sandbox-latch-access-control-system.md index 70a084d7e..c3dadde8d 100644 --- a/docs/guides/developer-tools/sandbox-and-sample-data/sandbox-latch-access-control-system.md +++ b/docs/guides/developer-tools/sandbox-and-sample-data/sandbox-latch-access-control-system.md @@ -1,6 +1,6 @@ # Sandbox Latch Access Control System -You do not need to specify any credentials to add a virtual [Latch access control system](../../device-and-system-integration-guides/latch-access-control-system/) to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces). +You do not need to specify any credentials to add a virtual [Latch access control system](https://docs.seam.co/latest/device-and-system-integration-guides/latch-access-control-system) to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces). To add a sandbox Latch access control system using the Seam Console: diff --git a/docs/guides/developer-tools/sandbox-and-sample-data/sandbox-salto-ks-access-control-system.md b/docs/guides/developer-tools/sandbox-and-sample-data/sandbox-salto-ks-access-control-system.md index c096a6eba..24afce9e0 100644 --- a/docs/guides/developer-tools/sandbox-and-sample-data/sandbox-salto-ks-access-control-system.md +++ b/docs/guides/developer-tools/sandbox-and-sample-data/sandbox-salto-ks-access-control-system.md @@ -1,6 +1,6 @@ # Sandbox Salto KS Access Control System -Use the following set of credentials to add the virtual [Salto KS access control system](../../device-and-system-integration-guides/salto-ks-access-control-system/) to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): +Use the following set of credentials to add the virtual [Salto KS access control system](https://docs.seam.co/latest/device-and-system-integration-guides/salto-ks-access-control-system) to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): | Email Address | Password | | ---------------- | -------- | diff --git a/docs/guides/developer-tools/sandbox-and-sample-data/sandbox-salto-ks-locks.md b/docs/guides/developer-tools/sandbox-and-sample-data/sandbox-salto-ks-locks.md index f566da4b6..bd003998a 100644 --- a/docs/guides/developer-tools/sandbox-and-sample-data/sandbox-salto-ks-locks.md +++ b/docs/guides/developer-tools/sandbox-and-sample-data/sandbox-salto-ks-locks.md @@ -1,6 +1,6 @@ # Sandbox Salto KS Locks -Use the following set of credentials to add virtual [Salto KS locks](../../device-and-system-integration-guides/salto-locks.md) to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): +Use the following set of credentials to add virtual [Salto KS locks](https://docs.seam.co/latest/device-and-system-integration-guides/salto-locks) to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): | Email Address | Password | | ---------------- | -------- | diff --git a/docs/guides/developer-tools/sandbox-and-sample-data/sandbox-sensi-thermostats.md b/docs/guides/developer-tools/sandbox-and-sample-data/sandbox-sensi-thermostats.md index c6d77dd4b..f0eb5e592 100644 --- a/docs/guides/developer-tools/sandbox-and-sample-data/sandbox-sensi-thermostats.md +++ b/docs/guides/developer-tools/sandbox-and-sample-data/sandbox-sensi-thermostats.md @@ -1,6 +1,6 @@ # Sandbox Sensi Thermostats -Use the following set of credentials to add virtual [Sensi thermostats](../../device-and-system-integration-guides/sensi-thermostats/) to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): +Use the following set of credentials to add virtual [Sensi thermostats](https://docs.seam.co/latest/device-and-system-integration-guides/sensi-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/sandbox-tedee-locks.md b/docs/guides/developer-tools/sandbox-and-sample-data/sandbox-tedee-locks.md index 55d8d3ae3..7f0f26498 100644 --- a/docs/guides/developer-tools/sandbox-and-sample-data/sandbox-tedee-locks.md +++ b/docs/guides/developer-tools/sandbox-and-sample-data/sandbox-tedee-locks.md @@ -1,6 +1,6 @@ # Sandbox Tedee Locks -Use the following set of credentials to add virtual [Tedee locks](../../device-and-system-integration-guides/tedee-locks/) to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): +Use the following set of credentials to add virtual [Tedee locks](https://docs.seam.co/latest/device-and-system-integration-guides/tedee-locks) to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): | Email Address | Password | | ---------------- | -------- | 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 40f03fd88..3dbd638d8 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](../../device-and-system-integration-guides/ttlock-locks.md) to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): +Use the following set of credentials to add virtual [TTLock locks](https://docs.seam.co/latest/device-and-system-integration-guides/ttlock-locks) 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 bcdb05f90..3ad3e5c0e 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](../../device-and-system-integration-guides/wyze-locks.md) to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): +Use the following set of credentials to add virtual [Wyze locks](https://docs.seam.co/latest/device-and-system-integration-guides/wyze-locks) 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 faa958e21..d68bc1e33 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](../../device-and-system-integration-guides/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](https://docs.seam.co/latest/device-and-system-integration-guides/yale-locks) to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): | Email Address | Password | Two Factor Code | | ----------------- | -------- | --------------- | diff --git a/docs/guides/industry-guides/hospitality-industry-guide/setting-up-the-hotel-site.md b/docs/guides/industry-guides/hospitality-industry-guide/setting-up-the-hotel-site.md index 2fc56a006..ed854ddb7 100644 --- a/docs/guides/industry-guides/hospitality-industry-guide/setting-up-the-hotel-site.md +++ b/docs/guides/industry-guides/hospitality-industry-guide/setting-up-the-hotel-site.md @@ -13,11 +13,11 @@ Before you can grant access using Seam, you must first set up the hotel access s Before integrating an access system with Seam, make sure that the system—including hardware and software—supports the capabilities that you want to offer guests in your hotel PMS app. -This section provides an overview of the capabilities and requirements. For more information about each supported access system and for detailed setup instructions, see the corresponding [system integration guide](../../device-and-system-integration-guides/overview.md#access-control-systems). +This section provides an overview of the capabilities and requirements. For more information about each supported access system and for detailed setup instructions, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). ### Supported Capabilities -Before integrating an access system with Seam, it is imperative to understand which access methods the system supports, such as mobile keys and Instant Keys, plastic cards, and PIN codes. Some access systems support a subset of the access methods that you can issue through Seam. For details, see the [system integration guide](../../device-and-system-integration-guides/overview.md#access-control-systems) for the access system. +Before integrating an access system with Seam, it is imperative to understand which access methods the system supports, such as mobile keys and Instant Keys, plastic cards, and PIN codes. Some access systems support a subset of the access methods that you can issue through Seam. For details, see the [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems) for the access system. ### Hotel Access System Requirements @@ -37,7 +37,7 @@ To ensure successful integration with Seam, confirm or configure the following s * For some access systems, you may need to configure communications protocol settings. * You may want to configure any available proximity behavior settings. -For details, see the [system integration guide](../../device-and-system-integration-guides/overview.md#access-control-systems) for the access system. +For details, see the [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems) for the access system. *** From 7d2b5fa3498ace7e103fb0e8801aa536e9e03522 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Louis=20Pr=C3=A9?= Date: Tue, 21 Apr 2026 20:55:00 -0700 Subject: [PATCH 6/8] feat(deps): Bump @seamapi/types to 1.806.0 Includes fix for /overview URLs in ACS resource descriptions. Co-Authored-By: Claude Opus 4.6 (1M context) --- package-lock.json | 8 ++++---- package.json | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/package-lock.json b/package-lock.json index 55828ce74..22548b929 100644 --- a/package-lock.json +++ b/package-lock.json @@ -14,7 +14,7 @@ "@prettier/plugin-ruby": "^4.0.4", "@seamapi/blueprint": "^0.55.0", "@seamapi/smith": "^0.5.2", - "@seamapi/types": "1.805.0", + "@seamapi/types": "^1.806.0", "@types/command-exists": "^1.2.3", "change-case": "^5.4.4", "command-exists": "^1.2.9", @@ -983,9 +983,9 @@ } }, "node_modules/@seamapi/types": { - "version": "1.805.0", - "resolved": "https://registry.npmjs.org/@seamapi/types/-/types-1.805.0.tgz", - "integrity": "sha512-G9STdKRht2qkUAp7jqQdH7U75N1UDUJspt/TnfRVaI0EO1GTWAjGd7NfVm28rsB8rkU9sN2M3fb6TBGUjfwfdA==", + "version": "1.806.0", + "resolved": "https://registry.npmjs.org/@seamapi/types/-/types-1.806.0.tgz", + "integrity": "sha512-2GI6meyqxBYy5gx05FKzNOSQZB9QikcYtotiZie0PwIarFwZvssvjICqfIZnraOuzMOgT2AJEAXph/kp2s0vAg==", "dev": true, "license": "MIT", "engines": { diff --git a/package.json b/package.json index 1af114cd7..d9d85e412 100644 --- a/package.json +++ b/package.json @@ -34,7 +34,7 @@ "@prettier/plugin-ruby": "^4.0.4", "@seamapi/blueprint": "^0.55.0", "@seamapi/smith": "^0.5.2", - "@seamapi/types": "1.805.0", + "@seamapi/types": "^1.806.0", "@types/command-exists": "^1.2.3", "change-case": "^5.4.4", "command-exists": "^1.2.9", From 9394ee9e4abaf92bdd5be8cc7be5121095b6090c Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Wed, 22 Apr 2026 04:05:47 +0000 Subject: [PATCH 7/8] ci: Generate docs --- docs/api-reference/_blueprint.json | 14 +++++++------- docs/api-reference/acs/README.md | 8 ++++---- docs/api-reference/acs/access_groups/README.md | 2 +- docs/api-reference/acs/credentials/create.md | 2 +- docs/api-reference/acs/encoders/README.md | 2 +- docs/api-reference/acs/users/README.md | 2 +- docs/api-reference/workspaces/README.md | 6 +++--- 7 files changed, 18 insertions(+), 18 deletions(-) diff --git a/docs/api-reference/_blueprint.json b/docs/api-reference/_blueprint.json index 3df09e3da..5177b1578 100644 --- a/docs/api-reference/_blueprint.json +++ b/docs/api-reference/_blueprint.json @@ -10675,7 +10675,7 @@ }, { "name": "code", - "description": "Access (PIN) code for the new credential. There may be manufacturer-specific code restrictions. For details, see the applicable [device or system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview).", + "description": "Access (PIN) code for the new credential. There may be manufacturer-specific code restrictions. For details, see the applicable [device or system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides).", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -94875,7 +94875,7 @@ "jsonType": "string" } ], - "description": "Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.\n\nSome access control systems use [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups), which are sets of users, combined with sets of permissions. These permissions include both the set of areas or assets that the users can access and the schedule during which the users can access these areas or assets. Instead of assigning access rights individually to each access control system user, which can be time-consuming and error-prone, administrators can assign users to an access group, thereby ensuring that the users inherit all the permissions associated with the access group. Using access groups streamlines the process of managing large numbers of access control system users, especially in bigger organizations or complexes.\n\nTo learn whether your access control system supports access groups, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems).", + "description": "Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.\n\nSome access control systems use [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups), which are sets of users, combined with sets of permissions. These permissions include both the set of areas or assets that the users can access and the schedule during which the users can access these areas or assets. Instead of assigning access rights individually to each access control system user, which can be time-consuming and error-prone, administrators can assign users to an access group, thereby ensuring that the users inherit all the permissions associated with the access group. Using access groups streamlines the process of managing large numbers of access control system users, especially in bigger organizations or complexes.\n\nTo learn whether your access control system supports access groups, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems).", "isDeprecated": false, "routePath": "/acs/access_groups", "deprecationMessage": "", @@ -96495,7 +96495,7 @@ "jsonType": "string" } ], - "description": "Represents a hardware device that encodes [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) data onto physical cards within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nSome access control systems require credentials to be encoded onto plastic key cards using a card encoder. This process involves the following two key steps:\n\n1. Credential creation\n Configure the access parameters for the credential.\n2. Card encoding\n Write the credential data onto the card using a compatible card encoder.\n\nSeparately, the Seam API also supports card scanning, which enables you to scan and read the encoded data on a card. You can use this action to confirm consistency with access control system records or diagnose discrepancies if needed.\n\nSee [Working with Card Encoders and Scanners](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).\n\nTo verify if your access control system requires a card encoder, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems).", + "description": "Represents a hardware device that encodes [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) data onto physical cards within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nSome access control systems require credentials to be encoded onto plastic key cards using a card encoder. This process involves the following two key steps:\n\n1. Credential creation\n Configure the access parameters for the credential.\n2. Card encoding\n Write the credential data onto the card using a compatible card encoder.\n\nSeparately, the Seam API also supports card scanning, which enables you to scan and read the encoded data on a card. You can use this action to confirm consistency with access control system records or diagnose discrepancies if needed.\n\nSee [Working with Card Encoders and Scanners](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).\n\nTo verify if your access control system requires a card encoder, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems).", "isDeprecated": false, "routePath": "/acs/encoders", "deprecationMessage": "", @@ -100597,7 +100597,7 @@ "jsonType": "string" } ], - "description": "Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nAn access system user typically refers to an individual who requires access, like an employee or resident. Each user can possess multiple credentials that serve as their keys or identifiers for access. The type of credential can vary widely. For example, in the Salto system, a user can have a PIN code, a mobile app account, and a fob. In other platforms, it is not uncommon for a user to have more than one of the same credential type, such as multiple key cards. Additionally, these credentials can have a schedule or validity period.\n\nFor details about how to configure users in your access system, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems).", + "description": "Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nAn access system user typically refers to an individual who requires access, like an employee or resident. Each user can possess multiple credentials that serve as their keys or identifiers for access. The type of credential can vary widely. For example, in the Salto system, a user can have a PIN code, a mobile app account, and a fob. In other platforms, it is not uncommon for a user to have more than one of the same credential type, such as multiple key cards. Additionally, these credentials can have a schedule or validity period.\n\nFor details about how to configure users in your access system, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems).", "isDeprecated": false, "routePath": "/acs/users", "deprecationMessage": "", @@ -100708,7 +100708,7 @@ }, { "name": "acs_access_groups", - "description": "Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.\n\nSome access control systems use [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups), which are sets of users, combined with sets of permissions. These permissions include both the set of areas or assets that the users can access and the schedule during which the users can access these areas or assets. Instead of assigning access rights individually to each access control system user, which can be time-consuming and error-prone, administrators can assign users to an access group, thereby ensuring that the users inherit all the permissions associated with the access group. Using access groups streamlines the process of managing large numbers of access control system users, especially in bigger organizations or complexes.\n\nTo learn whether your access control system supports access groups, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems).", + "description": "Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.\n\nSome access control systems use [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups), which are sets of users, combined with sets of permissions. These permissions include both the set of areas or assets that the users can access and the schedule during which the users can access these areas or assets. Instead of assigning access rights individually to each access control system user, which can be time-consuming and error-prone, administrators can assign users to an access group, thereby ensuring that the users inherit all the permissions associated with the access group. Using access groups streamlines the process of managing large numbers of access control system users, especially in bigger organizations or complexes.\n\nTo learn whether your access control system supports access groups, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -100736,7 +100736,7 @@ }, { "name": "acs_encoders", - "description": "Represents a hardware device that encodes [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) data onto physical cards within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nSome access control systems require credentials to be encoded onto plastic key cards using a card encoder. This process involves the following two key steps:\n\n1. Credential creation\n Configure the access parameters for the credential.\n2. Card encoding\n Write the credential data onto the card using a compatible card encoder.\n\nSeparately, the Seam API also supports card scanning, which enables you to scan and read the encoded data on a card. You can use this action to confirm consistency with access control system records or diagnose discrepancies if needed.\n\nSee [Working with Card Encoders and Scanners](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).\n\nTo verify if your access control system requires a card encoder, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems).", + "description": "Represents a hardware device that encodes [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) data onto physical cards within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nSome access control systems require credentials to be encoded onto plastic key cards using a card encoder. This process involves the following two key steps:\n\n1. Credential creation\n Configure the access parameters for the credential.\n2. Card encoding\n Write the credential data onto the card using a compatible card encoder.\n\nSeparately, the Seam API also supports card scanning, which enables you to scan and read the encoded data on a card. You can use this action to confirm consistency with access control system records or diagnose discrepancies if needed.\n\nSee [Working with Card Encoders and Scanners](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).\n\nTo verify if your access control system requires a card encoder, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -100778,7 +100778,7 @@ }, { "name": "acs_users", - "description": "Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nAn access system user typically refers to an individual who requires access, like an employee or resident. Each user can possess multiple credentials that serve as their keys or identifiers for access. The type of credential can vary widely. For example, in the Salto system, a user can have a PIN code, a mobile app account, and a fob. In other platforms, it is not uncommon for a user to have more than one of the same credential type, such as multiple key cards. Additionally, these credentials can have a schedule or validity period.\n\nFor details about how to configure users in your access system, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems).", + "description": "Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nAn access system user typically refers to an individual who requires access, like an employee or resident. Each user can possess multiple credentials that serve as their keys or identifiers for access. The type of credential can vary widely. For example, in the Salto system, a user can have a PIN code, a mobile app account, and a fob. In other platforms, it is not uncommon for a user to have more than one of the same credential type, such as multiple key cards. Additionally, these credentials can have a schedule or validity period.\n\nFor details about how to configure users in your access system, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, diff --git a/docs/api-reference/acs/README.md b/docs/api-reference/acs/README.md index 063cb87a7..cbca86ed4 100644 --- a/docs/api-reference/acs/README.md +++ b/docs/api-reference/acs/README.md @@ -15,7 +15,7 @@ To grant access using the Seam access control system API, use the following basi 1. Create `acs_user`s. 2. Configure access for these users. - For some access control systems, configure the allowed entrances and access schedule. For other systems, use `acs_access_group`s. For details, see the [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems) for your access control system. + For some access control systems, configure the allowed entrances and access schedule. For other systems, use `acs_access_group`s. For details, see the [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems) for your access control system. 3. Create `acs_credential`s, which are the digital means of granting access to users, such as PIN codes, mobile keys, and plastic (RFID) cards. If you are developing a mobile app to provide access for your users, you can also use [Seam's iOS and Android SDKs](https://docs.seam.co/latest/capability-guides/mobile-access/mobile-device-sdks) that pair with the Seam API to create and manage mobile keys. @@ -28,7 +28,7 @@ Group that defines the entrances to which a set of users has access and, in some Some access control systems use [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups), which are sets of users, combined with sets of permissions. These permissions include both the set of areas or assets that the users can access and the schedule during which the users can access these areas or assets. Instead of assigning access rights individually to each access control system user, which can be time-consuming and error-prone, administrators can assign users to an access group, thereby ensuring that the users inherit all the permissions associated with the access group. Using access groups streamlines the process of managing large numbers of access control system users, especially in bigger organizations or complexes. -To learn whether your access control system supports access groups, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems). +To learn whether your access control system supports access groups, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). --- ### [`acs_credential`](./credentials/README.md#acs_credential) @@ -53,7 +53,7 @@ Separately, the Seam API also supports card scanning, which enables you to scan See [Working with Card Encoders and Scanners](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners). -To verify if your access control system requires a card encoder, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems). +To verify if your access control system requires a card encoder, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). --- ### [`acs_entrance`](./entrances/README.md#acs_entrance) @@ -75,6 +75,6 @@ Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems An access system user typically refers to an individual who requires access, like an employee or resident. Each user can possess multiple credentials that serve as their keys or identifiers for access. The type of credential can vary widely. For example, in the Salto system, a user can have a PIN code, a mobile app account, and a fob. In other platforms, it is not uncommon for a user to have more than one of the same credential type, such as multiple key cards. Additionally, these credentials can have a schedule or validity period. -For details about how to configure users in your access system, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems). +For details about how to configure users in your access system, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). --- diff --git a/docs/api-reference/acs/access_groups/README.md b/docs/api-reference/acs/access_groups/README.md index c7bccf534..e2a017e83 100644 --- a/docs/api-reference/acs/access_groups/README.md +++ b/docs/api-reference/acs/access_groups/README.md @@ -12,7 +12,7 @@ Group that defines the entrances to which a set of users has access and, in some Some access control systems use [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups), which are sets of users, combined with sets of permissions. These permissions include both the set of areas or assets that the users can access and the schedule during which the users can access these areas or assets. Instead of assigning access rights individually to each access control system user, which can be time-consuming and error-prone, administrators can assign users to an access group, thereby ensuring that the users inherit all the permissions associated with the access group. Using access groups streamlines the process of managing large numbers of access control system users, especially in bigger organizations or complexes. -To learn whether your access control system supports access groups, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems). +To learn whether your access control system supports access groups, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). {% tabs %} {% tab title="ACS Access Group" %} diff --git a/docs/api-reference/acs/credentials/create.md b/docs/api-reference/acs/credentials/create.md index 6930faeec..d5ee00268 100644 --- a/docs/api-reference/acs/credentials/create.md +++ b/docs/api-reference/acs/credentials/create.md @@ -363,7 +363,7 @@ Vostio-specific metadata for the new credential. **`code`** *String* -Access (PIN) code for the new credential. There may be manufacturer-specific code restrictions. For details, see the applicable [device or system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview). +Access (PIN) code for the new credential. There may be manufacturer-specific code restrictions. For details, see the applicable [device or system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides). --- diff --git a/docs/api-reference/acs/encoders/README.md b/docs/api-reference/acs/encoders/README.md index a24664ae8..e7d400e43 100644 --- a/docs/api-reference/acs/encoders/README.md +++ b/docs/api-reference/acs/encoders/README.md @@ -20,7 +20,7 @@ Separately, the Seam API also supports card scanning, which enables you to scan See [Working with Card Encoders and Scanners](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners). -To verify if your access control system requires a card encoder, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems). +To verify if your access control system requires a card encoder, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). {% tabs %} {% tab title="ACS Encoder" %} diff --git a/docs/api-reference/acs/users/README.md b/docs/api-reference/acs/users/README.md index 1b9110b6d..b32337a24 100644 --- a/docs/api-reference/acs/users/README.md +++ b/docs/api-reference/acs/users/README.md @@ -13,7 +13,7 @@ Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems An access system user typically refers to an individual who requires access, like an employee or resident. Each user can possess multiple credentials that serve as their keys or identifiers for access. The type of credential can vary widely. For example, in the Salto system, a user can have a PIN code, a mobile app account, and a fob. In other platforms, it is not uncommon for a user to have more than one of the same credential type, such as multiple key cards. Additionally, these credentials can have a schedule or validity period. -For details about how to configure users in your access system, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems). +For details about how to configure users in your access system, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). {% tabs %} {% tab title="ACS User" %} diff --git a/docs/api-reference/workspaces/README.md b/docs/api-reference/workspaces/README.md index bcd04dbbc..778ff6e0f 100644 --- a/docs/api-reference/workspaces/README.md +++ b/docs/api-reference/workspaces/README.md @@ -50,7 +50,7 @@ Group that defines the entrances to which a set of users has access and, in some Some access control systems use [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups), which are sets of users, combined with sets of permissions. These permissions include both the set of areas or assets that the users can access and the schedule during which the users can access these areas or assets. Instead of assigning access rights individually to each access control system user, which can be time-consuming and error-prone, administrators can assign users to an access group, thereby ensuring that the users inherit all the permissions associated with the access group. Using access groups streamlines the process of managing large numbers of access control system users, especially in bigger organizations or complexes. -To learn whether your access control system supports access groups, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems). +To learn whether your access control system supports access groups, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). @@ -85,7 +85,7 @@ Separately, the Seam API also supports card scanning, which enables you to scan See [Working with Card Encoders and Scanners](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners). -To verify if your access control system requires a card encoder, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems). +To verify if your access control system requires a card encoder, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). @@ -122,7 +122,7 @@ Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems An access system user typically refers to an individual who requires access, like an employee or resident. Each user can possess multiple credentials that serve as their keys or identifiers for access. The type of credential can vary widely. For example, in the Salto system, a user can have a PIN code, a mobile app account, and a fob. In other platforms, it is not uncommon for a user to have more than one of the same credential type, such as multiple key cards. Additionally, these credentials can have a schedule or validity period. -For details about how to configure users in your access system, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems). +For details about how to configure users in your access system, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). From cf11cfa329039f212c646e40c9a6af5ecd0107ad Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Louis=20Pr=C3=A9?= Date: Tue, 21 Apr 2026 21:12:49 -0700 Subject: [PATCH 8/8] Fix asset paths in Brand Guides README Assets moved to brand-guides should use .gitbook/assets/ not ../.gitbook/assets/ which resolves outside the section. Co-Authored-By: Claude Opus 4.6 (1M context) --- docs/brand-guides/README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/brand-guides/README.md b/docs/brand-guides/README.md index 471a65466..efafc8c4a 100644 --- a/docs/brand-guides/README.md +++ b/docs/brand-guides/README.md @@ -20,28 +20,28 @@ To find the integration guide for each of your devices or systems, see the follo ## Smart Locks -
2N Intercom Systems2n-logo.png2n-intercom-systems.md
33 Lock Devices33-lock-logo.png33-lock-devices
4SUITES Locks4suites-logo.png4suites-locks
Akiles Locksakiles-logo.pngakiles-locks
August Locksaugust-logo.pngaugust-locks.md
dormakaba Oracode Locksdormakaba-logo.pngdormakaba-oracode-locks.md
iglooHome Locksigloohome-logo.pngigloohome-locks.md
Kwikset Lockskwikset-logo.pngkwikset-locks.md
Lockly Lockslockly-logo.pnglockly-locks
Nuki Locksnuki-logo.pngnuki-locks.md
Salto KS Lockssalto-logo.pngsalto-locks.md
Schlage Locksschlage-logo.pngget-started-with-schlage-locks.md
SmartThings Hubs + Smart Lockssmartthings-logo.pngsmartthings-hubs-+-devices
Tedee Lockstedee-logo.pngtedee-locks
TTLock Locksttlock-logo.pngttlock-locks.md
Wyze Lockswyze-logo.pngwyze-locks.md
Yale Locksyale-logo.pngyale-locks.md
+
2N Intercom Systems2n-logo.png2n-intercom-systems.md
33 Lock Devices33-lock-logo.png33-lock-devices
4SUITES Locks4suites-logo.png4suites-locks
Akiles Locksakiles-logo.pngakiles-locks
August Locksaugust-logo.pngaugust-locks.md
dormakaba Oracode Locksdormakaba-logo.pngdormakaba-oracode-locks.md
iglooHome Locksigloohome-logo.pngigloohome-locks.md
Kwikset Lockskwikset-logo.pngkwikset-locks.md
Lockly Lockslockly-logo.pnglockly-locks
Nuki Locksnuki-logo.pngnuki-locks.md
Salto KS Lockssalto-logo.pngsalto-locks.md
Schlage Locksschlage-logo.pngget-started-with-schlage-locks.md
SmartThings Hubs + Smart Lockssmartthings-logo.pngsmartthings-hubs-+-devices
Tedee Lockstedee-logo.pngtedee-locks
TTLock Locksttlock-logo.pngttlock-locks.md
Wyze Lockswyze-logo.pngwyze-locks.md
Yale Locksyale-logo.pngyale-locks.md
*** ## Access Control Systems -
ASSA ABLOY Credential Servicesassa-abloy-logo.pngBroken link
ASSA ABLOY Visionline Access Control Systemassa-abloy-logo.pngassa-abloy-visionline-access-control-system
Avigilon Alta Access Systemavigilon-alta-logo.pngavigilon-alta-access-system.md
Brivo Accessbrivo-logo.pngbrivo-access
Latch Access Control Systemlatch-logo.pnglatch-access-control-system
PTI Storlogix Cloudpti-logo.pngpti-storlogix-cloud.md
Salto KS Access Control Systemsalto-ks-logo.pngsalto-ks-access-control-system
Salto ProAccess Space Access Systemsalto-space-logo.pngsalto-proaccess-space-access-system
+
ASSA ABLOY Credential Servicesassa-abloy-logo.pngBroken link
ASSA ABLOY Visionline Access Control Systemassa-abloy-logo.pngassa-abloy-visionline-access-control-system
Avigilon Alta Access Systemavigilon-alta-logo.pngavigilon-alta-access-system.md
Brivo Accessbrivo-logo.pngbrivo-access
Latch Access Control Systemlatch-logo.pnglatch-access-control-system
PTI Storlogix Cloudpti-logo.pngpti-storlogix-cloud.md
Salto KS Access Control Systemsalto-ks-logo.pngsalto-ks-access-control-system
Salto ProAccess Space Access Systemsalto-space-logo.pngsalto-proaccess-space-access-system
*** ## Thermostats -
ecobee Thermostatsecobee-logo.pngecobee-thermostats.md
Google Nest Thermostatsnest-logo.pnggoogle-nest-thermostats
Honeywell Resideo Thermostatshoneywell-logo.pnghoneywell-thermostats
Sensi Thermostatssensi-logo.pngsensi-thermostats
SmartThings Hubs + Thermostatssmartthings-logo.pngsmartthings-hubs-+-devices
+
ecobee Thermostatsecobee-logo.pngecobee-thermostats.md
Google Nest Thermostatsnest-logo.pnggoogle-nest-thermostats
Honeywell Resideo Thermostatshoneywell-logo.pnghoneywell-thermostats
Sensi Thermostatssensi-logo.pngsensi-thermostats
SmartThings Hubs + Thermostatssmartthings-logo.pngsmartthings-hubs-+-devices
*** ## Noise sensors -
Minut Sensorsminut-logo.pngminut-sensors.md
NoiseAware Sensorsnoiseaware-logo.pngnoiseaware-sensors.md
+
Minut Sensorsminut-logo.pngminut-sensors.md
NoiseAware Sensorsnoiseaware-logo.pngnoiseaware-sensors.md
*** ## Relays -
ControlByWeb Relayscontrolbyweb-logo.pngget-started-with-controlbyweb-devices.md
+
ControlByWeb Relayscontrolbyweb-logo.pngget-started-with-controlbyweb-devices.md