Web Services SmartApps

SmartApps may themselves be a web service, exposing a URL and any defined endpoints.

This allows external applications to make web API calls to a SmartApp, and get information about, or control, end devices.

To understand how Web Services SmartApps work, including the security measures in place, read the Web Services SmartApps Overview guide.

For a step-by-step tutorial creating a Web Services SmartApp, read the SmartApp as Web Service tutorial. It’s organized into two parts:

• Building a Web Services SmartApp - Part 1, will walk you through a simple SmartApp that exposes endpoints, and use the simulator and curl to test making API calls to your SmartApp.
• Building a Web Services SmartApp - Part 2 will guide you through the steps an external application would take to integrate with SmartThings.

Contents:

• Web Services SmartApps Overview
  • Introduction
  • Concepts
  • How it Works
    • OAuth-Integrated App Installation Flow
  • The End-User Journey
    • Initiate Connection from External System
    • Authentication & Authorization
    • Application Configuration
  • Rate Limiting
    • Rate Limit Headers
    • Rate Limit HTTP Status Code
• Building a Web Services SmartApp - Part 1
  • Overview
  • Create a new SmartApp
  • Define Preferences
  • Specify Endpoints
  • GET Switch Information
  • UPDATE the Switches
  • Self-publish the SmartApp
  • Run the SmartApp in the Simulator
  • Make API Calls to the SmartApp
  • Uninstall the SmartApp
  • Summary
  • Source Code
• Building a Web Services SmartApp - Part 2
  • Overview
  • Prerequisites
  • Bootstrap the Sinatra App
  • Get an Authorization Code
  • Get an Access Token
  • Discover the Endpoint
  • Make API Calls
  • Summary
  • Source Code
  • Appendix - Just the URLs, Please
    • Get the OAuth Authorization Code
    • Get the API token
    • Discover the Endpoint URL
    • Make API Calls