API token

The API token connects the Helper in the game with your account on foe-helper.com. Without it the Notes do not open and you cannot send a city to the city planner.

Getting the token

  1. Log in on foe-helper.com. No account yet? See Creating an account.

  2. Select the world you need the token for in the world selector at the top. If it is missing, add it in your profile first (Worlds).

  3. Open your Profile (menu with your name at the top right). At the very top it says Api-Token - with the name of the world, and the token below it.

  4. Click into the field – the whole token gets selected – and copy it.

The API token in the profile on foe-helper.com
The API token in the profile on foe-helper.com

The token is the key to your notes and cities of this world – do not share it.

Entering the token

  1. In the game, enter the world the token belongs to.
  2. Open the settings › Info + Website › Website Api-Token.
  3. Paste the token into the field. The Helper saves it immediately.
The API token field in the settings
The API token field in the settings

A valid token has exactly 36 characters. With any other length the Helper reports Error! – "This is not a valid token. Please check your input!" – and saves nothing. Check whether a character went missing while copying or a space was added. Clearing the field deletes the token.

API Token missing

This message appears when you open the Notes or send a city to the city planner without a token entered for this world (also in a settlement). It always appears, even when the Notifications are switched off.

The Notes also need Upload/Send data to foe-helper.com to be active.

See also