CoffeeCloud

Configure App

1. Click on Settings [A]

2. Click on Apps [B]

3. Navigate to the CoffeeCloud App [C]

4. Click on [D] ▷ The app frontend opens

5. Paste the .json template below into the Request [E] window

6. ▷ Fill the .json template with correct data

7. Under Endpoint [F], select the /configs option ▷ The Method option appears

8. Under Method [G], select the POST option

9. Click on Send [H]

Under ↗ Assets, assets are created for all devices that are present in your CoffeeCloud account.

All machines within a group are displayed. However, subgroups are not considered.

If you have placed coffee machines in subgroups in your CoffeeCloud account, this structure is NOT adopted in BuildingPro Suites. The machines themselves will, however, appear in BuildingPro Suites.

.json Template

{
    "id": 1,
    "username": "Geben Sie hier Ihren Benutzernamen ein",
    "password": "Gegeb Sie hier Ihr Passwort ein",
    "apiKey": "Geben Sie hier Ihren API Key ein",
    "url": "https://coffeecloud.scanomat.com",
    "enable": true,
    "refreshInterval": 113600,
    "requestTimeout": 120,
    "active" false,
    "tenantIDs": [
        "10"
    ]
}

Generate API Key

To generate the API key, log in to your CoffeeCloud account with your data. The API key can be generated under "Settings."

Generated Asset Types

3 asset types are created:

1. CoffeeCloud

2. CoffeeCloud group

3. CoffeeCloud coffee machine

CoffeeCloud

A root directory for coffee machines

CoffeeCloud group

A group for coffee machines.

CoffeeCloud coffee machine

An asset type for a single coffee machine, including various attributes.

CoffeeCloud Dashboard

The CoffeeCloud App comes with a ↗ Dashboard Template.

Description

The CoffeeCloud Dashboard shows a list of connected CoffeeCloud coffee machines and associated status messages.

Activate Dashboard Template

See ↗ here

Known Limitations

Maximum Update Interval

The API is limited to about 20 to 30 requests per hour. If more requests are made in a period, no data may be sent.

We recommend performing about 1 request per hour.

Only the Root Folder is Considered

If you have placed coffee machines in subfolders in your CoffeeCloud account, these subfolders are NOT adopted in BuildingPro Suites!

However, the machines themselves will appear in BuildingPro Suites.

You can ↗ manually place the machines in folders, if desired.