Connect to vehicle

Connects a vehicle to the logged in user. You can choose a role which determines the access the user will have to the vehicle. Note that connecting might not always be possible but is restricted by previous assignments and access rights.

POST /me/connected-vehicle

Connect to vehicle

cURL

curl --request POST \
  --url https://ctechnology.io/api/v2.2/me/connected-vehicle \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "device_id": "<string>",
  "role": "<string>"
}
'

import requests

url = "https://ctechnology.io/api/v2.2/me/connected-vehicle"

payload = {
    "device_id": "<string>",
    "role": "<string>"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({device_id: '<string>', role: '<string>'})
};

fetch('https://ctechnology.io/api/v2.2/me/connected-vehicle', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ctechnology.io/api/v2.2/me/connected-vehicle",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'device_id' => '<string>',
    'role' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://ctechnology.io/api/v2.2/me/connected-vehicle"

	payload := strings.NewReader("{\n  \"device_id\": \"<string>\",\n  \"role\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://ctechnology.io/api/v2.2/me/connected-vehicle")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"device_id\": \"<string>\",\n  \"role\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://ctechnology.io/api/v2.2/me/connected-vehicle")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"device_id\": \"<string>\",\n  \"role\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "header": {
    "api_version": "<string>",
    "status": "<string>",
    "message": "<string>",
    "permission_via": [
      {
        "permission": "<string>",
        "organization_id": "<string>"
      }
    ]
  },
  "data": {
    "user_id": "<string>",
    "vehicle_id": "<string>",
    "id": "<string>",
    "user_email": "[e-mail]"
  }
}

{
  "header": {
    "api_version": "<string>",
    "status": "<string>",
    "message": "<string>",
    "permission_via": [
      {
        "permission": "<string>",
        "organization_id": "<string>"
      }
    ]
  },
  "error": {
    "id": "<string>",
    "status": 123,
    "type": "<string>",
    "message": "<string>",
    "message_i18n": "<string>",
    "data": {}
  }
}

{
  "header": {
    "api_version": "<string>",
    "status": "<string>",
    "message": "<string>",
    "permission_via": [
      {
        "permission": "<string>",
        "organization_id": "<string>"
      }
    ]
  },
  "error": {
    "id": "<string>",
    "status": 123,
    "type": "<string>",
    "message": "<string>",
    "message_i18n": "<string>",
    "data": {}
  }
}

{
  "header": {
    "api_version": "<string>",
    "status": "<string>",
    "message": "<string>",
    "permission_via": [
      {
        "permission": "<string>",
        "organization_id": "<string>"
      }
    ]
  },
  "error": {
    "id": "<string>",
    "status": 123,
    "type": "<string>",
    "message": "<string>",
    "message_i18n": "<string>",
    "data": {}
  }
}

{
  "header": {
    "api_version": "<string>",
    "status": "<string>",
    "message": "<string>",
    "permission_via": [
      {
        "permission": "<string>",
        "organization_id": "<string>"
      }
    ]
  },
  "error": {
    "id": "<string>",
    "status": 123,
    "type": "<string>",
    "message": "<string>",
    "message_i18n": "<string>",
    "data": {}
  }
}

Authorizations

Authorization · string · header · required

Note that the API key has to be sent as Token 123 where 123 is the key you received after logging in or by creating on the developer dashboard.

Body

application/json

The vehicle to connect to the user.

device_id · string · required

The device id of the vehicle to connect. This is the id given to owners and / or partners with the purpose of easily connecting vehicles.

role · string

The role which the user should have.

Response

200

application/json

Successfully connected the vehicle to this user.

header · API Header Single · object · required

Default header sent along with single-resource responses.

Show child attributes

data · User Vehicle Access · object · required

The response after a successful addition of a vehicle to a user.

Show child attributes