View on GitHub



The most important principle in the design of Relay is security.

Security is implemented in layers and there are often multiple protections that can be employed, based on your risk tolerance.

Connections to requires HTTPS (secure hypertext transfer protocol) for all connections.

We use the amazing Cloudflare for securing our website and protecting us against malicious traffic.

Connecting simple devices to Relay

For simpler devices like the ESP8266 WiFi Module Relay supports API Key bearer token authorization. For fully featured devices like Raspberry Pis or desktop / laptop computers, you can use interactive OpenID Connect flows that will grant short lived access tokens and longer lived refresh tokens.

Api Keys

You can create an API Key from the top menu in Relay Cloud:

Creating an API Key

API Keys are 50-character random strings created by a cryptographic random-number-generator (RNG).

The crypto-RNG-based creation process makes API Keys extremely hard to guess or brute-force.

API Keys are given restricted access to Relay platform features. At the time of writing, API Keys can be used to grant access to either:

You can read about Custom Properties here.

API Keys are then added to the request from the device:

Authorization: ApiKey abc123def456.....

Connecting Raspberry Pis to Relay Cloud

Devices that can provide both client and server functionality allow for much richer integrations with Relay Cloud.

The client needs to prepare an authorization request that will be sent to Edgecastle’s identity service:

While you can build your own Relay Client the fastest way to get start on a Raspberry Pi is to use the Sample Client.