Connect tariff
Connect session for a tariff vendor
Creates a connect URL to redirect to the IDP of the specified tariff vendor.
POST
/
v1.0.0
/
connections
/
tariffs
Authorizations
X-API-KEY
string
headerrequiredApiKey used for authorization and authentication
Query Parameters
language
enum<string>
Available options:
ENGLISH
, GERMAN
, FRENCH
Body
application/json
An object containing relevant information for linking to vendor account for tariff vendor.
redirectUrl
string
requiredThe URL to which user will be redirected
Maximum length:
2048
vendor
enum<string>
requiredAn API which we are connecting the user to
Available options:
TIBBER
, OSTROM
userId
string
requiredThe ID of the user for which to create the connect session.
Maximum length:
50
Response
201 - application/json
An object containing url which is used to redirect the user to IDP login portal.
url
string
requiredThe connect URL to follow for redirect to vendor IDP.