Internal endpoints

Volvo playground docs

Describes any unique additional API endpoints. Most of them are in /internal/*

GET /internal/APIKey

Creates a new API key

{"message":<api_key/str>,"description": f"THIS IS INTERNAL API/API key generated successfully"}

POST /internal/addCar

Creates a new Car. Header:

• vcc-api-key the api key created or the ready scenario key Body:
• VIN string (Use a dummy/simulated VIN for privacy)
• attributes a list of attributes (door status, engine status...) to be change. Can be empty
• values a list if values of changed attributes (it is not validated so your values could be not correct)

info: attribute and values length should be the same

POST /internal/update

Updates a specific car attributes. Header:

• vcc-api-key the api key created or the ready scenario key Body:
• VIN string
• attributes a list of attributes (door status, engine status...) to be change.
• values a list if values of changed attributes (it is validated. It means that only valid values for that attributes are updated)

info: there is additional attrbute nextInvoiceStatus it force the next invoice status ("" means auto mode)

Websocket /internal/status/ws

Websocket on start sends all data about the car then sends data only of changed attributes. Query:

• VIN VIN of virtual vehicle you want to monitor
• key api key

GET /internal/status

Sends all data about the car. Header:

• VIN VIN of virtual vehicle you want to monitor
• key api key

GET /internal/oauth2

Sends all information about Oauth2 settings header:

• vcc_api_key api key with enabled Oauth2

{
  "client_secret": <str>,
  "code": <str>,
  "access_token": <str>,
  "refresh_token": <str>,
  "token_type": <str>,
  "expires_in": 3599, # doesn't change and doesnt work
  "redirect_uri": <str> # if nothing then all redirects are alowed. This examptions is made for testing and doesnt exist in volvo api
}

POST /internal/oauth2/deactivate

Disable Oauth2 flow for provided API key header:

• vcc_api_key api key with enabled Oauth2

{
  "message": "OAuth2 deactivated successfully"
}

POST /internal/oauth2/regenerate

Creates new access and refresh tokens header:

• vcc_api_key api key with enabled Oauth2

{
  "access_token": <str>,
  "refresh_token": <str>,
  "token_type": "Bearer", #static
  "expires_in": 3599 #static
}

POST /internal/oauth2/activate

Activate Oauth2 flow for provided API key header:

• vcc_api_key api key with enabled Oauth2 body:

{
  "client_secret": <str>,
  "PKCE": <bool>,
  "redirect_uri": <str/optional>
}

{
    "message": "OAuth2 activated successfully"
}

POST /internal/snapshot

Saves or loads saved data about one API key (persistent storage about car and OAuth2 status) header:

• vcc_api_key api key body: { "command": , "name": } legend:
• command: load or save
• name: It is a name About:

Data is stored in snapshots.json it load at start and save every time one is created You can save a snapshots of one api key and use it in different one

POST /internal/scenario

Scenario can be used for faster setting resetting statuses about car header:

• vcc_api_key api key body: { "VIN": , "scenario": } legend:
• scenario: name from scenario in scenario.json
• VIN: the car VIN from the api key that you want to load the scenario about:

Scenario is stored in scenarios.json. You can manual add or delete the scenario there. If scenarios.json is not valid JSON file then only default scenarios will be loaded

Errors

If an error is returned and it is not caused by missing data, the response will have the following format:

{ "error": {"message": "THIS IS INTERNAL API/<Error text>","description": <error description>"}}

Playground sites:

PAGE /internal/terminal

Shows what the websocket sends. Query:

• VIN VIN of virtual vehicle you want to monitor
• key api key

PAGE /

If public mode is active it will show a small page with GitHub and and compare app else it will redirect to the login page

PAGE /internal/welcome

The main dashboard for the playground simulator. It allows you to:

• Generate a new API key or log in with an existing key.
• Select a virtual vehicle and modify its attributes or live state.
• Easily navigate to all other internal tools and endpoints.