# VirtualCar360 Img-Out API

VirtualCar360 API enables integration of vehicle photos, 360 galleries, video assets, hotspots and data required to present vehicles in dealer systems, classified portals and customer applications.

The API can be used to search galleries by VIN, registration number or gallery identifier, and then retrieve image sets, video links and additional metadata used by the Player and Player 360.

Access requires an API key passed as the `key` query parameter. To obtain access or configure a group key, contact VirtualCar360 support.

Vehicle photo, 360 gallery and multimedia integration API

Version: v6.0

## Servers

Production server
```
https://img-out.virtualcar360.pl
```

## Security

### ApiKeyQuery

API key assigned by VirtualCar360 support.

Type: apiKey
In: query
Name: key

## Download OpenAPI description

[VirtualCar360 Img-Out API](https://docs.virtualcar360.com/_bundle/@l10n/en-US/api/openapi.yaml)

## Gallery search

Search galleries using filters such as VIN, registration number and creation date.

### Search galleries by filters

 - [GET /api/v6.0/virtual-360/idsWithNames](https://docs.virtualcar360.com/en-us/api/openapi/gallery-search/paths/~1api~1v6.0~1virtual-360~1idswithnames/get.md): Searches galleries by exact or partial VIN, exact or partial registration number and optional creation date range. The response is paginated.

## Gallery lists

Retrieve paginated lists of galleries assigned to a vehicle.

### List galleries by registration number

 - [GET /api/v6.0/virtual-360/list/numberplates/{numberplates}](https://docs.virtualcar360.com/en-us/api/openapi/gallery-lists/paths/~1api~1v6.0~1virtual-360~1list~1numberplates~1%7Bnumberplates%7D/get.md): Returns a paginated list of all galleries assigned to the provided registration number.

### List galleries by VIN

 - [GET /api/v6.0/virtual-360/list/vin/{vin}](https://docs.virtualcar360.com/en-us/api/openapi/gallery-lists/paths/~1api~1v6.0~1virtual-360~1list~1vin~1%7Bvin%7D/get.md): Returns a paginated list of all galleries assigned to the provided VIN.

## Latest gallery

Retrieve the latest gallery for a VIN or registration number.

### Get latest gallery by registration number

 - [GET /api/v6.0/virtual-360/numberplates/{numberplates}](https://docs.virtualcar360.com/en-us/api/openapi/latest-gallery/paths/~1api~1v6.0~1virtual-360~1numberplates~1%7Bnumberplates%7D/get.md): Returns the latest gallery assigned to the provided registration number.

### Get latest gallery by VIN

 - [GET /api/v6.0/virtual-360/vin/{vin}](https://docs.virtualcar360.com/en-us/api/openapi/latest-gallery/paths/~1api~1v6.0~1virtual-360~1vin~1%7Bvin%7D/get.md): Returns the latest gallery assigned to the provided VIN.

## Images

Retrieve image sets, 1080p images, hotspots and video data.

### Get image set

 - [GET /api/v6.0/virtual-360/image-set](https://docs.virtualcar360.com/en-us/api/openapi/images/paths/~1api~1v6.0~1virtual-360~1image-set/get.md): Returns the complete gallery object with image sets, 1080p image sets, hotspots, inspection data and video links. Use the gallery id returned by search or latest-gallery endpoints as carId.