Skip to content

Latest commit

 

History

History
70 lines (48 loc) · 2.21 KB

API-Authentication.md

File metadata and controls

70 lines (48 loc) · 2.21 KB

Important

As of April 2024, it is strongly recommended to create and use an API Key and ID for compatibility with changes to the Wyze Authentication API (#1163).

Developer API Authentication

A free API Key and API Key ID can be obtained from the developer portal: https://developer-api-console.wyze.com/#/apikey/view

For more information, please see the official documentation on creating an API key.

Docker compose

environment:
    - WYZE_EMAIL=me@email.com
    - WYZE_PASSWORD=myPassword
    - API_ID=My-Unique-KeyID-From-WYZE
    - API_KEY=MySecretApiKeyFromWyze

Docker run

docker run \
  -e WYZE_EMAIL=me@email.com \
  -e WYZE_PASSWORD=myPassword \
  -e API_ID=My-Unique-KeyID-From-WYZE \
  -e API_KEY=MySecretApiKeyFromWyze \
  -p 8554:8554 -p 8888:8888 -p 5000:5000 \
  mrlt8/wyze-bridge

WebUI login

To enter your credentials and API key/ID using the webUI, simply start the container without defining your credentials, and you'll be prompted to enter your credentials through the WebUI:

webui

Token Based Authentication

The bridge can also use an active refresh or access token even if you don't have a developer key.

Tip

You can view your access token by logging into https://my.wyze.com and visiting https://services.wyze.com/api/v2/santa/refresh?tag=webview

Docker compose

environment:
    - REFRESH_TOKEN=myRefreshToken

or 

environment:
    - ACCESS_TOKEN=myAccessToken

Docker run

docker run -e REFRESH_TOKEN=myRefreshToken -p 8554:8554 -p 8888:8888 -p 5000:5000 mrlt8/wyze-bridge

or

docker run -e ACCESS_TOKEN=myAccessToken -p 8554:8554 -p 8888:8888 -p 5000:5000 mrlt8/wyze-bridge

WebUI

Tip

The access token field supports JSON, so you can copy and paste the response from wyze directly into the WebUI and have it parse out the token.

webui