Smart Me

smart-me

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…

IoT & devices#openapi#iot

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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.

Endpoints 64

AccessToken

  • PUTCreates a Access Token to write on a Card (e.g. NFC)/api/AccessTokenCreates a Access Token to write on a Card (e.g. NFC)

Account

  • GETAccount_Login/api/Account/login
  • POSTPOST /api/Account/login/api/Account/login

Actions

  • POSTSet an action for the specified device./api/ActionsSet an action for the specified device.
  • GETGets all available Actions of a Device/api/Actions/:idGets all available Actions of a Device

AdditionalDeviceInformation

  • GETGets the additional information (e.g. Firmware Version) about a device./api/AdditionalDeviceInformation/:idGets the additional information (e.g. Firmware Version) about a device.

CustomDevice

  • GETGets all Custom Devices/api/CustomDeviceGets all Devices
  • POSTCreates or updates a Custom Device or updates it's values./api/CustomDeviceCreates 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.…
  • GETGets a Custom Device by it's ID/api/CustomDevice/:idGets a Device by it's ID

DeviceBySerial

  • GETGets a Device by it's Serial Number. The Serial is the part before the "-"./api/DeviceBySerial?serial=0Gets a Device by it's Serial Number. The Serial is the part before the "-".

Devices

  • GETGets all Devices/api/DevicesGets all Devices
  • POSTCreates or updates a Device or updates it's values./api/DevicesCreates 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…
  • GETGets a Device by it's ID/api/Devices/:idGets a Device by it's ID
  • PUTUpdates the On/Off Switch on a device. For new implementations please use the "actions" command/api/Devices/:id?switchState=true&switchNumber=0Updates the On/Off Switch on a device For new implementations please use the "actions" command

DevicesByEnergy

  • GETGets all Devices for an Energy Type/api/DevicesByEnergy?meterEnergyType=MeterTypeUnknownGets all Devices for an Energy Type

DevicesBySubType

  • GETGets all Devices by it's Sub Type (e.g. E-Charging Station)/api/DevicesBySubType?meterSubType=MeterSubTypeUnknownGets all Devices by it's Sub Type (e.g. E-Charging Station)

FastSendDeviceValues

  • GETForce 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./api/FastSendDeviceValues/:id

Folder

  • GETGets the Values for a folder or a meter/api/Folder/:idGets the Values for a folder or a meter

FolderMenu

  • GETGets the folder menu items (each item might contain child items)/api/FolderMenu?filter=string
  • POSTCreates and updates the folder menu items/api/FolderMenu

Health

  • GETA method returning HTTP 200 OK when queried. It is used by Kubernetes probes to determine whether the app is healthy./api/Health

MBus

  • POSTM-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./api/MBusM-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

  • POSTSets the Name of a Meter or a Folder/api/MeterFolderInformationSets the Name of a Meter or a Folder
  • GETBeta: Gets the General Information for a Meter or a Folder/api/MeterFolderInformation/:idBeta: Gets the General Information for a Meter or a Folder

MeterValues

  • GETGets the Values for a Meter at a given Date. The first Value found before the given Date is returned./api/MeterValues/:id?date=2024-01-01T00:00:00ZGets the Values for a Meter at a given Date. The first Value found before the given Date is returned.

RegisterForRealtimeApi

  • GETGets all registrations for the Realtime API./api/RegisterForRealtimeApiGets all registrations for the Realtime API.
  • POSTCreates 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: https://www.smart-me.com/Description/api/realtimeapi.aspx/api/RegisterForRealtimeApiCreates 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…
  • DELETEDeletes a realtime API registration./api/RegisterForRealtimeApi/:idDeletes a realtime API registration.

SmartMeDeviceConfiguration

  • POSTSets the configuration of a smart-me device. The device needs to be online./api/SmartMeDeviceConfiguration
  • GETGets the configuration of a smart-me device./api/SmartMeDeviceConfiguration/:id

SubUser

  • POSTCreates or updates a subuser. To create a new user set no ID (empty)/api/SubUser
  • GETGet a sub user. The user must be assigend to the user that makes this call./api/SubUser/:id
  • DELETEDelete a subuser/api/SubUser/:id

User

  • GETGets the informations for the user./api/UserGets the informations for the user.
  • DELETETriggers user account deletion./api/User

Values

  • GETGets all (last) values of a device/api/Values/:id

ValuesInPast

  • GETGets all (last) values of a device The first Value found before the given Date is returned./api/ValuesInPast/:id?date=2024-01-01T00:00:00ZGets the Values for a device at a given Date. The first Value found before the given Date is returned.

ValuesInPastMultiple

  • GETGets multiple values of a device. This call needs a smart-me professional licence./api/ValuesInPastMultiple/:id?startDate=2024-01-01T00:00:00Z&endDate=2024-01-01T00:00:00Z&interval=0

VirtualBillingMeterActive

  • GETBeta: Gets all active virtual meters/api/VirtualBillingMeterActiveBeta: Gets all active virtual meters.
  • POSTBeta: Virtual Meter API: Activates a Meter and add the Consumption to a Virtual Meter assosiated with the User./api/VirtualBillingMeterActiveBeta: Virtual Meter API: Activates a Meter and add the Consumption to a Virtual Meter assosiated with the User.

VirtualBillingMeterDeactivate

  • POSTBeta: Virtual Meter API: Deactivates a Virtual Meter./api/VirtualBillingMeterDeactivateBeta: Virtual Meter API: Deactivates a Virtual Meter.

VirtualBillingMeters

  • GETBeta: Gets all Meters available to activate as a Virtual Meter./api/VirtualBillingMetersBeta: Gets all Meters available to activate as a Virtual Meter.

VirtualMeterCalculateFormula

  • GETCalculates a virtual meter from a formula. A meter is coded as ID("METERID")/api/VirtualMeterCalculateFormula?formula=stringCalculates a virtual meter from a formula. A meter is coded as ID("METERID") Ariphmetical operators: () parentheses; + plus (a + b); minus (a - b); *…

VirtualTariff

  • GETGets all Virtual Tariffs of a user/api/VirtualTariffGets all Virtual Tariffs of a user
  • GETGets all virtual tariffs of a folder/api/VirtualTariff/:idGets all virtual tariffs of a folder

VirtualTariffConsumption

  • GETGets the consumption of a folder with a virtuall tariffs./api/VirtualTariffConsumption?folderId=string&startDate=2024-01-01T00:00:00Z&endDate=2024-01-01T00:00:00ZGets the consumption of a folder with a virtuall tariffs.

VirtualTariffsForProperty

  • GETGets all Virtual Tariffs for a property (folder)/api/VirtualTariffsForProperty/:idGets all Virtual Tariffs for a property (folder)

VirtualTariffsStatusForProperty

  • GETGets the calculation status for a virtual tariff property/api/VirtualTariffsStatusForProperty/:id

FolderAssign

  • POSTAssign a folder (source) or meter to another folder (target). Can be used to create a folder structure./api/folder/assign?source=string&target=string

FolderSettings

  • GETGets the settings of a folder or meter/api/folder/settings/:id
  • POSTAdd or edit a folder or a meter. To add a new folder use and empty ID/api/folder/settings/:id
  • DELETEDeletes a folder/api/folder/settings/:id

UserToFolderAssign

  • POSTAssign a user to a folder/api/folder/user/assign?source=string&target=string&oldFolder=string
  • DELETEDeletes a user to folder assignement/api/folder/user/assign?source=string&target=string

OAuth

  • GETOAuth_Authorize/api/oauth/authorize?client_id=string&redirect_uri=string&state=string&scope=string&client_secret=string
  • POSTPOST /api/oauth/authorize/api/oauth/authorize?client_id=string&redirect_uri=string&state=string&scope=string&client_secret=string

Pico

  • GETGets all pico charging stations for this user/api/pico

PicoCharging

  • GETGets the active charging data of a pico station/api/pico/charging/:id

PicoChargingHistory

  • GETGets the last charging history for a pico station/api/pico/history/:id

PicoLoadmanagementGroup

  • GETGET: api/pico/loadmanagementgroup Returns all available load management groups/api/pico/loadmanagementgroup
  • GETGET: api/pico/loadmanagementgroup Returns a pico load management group by it's id/api/pico/loadmanagementgroup/:id

PicoLoadmanagementSetDynamicCurrent

  • POSTSets the dynamic current of a load management group or a single station./api/pico/loadmanagementgroup/current/:serial?current=0

PicoSettings

  • GETGET: api/pico/settings Returns the settings of a pico charging station./api/pico/settings/:id

PicoEnableFixCableLock

  • POSTTry 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./api/pico/tryenablecablelock/:id

API details

Base URL
https://smart-me.com:443
Authentication
HTTP Basic authentication (username and password)
Operations
64 operations on 51 pathsGET 39POST 18DELETE 5PUT 2
Main resources
Devices 4CustomDevice 3FolderSettings 3RegisterForRealtimeApi 3SubUser 3Account 2Actions 2FolderMenu 2MeterFolderInformation 2OAuth 2
Response formats
application/json text/json application/xml
Description format
OpenAPI 3.0.0, API version v1
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the smart-me in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the smart-me collection, without the publisher's secrets.
  3. Add your credentialsThis API uses HTTP Basic authentication (username and password). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Creates a Access Token to write on a Card (e.g. NFC)” (PUT /api/AccessToken), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the smart-me?

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… It is listed under IoT & devices and has 64 endpoints.

Who publishes the smart-me?

It is listed from Smart Me's public API description (an OpenAPI document), not published by Smart Me on Swastik Codes. Anyone who controls smart-me.com can claim the profile by adding a DNS TXT record.

What is the base URL of the smart-me?

Requests go to https://smart-me.com:443. Endpoint paths are added to this base URL.

How do I authenticate with the smart-me?

With HTTP Basic authentication (username and password).

How many endpoints does the smart-me have?

64 operations on 51 paths (39 GET, 18 POST, 5 DELETE, 2 PUT). The largest groups are Devices, CustomDevice, FolderSettings, RegisterForRealtimeApi.

Is forking the smart-me free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.