smart-me

OpenAPI apis-guru iot

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.

Homepage: https://api.apis.guru/v2/specs/smart-me.com/v1.json
Provider: smart-me.com
OpenAPI version: 3.0.0
Spec (JSON): https://api.apis.guru/v2/specs/smart-me.com/v1/openapi.json
Spec (YAML): https://api.apis.guru/v2/specs/smart-me.com/v1/openapi.yaml

Tools (66)

Extracted live via the executor SDK.

accessToken.accessTokenPut

Creates a Access Token to write on a Card (e.g. NFC)
account.accountLogin

GET /api/Account/login
account.postApiAccountLogin

POST /api/Account/login
actions.actionsGet

Gets all available Actions of a Device
actions.actionsPost

Set an action for the specified device.
additionalDeviceInformation.additionalDeviceInformationGet

Gets the additional information (e.g. Firmware Version) about a device.
customDevice.customDeviceGet

Gets all Devices
customDevice.customDevicePost

Creates or updates a Custom Device or updates it's values. A Custom Device can be any device that like to add some measurement values to the smart-me Cloud. Only use a custom device for all non meters. For a new device leave the ID empty. To create a device you have to set the DeviceEnergyType. To update values, add the ID of the device and the values you like to set. (See the Data Type Model for more Information)
customDevice.getApiCustomDeviceId

Gets a Device by it's ID
deviceBySerial.deviceBySerialGet

Gets a Device by it's Serial Number. The Serial is the part before the "-".
devices.devicesGet

Gets all Devices
devices.devicesPost

Creates or updates a Device or updates it's values. For a new device leave the ID empty. To create a device you have to set the DeviceEnergyType. To update values, add the ID of the device and the values you like to set. (See the Data Type Model for more Information)
devices.devicesPut

Updates the On/Off Switch on a device For new implementations please use the "actions" command
devices.getApiDevicesId

Gets a Device by it's ID
devicesByEnergy.devicesByEnergyGet

Gets all Devices for an Energy Type
devicesBySubType.devicesBySubTypeGet

Gets all Devices by it's Sub Type (e.g. E-Charging Station)
fastSendDeviceValues.fastSendDeviceValuesGet

Force a device to send the data every second (if supported). This for about 30s. Don't use this call to force a device to send the data every second for a longer time.
folder.folderGet

Gets the Values for a folder or a meter
folderAssign.folderAssignPost

Assign a folder (source) or meter to another folder (target). Can be used to create a folder structure.
folderMenu.folderMenuGet

Gets the folder menu items (each item might contain child items)
folderMenu.folderMenuPost

Creates and updates the folder menu items
folderSettings.folderSettingsDelete

Deletes a folder
folderSettings.folderSettingsGet

Gets the settings of a folder or meter
folderSettings.folderSettingsPost

Add or edit a folder or a meter. To add a new folder use and empty ID
health.healthGet

A method returning HTTP 200 OK when queried. It is used by Kubernetes probes to determine whether the app is healthy.
mBus.mBusPost

M-BUS API: Adds data of a M-BUS Meter to the smart-me Cloud. Just send us the M-BUS Telegram (RSP_UD) and we will do the Rest.
meterFolderInformation.meterFolderInformationGet

Beta: Gets the General Information for a Meter or a Folder
meterFolderInformation.meterFolderInformationPost

Sets the Name of a Meter or a Folder
meterValues.meterValuesGet

Gets the Values for a Meter at a given Date. The first Value found before the given Date is returned.
oAuth.oAuthAuthorize

GET /api/oauth/authorize
oAuth.postApiOauthAuthorize

POST /api/oauth/authorize
pico.picoGet

Gets all pico charging stations for this user
picoCharging.picoChargingGet

Gets the active charging data of a pico station
picoChargingHistory.picoChargingHistoryGet

Gets the last charging history for a pico station
picoEnableFixCableLock.picoEnableFixCableLockPost

Try to fix lock the cable of a pico. The pico must be online and a cable (without car) needs to be connected. Otherwise this will fail.
picoLoadmanagementGroup.getApiPicoLoadmanagementgroup
GET: api/pico/loadmanagementgroup
Returns all available load management groups
picoLoadmanagementGroup.picoLoadmanagementGroupGet
GET: api/pico/loadmanagementgroup
Returns a pico load management group by it's id
picoLoadmanagementSetDynamicCurrent.picoLoadmanagementSetDynamicCurrentPost

Sets the dynamic current of a load management group or a single station.

picoSettings.picoSettingsGet

GET: api/pico/settings

registerForRealtimeApi.registerForRealtimeApiDelete

Deletes a realtime API registration.
registerForRealtimeApi.registerForRealtimeApiGet

Gets all registrations for the Realtime API.
registerForRealtimeApi.registerForRealtimeApiPost

Creates a new registration for the realtime API. The Realtime API sends you the data of the registred devices as soon as we have them on the cloud. More Information about the realtime API:
smartMeDeviceConfiguration.smartMeDeviceConfigurationGet

Gets the configuration of a smart-me device.
smartMeDeviceConfiguration.smartMeDeviceConfigurationPost

Sets the configuration of a smart-me device. The device needs to be online.
subUser.subUserDelete

Delete a subuser
subUser.subUserGet

Get a sub user. The user must be assigend to the user that makes this call.
subUser.subUserPost

Creates or updates a subuser. To create a new user set no ID (empty)
user.userDelete

Triggers user account deletion.
user.userGet

Gets the informations for the user.
userToFolderAssign.userToFolderAssignDelete

Deletes a user to folder assignement
userToFolderAssign.userToFolderAssignPost

Assign a user to a folder
values.valuesGet

Gets all (last) values of a device
valuesInPast.valuesInPastGet

Gets the Values for a device at a given Date. The first Value found before the given Date is returned.
valuesInPastMultiple.valuesInPastMultipleGet

Gets multiple values of a device. This call needs a smart-me professional licence.
virtualBillingMeterActive.virtualBillingMeterActiveGet

Beta: Gets all active virtual meters.
virtualBillingMeterActive.virtualBillingMeterActivePost

Beta: Virtual Meter API: Activates a Meter and add the Consumption to a Virtual Meter assosiated with the User.
virtualBillingMeterDeactivate.virtualBillingMeterDeactivatePost

Beta: Virtual Meter API: Deactivates a Virtual Meter.
virtualBillingMeters.virtualBillingMetersGet

Beta: Gets all Meters available to activate as a Virtual Meter.

virtualMeterCalculateFormula.virtualMeterCalculateFormulaGet

Calculates a virtual meter from a formula.

        A meter is coded as ID("METERID")        Ariphmetical operators:         ()  parentheses;           +   plus (a + b);          -  minus (a - b);          *  multiplycation symbol (a * b);          /  divide symbol (a / b);         Example: (ID("63ac09cb-4e5f-4f3e-bd27-ad8c30bdfc0c") + ID("0209555e-9dc4-4e84-a166-a864488b4b12")) * 2

virtualTariff.getApiVirtualTariffId

Gets all virtual tariffs of a folder
virtualTariff.virtualTariffGet

Gets all Virtual Tariffs of a user
virtualTariffConsumption.virtualTariffConsumptionGet

Gets the consumption of a folder with a virtuall tariffs.
virtualTariffsForProperty.virtualTariffsForPropertyGet

Gets all Virtual Tariffs for a property (folder)
virtualTariffsStatusForProperty.virtualTariffsStatusForPropertyGet

Gets the calculation status for a virtual tariff property
openapi.previewSpec

Preview an OpenAPI document before adding it as a source
openapi.addSource

Add an OpenAPI source and register its operations as tools