图像
解析签名图像 URL
GET/api/{brand}/{model}/{year}/{variant}/{trim}/{view}
核心端点。返回元数据加上一个签名的 image_url,您可以直接将其嵌入到 <img> 中。
將任何選項添加為查詢參數。如果車輛不支持或您的計劃不允許的任何內容,則回退到最接近的有效值,並在errornotes中報告(而不是失敗)。
示例
?format=webp&width=1200— WebP,宽 1200 像素。?ratio=16:9&format=jpeg— 填充为 16:9。?mirroring=true— 车辆在反光展厅地板上。?transparency=true&format=png— 透明背景剪切。?color=wine_red— 重新喷漆为 wine_red 房屋颜色。?color=Racing%20Red&shadow=true— Kia 目录颜色加工作室阴影。
API v2附加功能: 对于带有附加图像的汽车,以下额外选项适用(lights,background,十六进制 color,windows,plate,fit,size,hotspots),例如 ?color=c8102e&windows=dark&size=1080p。使用附加功能,{view} 也可以是工作室组(hero,steered,extra,drone):它列出了该组的图像 — 请参阅 *API v2附加功能*。
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
brand 必需 | 字符串 | 品牌名称或别名(不区分大小写)。 |
model 必需 | 字符串 | 车型名称 |
year 必需 | 整数 | 车型年份(四位数)。如果缺少精确年份,则使用最近可用的车型(错误提示 `Y01`) |
variant 必需 | 字符串 | 车身变体 |
trim 必需 | 字符串 | 修剪级别 |
view 必需 | 字符串 | 视图名称 — 请参阅 /api/views(例如 front, front_left, rear) |
查询参数
| 名称 | 类型 | 描述 |
|---|---|---|
format | 字符串 | 交付格式。`auto` 选择 WebP。原始格式是 PNG。pngwebpjpegavifauto |
resolution | 字符串 | 尺寸/质量预设(由显式宽度/质量覆盖)。 defaultthumbsmallmediumlargefull |
ratio | 字符串 | 填充到宽高比。1:14:33:216:916:102:121:95:43:44:52:39:16 |
width | 整数 | 像素的显式宽度(对齐到宽度梯度) |
height | 整数 | 像素的显式高度 |
quality | 整数 | 编码器质量 (40–100) |
color | 字符串 | 按名称指定涂装颜色(不区分大小写;URL编码空格,例如 `Racing%20Red`)。车辆按需重新喷漆——保持真实效果、反射和装饰。车辆的 `/colors` 列出其显示的颜色集(车厂颜色 + 品牌颜色);可以请求 `/api/colors` 中的任何活动颜色。未知颜色 → 默认涂装 + 错误提示 `F04`。与所有其他选项结合。 **API v2 附加功能:** 目录颜色带有其真实效果(金属、珍珠、哑光、丝绒、镀铬、铝、碳纤维)。也可以使用任何 6 位数十六进制涂装颜色,例如 `c8102e`(光泽),或带有效果的十六进制颜色:`<finish>_<hex>`,例如 `metallic_315fbf`,`matte_283b56`,`carbon_545454`,`chrome_eac972`;金属、珍珠和丝绒效果可选第二种颜色,例如 `metallic_315fbf_5693f9`。效果:`solid`,`metallic`,`pearl`,`satin`,`matte`(也可写作 `matt`),`chrome`,`aluminium`,`carbon`。 |
shadow | 字符串 | 工作室地面阴影 — 在交付时生成,适用于每个外观视图。使用 `mirroring=true` 时,这控制的是底盘阴影。truefalse |
transparency | 字符串 | 透明剪切背景 — 每个外观视图都可用(与PNG/WebP一起使用)。 truefalse |
ground | 字符串 | 将车辆放在地面上(需要透明变体)。 true |
mirroring | 字符串 | 反光地面。`true` = 带底盘阴影,`clean` = 仅反光。需要透明变体。trueclean |
lights | 字符串 | **API v2 插件:**车灯开关。 **默认 `on`:**不带参数时,图像会带灯,无论图像中是否有灯;发送 `lights=off` 以获取无灯的图像。没有灯光变体的图像直接不带灯;带 `lights=on` 时也会携带错误提示 `L26`。 onoff |
background | 字符串 | **API v2 插件:** `white`(默认),`transparent`,或类似 `f4f4f4` 的六位十六进制颜色。仅适用于工作室图像(生活方式 → 错误提示 `B32`)。 |
windows | 字符串 | **API v2 插件:** `see_through` = 玻璃,如图所示(默认),`dark` = 隐私玻璃,无法看透。不可用 → 错误提示 `W28`。see_throughdark |
plate | 字符串 | **API v2 插件:**车牌 — `none` = 图片中的车牌 (默认),`blank` = 空白车牌,`logo` = 你的标志在车牌上 (设置在你的密钥上;缺失 → 空白 + 错误提示 `N30`),`text` = 你自己的文本来自 `plate_text` (必须为你的密钥启用,见 `/api/me` 中的 `addon.plate_text`;否则错误提示 `O31`)。 noneblanklogotext |
plate_text | 字符串 | **API v2 插件:**`plate=text` 的文本 — 最多 10 个字符:字母、数字、空格和 `-` `.` `&`。按发送的内容写在车牌上 (保留大小写),居中并尽可能大。缺失、过长或其他字符 → `400`。 |
fit | 字符串 | **API v2 插件:** 车辆如何填充 `ratio` / `size` 框 — `contain` 填充(默认),`cover` 裁剪。生活方式图像总是覆盖。containcover |
size | 字符串 | **API v2 插件:**最长边 — `2k` 2560 像素,`1080p` 1920 像素,`720p` 1280 像素,`540p` 960 像素,`360p` 640 像素,`thumb` 320 像素。`width` / `height` 优先于 `size`。2k1080p720p540p360pthumb |
hotspots | 字符串 | **API v2 插件:** 在响应中添加 `hotspots` — 图像中的兴趣点(轮毂、前灯等)以 0–1 的分数表示,例如用于交互式查看器。true |
version | 字符串 | 仅从一个版本获取结果:`v1` = 标准图像,`v2` = API v2 附加部分(无回退到标准图像)。没有它:您的密钥允许的所有内容。您的密钥不允许 → `403`。v1v2 |

