KnowGo Vehicle Simulator API
This is a simple API for interacting with the KnowGo Vehicle Simulator. It provides mechanisms for starting/stopping the simulated vehicle, sending…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
This is a simple API for interacting with the KnowGo Vehicle Simulator. It
provides mechanisms for starting/stopping the simulated vehicle, sending
notifications to the vehicle, registering webhooks, and for obtaining
detailed information and generated telemetry from the vehicle.
It further offers the ability to submit external events in order to allow
the vehicle simulation state to be synchronized with external vehicle data,
allowing the simulated vehicle to act as a digital twin upon which
additional applications and services can be modelled.
Fine-grained access to vehicle data is provided through ISO 20078
Extended Vehicle (ExVe)-compatible API endpoints.
Endpoints 36
simulator
- POSTstart the simulated vehicle
/simulator/startStarts the running of the vehicle within the simulator - POSTstop the simulated vehicle
/simulator/stopStops the running of the vehicle within the simulator - POSTsend a notification to the simulated vehicle
/simulator/notificationSends a notification to the simulated vehicle - GETinformation about the simulated vehicle
/simulator/infoObtain detailed information about the simulated vehicle. - GETget simulated vehicle events
/simulator/eventsObtain detailed events from the simulated vehicle in its running state. - POSTapply events to the simulated vehicle
/simulator/eventsSubmit a list of vehicle events to apply to the simulated vehicle. This can be used for digital twinning, where the simulation model state can be synchronized… - GETget a list of available event triggers
/simulator/webhooks - POSTregister a new event-triggered webhook
/simulator/webhooks - GETget information about a registered webhook
/simulator/webhooks/:subscriptionId - PUTupdate a registered webhook
/simulator/webhooks/:subscriptionId - DELETEunregister a webhook
/simulator/webhooks/:subscriptionId
exve
- GETget list of vehicles available
/exve/vehiclesObtain a list of vehicles available to the accessing party - GETget information about a specific vehicle
/exve/vehicles/:vehicleIdObtain detailed information about a specific vehicle - GETget the capabilities of a specific vehicle
/exve/vehicles/:vehicleId/capabilitiesObtain a list of capabilities of a specific vehicle - GETget the available resources a specific vehicle
/exve/vehicles/:vehicleId/resourcesObtain a list of available resources for a specific vehicle - POSTsend a notification to a specific vehicle
/exve/vehicles/:vehicleId/notificationSends a notification to a specific vehicle - GETget the accelerator pedal positions for a specific vehicle
/exve/vehicles/:vehicleId/acceleratorPedalPositionsObtain a list of changes in accelerator pedal positions for a specific vehicle. - GETget the automation levels for a specific vehicle
/exve/vehicles/:vehicleId/automationLevelsObtain a list of changes in SAE J3016 automation levels for a specific vehicle. - GETget the brake pedal positions for a specific vehicle
/exve/vehicles/:vehicleId/brakePedalPositionsObtain a list of changes in brake pedal positions for a specific vehicle. - GETget the changes in door status for a specific vehicle
/exve/vehicles/:vehicleId/doorStatusesObtain a list of changes in door status for a specific vehicle. - GETget the changes in fuel levels for a specific vehicle
/exve/vehicles/:vehicleId/fuelLevelsObtain a list of changes in fuel levels for a specific vehicle. - GETget the changes in headlamp status for a specific vehicle
/exve/vehicles/:vehicleId/headlampStatusesObtain a list of changes in headlamp status for a specific vehicle. - GETget the changes in high beam status for a specific vehicle
/exve/vehicles/:vehicleId/highBeamStatusesObtain a list of changes in high beam status for a specific vehicle. - GETget the changes in ignition status for a specific vehicle
/exve/vehicles/:vehicleId/ignitionStatusesObtain a list of changes in ignition status for a specific vehicle. - GETget the locations for a specific vehicle
/exve/vehicles/:vehicleId/locationsObtain a list of changes in geolocation for a specific vehicle. - GETget the odometer values for a specific vehicle
/exve/vehicles/:vehicleId/odometersObtain a list of changes in odometer readings for a specific vehicle. - GETget the changes in parking brake status for a specific vehicle
/exve/vehicles/:vehicleId/parkingBrakeStatusesObtain a list of changes in parking brake status for a specific vehicle. - GETget the changes in windshield wiper status for a specific vehicle
/exve/vehicles/:vehicleId/windshieldWiperStatusesObtain a list of changes in windshield wiper status for a specific vehicle.
fleet
- GETget list of fleets available
/exve/fleetsObtain a list of fleets available to the accessing party - POSTcreate a new vehicle fleet
/exve/fleetsOrganize a number of vehicles into a fleet - GETget information about a specific vehicle fleet
/exve/fleets/:fleetIdObtain detailed information about a specific vehicle fleet - POSTadd vehicles to an existing fleet
/exve/fleets/:fleetIdAdd one or more vehicles to an existing fleet - DELETEdelete a vehicle fleet
/exve/fleets/:fleetIdRemove a vehicle fleet - GETget list of vehicles contained in the fleet
/exve/fleets/:fleetId/vehiclesObtain a list of vehicles contained within the fleet - GETget information about a specific vehicle within a fleet
/exve/fleets/:fleetId/vehicles/:vehicleIdObtain detailed information about a specific vehicle within a fleet - DELETEremove a specific vehicle from a fleet
/exve/fleets/:fleetId/vehicles/:vehicleIdRemove a specific vehicle from a fleet
API details
- Base URL
http://localhost:8086https://virtserver.swaggerhub.com/KnowGo/knowgo-vehicle-simulator-api/1.2.0- Authentication
- A bearer token in the Authorization header
- Operations
- 36 operations on 28 pathsGET 24POST 8DELETE 3PUT 1
- Main resources
- exve 17simulator 11fleet 8
- Response formats
application/json- Description format
- OpenAPI 3.0.0, API version
1.2.0 - Links
- OpenAPI document
- Listed from
- KnowGo's published OpenAPI description (knowgoio/knowgo-api-specifications) (Apache-2.0)
How to test the KnowGo Vehicle Simulator API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the KnowGo Vehicle Simulator API collection, without the publisher's secrets.
- Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “start the simulated vehicle” (POST /simulator/start), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the KnowGo Vehicle Simulator API?
This is a simple API for interacting with the KnowGo Vehicle Simulator. It provides mechanisms for starting/stopping the simulated vehicle, sending… It is listed under IoT & devices and has 36 endpoints.
Who publishes the KnowGo Vehicle Simulator API?
It is listed from KnowGo's public API description (an OpenAPI document), not published by KnowGo on Swastik Codes. Anyone who controls knowgo.io can claim the profile by adding a DNS TXT record.
What is the base URL of the KnowGo Vehicle Simulator API?
Its description lists 2 base URLs: http://localhost:8086, https://virtserver.swaggerhub.com/KnowGo/knowgo-vehicle-simulator-api/1.2.0. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the KnowGo Vehicle Simulator API?
With A bearer token in the Authorization header.
How many endpoints does the KnowGo Vehicle Simulator API have?
36 operations on 28 paths (24 GET, 8 POST, 3 DELETE, 1 PUT). The largest groups are exve, simulator, fleet.
Is forking the KnowGo Vehicle Simulator API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.