The management console

The management console is where you set up and change your community’s Cofy API. Everything you change there is live within seconds; you never install or restart anything.

Logging in

Open the console’s address and log in with your account at your Cofy host, such as your EnergyID account for the Cofy that EnergyID hosts. Use the email address you were given access with.

If you see no communities after logging in, nobody has given you access yet: ask whoever manages your community, or your Cofy host, to give you access.

Your communities

The first page lists the communities you have access to, with how many modules each has and the status of its API. Click a community to open it.

At the top of a community’s page you find:

• Its API address, with a button to copy it. Apps use this address to reach your community’s data; see connect an app.

• The status of its API:

  Status	What it means
  Live	The API runs your latest saved settings.
  Changes pending	The API still runs the previous settings. Saved changes normally apply within a few seconds; if this stays, the new settings could not be applied: ask your Cofy host.
  Unavailable	The API is not running. Ask your Cofy host.

Below them, a community has these tabs:

Tab	What you do there
Modules	Switch on the modules your community needs, and configure each one
Resources	Configure things several modules share, like a data source or a tariff
Secrets	Store credentials, such as an API key, without showing them again
API tokens	Create the keys other applications use to call your community’s API
Access	Decide who else can manage this community

You only see the tabs you are allowed to use.

Your settings

The button at the top right opens your settings: light or dark appearance, the console’s language, and logging out.

Where to start

1. Read the concepts, to know what modules, sources and resources are.
2. Add your first module.
3. Create an API token for the app that will use it.