{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/api.vanmoof-api.com" } ], "info": { "name": "VanMoof API Documentation", "_postman_id": "9046693a-83c6-4a19-b3dc-eb145d23b728", "description": "", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Authentication", "description": "Endpoints for user authentication", "item": [ { "name": "1. Obtain Initial Token", "request": { "url": { "host": "{{baseUrl}}", "path": "v8\/authenticate", "query": [], "raw": "{{baseUrl}}\/v8\/authenticate" }, "method": "POST", "header": [ { "key": "Api-Key", "value": "fcb38d47-f14b-30cf-843b-26283f6a5819" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Authenticate with email and password to get an initial token. This token is then exchanged for an Application JWT which expires within two hours. This token however is valid for one year to continusly optain new Application JWTs without re-authenticating.\n\nJWT Payload:\n```\n{\n \"iss\": \"http:\/\/api.vanmoof-api.com\",\n \"iat\": {issued_at_timestamp},\n \"nbf\": {not_before_timestamp},\n \"exp\": {expiration_timestamp},\n \"user\": {userID},\n \"api_key\": 3,\n \"device\": null,\n \"refresh_token\": \"{UUIDv4}\"\n}\n```\n", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"token\":\"{TOKEN}\",\"refreshToken\":\"UUIDv4\"}", "name": "Success" }, { "header": [], "code": 401, "body": "{\"error\":\"AuthenticationException\",\"message\":\"Invalid Credentials\"}", "name": "Unauthorized" }, { "header": [], "code": 422, "body": "{\"error\":\"Please provide your 'Api-Key' header. You can obtain an API key from VanMoof. For more information see the documentation: http:\\\/\\\/api.vanmoof-api.com\\\/apidoc\\\/my\\\/pretty\",\"message\":\"Please provide an API key\"}", "name": "Unprocessable Entity" } ] }, { "name": "2. Obtain Application Token", "request": { "url": { "host": "{{baseUrl}}", "path": "v8\/getApplicationToken", "query": [], "raw": "{{baseUrl}}\/v8\/getApplicationToken" }, "method": "GET", "header": [ { "key": "Api-Key", "value": "fcb38d47-f14b-30cf-843b-26283f6a5819" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Exchange the initial token for an Application JWT used for subsequent requests.\n\nJWT payload:\n```json\n{\n \"iss\": \"http:\/\/api.vanmoof-api.com\",\n \"iat\": {issued_at_timestamp},\n \"nbf\": {not_before_timestamp},\n \"exp\": {expiration_timestamp},\n \"user\": \"{email}\",\n \"uuid\": \"{UUIDv3}\",\n \"bikes\": [\n {bikeID},\n ],\n \"owner\": [\n \"{FrameNumber}\"\n ]\n}\n```\n" }, "response": [ { "header": [], "code": 200, "body": "{\"token\": \"{JWT_TOKEN}\"}", "name": "Success" }, { "header": [], "code": 401, "body": "{\"error\": \"UnexpectedError\",\"message\": \"An unexpected error occurred. Please contact support if this problem persists.\"}", "name": "Unauthorized" }, { "header": [], "code": 401, "body": "{\"error\":\"AuthenticationException\",\"message\":\"Invalid Credentials\"}", "name": "Unauthorized" }, { "header": [], "code": 422, "body": "{\"error\":\"Please provide your 'Api-Key' header. You can obtain an API key from VanMoof. For more information see the documentation: http:\\\/\\\/api.vanmoof-api.com\\\/apidoc\\\/my\\\/pretty\",\"message\":\"Please provide an API key\"}", "name": "Unprocessable Entity" } ] }, { "name": "Refresh Token", "request": { "url": { "host": "{{baseUrl}}", "path": "v8\/token", "query": [], "raw": "{{baseUrl}}\/v8\/token" }, "method": "POST", "header": [ { "key": "Api-Key", "value": "fcb38d47-f14b-30cf-843b-26283f6a5819" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"refreshToken\":null}" }, "description": "Refresh the authentication token using a refresh token.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"token\": \"eyXXX.eyXXX\"\n}", "name": "Success" }, { "header": [], "code": 401, "body": "{\"error\":\"AuthenticationException\",\"message\":\"Invalid Credentials\"}", "name": "Invalid Refresh Token" }, { "header": [], "code": 401, "body": "{\"error\":\"UnexpectedError\",\"message\":\"An unexpected error occurred. Please contact support if this problem persists.\"}", "name": "Missing API Key" } ] } ] }, { "name": "Bike", "description": "Endpoints for bike operations", "item": [ { "name": "Change Bike Name", "request": { "url": { "host": "{{baseUrl}}", "path": "v8\/changeBikeName\/:bikeId", "query": [], "raw": "{{baseUrl}}\/v8\/changeBikeName\/:bikeId", "variable": [ { "id": "bikeId", "key": "bikeId", "value": "", "description": "The bike ID" } ] }, "method": "POST", "header": [ { "key": "Api-Key", "value": "fcb38d47-f14b-30cf-843b-26283f6a5819" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":null}" }, "description": "Change the name of a specific bike. Limited to 255 Characters." }, "response": [ { "header": [], "code": 200, "body": "{\"result\": true}", "name": "Success" }, { "header": [], "code": 401, "body": "{\"error\":\"AuthenticationException\",\"message\":\"Invalid Credentials\"}", "name": "Unauthorized" }, { "header": [], "code": 422, "body": "{\"error\":\"Please provide your 'Api-Key' header. You can obtain an API key from VanMoof. For more information see the documentation: http:\\\/\\\/api.vanmoof-api.com\\\/apidoc\\\/my\\\/pretty\",\"message\":\"Please provide an API key\"}", "name": "Unprocessable Entity" } ] }, { "name": "Changed Backup Code", "request": { "url": { "host": "{{baseUrl}}", "path": "v8\/changedBackupCode", "query": [], "raw": "{{baseUrl}}\/v8\/changedBackupCode" }, "method": "POST", "header": [ { "key": "Api-Key", "value": "fcb38d47-f14b-30cf-843b-26283f6a5819" }, { "key": "Content-Type", "value": "application\/json; charset=utf-8" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"macAddress\":null}" }, "description": "Notify Backend that the bikes backup code was changed. Requires `macAddress` in body. Since the SA5 do not have the macAddress in the API.. This is kinda pointless. Even with the SA3 the API responds with macAddress field is required." }, "response": [ { "header": [], "code": 401, "body": "{\"error\":\"AuthenticationException\",\"message\":\"Invalid Credentials\"}", "name": "Invalid Credentials" }, { "header": [], "code": 422, "body": "{\"error\":\"ValidationException\",\"message\":\"Validation failed\",\"violations\":{\"macAddress\":[\"The macAddress field is required.\"]}}", "name": "Validation Failed" } ] }, { "name": "Get Bike Sharing Invitations", "request": { "url": { "host": "{{baseUrl}}", "path": "v8\/getBikeSharingInvitations", "query": [], "raw": "{{baseUrl}}\/v8\/getBikeSharingInvitations" }, "method": "GET", "header": [ { "key": "Api-Key", "value": "fcb38d47-f14b-30cf-843b-26283f6a5819" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve bike sharing invitations for the authenticated user. Hash is likely MD5." }, "response": [ { "header": [], "code": 200, "body": "{\"invitations\": [], \"hash\": \"{MD5_HASH}\"}", "name": "Success" }, { "header": [], "code": 200, "body": "{\n \"invitations\": [\n {\n \"guid\": \"{UUIDv3}\",\n \"expiresAt\": \"{ISO8601 Date}\",\n \"startsAt\": null,\n \"endsAt\": null,\n \"duration\": {time in seconds},\n \"ownerName\": \"{Owner Name}\",\n \"bikeName\": \"{Bike Name}\",\n \"modelName\": \"B-05S-E01EU-XX\",\n \"modelColor\": {\n \"name\": \"Gray\",\n \"primary\": \"#929393\",\n \"secondary\": \"#929393\"\n },\n \"frameShape\": \"S\",\n \"bleProfile\": \"ELECTRIFIED_2022\",\n \"links\": {\n \"thumbnail\": \"https:\/\/my.vanmoof.com\/image\/model\/99\"\n }\n }\n ],\n \"hash\": \"{MD5_HASH}\"\n}\n", "name": "Success with invitations" }, { "header": [], "code": 401, "body": "{\"error\":\"AuthenticationException\",\"message\":\"Invalid Credentials\"}", "name": "Unauthorized" }, { "header": [], "code": 422, "body": "{\"error\":\"Please provide your 'Api-Key' header. You can obtain an API key from VanMoof. For more information see the documentation: http:\\\/\\\/api.vanmoof-api.com\\\/apidoc\\\/my\\\/pretty\",\"message\":\"Please provide an API key\"}", "name": "Unprocessable Entity" } ] }, { "name": "Get Bike Sharing Invitations For Bike", "request": { "url": { "host": "{{baseUrl}}", "path": "v8\/getBikeSharingInvitationsForBike\/:bikeId", "query": [], "raw": "{{baseUrl}}\/v8\/getBikeSharingInvitationsForBike\/:bikeId", "variable": [ { "id": "bikeId", "key": "bikeId", "value": "", "description": "The bike ID" } ] }, "method": "GET", "header": [ { "key": "Api-Key", "value": "fcb38d47-f14b-30cf-843b-26283f6a5819" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve bike sharing invitations for a specific bike." }, "response": [ { "header": [], "code": 200, "body": "{\"invitations\": []}", "name": "Success" }, { "header": [], "code": 401, "body": "{\"error\":\"AuthenticationException\",\"message\":\"Invalid Credentials\"}", "name": "Unauthorized" }, { "header": [], "code": 422, "body": "{\"error\":\"Please provide your 'Api-Key' header. You can obtain an API key from VanMoof. For more information see the documentation: http:\\\/\\\/api.vanmoof-api.com\\\/apidoc\\\/my\\\/pretty\",\"message\":\"Please provide an API key\"}", "name": "Unprocessable Entity" } ] }, { "name": "Get Bike Data", "request": { "url": { "host": "{{baseUrl}}", "path": "v8\/getBikeData\/:bikeId", "query": [], "raw": "{{baseUrl}}\/v8\/getBikeData\/:bikeId", "variable": [ { "id": "bikeId", "key": "bikeId", "value": "", "description": "The bike ID" } ] }, "method": "GET", "header": [ { "key": "Api-Key", "value": "fcb38d47-f14b-30cf-843b-26283f6a5819" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve detailed data for a specific bike. Returns same structure as bikeDetails in getCustomerData. Hash is likely MD5." }, "response": [ { "header": [], "code": 200, "body": "{\"data\": {\"id\": \"{BikeID}\", \"name\": \"{Bike Name}\", \"frameNumber\": \"{Frame Number}\", \"bikeId\": \"{Bike ID}\", \"frameSerial\": \"{Frame Serial}\", \"ownerName\": \"{Owner Name}\", \"tripDistance\": 0, \"pendingSmartmoduleMacAddress\": null, \"macAddress\": null, \"mainEcuSerial\": \"{ECU Serial}\", \"smartmoduleCurrentVersion\": null, \"smartmoduleDesiredVersion\": null, \"smartmoduleLatestStable\": false, \"changeBackupCode\": true, \"isTracking\": false, \"highestAvailableSpeedLimit\": null, \"messageAvailable\": false, \"modelName\": \"{Model Name}\", \"modelDetails\": null, \"modelColor\": {\"name\": \"{Color Name}\", \"primary\": \"{Hex Color}\", \"secondary\": \"{Hex Color}\"}, \"frameShape\": \"{Shape}\", \"manufacturer\": \"{Manufacturer}\", \"controller\": \"{Controller}\", \"updateMethod\": \"OAD (encrypted)\", \"eLock\": true, \"gsmModule\": \"{GSM Module}\", \"speaker\": true, \"bleProfile\": \"{BLE Profile}\", \"bleVersion\": null, \"messagesViaBLE\": \"BLEv2\", \"customerRoleFamily\": \"Responsible\", \"customerRole\": \"owner\", \"startsAt\": \"{ISO8601 Date}\", \"endsAt\": null, \"permissions\": [\"ADD_USER\", \"FIRMWARE_UPDATES\", \"REMOVE_USER\", \"REPORT_FOUND\", \"REPORT_STOLEN\", \"SEND_STATISTICS\", \"BACKUP_CODE\", \"BIKE_NAME\", \"VIEW_THEFT_CASES\", \"ALARM_SETTINGS\", \"COUNTRY_SETTINGS\", \"LIGHTS\", \"MOTOR_SUPPORT_LEVEL\", \"UNLOCK\", \"READ_VALUES\", \"STOLEN_MODE\", \"SWAP_SMARTMODULE\"], \"key\": null, \"isFactoryKey\": true, \"customerCount\": 1, \"invitationCount\": 0, \"stolen\": {\"isStolen\": false, \"dateStolen\": null, \"status\": \"not_stolen\", \"latestLocation\": null}, \"hasPeaceOfMind\": false, \"peaceOfMind\": null, \"links\": {\"hash\": \"http:\/\/api.vanmoof-api.com\/v8\/getBikeDataHash\/{BikeID}\", \"thumbnail\": \"https:\/\/my.vanmoof.com\/image\/model\/{ModelID}\"}, \"serviceModeEnabled\": false, \"workshopInfo\": []}, \"hash\": \"{MD5_HASH}\"}", "name": "Success (example from S5)" }, { "header": [], "code": 400, "body": "{\"error\": \"BikeNotFoundException\", \"message\": \"Bike not found\"}", "name": "Bike Not Found" }, { "header": [], "code": 401, "body": "{\"error\":\"AuthenticationException\",\"message\":\"Invalid Credentials\"}", "name": "Invalid Credentials" }, { "header": [], "code": 401, "body": "{\"error\": \"CustomerNotAuthorizedException\", \"message\": \"Customer not authorized for this action\"}", "name": "Customer Not Authorized" }, { "header": [], "code": 422, "body": "{\"error\":\"Please provide your 'Api-Key' header. You can obtain an API key from VanMoof. For more information see the documentation: http:\\\/\\\/api.vanmoof-api.com\\\/apidoc\\\/my\\\/pretty\",\"message\":\"Please provide an API key\"}", "name": "Unprocessable Entity" } ] }, { "name": "Get Bike Messages", "request": { "url": { "host": "{{baseUrl}}", "path": "v8\/getBikeMessages\/:bikeId", "query": [], "raw": "{{baseUrl}}\/v8\/getBikeMessages\/:bikeId", "variable": [ { "id": "bikeId", "key": "bikeId", "value": "", "description": "The bike ID" } ] }, "method": "GET", "header": [ { "key": "Api-Key", "value": "fcb38d47-f14b-30cf-843b-26283f6a5819" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve messages for a specific bike." }, "response": [ { "header": [], "code": 200, "body": "[]", "name": "Success" }, { "header": [], "code": 200, "body": "[{\"content\":\"\"}]", "name": "Success with content" }, { "header": [], "code": 400, "body": "{\"error\":\"ValidationException\",\"message\":\"Validation failed\",\"violations\":{\"bikeId\":[\"You are not registered as customer of this bike.\"]}}", "name": "Validation Failed" }, { "header": [], "code": 401, "body": "{\"error\":\"AuthenticationException\",\"message\":\"Invalid Credentials\"}", "name": "Unauthorized" }, { "header": [], "code": 422, "body": "{\"error\":\"Please provide your 'Api-Key' header. You can obtain an API key from VanMoof. For more information see the documentation: http:\\\/\\\/api.vanmoof-api.com\\\/apidoc\\\/my\\\/pretty\",\"message\":\"Please provide an API key\"}", "name": "Unprocessable Entity" } ] }, { "name": "Get Theft Case", "request": { "url": { "host": "{{baseUrl}}", "path": "v8\/getTheftCase\/:frameNumber", "query": [], "raw": "{{baseUrl}}\/v8\/getTheftCase\/:frameNumber", "variable": [ { "id": "frameNumber", "key": "frameNumber", "value": "", "description": "The bike frame number" } ] }, "method": "GET", "header": [ { "key": "Api-Key", "value": "fcb38d47-f14b-30cf-843b-26283f6a5819" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve theft case information for a specific bike by frame number." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Success" }, { "header": [], "code": 400, "body": "{\"error\":\"BikeNotStolenException\",\"message\":\"Bike not stolen\"}", "name": "Bike Not Stolen" }, { "header": [], "code": 401, "body": "{\"error\":\"AuthenticationException\",\"message\":\"Invalid Credentials\"}", "name": "Unauthorized" }, { "header": [], "code": 401, "body": "{\"error\": \"CustomerNotAuthorizedException\", \"message\": \"Customer not authorized for this action\"}", "name": "Customer Not Authorized" }, { "header": [], "code": 422, "body": "{\"error\":\"Please provide your 'Api-Key' header. You can obtain an API key from VanMoof. For more information see the documentation: http:\\\/\\\/api.vanmoof-api.com\\\/apidoc\\\/my\\\/pretty\",\"message\":\"Please provide an API key\"}", "name": "Unprocessable Entity" } ] }, { "name": "Get Bike Data Hash", "request": { "url": { "host": "{{baseUrl}}", "path": "v8\/getBikeDataHash\/:bikeId", "query": [], "raw": "{{baseUrl}}\/v8\/getBikeDataHash\/:bikeId", "variable": [ { "id": "bikeId", "key": "bikeId", "value": "", "description": "The bike ID" } ] }, "method": "GET", "header": [ { "key": "Api-Key", "value": "fcb38d47-f14b-30cf-843b-26283f6a5819" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve the hash for a specific bike using its bike ID." }, "response": [ { "header": [], "code": 200, "body": "{\"hash\": \"{MD5_HASH}\"}", "name": "Success" }, { "header": [], "code": 401, "body": "{\"error\":\"AuthenticationException\",\"message\":\"Invalid Credentials\"}", "name": "Invalid Credentials" }, { "header": [], "code": 401, "body": "{\"error\": \"CustomerNotAuthorizedException\", \"message\": \"Customer not authorized for this action\"}", "name": "Customer Not Authorized" }, { "header": [], "code": 422, "body": "{\"error\":\"Please provide your 'Api-Key' header. You can obtain an API key from VanMoof. For more information see the documentation: http:\\\/\\\/api.vanmoof-api.com\\\/apidoc\\\/my\\\/pretty\",\"message\":\"Please provide an API key\"}", "name": "Unprocessable Entity" } ] }, { "name": "Create Bike Sharing Invitation", "request": { "url": { "host": "{{baseUrl}}", "path": "v8\/createBikeSharingInvitation", "query": [], "raw": "{{baseUrl}}\/v8\/createBikeSharingInvitation" }, "method": "POST", "header": [ { "key": "Api-Key", "value": "fcb38d47-f14b-30cf-843b-26283f6a5819" }, { "key": "Content-Type", "value": "application\/json; charset=utf-8" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":null,\"duration\":null,\"bikeId\":null}" }, "description": "Create an invitation to share a bike with another user via email." }, "response": [ { "header": [], "code": 200, "body": "{\"result\": {\"guid\": \"{UUIDv3}\", \"expiresAt\": \"{ISO8601 Date}\", \"startsAt\": null, \"endsAt\": null, \"duration\": \"{time in seconds}\", \"role\": \"user\", \"email\": \"{email}\"}}", "name": "Success" }, { "header": [], "code": 400, "body": "{\"error\":\"ValidationException\",\"message\":\"Validation failed\",\"violations\":{\"email\":[\"The email must be a valid email address.\"],\"duration\":[\"The duration must be an integer.\"]}}", "name": "Validation Failed" }, { "header": [], "code": 401, "body": "{\"error\":\"AuthenticationException\",\"message\":\"Invalid Credentials\"}", "name": "Invalid Credentials" }, { "header": [], "code": 401, "body": "{\"error\":\"CustomerNotAuthorizedException\",\"message\":\"Customer not authorized for this action\"}", "name": "Customer Not Authorized" }, { "header": [], "code": 422, "body": "{\"error\":\"Please provide your 'Api-Key' header. You can obtain an API key from VanMoof. For more information see the documentation: http:\\\/\\\/api.vanmoof-api.com\\\/apidoc\\\/my\\\/pretty\",\"message\":\"Please provide an API key\"}", "name": "Unprocessable Entity" } ] }, { "name": "Revoke Workshop Sharing Invitation", "request": { "url": { "host": "{{baseUrl}}", "path": "v8\/revokeWorkshopSharingInvitation", "query": [], "raw": "{{baseUrl}}\/v8\/revokeWorkshopSharingInvitation" }, "method": "POST", "header": [ { "key": "Api-Key", "value": "fcb38d47-f14b-30cf-843b-26283f6a5819" }, { "key": "Content-Type", "value": "application\/json; charset=utf-8" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"bikeId\":null}" }, "description": "Revoke workshop sharing invitations for a specific bike. It updates the invitation and sets endsAt to now." }, "response": [ { "header": [], "code": 200, "body": "{\"result\": [{\"email\": \"{Workshop Email}\", \"name\": \"{Workshop Name}\", \"startsAt\": \"{ISO8601 Date}\", \"endsAt\": \"{ISO8601 Date}\"}]}", "name": "Success" }, { "header": [], "code": 200, "body": "{\"result\": []}", "name": "Success (no workshops)" }, { "header": [], "code": 401, "body": "{\"error\":\"AuthenticationException\",\"message\":\"Invalid Credentials\"}", "name": "Invalid Credentials" }, { "header": [], "code": 401, "body": "{\"error\":\"CustomerNotAuthorizedException\",\"message\":\"Customer not authorized for this action\"}", "name": "Customer Not Authorized" }, { "header": [], "code": 422, "body": "{\"error\":\"Please provide your 'Api-Key' header. You can obtain an API key from VanMoof. For more information see the documentation: http:\\\/\\\/api.vanmoof-api.com\\\/apidoc\\\/my\\\/pretty\",\"message\":\"Please provide an API key\"}", "name": "Unprocessable Entity" } ] }, { "name": "Revoke Bike Sharing Invitation", "request": { "url": { "host": "{{baseUrl}}", "path": "v8\/revokeBikeSharingInvitation\/:guid", "query": [], "raw": "{{baseUrl}}\/v8\/revokeBikeSharingInvitation\/:guid", "variable": [ { "id": "guid", "key": "guid", "value": "", "description": "Invitation GUID" } ] }, "method": "POST", "header": [ { "key": "Api-Key", "value": "fcb38d47-f14b-30cf-843b-26283f6a5819" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Revoke a previously created bike sharing invitation by GUID." }, "response": [ { "header": [], "code": 200, "body": "{\"result\": true}", "name": "Success" }, { "header": [], "code": 401, "body": "{\"error\":\"AuthenticationException\",\"message\":\"Invalid Credentials\"}", "name": "Invalid Credentials" }, { "header": [], "code": 401, "body": "{\"error\":\"CustomerNotAuthorizedException\",\"message\":\"Customer not authorized for this action\"}", "name": "Customer Not Authorized" }, { "header": [], "code": 404, "body": "{\"error\":\"BikeSharingInvitationNotFoundException\",\"message\":\"This bike sharing invitation does not exist.\"}", "name": "Invitation Not Found" }, { "header": [], "code": 422, "body": "{\"error\":\"Please provide your 'Api-Key' header. You can obtain an API key from VanMoof. For more information see the documentation: http:\\\/\\\/api.vanmoof-api.com\\\/apidoc\\\/my\\\/pretty\",\"message\":\"Please provide an API key\"}", "name": "Unprocessable Entity" } ] }, { "name": "Create Workshop Sharing Invitation", "request": { "url": { "host": "{{baseUrl}}", "path": "v8\/createWorkshopSharingInvitation", "query": [], "raw": "{{baseUrl}}\/v8\/createWorkshopSharingInvitation" }, "method": "POST", "header": [ { "key": "Api-Key", "value": "fcb38d47-f14b-30cf-843b-26283f6a5819" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":null,\"bikeId\":null}" }, "description": "Create an invitation for a workshop to access a bike. Valid for 6 months. QR Code content \"https:\/\/www.vanmoof.com\/invite-shop?email={Workshop Email}&name={workshop Name}\"" }, "response": [ { "header": [], "code": 200, "body": "{\"result\": {\"email\": \"{Workshop Email}\", \"name\": \"{Workshop Name}\", \"startsAt\": \"{ISO8601 Date}\", \"endsAt\": \"{ISO8601 Date}\"}}", "name": "Success" }, { "header": [], "code": 400, "body": "{\"error\":\"BikeSharingNotAWorkshopException\",\"message\":\"The provided e-mail address does not belong to a valid bike workshop.\"}", "name": "Validation Failed" }, { "header": [], "code": 401, "body": "{\"error\":\"AuthenticationException\",\"message\":\"Invalid Credentials\"}", "name": "Invalid Credentials" }, { "header": [], "code": 401, "body": "{\"error\":\"CustomerNotAuthorizedException\",\"message\":\"Customer not authorized for this action\"}", "name": "Customer Not Authorized" }, { "header": [], "code": 422, "body": "{\"error\":\"Please provide your 'Api-Key' header. You can obtain an API key from VanMoof. For more information see the documentation: http:\\\/\\\/api.vanmoof-api.com\\\/apidoc\\\/my\\\/pretty\",\"message\":\"Please provide an API key\"}", "name": "Unprocessable Entity" } ] }, { "name": "Decline Bike Sharing Invitation", "request": { "url": { "host": "{{baseUrl}}", "path": "v8\/declineBikeSharingInvitation\/:guid", "query": [], "raw": "{{baseUrl}}\/v8\/declineBikeSharingInvitation\/:guid", "variable": [ { "id": "guid", "key": "guid", "value": "", "description": "The GUID of the bike sharing invitation to decline." } ] }, "method": "POST", "header": [ { "key": "Api-Key", "value": "fcb38d47-f14b-30cf-843b-26283f6a5819" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Decline a bike sharing invitation using the invitation GUID." }, "response": [ { "header": [], "code": 200, "body": "{\"result\": true}", "name": "Success" }, { "header": [], "code": 401, "body": "{\"error\":\"AuthenticationException\",\"message\":\"Invalid Credentials\"}", "name": "Unauthorized" }, { "header": [], "code": 401, "body": "{\"error\":\"CustomerNotAuthorizedException\",\"message\":\"Customer not authorized for this action\"}", "name": "Customer Not Authorized" }, { "header": [], "code": 404, "body": "{\"error\":\"BikeSharingInvitationNotFoundException\",\"message\":\"This bike sharing invitation does not exist.\"}", "name": "Invitation Not Found" }, { "header": [], "code": 422, "body": "{\"error\":\"Please provide your 'Api-Key' header. You can obtain an API key from VanMoof. For more information see the documentation: http:\\\/\\\/api.vanmoof-api.com\\\/apidoc\\\/my\\\/pretty\",\"message\":\"Please provide an API key\"}", "name": "Unprocessable Entity" } ] }, { "name": "Accept Bike Sharing Invitation", "request": { "url": { "host": "{{baseUrl}}", "path": "v8\/acceptBikeSharingInvitation\/:guid", "query": [], "raw": "{{baseUrl}}\/v8\/acceptBikeSharingInvitation\/:guid", "variable": [ { "id": "guid", "key": "guid", "value": "", "description": "The GUID of the bike sharing invitation to accept." } ] }, "method": "POST", "header": [ { "key": "Api-Key", "value": "fcb38d47-f14b-30cf-843b-26283f6a5819" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Accept a bike sharing invitation using the invitation GUID. It responds with the same schema as getBikeData. \"user\" is missing ADD_USER, FIRMWARE_UPDATES, REMOVE_USER, BACKUP_CODE, BIKE_NAME, STOLEN_MODE, SWAP_SMARTMODULE permissions." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": {BikeID},\n \"name\": \"{Bike Name}\",\n \"frameNumber\": \"{Frame Number}\",\n \"bikeId\": \"{Bike ID}\",\n \"frameSerial\": \"{Frame Serial}\",\n \"ownerName\": \"{Owner Name}\",\n \"tripDistance\": 0,\n \"pendingSmartmoduleMacAddress\": null,\n \"macAddress\": null,\n \"mainEcuSerial\": \"{ECU Serial}\",\n \"smartmoduleCurrentVersion\": null,\n \"smartmoduleDesiredVersion\": null,\n \"smartmoduleLatestStable\": false,\n \"changeBackupCode\": true,\n \"isTracking\": false,\n \"highestAvailableSpeedLimit\": null,\n \"messageAvailable\": false,\n \"modelName\": \"{Model Name}\",\n \"modelDetails\": null,\n \"modelColor\": {\n \"name\": \"{Color Name}\",\n \"primary\": \"{Primary Color}\",\n \"secondary\": \"{Secondary Color}\"\n },\n \"frameShape\": \"S\",\n \"manufacturer\": \"pegatron\",\n \"controller\": \"2022\",\n \"updateMethod\": \"OAD (encrypted)\",\n \"eLock\": true,\n \"gsmModule\": \"4G\",\n \"speaker\": true,\n \"bleProfile\": \"ELECTRIFIED_2022\",\n \"bleVersion\": null,\n \"messagesViaBLE\": \"BLEv2\",\n \"customerRoleFamily\": \"User\",\n \"customerRole\": \"user\",\n \"startsAt\": \"{ISO8601 Date}\",\n \"endsAt\": \"{ISO8601 Date}\",\n \"permissions\": [\n \"REPORT_FOUND\",\n \"SEND_STATISTICS\",\n \"REPORT_STOLEN\",\n \"VIEW_THEFT_CASES\",\n \"ALARM_SETTINGS\",\n \"COUNTRY_SETTINGS\",\n \"LIGHTS\",\n \"MOTOR_SUPPORT_LEVEL\",\n \"UNLOCK\",\n \"READ_VALUES\"\n ],\n \"key\": null,\n \"isFactoryKey\": true,\n \"customerCount\": 2,\n \"invitationCount\": 2,\n \"stolen\": {\n \"isStolen\": false,\n \"dateStolen\": null,\n \"status\": \"not_stolen\",\n \"latestLocation\": null\n },\n \"hasPeaceOfMind\": false,\n \"peaceOfMind\": null,\n \"links\": {\n \"hash\": \"http:\/\/api.vanmoof-api.com\/v8\/getBikeDataHash\/176393\",\n \"thumbnail\": \"https:\/\/my.vanmoof.com\/image\/model\/99\"\n },\n \"serviceModeEnabled\": false,\n \"workshopInfo\": []\n }\n}\n", "name": "Success (example from S5)" }, { "header": [], "code": 401, "body": "{\"error\":\"AuthenticationException\",\"message\":\"Invalid Credentials\"}", "name": "Unauthorized" }, { "header": [], "code": 422, "body": "{\"error\":\"ValidationException\",\"message\":\"Validation failed\",\"violations\":{\"guid\":[\"The guid field is required.\"]}}", "name": "Validation Failed" }, { "header": [], "code": 422, "body": "{\"error\":\"Please provide your 'Api-Key' header. You can obtain an API key from VanMoof. For more information see the documentation: http:\\\/\\\/api.vanmoof-api.com\\\/apidoc\\\/my\\\/pretty\",\"message\":\"Please provide an API key\"}", "name": "Unprocessable Entity" } ] }, { "name": "Remove Customer Bike Sharing For Bike", "request": { "url": { "host": "{{baseUrl}}", "path": "v8\/removeCustomerBikeSharingForBike", "query": [], "raw": "{{baseUrl}}\/v8\/removeCustomerBikeSharingForBike" }, "method": "POST", "header": [ { "key": "Api-Key", "value": "fcb38d47-f14b-30cf-843b-26283f6a5819" }, { "key": "Content-Type", "value": "application\/json; charset=utf-8" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"bikeId\":null}" }, "description": "Remove all bike sharing invitations for a specific bike." }, "response": [ { "header": [], "code": 200, "body": "{\"result\": true}", "name": "Success" }, { "header": [], "code": 400, "body": "{\"error\":\"BikeNotFoundException\",\"message\":\"Bike not found\"}", "name": "Validation Failed" }, { "header": [], "code": 401, "body": "{\"error\":\"AuthenticationException\",\"message\":\"Invalid Credentials\"}", "name": "Unauthorized" }, { "header": [], "code": 422, "body": "{\"error\":\"ValidationException\",\"message\":\"Validation failed\",\"violations\":{\"bikeId\":[\"The bikeId field is required.\"]}}", "name": "Validation Failed" }, { "header": [], "code": 422, "body": "{\"error\":\"Please provide your 'Api-Key' header. You can obtain an API key from VanMoof. For more information see the documentation: http:\\\/\\\/api.vanmoof-api.com\\\/apidoc\\\/my\\\/pretty\",\"message\":\"Please provide an API key\"}", "name": "Unprocessable Entity" } ] }, { "name": "Register Bike To Current User", "request": { "url": { "host": "{{baseUrl}}", "path": "v8\/registerBikeToCurrentUser", "query": [], "raw": "{{baseUrl}}\/v8\/registerBikeToCurrentUser" }, "method": "POST", "header": [ { "key": "Api-Key", "value": "fcb38d47-f14b-30cf-843b-26283f6a5819" }, { "key": "Content-Type", "value": "application\/json; charset=utf-8" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"framenumber\":null,\"verification\":null}" }, "description": "Register a bike to the currently authenticated user using the frame number and verification code. QR Code Content: https:\/\/my.vanmoof.com\/proof-of-ownership?bike_id={framenumber}&validation={validationCode}" }, "response": [ { "header": [], "code": 400, "body": "{\n \"error\": \"BikeRegisterToCurrentCustomerException\",\n \"message\": \"This frame number can\u2019t be registered.\"\n}\n", "name": "Bike Registration Failed" }, { "header": [], "code": 400, "body": "{\n \"error\": \"InvalidVerificationCodeException\",\n \"message\": \"An invalid verification code is provided to register bike with framenumber \/ frameserial: {FrameNumber} verification code : {VerificationCode}\"\n}\n", "name": "Invalid Verification Code" }, { "header": [], "code": 400, "body": "{\n \"error\": \"BikeNotFoundException\",\n \"message\": \"No bike found during registration\"\n}\n", "name": "No Bike Found During Registration" }, { "header": [], "code": 401, "body": "{\"error\":\"AuthenticationException\",\"message\":\"Invalid Credentials\"}", "name": "Unauthorized" }, { "header": [], "code": 422, "body": "{\"error\":\"Please provide your 'Api-Key' header. You can obtain an API key from VanMoof. For more information see the documentation: http:\\\/\\\/api.vanmoof-api.com\\\/apidoc\\\/my\\\/pretty\",\"message\":\"Please provide an API key\"}", "name": "Unprocessable Entity" } ] }, { "name": "Get Desired Update Version Info", "request": { "url": { "host": "{{baseUrl}}", "path": "v8\/getDesiredUpdateVersionInfo\/:bikeId", "query": [], "raw": "{{baseUrl}}\/v8\/getDesiredUpdateVersionInfo\/:bikeId", "variable": [ { "id": "bikeId", "key": "bikeId", "value": "", "description": "The ID of the bike to retrieve update information for." } ] }, "method": "GET", "header": [ { "key": "Api-Key", "value": "fcb38d47-f14b-30cf-843b-26283f6a5819" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve the desired update version information for a specific bike. This only works for at least the SA3\/SA4 bikes. SA5 and later uses another API." }, "response": [ { "header": [], "code": 200, "body": "{\n \"updateVersion\": \"{Version}\",\n \"releaseDate\": \"{ISO8601 Date}\",\n \"latestStable\": false,\n \"releaseNotes\": \"\",\n \"fileSize\": 0,\n \"firmwareCrc\": \"{CRC}\",\n \"transportCrc\": \"{CRC}\",\n \"encrypted\": true,\n \"pendingUpdatesCount\": 0,\n \"pendingUpdates\": [\n {\n \"updateVersion\": \"{Version}\",\n \"releaseDate\": \"{ISO8601 Date}\",\n \"latestStable\": true,\n \"releaseNotes\": \"\",\n \"fileSize\": 0\",\n \"firmwareCrc\": \"{CRC}\",\n \"transportCrc\": \"{CRC}\",\n \"encrypted\": true\n }\n ]\n}\n", "name": "Success" }, { "header": [], "code": 400, "body": "{\n \"error\": \"ValidationException\",\n \"message\": \"Validation failed\",\n \"violations\": {\n \"bikeId\": [\n \"You are not registered as customer of this bike.\"\n ]\n }\n}\n", "name": "Validation Failed" }, { "header": [], "code": 401, "body": "{\"error\":\"AuthenticationException\",\"message\":\"Invalid Credentials\"}", "name": "Unauthorized" }, { "header": [], "code": 422, "body": "{\"error\":\"Please provide your 'Api-Key' header. You can obtain an API key from VanMoof. For more information see the documentation: http:\\\/\\\/api.vanmoof-api.com\\\/apidoc\\\/my\\\/pretty\",\"message\":\"Please provide an API key\"}", "name": "Unprocessable Entity" } ] }, { "name": "Get Desired Update Version File", "request": { "url": { "host": "{{baseUrl}}", "path": "v8\/getDesiredUpdateVersionFile\/:bikeId", "query": [], "raw": "{{baseUrl}}\/v8\/getDesiredUpdateVersionFile\/:bikeId", "variable": [ { "id": "bikeId", "key": "bikeId", "value": "", "description": "The ID of the bike to retrieve the update file for." } ] }, "method": "GET", "header": [ { "key": "Api-Key", "value": "fcb38d47-f14b-30cf-843b-26283f6a5819" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve the desired update version file for a specific bike. This only works for at least the SA3\/SA4 bikes. SA5 and later uses another API." }, "response": [ { "header": [], "code": 200, "body": "application\/zip", "name": "Success" }, { "header": [], "code": 400, "body": "{\n \"error\": \"ValidationException\",\n \"message\": \"Validation failed\",\n \"violations\": {\n \"bikeId\": [\n \"You are not registered as customer of this bike.\"\n ]\n }\n}\n", "name": "Validation Failed" }, { "header": [], "code": 401, "body": "{\"error\":\"AuthenticationException\",\"message\":\"Invalid Credentials\"}", "name": "Unauthorized" }, { "header": [], "code": 422, "body": "{\"error\":\"Please provide your 'Api-Key' header. You can obtain an API key from VanMoof. For more information see the documentation: http:\\\/\\\/api.vanmoof-api.com\\\/apidoc\\\/my\\\/pretty\",\"message\":\"Please provide an API key\"}", "name": "Unprocessable Entity" } ] }, { "name": "Report Stolen", "request": { "url": { "host": "{{baseUrl}}", "path": "v8\/reportStolen", "query": [], "raw": "{{baseUrl}}\/v8\/reportStolen" }, "method": "POST", "header": [ { "key": "Api-Key", "value": "fcb38d47-f14b-30cf-843b-26283f6a5819" }, { "key": "Content-Type", "value": "application\/json; charset=utf-8" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"bikeId\":null}" }, "description": "Report a bike as stolen." }, "response": [ { "header": [], "code": 200, "body": "{\n \"isStolen\": true,\n \"dateStolen\": \"{ISO8601 Date}\",\n \"status\": \"confirmed\",\n \"latestLocation\": null,\n \"publicTrackingUrl\": \"https:\/\/my.vanmoof.com\/findmybike\/show\/{UUIDv4}\"\n}\n", "name": "Success" }, { "header": [], "code": 400, "body": "{\n \"error\": \"ValidationException\",\n \"message\": \"Validation failed\",\n \"violations\": {\n \"bikeId\": [\n \"You are not registered as customer of this bike.\"\n ]\n }\n}\n", "name": "Validation Failed" }, { "header": [], "code": 401, "body": "{\"error\":\"AuthenticationException\",\"message\":\"Invalid Credentials\"}", "name": "Unauthorized" }, { "header": [], "code": 422, "body": "{\"error\":\"Please provide your 'Api-Key' header. You can obtain an API key from VanMoof. For more information see the documentation: http:\\\/\\\/api.vanmoof-api.com\\\/apidoc\\\/my\\\/pretty\",\"message\":\"Please provide an API key\"}", "name": "Unprocessable Entity" } ] }, { "name": "Report Found", "request": { "url": { "host": "{{baseUrl}}", "path": "v8\/reportFound", "query": [], "raw": "{{baseUrl}}\/v8\/reportFound" }, "method": "POST", "header": [ { "key": "Api-Key", "value": "fcb38d47-f14b-30cf-843b-26283f6a5819" }, { "key": "Content-Type", "value": "application\/json; charset=utf-8" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"bikeId\":null}" }, "description": "Report a bike as found and optionally disable tracking." }, "response": [ { "header": [], "code": 200, "body": "{\"result\": true}", "name": "Success" }, { "header": [], "code": 400, "body": "{\n \"error\": \"ValidationException\",\n \"message\": \"Validation failed\",\n \"violations\": {\n \"bikeId\": [\n \"You are not registered as customer of this bike.\"\n ]\n }\n}\n", "name": "Validation Failed" }, { "header": [], "code": 400, "body": "{\"error\":\"BikeNotStolenException\",\"message\":\"Bike not stolen\"}", "name": "Bike Not Stolen" }, { "header": [], "code": 401, "body": "{\"error\":\"AuthenticationException\",\"message\":\"Invalid Credentials\"}", "name": "Unauthorized" }, { "header": [], "code": 422, "body": "{\"error\":\"Please provide your 'Api-Key' header. You can obtain an API key from VanMoof. For more information see the documentation: http:\\\/\\\/api.vanmoof-api.com\\\/apidoc\\\/my\\\/pretty\",\"message\":\"Please provide an API key\"}", "name": "Unprocessable Entity" } ] }, { "name": "Remove Bike Ownership", "request": { "url": { "host": "{{baseUrl}}", "path": "v8\/removeBikeOwnership", "query": [], "raw": "{{baseUrl}}\/v8\/removeBikeOwnership" }, "method": "POST", "header": [ { "key": "Api-Key", "value": "fcb38d47-f14b-30cf-843b-26283f6a5819" }, { "key": "Content-Type", "value": "application\/json; charset=utf-8" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"bikeId\":null}" }, "description": "Remove ownership of a bike by providing the bike ID." }, "response": [ { "header": [], "code": 200, "body": "{\"result\": true}", "name": "Success" }, { "header": [], "code": 400, "body": "{\"error\":\"ValidationException\",\"message\":\"Validation failed\",\"violations\":{\"bikeId\":[\"The bikeId field is required.\"]}}", "name": "Validation Failed" }, { "header": [], "code": 400, "body": "{\"error\":\"BikeNotFoundException\",\"message\":\"Bike not found\"}", "name": "Bike Not Found" }, { "header": [], "code": 401, "body": "{\"error\":\"AuthenticationException\",\"message\":\"Invalid Credentials\"}", "name": "Invalid Credentials" }, { "header": [], "code": 422, "body": "{\"error\":\"Please provide your 'Api-Key' header. You can obtain an API key from VanMoof. For more information see the documentation: http:\\\/\\\/api.vanmoof-api.com\\\/apidoc\\\/my\\\/pretty\",\"message\":\"Please provide an API key\"}", "name": "Unprocessable Entity" } ] }, { "name": "Update Customer on Bike", "request": { "url": { "host": "{{baseUrl}}", "path": "v8\/updateCustomerOnBike", "query": [], "raw": "{{baseUrl}}\/v8\/updateCustomerOnBike" }, "method": "POST", "header": [ { "key": "Api-Key", "value": "fcb38d47-f14b-30cf-843b-26283f6a5819" }, { "key": "Content-Type", "value": "application\/json; charset=utf-8" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"bikeId\":null,\"email\":null,\"role\":null}" }, "description": "Update the customer associated with a bike, specifying their role." }, "response": [ { "header": [], "code": 200, "body": "{\"result\": true}", "name": "Success" }, { "header": [], "code": 204, "body": null, "name": "No Content" }, { "header": [], "code": 400, "body": "{\"error\":\"ValidationException\",\"message\":\"Validation failed\",\"violations\":{\"bikeId\":[\"The bikeId field is required.\"]}}", "name": "Validation Failed" }, { "header": [], "code": 400, "body": "{\"error\":\"ValidationException\",\"message\":\"Validation failed\",\"violations\":{\"bikeId\":[\"You are not registered as customer of this bike.\"],\"role\":[\"This is not a regular customer role.\"]}}", "name": "Validation Failed (tried owner role)" }, { "header": [], "code": 400, "body": "{\"error\":\"ValidationException\",\"message\":\"Validation failed\",\"violations\":{\"email\":[\"There is no customer with this email.\"]}}", "name": "Customer Not Found" }, { "header": [], "code": 400, "body": "{\"error\":\"BikeNotFoundException\",\"message\":\"Bike not found\"}", "name": "Bike Not Found" }, { "header": [], "code": 401, "body": "{\"error\":\"AuthenticationException\",\"message\":\"Invalid Credentials\"}", "name": "Invalid Credentials" }, { "header": [], "code": 422, "body": "{\"error\":\"Please provide your 'Api-Key' header. You can obtain an API key from VanMoof. For more information see the documentation: http:\\\/\\\/api.vanmoof-api.com\\\/apidoc\\\/my\\\/pretty\",\"message\":\"Please provide an API key\"}", "name": "Unprocessable Entity" } ] }, { "name": "Remove Customer from Bike", "request": { "url": { "host": "{{baseUrl}}", "path": "v8\/removeCustomerFromBike", "query": [], "raw": "{{baseUrl}}\/v8\/removeCustomerFromBike" }, "method": "POST", "header": [ { "key": "Api-Key", "value": "fcb38d47-f14b-30cf-843b-26283f6a5819" }, { "key": "Content-Type", "value": "application\/json; charset=utf-8" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"bikeId\":null,\"email\":null}" }, "description": "Remove a customer from a bike using the bike ID and customer email." }, "response": [ { "header": [], "code": 200, "body": "{\"result\": true}", "name": "Success" }, { "header": [], "code": 400, "body": "{\"error\":\"ValidationException\",\"message\":\"Validation failed\",\"violations\":{\"bikeId\":[\"The bikeId field is required.\"]}}", "name": "Validation Failed" }, { "header": [], "code": 400, "body": "{\"error\":\"ValidationException\",\"message\":\"Validation failed\",\"violations\":{\"bikeId\":[\"You are not registered as customer of this bike.\"],\"role\":[\"This is not a regular customer role.\"]}}", "name": "Validation Failed (tried owner role)" }, { "header": [], "code": 400, "body": "{\"error\":\"ValidationException\",\"message\":\"Validation failed\",\"violations\":{\"email\":[\"There is no customer with this email.\"]}}", "name": "Customer Not Found" }, { "header": [], "code": 400, "body": "{\"error\":\"BikeNotFoundException\",\"message\":\"Bike not found\"}", "name": "Bike Not Found" }, { "header": [], "code": 401, "body": "{\"error\":\"AuthenticationException\",\"message\":\"Invalid Credentials\"}", "name": "Invalid Credentials" }, { "header": [], "code": 422, "body": "{\"error\":\"Please provide your 'Api-Key' header. You can obtain an API key from VanMoof. For more information see the documentation: http:\\\/\\\/api.vanmoof-api.com\\\/apidoc\\\/my\\\/pretty\",\"message\":\"Please provide an API key\"}", "name": "Unprocessable Entity" } ] }, { "name": "Post Statistics", "request": { "url": { "host": "{{baseUrl}}", "path": "v8\/postStatistics", "query": [], "raw": "{{baseUrl}}\/v8\/postStatistics" }, "method": "POST", "header": [ { "key": "Api-Key", "value": "fcb38d47-f14b-30cf-843b-26283f6a5819" }, { "key": "Content-Type", "value": "application\/json; charset=utf-8" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"bikeId\":null,\"timestamp\":null,\"distance\":null,\"rideTime\":null,\"batteryLevel\":null,\"averageSpeed\":null,\"maxSpeed\":null}" }, "description": "Submit ride statistics for a specific bike." }, "response": [ { "header": [], "code": 200, "body": "{\"result\": true}", "name": "Success" }, { "header": [], "code": 400, "body": "{\"error\":\"ValidationException\",\"message\":\"Validation failed\",\"violations\":{\"bikeId\":[\"The bikeId field is required.\"]}}", "name": "Validation Failed" }, { "header": [], "code": 400, "body": "{\"error\":\"BikeNotFoundException\",\"message\":\"Bike not found\"}", "name": "Bike Not Found" }, { "header": [], "code": 401, "body": "{\"error\":\"AuthenticationException\",\"message\":\"Invalid Credentials\"}", "name": "Invalid Credentials" }, { "header": [], "code": 422, "body": "{\"error\":\"Please provide your 'Api-Key' header. You can obtain an API key from VanMoof. For more information see the documentation: http:\\\/\\\/api.vanmoof-api.com\\\/apidoc\\\/my\\\/pretty\",\"message\":\"Please provide an API key\"}", "name": "Unprocessable Entity" } ] }, { "name": "Post Bike Response", "request": { "url": { "host": "{{baseUrl}}", "path": "v8\/postBikeResponse\/:bikeId", "query": [], "raw": "{{baseUrl}}\/v8\/postBikeResponse\/:bikeId", "variable": [ { "id": "bikeId", "key": "bikeId", "value": "", "description": "The ID of the bike to submit the response for." } ] }, "method": "POST", "header": [ { "key": "Api-Key", "value": "fcb38d47-f14b-30cf-843b-26283f6a5819" }, { "key": "Content-Type", "value": "application\/json; charset=utf-8" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"data\":null}" }, "description": "Submit a response from the bike using its bike ID." }, "response": [ { "header": [], "code": 200, "body": "{\"result\": true}", "name": "Success" }, { "header": [], "code": 204, "body": null, "name": "No Content" }, { "header": [], "code": 400, "body": "{\"error\":\"ValidationException\",\"message\":\"Validation failed\",\"violations\":{\"bikeId\":[\"The bikeId field is required.\"]}}", "name": "Validation Failed" }, { "header": [], "code": 400, "body": "{\"error\":\"BikeNotFoundException\",\"message\":\"Bike not found\"}", "name": "Bike Not Found" }, { "header": [], "code": 401, "body": "{\"error\":\"AuthenticationException\",\"message\":\"Invalid Credentials\"}", "name": "Invalid Credentials" }, { "header": [], "code": 422, "body": "{\"error\":\"Please provide your 'Api-Key' header. You can obtain an API key from VanMoof. For more information see the documentation: http:\\\/\\\/api.vanmoof-api.com\\\/apidoc\\\/my\\\/pretty\",\"message\":\"Please provide an API key\"}", "name": "Unprocessable Entity" } ] }, { "name": "Create Certificate", "request": { "url": { "host": "{{baseUrl}}", "path": "bikes\/:frameNumber\/create_certificate", "query": [], "raw": "{{baseUrl}}\/bikes\/:frameNumber\/create_certificate", "variable": [ { "id": "frameNumber", "key": "frameNumber", "value": "", "description": "The frame number of the bike." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json; charset=utf-8" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"public_key\":null}" }, "description": "Create a certificate for a bike using its Bike ID. This endpoint uses the Bike API (bikeapi.production.vanmoof.cloud) instead of the main API. Ratelimited at 100 requests per 15 seconds." }, "response": [ { "header": [], "code": 200, "body": "{\n \"created_at\": \"{ISO8601 Date}\",\n \"expiry\": \"{ISO8601 Date}\",\n \"certificate\": \"{Base64 Encoded Certificate}\"\n}", "name": "Success" }, { "header": [], "code": 400, "body": "{\"err\": \"invalid body: EOF\"}", "name": "Missing Body" }, { "header": [], "code": 400, "body": "{\"err\": \"bike_id format invalid\"}", "name": "Bike ID invalid" }, { "header": [], "code": 400, "body": "{\"err\":\"invalid ed25519 public key\"}", "name": "Invalid Public Key" }, { "header": [], "code": 400, "body": "{\"err\":\"invalid body: illegal base64 data at input byte 0\"}", "name": "Base64 Decoding Error" }, { "header": [], "code": 401, "body": "{\"error\":\"AuthenticationException\",\"message\":\"Invalid Credentials\"}", "name": "Invalid Credentials" }, { "header": [], "code": 403, "body": "{\"err\": \"forbidden\"}", "name": "User not allowed to create certificate for this bike" } ] } ] }, { "name": "Cloud", "description": "Endpoints for the Cloud.", "item": [ { "name": "Get Subscriptions", "request": { "url": { "host": "{{baseUrl}}", "path": "subscriptions", "query": [ { "key": "status", "value": "", "description": "Filter by subscription status (e.g. ACTIVE, EXPIRED).", "disabled": true } ], "raw": "{{baseUrl}}\/subscriptions?status=" }, "method": "GET", "header": [ { "key": "Host", "value": "subscription.production.vanmoof.cloud" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve a list of subscriptions. USE https:\/\/subscription.production.vanmoof.cloud" }, "response": [ { "header": [], "code": 200, "body": "[]", "name": "Success (No Subscriptions)" }, { "header": [], "code": 200, "body": "[{\"id\":\"{uuid}\",\"vehicle_id\":\"{vehicle_id}\",\"sku\":\"BETA-TRIAL\",\"status\":\"EXPIRED\",\"product\":\"FEATURE_SUBSCRIPTION\",\"billing_cycle\":\"NONE\",\"is_recurring\":false,\"created_at\":\"2026-01-01T01:00:00.000000Z\",\"updated_at\":\"2026-01-01T01:00:00.000000Z\",\"expired_at\":\"2026-01-01T01:00:00.000000Z\",\"canceled_at\":null,\"next_billing_at\":null,\"trial_until\":null}]", "name": "Success" }, { "header": [], "code": 401, "body": "Unauthorized", "name": "Unauthorized" } ] }, { "name": "Get Notification Preferences", "request": { "url": { "host": "{{baseUrl}}", "path": "preferences", "query": [], "raw": "{{baseUrl}}\/preferences" }, "method": "GET", "header": [ { "key": "Host", "value": "notification.production.vanmoof.cloud" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve notification preferences for the user. USE https:\/\/notification.production.vanmoof.cloud" }, "response": [ { "header": [], "code": 200, "body": "{\"languages\":[\"en-US\"],\"channels\":{\"push\":{\"vehicles\":{\"FrameNumber\":{\"notifications\":{\"alarm_state\/1\":{\"enabled\":false},\"alarm_state\/2\":{\"enabled\":true},\"alarm_state\/3\":{\"enabled\":false},\"battery_charge\/custom\":{\"enabled\":false,\"preferences\":{\"soc\":25}},\"battery_charge\/empty\":{\"enabled\":true},\"battery_charge\/full\":{\"enabled\":true},\"battery_charge\/low\":{\"enabled\":true},\"location_update\":{\"enabled\":true},\"not_locked\":{\"enabled\":true}}}}}}}", "name": "Success" }, { "header": [], "code": 401, "body": "Unauthorized", "name": "Unauthorized" } ] }, { "name": "Get Vehicle Accesses", "request": { "url": { "host": "{{baseUrl}}", "path": "external\/vehicles\/:vehicle_id\/accesses", "query": [], "raw": "{{baseUrl}}\/external\/vehicles\/:vehicle_id\/accesses", "variable": [ { "id": "vehicle_id", "key": "vehicle_id", "value": "", "description": "The frame number of the vehicle." } ] }, "method": "GET", "header": [ { "key": "Host", "value": "vehicleregistry.production.vanmoof.cloud" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve access list for a specific vehicle, showing owners and guests. USE https:\/\/vehicleregistry.production.vanmoof.cloud" }, "response": [ { "header": [], "code": 200, "body": "{\"vehicle_id\":\"{vehicle_id}\",\"vehicle_access\":[{\"rider_id\":\"{uuid}\",\"rider_name\":\"Rider Name\",\"rider_email\":\"rider@vanmoof.com\",\"owner_id\":\"{owner_uuid}\",\"owner_name\":\"Owner Name\",\"owner_email\":\"owner@vanmoof.com\",\"role\":\"GUEST\",\"expires_at\":\"2027-01-01T01:00:00.000000Z\",\"starts_at\":\"2026-01-01T01:00:00.000000Z\"}]}", "name": "Success" }, { "header": [], "code": 401, "body": "Unauthorized", "name": "Unauthorized" } ] }, { "name": "Get Rider Invitations", "request": { "url": { "host": "{{baseUrl}}", "path": "external\/riders\/:uuid\/invitations", "query": [], "raw": "{{baseUrl}}\/external\/riders\/:uuid\/invitations" }, "method": "GET", "header": [ { "key": "Host", "value": "vehicleregistry.production.vanmoof.cloud" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve invitations for a specific rider. USE https:\/\/vehicleregistry.production.vanmoof.cloud" }, "response": [ { "header": [], "code": 200, "body": "[]", "name": "Success" } ] }, { "name": "Get External Invitations", "request": { "url": { "host": "{{baseUrl}}", "path": "external\/invitations", "query": [], "raw": "{{baseUrl}}\/external\/invitations" }, "method": "GET", "header": [ { "key": "Host", "value": "vehicleregistry.production.vanmoof.cloud" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve all external invitations. USE https:\/\/vehicleregistry.production.vanmoof.cloud" }, "response": [ { "header": [], "code": 200, "body": "[]", "name": "Success" }, { "header": [], "code": 401, "body": "Unauthorized", "name": "Unauthorized" } ] }, { "name": "Get Rider Vehicles", "request": { "url": { "host": "{{baseUrl}}", "path": "external\/riders\/:uuid\/vehicles", "query": [], "raw": "{{baseUrl}}\/external\/riders\/:uuid\/vehicles" }, "method": "GET", "header": [ { "key": "Host", "value": "vehicleregistry.production.vanmoof.cloud" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve vehicles associated with a specific rider. USE https:\/\/vehicleregistry.production.vanmoof.cloud" }, "response": [ { "header": [], "code": 200, "body": "{\"rider_id\":\"{uuid}\",\"vehicle_access\":[]}", "name": "Success" }, { "header": [], "code": 401, "body": "Unauthorized", "name": "Unauthorized" } ] }, { "name": "Bike Tracking", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/rider\/bikes", "query": [], "raw": "{{baseUrl}}\/v1\/rider\/bikes" }, "method": "GET", "header": [ { "key": "Host", "value": "biketracking.production.vanmoof.cloud" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Bike Tracking. USE https:\/\/biketracking.production.vanmoof.cloud" }, "response": [ { "header": [], "code": 200, "body": "{\"items\":[]}", "name": "Success" }, { "header": [], "code": 401, "body": "Unauthorized", "name": "Unauthorized" } ] }, { "name": "Get Bike Tracking State", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/states\/:vehicle_id", "query": [], "raw": "{{baseUrl}}\/v2\/states\/:vehicle_id", "variable": [ { "id": "vehicle_id", "key": "vehicle_id", "value": "", "description": "The frame number of the vehicle." } ] }, "method": "GET", "header": [ { "key": "Host", "value": "biketracking.production.vanmoof.cloud" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve the tracking state of a specific vehicle. USE https:\/\/biketracking.production.vanmoof.cloud" }, "response": [ { "header": [], "code": 200, "body": "{\"id\":\"{uuid}\",\"missing\":\"NOT_MISSING\",\"tracking\":\"ENABLED\",\"created_at\":\"2026-01-01T10:00:00.000000Z\"}", "name": "Success" }, { "header": [], "code": 401, "body": "Unauthorized", "name": "Unauthorized" } ] }, { "name": "Update Notification Preferences", "request": { "url": { "host": "{{baseUrl}}", "path": "preferences", "query": [], "raw": "{{baseUrl}}\/preferences" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json; charset=utf-8" }, { "key": "Host", "value": "notification.production.vanmoof.cloud" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Update the notification preferences for the user. USE https:\/\/notification.production.vanmoof.cloud" }, "response": [ { "header": [], "code": 200, "body": "{\"languages\":[\"en-US\"],\"channels\":{\"push\":{\"vehicles\":{\"FrameNumber\":{\"notifications\":{\"alarm_state\/1\":{\"enabled\":false},\"alarm_state\/2\":{\"enabled\":true},\"alarm_state\/3\":{\"enabled\":false},\"battery_charge\/custom\":{\"enabled\":false,\"preferences\":{\"soc\":25}},\"battery_charge\/empty\":{\"enabled\":true},\"battery_charge\/full\":{\"enabled\":true},\"battery_charge\/low\":{\"enabled\":true},\"location_update\":{\"enabled\":true},\"not_locked\":{\"enabled\":true}}}}}}}", "name": "Success" }, { "header": [], "code": 400, "body": "{\"error_code\":1000,\"error_message\":\"could not decode request\"}", "name": "Bad Request" }, { "header": [], "code": 401, "body": "Unauthorized", "name": "Unauthorized" } ] }, { "name": "Remove Notification Channel", "request": { "url": { "host": "{{baseUrl}}", "path": "channels", "query": [], "raw": "{{baseUrl}}\/channels" }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json; charset=utf-8" }, { "key": "Host", "value": "notification.production.vanmoof.cloud" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Remove a notification channel for the user. USE https:\/\/notification.production.vanmoof.cloud" }, "response": [ { "header": [], "code": 204, "body": null, "name": "No Content" }, { "header": [], "code": 400, "body": "{\"error_code\":1000,\"error_message\":\"could not decode request\"}", "name": "Bad Request" }, { "header": [], "code": 401, "body": "Unauthorized", "name": "Unauthorized" } ] }, { "name": "Create Notification Channel", "request": { "url": { "host": "{{baseUrl}}", "path": "channels", "query": [], "raw": "{{baseUrl}}\/channels" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json; charset=utf-8" }, { "key": "Host", "value": "notification.production.vanmoof.cloud" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Create a new notification channel for the user. USE https:\/\/notification.production.vanmoof.cloud" }, "response": [ { "header": [], "code": 201, "body": "{\"id\":\"{CHANNEL_ID}\"}", "name": "Created" }, { "header": [], "code": 400, "body": "{\"error_code\":1000,\"error_message\":\"could not decode request\"}", "name": "Bad Request" }, { "header": [], "code": 401, "body": "Unauthorized", "name": "Unauthorized" } ] } ] }, { "name": "Customer", "description": "Endpoints for customer data", "item": [ { "name": "Get Customers On Bike", "request": { "url": { "host": "{{baseUrl}}", "path": "v8\/getCustomersOnBike\/:bikeId", "query": [], "raw": "{{baseUrl}}\/v8\/getCustomersOnBike\/:bikeId", "variable": [ { "id": "bikeId", "key": "bikeId", "value": "", "description": "The bike ID" } ] }, "method": "GET", "header": [ { "key": "Api-Key", "value": "fcb38d47-f14b-30cf-843b-26283f6a5819" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve all customers associated with a specific bike." }, "response": [ { "header": [], "code": 200, "body": "{\"customers\": [{\"name\": \"{Customer Name}\", \"email\": \"{Customer Email}\", \"role\": \"owner\", \"start\": \"{ISO8601 Date}\", \"end\": null, \"status\": \"current\"}]}", "name": "Success" }, { "header": [], "code": 401, "body": "{\"error\":\"AuthenticationException\",\"message\":\"Invalid Credentials\"}", "name": "Unauthorized" }, { "header": [], "code": 422, "body": "{\"error\":\"Please provide your 'Api-Key' header. You can obtain an API key from VanMoof. For more information see the documentation: http:\\\/\\\/api.vanmoof-api.com\\\/apidoc\\\/my\\\/pretty\",\"message\":\"Please provide an API key\"}", "name": "Unprocessable Entity" } ] }, { "name": "Update Customer", "request": { "url": { "host": "{{baseUrl}}", "path": "v8\/updateCustomer", "query": [], "raw": "{{baseUrl}}\/v8\/updateCustomer" }, "method": "POST", "header": [ { "key": "Api-Key", "value": "fcb38d47-f14b-30cf-843b-26283f6a5819" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "[]" }, "description": "Update current customer's profile (partial updates allowed). Updating the email or the password requires a fresh initial token from v8\/authenticate." }, "response": [ { "header": [], "code": 200, "body": "{\"result\": {\"uuid\": \"{Customer UUIDv3}\", \"name\": \"{Customer Name}\", \"email\": \"{Customer Email}\", \"emailConfirmed\": \"boolean\", \"phone\": \"{Customer Phone}\", \"country\": \"{ISO 3166-1}\", \"links\": {\"show\": \"http:\\\/\\\/api.vanmoof-api.com\\\/v8\\\/getCustomerData\"}}}", "name": "Success" }, { "header": [], "code": 401, "body": "{\"error\":\"AuthenticationException\",\"message\":\"Invalid Credentials\"}", "name": "Invalid Credentials" }, { "header": [], "code": 422, "body": "{\"error\":\"Please provide your 'Api-Key' header. You can obtain an API key from VanMoof. For more information see the documentation: http:\\\/\\\/api.vanmoof-api.com\\\/apidoc\\\/my\\\/pretty\",\"message\":\"Please provide an API key\"}", "name": "Unprocessable Entity" } ] }, { "name": "Create Customer", "request": { "url": { "host": "{{baseUrl}}", "path": "v8\/createCustomer", "query": [], "raw": "{{baseUrl}}\/v8\/createCustomer" }, "method": "POST", "header": [ { "key": "Api-Key", "value": "fcb38d47-f14b-30cf-843b-26283f6a5819" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":null,\"email\":null,\"country\":null,\"password\":null,\"confirmationUrl\":null}" }, "description": "Create a new customer account. All fields are required. Password policy: The password must contain between 6 and 50 characters, a digit, an upper case and a lower case character", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"result\":{\"uuid\":\"{Customer UUIDv3}\",\"name\":\"{Customer Name}\",\"email\":\"{Customer Email}\",\"emailConfirmed\":false,\"privacyPolicyAccepted\":false}}", "name": "Success" }, { "header": [], "code": 400, "body": "{\"error\": \"ValidationException\", \"message\": \"Validation failed\", \"violations\": {\"name\": [\"The name field is required.\"], \"email\": [\"The email field is required.\"], \"country\": [\"The country field is required.\"], \"password\": [\"The password field is required.\"], \"confirmationUrl\": [\"The confirmationUrl field is required.\"]}}", "name": "Validation Failed" }, { "header": [], "code": 400, "body": "{\"error\":\"ValidationException\",\"message\":\"Validation failed\",\"violations\":{\"email\":[\"The email has already been taken.\"]}}", "name": "Email taken" }, { "header": [], "code": 401, "body": "{\"error\":\"AuthenticationException\",\"message\":\"Invalid Credentials\"}", "name": "Invalid Credentials" }, { "header": [], "code": 401, "body": "{\"error\":\"CustomerNotAuthorizedException\",\"message\":\"Customer not authorized for this action\"}", "name": "Customer Not Authorized" } ] }, { "name": "Get Customer Data Hash", "request": { "url": { "host": "{{baseUrl}}", "path": "v8\/getCustomerDataHash", "query": [], "raw": "{{baseUrl}}\/v8\/getCustomerDataHash" }, "method": "GET", "header": [ { "key": "Api-Key", "value": "fcb38d47-f14b-30cf-843b-26283f6a5819" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve MD5 hash of customer data." }, "response": [ { "header": [], "code": 200, "body": "{\"hash\": \"{MD5_HASH}\"}", "name": "Success" }, { "header": [], "code": 401, "body": "{\"error\":\"AuthenticationException\",\"message\":\"Invalid Credentials\"}", "name": "Unauthorized" }, { "header": [], "code": 422, "body": "{\"error\":\"Please provide your 'Api-Key' header. You can obtain an API key from VanMoof. For more information see the documentation: http:\\\/\\\/api.vanmoof-api.com\\\/apidoc\\\/my\\\/pretty\",\"message\":\"Please provide an API key\"}", "name": "Unprocessable Entity" } ] }, { "name": "Get Customer Data", "request": { "url": { "host": "{{baseUrl}}", "path": "v8\/getCustomerData", "query": [ { "key": "includeBikeDetails", "value": "", "description": "Include details about the customer's bikes.", "disabled": true } ], "raw": "{{baseUrl}}\/v8\/getCustomerData?includeBikeDetails=" }, "method": "GET", "header": [ { "key": "Api-Key", "value": "fcb38d47-f14b-30cf-843b-26283f6a5819" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve the authenticated customer's data and associated bikes. Data Hash is likely MD5. If a workshop is invited. The Field contains email, name, start and end. Also serviceModeEnabled is true for the time being in service mode." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"uuid\":\"{UUIDv4}\",\"name\":\"{Customer Name}\",\"email\":\"{Customer Email}\",\"confirmed\":\"boolean\",\"privacyPolicyAccepted\":\"boolean\",\"phone\":\"\",\"country\":\"{Country Code}\",\"bikes\":[{\"id\":\"{BikeID}\",\"name\":\"VanMoof\",\"frameNumber\":\"ASY31ddddd\",\"bikeId\":\"ASY31ddddd\",\"frameSerial\":null,\"ownerName\":\"{Owner}\",\"pendingSmartmoduleMacAddress\":null,\"macAddress\":\"{MAC Address}\",\"mainEcuSerial\":null,\"bleProfile\":\"ELECTRIFIED_2021\",\"controller\":\"2020 S\",\"eLock\":true,\"speaker\":true,\"smartmoduleCurrentVersion\":\"1.8.2\",\"smartmoduleDesiredVersion\":\"1.9.1\",\"smartmoduleLatestStable\":false,\"highestAvailableSpeedLimit\":null,\"tripDistance\":\"{TripDistance}\",\"modelName\":\"VM01-203-EU\",\"modelColor\":{\"name\":\"Light\",\"primary\":\"#7a99ac\",\"secondary\":\"#7a99ac\"},\"frameShape\":\"S\",\"customerRole\":\"owner\",\"startsAt\":\"{Date}\",\"endsAt\":null,\"permissions\":[\"ADD_USER\",\"FIRMWARE_UPDATES\",\"REMOVE_USER\",\"REPORT_FOUND\",\"REPORT_STOLEN\",\"SEND_STATISTICS\",\"BACKUP_CODE\",\"BIKE_NAME\",\"VIEW_THEFT_CASES\",\"ALARM_SETTINGS\",\"COUNTRY_SETTINGS\",\"LIGHTS\",\"MOTOR_SUPPORT_LEVEL\",\"UNLOCK\",\"READ_VALUES\",\"STOLEN_MODE\",\"SWAP_SMARTMODULE\"],\"isTracking\":false,\"stolen\":{\"isStolen\":false,\"dateStolen\":null,\"status\":\"not_stolen\",\"latestLocation\":null},\"links\":{\"thumbnail\":\"https:\/\/my.vanmoof.com\/image\/model\/84\",\"show\":\"http:\/\/api.vanmoof-api.com\/v8\/getBikeData\/{BikeID}\"}},{\"id\":\"{BikeID}\",\"name\":\"VanMoof\",\"frameNumber\":\"SVTBKLdddddLL\",\"bikeId\":\"SVTBKLdddddLL\",\"frameSerial\":\"AST52IdddddL\",\"ownerName\":\"{Owner}\",\"pendingSmartmoduleMacAddress\":null,\"macAddress\":null,\"mainEcuSerial\":\"\",\"bleProfile\":\"ELECTRIFIED_2022\",\"controller\":\"2022\",\"eLock\":true,\"speaker\":true,\"smartmoduleCurrentVersion\":null,\"smartmoduleDesiredVersion\":null,\"smartmoduleLatestStable\":false,\"highestAvailableSpeedLimit\":null,\"tripDistance\":\"{TripDistance}\",\"modelName\":\"B-05S-E01EU-XX\",\"modelColor\":{\"name\":\"Gray\",\"primary\":\"#929393\",\"secondary\":\"#929393\"},\"frameShape\":\"S\",\"customerRole\":\"owner\",\"startsAt\":\"{Date}\",\"endsAt\":null,\"permissions\":[\"ADD_USER\",\"FIRMWARE_UPDATES\",\"REMOVE_USER\",\"REPORT_FOUND\",\"REPORT_STOLEN\",\"SEND_STATISTICS\",\"BACKUP_CODE\",\"BIKE_NAME\",\"VIEW_THEFT_CASES\",\"ALARM_SETTINGS\",\"COUNTRY_SETTINGS\",\"LIGHTS\",\"MOTOR_SUPPORT_LEVEL\",\"UNLOCK\",\"READ_VALUES\",\"STOLEN_MODE\",\"SWAP_SMARTMODULE\"],\"isTracking\":false,\"stolen\":{\"isStolen\":false,\"dateStolen\":null,\"status\":\"not_stolen\",\"latestLocation\":null},\"links\":{\"thumbnail\":\"https:\/\/my.vanmoof.com\/image\/model\/99\",\"show\":\"http:\/\/api.vanmoof-api.com\/v8\/getBikeData\/{BikeID}\"}}],\"hasPendingBikeSharingInvitations\":false,\"links\":{\"hash\":\"http:\/\/api.vanmoof-api.com\/v8\/getCustomerDataHash\",\"devices\":\"http:\/\/api.vanmoof-api.com\/v8\/getDevices\",\"resendConfirmation\":null,\"update\":\"http:\/\/api.vanmoof-api.com\/v8\/updateCustomer\",\"addBike\":\"http:\/\/api.vanmoof-api.com\/v8\/registerBikeToCurrentUser\",\"addFcmToken\":\"http:\/\/api.vanmoof-api.com\/v8\/registrationToken\",\"theftCases\":\"http:\/\/api.vanmoof-api.com\/v8\/getCurrentTheftCasesForCurrentUser\"},\"bikeDetails\":[{\"id\":\"{BikeID}\",\"name\":\"VanMoof\",\"frameNumber\":\"ASY31ddddd\",\"bikeId\":\"ASY31ddddd\",\"frameSerial\":null,\"ownerName\":\"{Owner}\",\"tripDistance\":1234,\"pendingSmartmoduleMacAddress\":null,\"macAddress\":\"{MAC Address}\",\"mainEcuSerial\":null,\"smartmoduleCurrentVersion\":\"1.8.2\",\"smartmoduleDesiredVersion\":\"1.9.1\",\"smartmoduleLatestStable\":false,\"changeBackupCode\":false,\"isTracking\":false,\"highestAvailableSpeedLimit\":null,\"messageAvailable\":false,\"modelName\":\"VM01-203-EU\",\"modelDetails\":{\"Gears\":\"Automatic 4 speed shifting gears\",\"Motor\":\"250 - 500 W front-wheel hub motor\",\"Top Speed\":\"25 km\/h (EU speed)\",\"Range\":\"60 km (full power) ~ 150 km (economy mode)\",\"Edition\":\"ES-3 2G\"},\"modelColor\":{\"name\":\"Light\",\"primary\":\"#7a99ac\",\"secondary\":\"#7a99ac\"},\"frameShape\":\"S\",\"manufacturer\":\"muco\",\"controller\":\"2020 S\",\"updateMethod\":\"OAD (encrypted)\",\"eLock\":true,\"gsmModule\":\"2G\",\"speaker\":true,\"bleProfile\":\"ELECTRIFIED_2021\",\"bleVersion\":null,\"messagesViaBLE\":\"BLEv2\",\"customerRoleFamily\":\"Responsible\",\"customerRole\":\"owner\",\"startsAt\":\"{Date}\",\"endsAt\":null,\"permissions\":[\"ADD_USER\",\"FIRMWARE_UPDATES\",\"REMOVE_USER\",\"REPORT_FOUND\",\"REPORT_STOLEN\",\"SEND_STATISTICS\",\"BACKUP_CODE\",\"BIKE_NAME\",\"VIEW_THEFT_CASES\",\"ALARM_SETTINGS\",\"COUNTRY_SETTINGS\",\"LIGHTS\",\"MOTOR_SUPPORT_LEVEL\",\"UNLOCK\",\"READ_VALUES\",\"STOLEN_MODE\",\"SWAP_SMARTMODULE\"],\"key\":{\"encryptionKey\":\"{BLE Encryption Key}\",\"passcode\":\"{BLE Passcode}\",\"userKeyId\":1},\"isFactoryKey\":false,\"customerCount\":1,\"invitationCount\":0,\"stolen\":{\"isStolen\":false,\"dateStolen\":null,\"status\":\"not_stolen\",\"latestLocation\":null},\"hasPeaceOfMind\":false,\"peaceOfMind\":null,\"links\":{\"hash\":\"http:\/\/api.vanmoof-api.com\/v8\/getBikeDataHash\/{BikeID}\",\"thumbnail\":\"https:\/\/my.vanmoof.com\/image\/model\/84\"},\"serviceModeEnabled\":false,\"workshopInfo\":[]},{\"id\":\"{BikeID}\",\"name\":\"VanMoof\",\"frameNumber\":\"SVTBKLdddddLL\",\"bikeId\":\"SVTBKLdddddLL\",\"frameSerial\":\"AST52IdddddL\",\"ownerName\":\"{Owner}\",\"tripDistance\":\"{TripDistance}\",\"pendingSmartmoduleMacAddress\":null,\"macAddress\":null,\"mainEcuSerial\":\"\",\"smartmoduleCurrentVersion\":null,\"smartmoduleDesiredVersion\":null,\"smartmoduleLatestStable\":false,\"changeBackupCode\":true,\"isTracking\":false,\"highestAvailableSpeedLimit\":null,\"messageAvailable\":false,\"modelName\":\"B-05S-E01EU-XX\",\"modelDetails\":null,\"modelColor\":{\"name\":\"Gray\",\"primary\":\"#929393\",\"secondary\":\"#929393\"},\"frameShape\":\"S\",\"manufacturer\":\"pegatron\",\"controller\":\"2022\",\"updateMethod\":\"OAD (encrypted)\",\"eLock\":true,\"gsmModule\":\"4G\",\"speaker\":true,\"bleProfile\":\"ELECTRIFIED_2022\",\"bleVersion\":null,\"messagesViaBLE\":\"BLEv2\",\"customerRoleFamily\":\"Responsible\",\"customerRole\":\"owner\",\"startsAt\":\"{Date}\",\"endsAt\":null,\"permissions\":[\"ADD_USER\",\"FIRMWARE_UPDATES\",\"REMOVE_USER\",\"REPORT_FOUND\",\"REPORT_STOLEN\",\"SEND_STATISTICS\",\"BACKUP_CODE\",\"BIKE_NAME\",\"VIEW_THEFT_CASES\",\"ALARM_SETTINGS\",\"COUNTRY_SETTINGS\",\"LIGHTS\",\"MOTOR_SUPPORT_LEVEL\",\"UNLOCK\",\"READ_VALUES\",\"STOLEN_MODE\",\"SWAP_SMARTMODULE\"],\"key\":null,\"isFactoryKey\":true,\"customerCount\":1,\"invitationCount\":0,\"stolen\":{\"isStolen\":false,\"dateStolen\":null,\"status\":\"not_stolen\",\"latestLocation\":null},\"hasPeaceOfMind\":false,\"peaceOfMind\":null,\"links\":{\"hash\":\"http:\/\/api.vanmoof-api.com\/v8\/getBikeDataHash\/{BikeID}\",\"thumbnail\":\"https:\/\/my.vanmoof.com\/image\/model\/99\"},\"serviceModeEnabled\":false,\"workshopInfo\":[]}]},\"hash\":\"{DATA_HASH}\"}", "name": "Success" }, { "header": [], "code": 401, "body": "{\"error\":\"AuthenticationException\",\"message\":\"Invalid Credentials\"}", "name": "Unauthorized" }, { "header": [], "code": 422, "body": "{\"error\":\"Please provide your 'Api-Key' header. You can obtain an API key from VanMoof. For more information see the documentation: http:\\\/\\\/api.vanmoof-api.com\\\/apidoc\\\/my\\\/pretty\",\"message\":\"Please provide an API key\"}", "name": "Unprocessable Entity" } ] }, { "name": "Get Current Theft Cases For Current User", "request": { "url": { "host": "{{baseUrl}}", "path": "v8\/getCurrentTheftCasesForCurrentUser", "query": [], "raw": "{{baseUrl}}\/v8\/getCurrentTheftCasesForCurrentUser" }, "method": "GET", "header": [ { "key": "Api-Key", "value": "fcb38d47-f14b-30cf-843b-26283f6a5819" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve theft cases for the authenticated user." }, "response": [ { "header": [], "code": 200, "body": "{\"theftCases\": []}", "name": "Success" }, { "header": [], "code": 401, "body": "{\"error\":\"AuthenticationException\",\"message\":\"Invalid Credentials\"}", "name": "Unauthorized" }, { "header": [], "code": 422, "body": "{\"error\":\"Please provide your 'Api-Key' header. You can obtain an API key from VanMoof. For more information see the documentation: http:\\\/\\\/api.vanmoof-api.com\\\/apidoc\\\/my\\\/pretty\",\"message\":\"Please provide an API key\"}", "name": "Unprocessable Entity" } ] }, { "name": "Get Devices", "request": { "url": { "host": "{{baseUrl}}", "path": "v8\/getDevices", "query": [], "raw": "{{baseUrl}}\/v8\/getDevices" }, "method": "GET", "header": [ { "key": "Api-Key", "value": "fcb38d47-f14b-30cf-843b-26283f6a5819" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve registered devices for the authenticated user." }, "response": [ { "header": [], "code": 200, "body": "[{\"device\": null, \"key\": \"{Device Key}\"}]", "name": "Success" }, { "header": [], "code": 401, "body": "{\"error\":\"AuthenticationException\",\"message\":\"Invalid Credentials\"}", "name": "Unauthorized" }, { "header": [], "code": 422, "body": "{\"error\":\"Please provide your 'Api-Key' header. You can obtain an API key from VanMoof. For more information see the documentation: http:\\\/\\\/api.vanmoof-api.com\\\/apidoc\\\/my\\\/pretty\",\"message\":\"Please provide an API key\"}", "name": "Unprocessable Entity" } ] }, { "name": "Resend Confirmation Email", "request": { "url": { "host": "{{baseUrl}}", "path": "v8\/resendConfirmationEmail", "query": [], "raw": "{{baseUrl}}\/v8\/resendConfirmationEmail" }, "method": "POST", "header": [ { "key": "Api-Key", "value": "fcb38d47-f14b-30cf-843b-26283f6a5819" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Resend confirmation email to the authenticated user." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "Success \\#TODO" }, { "header": [], "code": 400, "body": "{\"error\":\"CustomerAlreadyConfirmedException\",\"message\":\"Customer account is already confirmed\"}", "name": "Customer Already Confirmed" }, { "header": [], "code": 401, "body": "{\"error\":\"AuthenticationException\",\"message\":\"Invalid Credentials\"}", "name": "Unauthorized" }, { "header": [], "code": 422, "body": "{\"error\":\"Please provide your 'Api-Key' header. You can obtain an API key from VanMoof. For more information see the documentation: http:\\\/\\\/api.vanmoof-api.com\\\/apidoc\\\/my\\\/pretty\",\"message\":\"Please provide an API key\"}", "name": "Unprocessable Entity" } ] }, { "name": "Validate Customer Email", "request": { "url": { "host": "{{baseUrl}}", "path": "v8\/validateCustomerEmail", "query": [], "raw": "{{baseUrl}}\/v8\/validateCustomerEmail" }, "method": "POST", "header": [ { "key": "Api-Key", "value": "fcb38d47-f14b-30cf-843b-26283f6a5819" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"token\":null}" }, "description": "Validate a customer's email address using a token." }, "response": [ { "header": [], "code": 200, "body": "{\"result\": true}", "name": "Success" }, { "header": [], "code": 400, "body": "{\"error\": \"CustomerNotConfirmedException\", \"message\": \"Customer account is not confirmed\"}", "name": "Wrong Token" }, { "header": [], "code": 401, "body": "{\"error\":\"AuthenticationException\",\"message\":\"Invalid Credentials\"}", "name": "Unauthorized" }, { "header": [], "code": 422, "body": "{\"error\":\"Please provide your 'Api-Key' header. You can obtain an API key from VanMoof. For more information see the documentation: http:\\\/\\\/api.vanmoof-api.com\\\/apidoc\\\/my\\\/pretty\",\"message\":\"Please provide an API key\"}", "name": "Unprocessable Entity" } ] }, { "name": "Accept Privacy Policy", "request": { "url": { "host": "{{baseUrl}}", "path": "v8\/privacyPolicyAccepted", "query": [], "raw": "{{baseUrl}}\/v8\/privacyPolicyAccepted" }, "method": "POST", "header": [ { "key": "Api-Key", "value": "fcb38d47-f14b-30cf-843b-26283f6a5819" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Mark the privacy policy as accepted for the authenticated customer." }, "response": [ { "header": [], "code": 200, "body": "{\"result\": true}", "name": "Success" }, { "header": [], "code": 401, "body": "{\"error\":\"AuthenticationException\",\"message\":\"Invalid Credentials\"}", "name": "Unauthorized" }, { "header": [], "code": 422, "body": "{\"error\":\"Please provide your 'Api-Key' header. You can obtain an API key from VanMoof. For more information see the documentation: http:\\\/\\\/api.vanmoof-api.com\\\/apidoc\\\/my\\\/pretty\",\"message\":\"Please provide an API key\"}", "name": "Unprocessable Entity" } ] }, { "name": "Forgot Password", "request": { "url": { "host": "{{baseUrl}}", "path": "v8\/forgotPassword", "query": [], "raw": "{{baseUrl}}\/v8\/forgotPassword" }, "method": "POST", "header": [ { "key": "Api-Key", "value": "fcb38d47-f14b-30cf-843b-26283f6a5819" }, { "key": "Content-Type", "value": "application\/json; charset=utf-8" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":null,\"redirectUrl\":null}" }, "description": "Request a password reset email for the given email address.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"result\": true}", "name": "Success" }, { "header": [], "code": 400, "body": "{\n \"error\": \"ValidationException\",\n \"message\": \"Validation failed\",\n \"violations\": {\n \"email\": [\n \"The selected email is invalid.\"\n ]\n }\n}\n", "name": "Validation Failed" } ] }, { "name": "Register APN Token", "request": { "url": { "host": "{{baseUrl}}", "path": "v8\/registrationToken", "query": [], "raw": "{{baseUrl}}\/v8\/registrationToken" }, "method": "POST", "header": [ { "key": "Api-Key", "value": "fcb38d47-f14b-30cf-843b-26283f6a5819" }, { "key": "Content-Type", "value": "application\/json; charset=utf-8" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"token\":null}" }, "description": "Submit a APN registration token. (Used for push notifications on Android. No longer used)" }, "response": [ { "header": [], "code": 200, "body": "{\"result\": true}", "name": "Success" }, { "header": [], "code": 401, "body": "{\"error\":\"AuthenticationException\",\"message\":\"Invalid Credentials\"}", "name": "Unauthorized" }, { "header": [], "code": 422, "body": "{\"error\":\"Please provide your 'Api-Key' header. You can obtain an API key from VanMoof. For more information see the documentation: http:\\\/\\\/api.vanmoof-api.com\\\/apidoc\\\/my\\\/pretty\",\"message\":\"Please provide an API key\"}", "name": "Unprocessable Entity" } ] } ] }, { "name": "Firmwares", "description": "Endpoints for SA5+ firmwares", "item": [ { "name": "Get Latest Firmware (SA5+)", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/firmwares\/last", "query": [], "raw": "{{baseUrl}}\/v1\/firmwares\/last" }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve the latest firmware version and release notes for SA5 and later Bikes. USE https:\/\/fima.production.vanmoof.cloud" }, "response": [ { "header": [], "code": 200, "body": "{\n \"version\": \"{version}\",\n \"stage\": \"{stage}\",\n \"releaseNotes\": {\n \"EN\": \"\",\n \"DE\": \"\",\n \"NL\": \"\"\n }\n}", "name": "Success" }, { "header": [], "code": 403, "body": "{\"error\": \"Token not found\"}", "name": "Forbidden" } ] } ] }, { "name": "Rides", "description": "Endpoints for tracking and retrieving rider rides", "item": [ { "name": "Get Rider Preferences", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/riders\/:riderID\/preferences", "query": [], "raw": "{{baseUrl}}\/api\/v1\/riders\/:riderID\/preferences" }, "method": "GET", "header": [ { "key": "Api-Key", "value": "fcb38d47-f14b-30cf-843b-26283f6a5819" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve rider preferences by rider UUID. The city field uses a format like \"{COUNTRY CITY}\" where COUNTRY is the international country code (e.g., DE for Germany) and CITY is the city code (e.g., FRA for Frankfurt am Main). Example: \"DE FRA\". USE https:\/\/tenjin.vanmoof.com\/\n", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"recordRides\": true, \"recordCountry\": false, \"city\": \"{COUNTRY CITY}\", \"optedOutOfCity\": false}", "name": "Success" }, { "header": [], "code": 401, "body": "{\"error\":\"Unauthorized\"}", "name": "Unauthorized - Also returned if the rider ID is invalid" } ] }, { "name": "Get Cities", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/cities", "query": [], "raw": "{{baseUrl}}\/api\/v1\/cities" }, "method": "GET", "header": [ { "key": "Api-Key", "value": "fcb38d47-f14b-30cf-843b-26283f6a5819" }, { "key": "Host", "value": "tenjin.vanmoof.com" }, { "key": "Rider-Etag", "value": "{ETAG}" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve a list of cities. USE https:\/\/tenjin.vanmoof.com" }, "response": [ { "header": [], "code": 200, "body": "[{\"country\":\"DE\",\"code\":\"DE FRA\",\"name\":\"Frankfurt (Frankfurt am Main)\",\"location\":{\"lat\":50.1136,\"long\":8.6797}}]", "name": "Success" }, { "header": [], "code": 401, "body": "{\"error\":\"Unauthorized\"}", "name": "Unauthorized" } ] } ] }, { "name": "Website", "description": "Endpoints you interact with via the VanMoof website", "item": [ { "name": "Get Bike Coordinates", "request": { "url": { "host": "{{baseUrl}}", "path": "findmybike\/coords\/{bike UUIDv4}", "query": [], "raw": "{{baseUrl}}\/findmybike\/coords\/{bike UUIDv4}" }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve the latest known coordinates of a bike by its UUIDv4. This endpoint does not require authentication nor is it disabled after the bike is found. USE https:\/\/my.vanmoof.com", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"coordinates\":[{\"lat\":-10.47,\"lon\":105.61,\"acc\":0,\"datetime\":{\"user\":{\"date\":\"{DD-MM-YYYY}\",\"time\":\"13:37\"},\"bike\":{\"date\":\"{DD-MM-YYYY}\",\"time\":\"13:37\"}},\"timezone\":{\"user\":\"Europe\/Amsterdam\",\"bike\":\"Europe\/Berlin\"},\"firstTime\":{\"user\":\"13:37\",\"bike\":\"13:37\"},\"measurements\":1,\"type\":\"ublox\",\"measured_by\":[]}],\"timezone\":2}", "name": "Success" } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "key", "type": "string" } ] } }