{"@context": "https://schema.org", "@type": "WebAPI", "name": "smart-me API", "description": "With the smart-me REST API you get Access to all your devices in the smart-me Cloud and you can add your own devices. So its an easy way to add the smart-me Cloud support to your Hardware or Software Product.", "provider": {"@type": "Organization", "name": "smart-me.com"}, "documentation": "https://smart-me.com/swagger/docs/v1"}
Index / APIs / smart-me.com

smart-me API

With the smart-me REST API you get Access to all your devices in the smart-me Cloud and you can add your own devices. So its an easy way to add the smart-me Cloud support to your Hardware or Software Product.

Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.

Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.

base URLs: https://smart-me.com:443

auth: b a s i c

find it by capability: POST /search {"query":{"text":"..."}} returns these operations with their invocation detail. Connect any agent client.

smart-me vv1

With the smart-me REST API you get Access to all your devices in the smart-me Cloud and you can add your own devices. So its an easy way to add the smart-me Cloud support to your Hardware or Software Product.

methodpathwhat the vendor says it does
PUT/api/AccessTokenCreates a Access Token to write on a Card (e.g. NFC) Creates a Access Token to write on a Card (e.g. NFC) Acce
POST/api/ActionsSet an action for the specified device. Set an action for the specified device. Actions
GET/api/Actions/{id}Gets all available Actions of a Device Gets all available Actions of a Device Actions
GET/api/AdditionalDeviceInformation/{id}Gets the additional information (e.g. Firmware Version) about a device. Gets the additional information (e.g.
GET/api/CustomDeviceGets all Custom Devices Gets all Devices CustomDevice
POST/api/CustomDeviceCreates or updates a Custom Device or updates it's values. Creates or updates a Custom Device or updates it's
GET/api/CustomDevice/{id}Gets a Custom Device by it's ID Gets a Device by it's ID CustomDevice
GET/api/DeviceBySerialGets a Device by it's Serial Number. The Serial is the part before the "-". Gets a Device by it's Serial Numbe
GET/api/DevicesGets all Devices Gets all Devices Devices
POST/api/DevicesCreates or updates a Device or updates it's values. Creates or updates a Device or updates it's values.
GET/api/Devices/{id}Gets a Device by it's ID Gets a Device by it's ID Devices
PUT/api/Devices/{id}Updates the On/Off Switch on a device. For new implementations please use the "actions" command
GET/api/DevicesByEnergyGets all Devices for an Energy Type Gets all Devices for an Energy Type DevicesByEnergy
GET/api/DevicesBySubTypeGets all Devices by it's Sub Type (e.g. E-Charging Station) Gets all Devices by it's Sub Type (e.g. E-Charging
GET/api/FastSendDeviceValues/{id}Force a device to send the data every second (if supported). This for about 30s. Don't use this c
GET/api/Folder/{id}Gets the Values for a folder or a meter Gets the Values for a folder or a meter Folder
GET/api/FolderMenuGets the folder menu items (each item might contain child items) FolderMenu
POST/api/FolderMenuCreates and updates the folder menu items FolderMenu
GET/api/HealthA method returning HTTP 200 OK when queried. It is used by Kubernetes probes to determine whether
POST/api/MBusM-BUS API: Adds data of a M-BUS Meter to the smart-me Cloud. Just send us the M-BUS Telegram (RSP
POST/api/MeterFolderInformationSets the Name of a Meter or a Folder Sets the Name of a Meter or a Folder MeterFolderInformation
GET/api/MeterFolderInformation/{id}Beta: Gets the General Information for a Meter or a Folder Beta: Gets the General Information for a Meter or a
GET/api/MeterValues/{id}Gets the Values for a Meter at a given Date. The first Value found before the given Date is retu
GET/api/RegisterForRealtimeApiGets all registrations for the Realtime API. Gets all registrations for the Realtime API. RegisterForRealtimeA
POST/api/RegisterForRealtimeApiCreates a new registration for the realtime API. The Realtime API sends you the data of the registred devices
DELETE/api/RegisterForRealtimeApi/{id}Deletes a realtime API registration. Deletes a realtime API registration. RegisterForRealtimeApi
POST/api/SmartMeDeviceConfigurationSets the configuration of a smart-me device. The device needs to be online. SmartMeDeviceConfiguration
GET/api/SmartMeDeviceConfiguration/{id}Gets the configuration of a smart-me device. SmartMeDeviceConfiguration
POST/api/SubUserCreates or updates a subuser. To create a new user set no ID (empty) SubUser
GET/api/SubUser/{id}Get a sub user. The user must be assigend to the user that makes this call. SubUser
DELETE/api/SubUser/{id}Delete a subuser SubUser
GET/api/UserGets the informations for the user. Gets the informations for the user. User
DELETE/api/UserTriggers user account deletion. User
GET/api/Values/{id}Gets all (last) values of a device Values
GET/api/ValuesInPast/{id}Gets all (last) values of a device The first Value found before the given Date is returned. Gets
GET/api/ValuesInPastMultiple/{id}Gets multiple values of a device. This call needs a smart-me professional licence. ValuesInPastMultiple
GET/api/VirtualBillingMeterActiveBeta: Gets all active virtual meters Beta: Gets all active virtual meters. VirtualBillingMeterActive
POST/api/VirtualBillingMeterActiveBeta: Virtual Meter API: Activates a Meter and add the Consumption to a Virtual Meter assosiated with the User
POST/api/VirtualBillingMeterDeactivateBeta: Virtual Meter API: Deactivates a Virtual Meter. Beta: Virtual Meter API: Deactivates a Virtual Meter. Vi
GET/api/VirtualBillingMetersBeta: Gets all Meters available to activate as a Virtual Meter. Beta: Gets all Meters available to activate as

and 20 more operation(s) in this specification, all searchable.

specification origin: https://smart-me.com/swagger/docs/v1

nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.