RegisterForRealtimeApi

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.

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.

post/RegisterForRealtimeApi

Request

  • Base URL: https://api.smart-me.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.smart-me.com/RegisterForRealtimeApi
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL /oauth/authorize, token URL /oauth/token; client credentials, token URL /oauth/token)
    • HTTP basic

Request body

idstring uuid

The ID of the registration

registrationType0 | 1 | 2
<p>Members: </p><ul><li><i>0</i> - Disabled</li><li><i>1</i> - Single meter that we are looking for data</li><li><i>2</i> - Registration for a Server User. All devices of this users we are looking for new data.</li></ul>
meterIdstring uuid nullable

The ID of the Meter. Just used if the RegistrationType is "SingleMeterRegistration".

serialNumberstring nullable

The serial number of the Meter. Just used if the RegistrationType is "SingleMeterRegistration" and the MeterId is null. Example: 1 SME 01 63000000 or 6300000

apiUrlstring nullable

The URL of your endpoint. To this endpoint all the values are send to.

basicAuthUsernamestring nullable

The Username (basic auth) of your endpoint. Leave empty of none.

basicAuthPasswordstring nullable

The Password (basic auth) of your endpoint. Leave empty of none.

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.