Spyne Common API: A Unified Gateway to Vehicle Media Processing
What is the Common API?
The Spyne Common API is a single integration point designed to streamline all vehicle media processing needs. Whether you're enhancing images, generating 360 spins, or creating feature videos, the Common API simplifies workflows by consolidating these capabilities into one endpoint.
What It Does:
- Processes images and videos to create catalog-friendly outputs.
- Automates 360° spin creation and feature video generation.
- Reduces complexity by providing a unified interface for multiple functionalities.
The Common API ensures faster development, consistent processing, and effortless integration into your existing systems.
Parameters of the API
Below is a detailed explanation of each parameter, its significance, and how to use it effectively.
General Parameters
| Category | Parameter | Description |
|---|---|---|
| Vehicle Unique Identifier | 1.vin 2.stockNumber 3.registrationNumber | A unique Vehicle Identification Number that is used to identify the vehicle being processed. Note: Provide the vehicle's VIN, or alternatively, use stockNumber or registrationNumber. |
| Rooftop of the Dealership | dealerId | Identifies the specific dealership or rooftop submitting the request. Note: The vehicle will be processed within the default team if the Dealer ID is not provided. |
| Products to be processed | media | This Specifies the types of media to process. image: Process a single vehicle image. spin: Generate a 360-spin of the vehicle. featureVideo: Create a feature video. How to Use: Use true or false for each option. If a value is not passed, it defaults to null. |
| Input Media to be processed | mediaInput (imageData or videoData) | The mediaInput parameter contains the URLs for the media to be processed, either images, videos, or both. 1. Image URLs (imageData): An array of URLs pointing to the images to be processed for catalog-friendly outputs. 2. Video URLs (videoData): An array of URLs pointing to videos, primarily used for generating 360° spins or feature videos. 3. Key Note: It is not always necessary to provide a video URL to generate a 360-spin. If you provide 8 exterior image frames of a vehicle, the system can also create a smooth and seamless 360-spin. 4. Priority: Videos are prioritized for 360° spin generation and Images are prioritized for catalog processing or as an alternative source for spins when video is not available. |
| Processing Details Parameters - Common Configurations | numberPlateLogo bannerId backgroundId | numberPlateLogo Customizes the vehicle’s number plate. Pass 0 for no masking, Pass 1 for white masking, or Provide a URL for a custom logo or image. bannerId: Adds a banner to the processed output. Provide the unique banner ID that is maintained by the Spyne team. backgroundId: Specifies the background for processed media. Provide the unique background ID that is shared with you by the Spyne Team |
| Processing Details Parameters - Product-Specific Configurations | catalog spin featureVideo | Catalog Parameters extractCatalogCount: Defines the number of catalog images to be extracted from the input media. This parameter is only needed if the input media is a video and image processing is set to true. backgroundType: Specifies the background style for catalog images. If no parameter is provided, it defaults to "legacy". spin: spinFrameCount: Sets the number of frames in the 360-spin. Provide an integer value (e.g., 36 or 72). Higher number results in a smoother spin. hotspot: Indicates whether hotspots (interactive elements) are added to the spin. Use true to enable or false to disable hotspots. featureVideo: templateId: Chooses the template for the feature video. Provide the unique template ID provided by Spyne. musicId: Adds background music to the video. Provide the unique music ID provided by Spyne. voiceId: Adds a voice-over to the video. Provide the unique voice ID provided by Spyne. |