📘 General Concept – Miele 3rd Party API

The Miele 3rd Party API is a RESTful interface designed to enable integration with Miele smart appliances. It provides access to appliance data and control capabilities through a standardized, generic model.

Authentication & Access

To use the API:

• You need a Miele user account with registered appliances.
• Authentication is handled via OAuth2.
• API credentials can be generated in the "Get Involved" section of the developer portal.

---

Generic Appliance Model

The API uses a generic appliance model, meaning:

• All appliances are represented using a unified schema.
• The response includes all possible capabilities, regardless of whether the physical device supports them.
• Unsupported properties return null.
• Properties without a current value return -32768.

Code sample

GET/devices

Device Overview

Endpoint: GET /devices

Returns a list of registered appliances with detailed metadata and current state.

Device Identification

Endpoint: GET /devices/<deviceId>/ident

Provides detailed identification info for a specific appliance.

Key fields:

• fabNumber: Unique device identifier (also used as deviceId)
• type: Basic appliance type
• techType: Catalog type

Code sample

GET/devices/<deviceId>/ident

Device State

Endpoint: GET /devices/<deviceId>/state

Returns the current state of the appliance.

Code sample

GET/devices/<deviceId>/state

Device Actions

Endpoint: GET /devices/<deviceId>/actions

Returns available actions for a specific appliance.

Code sample

GET/devices/<deviceId>/state

Execute an action:

Endpoint: PUT /devices/<deviceId>/actions

Code sample

PUT/devices/<deviceId>/actions