Authentication

Learn how to authorize your requests to the FUTO Home API


Overview

A few endpoints, such as sign in, need no authentication. Everything else needs either a session token or an API key. Session tokens come from signing in and act as the signed in user. API keys are made for scripts and 3rd party applications, and can be scoped to fine grained permissions.

Credentials

Send one of the values below with each request.

API Keys

To authenticate a request with an API key, include the x-api-key header.

x-api-key: <apiKey>

Alternatively, pass the API key in the apiKey query parameter.

https://<server>/api/users/me?apiKey=<apiKey>