NAV
nodejs cURL ruby python

Introduction

Welcome to the Orange Power Connect Documentation! This documentation will give you insight about the various APIs and their implementation details. You can use our API to access different devices API endpoints, which can get information, or give access to different control mechanisms.

We have language bindings in Shell, Ruby, Python, and JavaScript! You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right.

API DOCUMENTATION

BMW

For BMW the APIs have been implemented using Reverse Engineering MyBMW app.

Repositories used as reference for our API implementation: https://github.com/bimmerconnected/bimmer_connected

Schema

const bmw_user_token_schema = new Schema({
  user_id: { type: mongoose.Schema.Types.ObjectId, required: true, ref: 'user' },
  token_type: {
    type: String, default: 'bmw', enum: ['bmw'], required: true
  },
  bmw_access_token: { type: String },
  bmw_refresh_token: { type: String },
  bmw_expires_in: { type: Date },
}, { timestamps: true });

const bmw_device_schema = new Schema({
  user_id: { type: mongoose.Schema.Types.ObjectId, required: true, ref: 'user' },
  device_type: {
    type: String, default: 'bmw', enum: ['bmw'], required: true
  },
  device_id: { type: String, required: true, unique: true }, // device_id is the vin
  id: { type: String, required: true, unique: true }, // device_id is the vin
  model: { type: String },
  year: { type: Number },
  brand: { type: String },
  charging_state: {
    charge_percentage: { type: String },
    state: { type: String },
    type: { type: String },
    is_charger_connected: { type: Boolean }
  },
  electric_range: {
    distance: {
      value: { type: Number },
      units: { type: String }
    }
  },

});

There are two schemas:

  1. Token Schema

  2. Bmw Devices Schema

Code Algorithm

Coming soon

Get Token API

require "uri"
require "json"
require "net/http"

url = URI("http://localhost:3000/api/bmw/oauth-token")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/json"
request.body = JSON.dump({
  "email": "georgebatts1@outlook.com",
  "password": "Myenergi123&",
  "payload": {
    "email": "test@test.com"
  }
})

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

import requests
import json

url = "http://localhost:3000/api/bmw/oauth-token"

payload = json.dumps({
  "email": "georgebatts1@outlook.com",
  "password": "Myenergi123&",
  "payload": {
    "email": "test@test.com"
  }
})
headers = {
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

curl --location --request POST 'http://localhost:3000/api/bmw/oauth-token' \
--header 'Content-Type: application/json' \
--data-raw '{
 "email":"georgebatts1@outlook.com",
 "password":"Myenergi123&",
 "payload":{
     "email":"test@test.com"
 }
}'

var axios = require('axios');
var data = JSON.stringify({
  "email": "georgebatts1@outlook.com",
  "password": "Myenergi123&",
  "payload": {
    "email": "test@test.com"
  }
});

var config = {
  method: 'post',
  url: 'http://localhost:3000/api/bmw/oauth-token',
  headers: { 
    'Content-Type': 'application/json'
  },
  maxRedirects: 0,
  data : data
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

Request body:

{
 "email":"demo@outlook.com",
 "password":"demopass",
 "payload":{
     "email":"test@test.com"
 }
}

Response:

{
    "access_token": "YKJUUwmBXcQThWx7XzU7ddd4pyMZkd3tgWM",
    "token_type": "Bearer",
    "expires_in": 28800,
    "refresh_token": "mRlcF34pWzkfHxOauwpVe7B3GSMxCSFdfeRIPA3G9ilkHSGacnkUUo",
    "scope": "smacc vehicle_data vehicle_list perseus svds dlm cesim mini_connected remote_services authenticate_user fupo"
}

This endpoint returns access token.

HTTP Request

POST https://www.connect.orangepower.co.uk/api/bmw/oauth-token

Get vehicle info - API

require "uri"
require "json"
require "net/http"

url = URI("https://www.connect.orangepower.co.uk/api/get-user-devices")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJlbWFpbCI6InRyYW5zcG9ydGVyQGdtYWlsLmNvbSIsInBhc3N3b3JkIjoidHJhbnNwb3J0ZXIiLCJpYXQiOjE2NDQwNzQ0OTgsImV4cCI6MTY0NDA3ODA5OH0"
request["Content-Type"] = "application/json"
request.body = JSON.dump({
  "email": "test@test.com",
  "password": "testing123"
})

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


import requests
import json

url = "https://www.connect.orangepower.co.uk/api/get-user-devices"

payload = json.dumps({
  "email": "test@test.com",
  "password": "testing123"
})
headers = {
  'Authorization': 'Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJlbWFpbCI6InRyYW5zcG9ydGVyQGdtYWlsLmNvbSIsInBhc3N3b3JkIjoidHJhbnNwb3J0ZXIiLCJpYXQiOjE2NDQwNzQ0OTgsImV4cCI6MTY0NDA3ODA5OH0',
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

curl --location --request POST 'https://www.connect.orangepower.co.uk/api/get-user-devices' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJlbWFpbCI6InRyYW5zcG9ydGVyQGdtYWlsLmNvbSIsInBhc3N3b3JkIjoidHJhbnNwb3J0ZXIiLCJpYXQiOjE2NDQwNzQ0OTgsImV4cCI6MTY0NDA3ODA5OH0' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email":"test@test.com",
    "password":"testing123"
}'

var axios = require('axios');
var data = JSON.stringify({
  "email": "test@test.com",
  "password": "testing123"
});

var config = {
  method: 'post',
  url: 'https://www.connect.orangepower.co.uk/api/get-user-devices',
  headers: { 
    'Authorization': 'Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJlbWFpbCI6InRyYW5zcG9ydGVyQGdtYWlsLmNvbSIsInBhc3N3b3JkIjoidHJhbnNwb3J0ZXIiLCJpYXQiOjE2NDQwNzQ0OTgsImV4cCI6MTY0NDA3ODA5OH0', 
    'Content-Type': 'application/json'
  },
  maxRedirects: 0,
  data : data
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

Request body:

{
  "email": "demo@hotmail.com",
  "password": "password"
}

Response:

    {
        "_id": "62137c48e075b1442f0c955c",
        "electric_range": {
            "distance": {
                "value": 121,
                "units": "KILOMETERS"
            }
        },
        "device_type": "bmw",
        "user_id": "61b1d1a2d5df13f67657dbf2",
        "device_id": "WBY7ZddD802daf16",
        "id": "916ba1b2eeba4b4881ce9d829852d70e",
        "model": "i3s 94 REX",
        "year": 2018,
        "brand": "BMW",
        "charging_state": {
            "charge_percentage": "82",
            "state": "NOT_CHARGING",
            "type": "CONDUCTIVE",
            "is_charger_connected": false
        },
        "__v": 0
    }

This endpoint retrieves all the details related to your BMW car

HTTP Request

POST https://www.connect.orangepower.co.uk/api/get-user-devices

Authorisation

Bearer <token>

Errors

The Kittn API uses the following error codes:

Error Code Meaning
400 Bad Request -- Your request is invalid.
401 Unauthorized
403 Forbidden -- The kitten requested is hidden for administrators only.
404 Not Found
405 Method Not Allowed -- You tried to access a device with an invalid method.
406 Not Acceptable -- You requested a format that isn't json.
410 Gone -- The api requested has been removed from our servers.
429 Too Many Requests
500 Internal Server Error -- We had a problem with our server. Try again later.
503 Service Unavailable -- We're temporarily offline for maintenance. Please try again later.
nodejs cURL ruby python