{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-@l10n/en-US/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"API","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"api","__idx":0},"children":["API"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The VirtualCar360 API allows customers to retrieve vehicle gallery data, image sets, hotspots and video links. It is intended for integrations that want to use VirtualCar360 data in a custom website, CRM, administrative system, classified portal or dealer tool."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The API can be used to:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["build offer listings,"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["retrieve vehicle photos for a website,"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["archive vehicle photos,"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["import gallery data into administrative systems,"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["integrate with CRM or DMS systems,"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["feed external tools such as WebWizard or other customer systems,"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["retrieve video links,"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["retrieve hotspots and additional photos,"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["build a custom vehicle gallery interface."]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Tip"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you only want to embed a ready-made vehicle presentation, use the Player. If you want to retrieve photos and build a custom view, use the API."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"base-url","__idx":1},"children":["Base URL"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Production API base URL:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"txt","header":{"controls":{"copy":{}}},"source":"https://img-out.virtualcar360.pl/api/v6.0/virtual-360\n","lang":"txt"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"authorization","__idx":2},"children":["Authorization"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["API access requires the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["key"]}," query string parameter."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"txt","header":{"controls":{"copy":{}}},"source":"https://img-out.virtualcar360.pl/api/v6.0/virtual-360/vin/WBA1234567890?key=YOUR_API_KEY\n","lang":"txt"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The key can be assigned to one location or multiple locations as a group key. See ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API Authorization"]}," for details."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Security"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For direct API calls, do not expose the API key in frontend code. Use a backend proxy whenever possible."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"core-concepts","__idx":3},"children":["Core concepts"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"gallery","__idx":4},"children":["Gallery"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A gallery represents a vehicle photo session. A single vehicle can have more than one gallery, for example when it was photographed at different times or in different standards."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A basic gallery record contains:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},","]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]},","]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["vin"]},","]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["numberPlates"]},","]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["createdAt"]},","]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," field is used as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["carId"]}," in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/image-set"]}," endpoint."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"image-set","__idx":5},"children":["Image set"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["An image set contains the data needed to build a custom gallery view, including photo URLs, 1080p photos, hotspots, video information and metadata."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"hotspot","__idx":6},"children":["Hotspot"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A hotspot marks a specific point on a vehicle photo. It can indicate an equipment element, damage, scratch, body detail or inspection feature."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"video","__idx":7},"children":["Video"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If video is available for a gallery, the API can return the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["video"]}," field. This field may be a JSON string containing links to platforms such as Vimeo and YouTube."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"endpoints","__idx":8},"children":["Endpoints"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Method"},"children":["Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Endpoint"},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/vin/{vin}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Retrieves the latest gallery by VIN."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/numberplates/{numberplates}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Retrieves the latest gallery by registration number."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/list/vin/{vin}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Retrieves all galleries assigned to a VIN."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/list/numberplates/{numberplates}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Retrieves all galleries assigned to a registration number."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/image-set"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Retrieves image sets, hotspots and video data for a gallery."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/idsWithNames"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Searches galleries by filters such as VIN, registration number and creation date."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/add-announcement"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Adds an announcement. Intended for integrations exporting data."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"api-reference-grouping","__idx":9},"children":["API Reference grouping"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The OpenAPI file groups endpoints according to the documentation structure:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"API Reference section"},"children":["API Reference section"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Endpoints"},"children":["Endpoints"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Use case"},"children":["Use case"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Gallery search"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/idsWithNames"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Search galleries by filters."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Gallery lists"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/list/vin/{vin}"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/list/numberplates/{numberplates}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Retrieve all galleries for a vehicle."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Latest gallery"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/vin/{vin}"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/numberplates/{numberplates}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Retrieve the latest gallery for a vehicle."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Images"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/image-set"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Retrieve image sets, hotspots, video data and 1080p photos."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Announcements"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/add-announcement"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Export or add announcement data."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"typical-api-flow","__idx":10},"children":["Typical API flow"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"step-1--get-the-latest-gallery","__idx":11},"children":["Step 1 — Get the latest gallery"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["By VIN:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"GET https://img-out.virtualcar360.pl/api/v6.0/virtual-360/vin/WBA1234567890?key=YOUR_API_KEY\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["By registration number:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"GET https://img-out.virtualcar360.pl/api/v6.0/virtual-360/numberplates/WW4433E?key=YOUR_API_KEY\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Example response:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"id\": 10209937,\n  \"name\": \"WBA1234567890_skodaplus\",\n  \"vin\": \"WBA1234567890\",\n  \"numberPlates\": \"WW4433E\",\n  \"createdAt\": \"2026-04-21T10:42:30.3038179\",\n  \"type\": \"3000_2250_8_JPG_SKODAPLUS\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the returned ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["carId"]}," in the next request."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"step-2--retrieve-image-sets","__idx":12},"children":["Step 2 — Retrieve image sets"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"GET https://img-out.virtualcar360.pl/api/v6.0/virtual-360/image-set?carId=10209937&key=YOUR_API_KEY\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The endpoint returns the full gallery object with image sets, hotspots and video links."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"pagination-and-sorting","__idx":13},"children":["Pagination and sorting"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["List endpoints support:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Sorting"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sort direction. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["1"]}," means ASC, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["-1"]}," means DESC."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Page"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Page number. Default: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["1"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PageSize"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Number of results per page. Range: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["1–100"]},", default: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["20"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"the-image-set-endpoint","__idx":14},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/image-set"]}," endpoint"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/image-set"]}," is the main endpoint for retrieving photos and gallery data."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["It can return:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},","]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["vin"]},","]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["numberPlates"]},","]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]},","]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["inspection"]},","]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["video"]},","]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["hotspots"]},","]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["carImageSets"]},","]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["carImageSets1080p"]},"."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"the-type-field","__idx":15},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}," field"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}," field describes the technical photo standard. Example:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"txt","header":{"controls":{"copy":{}}},"source":"3000_2250_8_JPG_SKODAPLUS\n","lang":"txt"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["It can include photo width, height, number of photos, file format and standard name."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"error-codes","__idx":16},"children":["Error codes"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"right","data-label":"Code"},"children":["Code"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Meaning"},"children":["Meaning"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"right"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Request completed successfully."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"right"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invalid request parameters."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"right"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["404"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No data found for the provided criteria."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"right"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["500"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Server error. Contact VirtualCar360 support."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"best-practices","__idx":17},"children":["Best practices"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Use a backend proxy and do not expose the API key in frontend code."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/image-set"]}," directly when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["carId"]}," is known."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Use VIN or registration number to find the latest gallery first."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Use pagination for list endpoints."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Handle missing video and hotspots."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Cache API responses in your backend when possible."]}]}]},"headings":[{"value":"API","id":"api","depth":1},{"value":"Base URL","id":"base-url","depth":2},{"value":"Authorization","id":"authorization","depth":2},{"value":"Core concepts","id":"core-concepts","depth":2},{"value":"Gallery","id":"gallery","depth":3},{"value":"Image set","id":"image-set","depth":3},{"value":"Hotspot","id":"hotspot","depth":3},{"value":"Video","id":"video","depth":3},{"value":"Endpoints","id":"endpoints","depth":2},{"value":"API Reference grouping","id":"api-reference-grouping","depth":2},{"value":"Typical API flow","id":"typical-api-flow","depth":2},{"value":"Step 1 — Get the latest gallery","id":"step-1--get-the-latest-gallery","depth":3},{"value":"Step 2 — Retrieve image sets","id":"step-2--retrieve-image-sets","depth":3},{"value":"Pagination and sorting","id":"pagination-and-sorting","depth":2},{"value":"The /image-set endpoint","id":"the-image-set-endpoint","depth":2},{"value":"The type field","id":"the-type-field","depth":2},{"value":"Error codes","id":"error-codes","depth":2},{"value":"Best practices","id":"best-practices","depth":2}],"frontmatter":{"seo":{"title":"API"}},"lastModified":"2026-06-16T21:52:40.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/en-us/api","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}