Get Started with API Access Apps
This guide uses concepts from the OAuth 2.0 authorization code flow. If you are new to OAuth, we recommend familiarizing yourself with the OAuth 2.0 specification and authorization flow prior to creating your API Access App. Knowing OAuth basics — like what access tokens are, what a redirect URI does, and how users authorize your app — will help you get started smoothly and avoid common errors.
API Access App plans are coming soon and is not yet available.
API Access is a paid feature. Access requires an account on a qualifying Developer or Business plan. Visit the SmartThings Developer Console to review plan tiers.
A SmartThings API Access App is an application that connects to the SmartThings platform to monitor and control connected devices. Your app authenticates with SmartThings using OAuth 2.0, allowing users to grant your app access to their SmartThings account.
Once connected, your app can:
- Discover devices in a user's SmartThings location
- Read device status such as whether a switch is on or off
- Control devices by sending commands like turning a switch on or off
- Receive real-time events when devices and other resources change state on the SmartThings platform
Before you begin writing code, it is essential to understand the mechanics of how your server will interact with the SmartThings platform.
Up next, Architecture and Authorization Flow will help you explore:
- 🔀 Two-Way Communication: How your app handles incoming webhooks and outgoing API requests.
- 🔐 The OAuth Lifecycle: A step-by-step breakdown of how access and refresh tokens are securely handled.
- ⏱️ The Integration Timeline: A comprehensive sequence timeline mapping the entire lifecycle from installation to event processing.