🔏
API Docs
  • Beam API Docs
  • Overview
    • About Beam
    • API Requirements
    • Roles and Permissions
  • Getting Started
    • Requesting an Account
    • Using RESTful Tools
    • Webhooks
  • The Basics
    • Entities
    • Best Practices
    • Testing Accounts
  • OAuth
    • Overview
    • How to Authorize Access
      • Step 1: Generate Authorization URL
      • Step 2: Handle Authorization Response
      • Step 3: Request an Access Token
      • Step 4: Call API Endpoints
      • Step 5: Refresh the Tokens
  • API Endpoints
    • Overview
    • Get User Devices
    • Toggle Door
    • Invite User (internal)
    • Get Toggle History
    • Get User Info
    • Get User Settings
Powered by GitBook
On this page
  • Security
  • Caching and Querying
  1. Overview

API Requirements

In Beam's world, security is paramount. Therefore, the following requirements must be adhered to strictly:

Security

  • All requests must be made over HTTPS (no exceptions)

  • All requests are governed by OAuth 2.0 access tokens

Caching and Querying

  • Data related to the state of the door may not be cached

  • No long-polling of the service is allowed

PreviousAbout BeamNextRoles and Permissions

Last updated 4 years ago