Create session

post https://api.telematica.so/v3/create-session

Create a new short-lived auth session (10 minutes). Needed only in production environment. If you are in pilot / development phase, you can skip this step.

Body Params

user

string

required

Unique identifier of the user, in your database. Telematica will only use this for high level identification purposes, and while sending webhook callbacks.

siteId

string

Site-ID in your database, of which the device is part of. Telematica will only use this for high level identification purposes, and while sending webhook callbacks.

siteName

string

Site name in your database, of which the device is part of. Telematica will only use this for high level identification purposes, and while sending webhook callbacks.

callbackEnv

string

Callback Environment to which Telematica will send webhook of 'user.devices-connected' event. If not provided, the callback will be sent to all URLs registered with us.

region

string

Defaults to EU

Region of operation for your app. This will determine the set of brands available for auth.

metadata

object

Metadata to be sent along with payload in the 'user.devices-connected' webhook.

redirectUrl

string

Redirect URL or URI to which Telematica will redirect the user after successful auth session. If not provided, the default redirect URL registered with us will be used.

brand

string

If this param is not provided, the user will be presented with a list of all brands available in the region. It is highly recommended to use Telematica provided interface for OEM selection for best user experience, as we might dynamically adjust the list based on OEM uptime. Below is a list of brands available in each region. Some brands need to be activated on request. Some brands in beta/pre-prod rollout phase might not be seen below. Please contact us to activate them.

EV OEMs availability list:
  - EU:  TESLA, AUDI, BMW, CITROEN, CUPRA, DS, FIAT, FORD, HYUNDAI, JAGUAR, JEEP, KIA, LANDROVER, MERCEDES, MINI, OPEL, MG, NISSAN, PEUGEOT, PORSCHE, RENAULT, SEAT, SKODA, SMART, TOYOTA, VOLVO, VW, SIMULATOR
  - US:  TESLA, AUDI, ETRON, BMW, CHEVROLET, FIAT, FORD, JAGUAR, JEEP, LANDROVER, MINI, HYUNDAI, KIA, MERCEDES, NISSAN, PORSCHE, RIVIAN, VW, VWID, VOLVO, TOYOTA, SIMULATOR

Charger OEMs availability list:
  - EU: EASEE, ZAPTEC, CHARGEAMPS, ENELX, SIMULATOR, WALLBOX, CHARGEPOINT
  - US: ENELX, SIMULATOR, WALLBOX, CHARGEPOINT

HVACs availability list:
  - EU: ADAX, MITSUBISHIELECTRIC, DAIKIN, SENSIBO, LG, MILL, VIESSMANN, SIMULATOR, NEST, TADO, TOSHIBA
  - US: MITSUBISHIELECTRIC, DAIKIN, SENSIBO, LG, SIMULATOR, NEST, VIESSMANN, TADO, TOSHIBA

Solar Inverters availability list:
  - EU: GROWATT, SOLARMAN, INVT, HUAWEI, SIMULATOR, TESLA, SOLAX, SOLIS
  - US: GROWATT, SOLARMAN, INVT, HUAWEI, SIMULATOR, TESLA, SOLAX, SOLIS
    
Battery OEMs availability list:
    - EU: TESLA, SIMULATOR, ENPHASE, GROWATT, SOLAX, SOLIS
    - US: TESLA, SIMULATOR, ENPHASE, GROWATT, SOLAX, SOLIS

deviceType

string

Defaults to vehicle

Type of the device to authenticate. User will be presented relevant OEMs based on this value.

brandSubset

array of strings

Subset of brands that you want to selectively show on the UI

Brand Subset

excludeBrands

array of strings

Subset of brands that you want to exclude from being shown on the UI

Brand Exclusions

devMode

boolean

If true, the select-brand screen will also show Telematica Simulator

Response

200