はじめる

Vehicle Imagery API v1.2.0

すべてのメーカー、モデル、年、バリアント、トリム、ビューに対するスタジオクオリティの車両画像 — 画像フォーマット、サイズ、アスペクト比、塗装色、影、透明度、地面の影、床のミラー反射をリアルタイムで調整した署名付き CDN URLで配信。

ベースURL

すべてのエンドポイントは https://api.vehicleimagery.com の下でライブです。

認証

各リクエストは、x-api-key ヘッダーにAPIキーが必要です。

curl -H "x-api-key: YOUR_API_KEY" https://api.vehicleimagery.com/api/brands

キーが行うこと（フォーマット、比率、機能、ブランド）は、/api/me で返されます。ドキュメントエンドポイント（/api/openapi.json、/api/docs）は公開されており、キーは不要です。

二つの入力方法

車を知っていますか？ カタログをナビゲート： ブランド → モデル → 年 → バリアント → トリム → ビュー。実際の車をお持ちですか？ ルックアップアドオンを使用してください — GET /vin/{vin} または GET /plate/{plate} は、VINまたは登録番号をそのまま車両データに変換し、その車のスタジオ画像を提供します。実際の塗装色が適用されます。アドオンはキーごとに有効になります；/api/me は、あなたのキーがどのような機能を持っているかを示します。

動作方法

カタログをナビゲートして一台の車に絞り込みます：brand → model → year → variant → trim → view、例：GET /api/Abarth/124_Spider_Abarth/2016/Basis/base。
画像を解決するには、ビューとオプションを追加します: GET /api/Abarth/124_Spider_Abarth/2016/Basis/base/front_left?format=webp&width=1200 → メタデータと署名付きのimage_urlが返されます。
Embed image_urlを直接<img>に埋め込みます。署名付きで変換ロックされており、バイトは最初のリクエスト時に生成され、プランのTTL（デフォルト7日）でCDNにキャッシュされます。

画像オプション

画像リクエストに追加: format, resolution, ratio, width, height, quality, color, shadow, transparency, ground, mirroring. すべてのオプションは自由に組み合わせ可能です (例: ?color=wine_red&shadow=true&format=webp&width=1200). 完全なプランフィルタリングされたセットは /api/options にあります。

塗装色

車は必要に応じて再塗装できます — 反射、クローム、ガラス、インテリアはそのまま、塗装だけが変わります、その仕上げ（ソリッドまたはメタリック）に忠実です。/api/colorsは、{ color_name, color_make }のペアとして全カタログをリストします：ハウスカラー (black, white, blue, orange, wine_red — color_make: "Vehicleimagery") はすべての車に利用可能です。ブランドカラー（例：Kia *Racing Red*）はそのブランドの車に属します。車自体の/colorsエンドポイントは、その車に表示されるものをリストします（ハウスカラー + そのブランドのカラー） — どのアクティブなカタログカラーでも、?color=を通じて任意の車でリクエストできます。詳細については、*Paint colors*ガイドの/info/guides/colorsを参照してください。

影、透明度、合成

スタジオの地面の影 (shadow=true)、透明なカットアウト (transparency=true) および不透明な白色の配信は、すべての外観ビューで配信時に生成されます — カタログ全体で一様に利用可能です。

エラーノート（致命的でない）

リクエストが正確に処理できない場合、APIは失敗しません — 最も近い有効な値にフォールバックし、errornotes 配列に短いコードを追加します（例：Y01 = 最も近い年使用、S05 = 影が利用できない）。完全なリストは /api/errornotes にあります。

画像の配信とキャッシュ

返されるimage_urlはCDNを指し、署名と有効期限を携え、正確な変換にロックされています — クライアントはこれを改ざんできません。最初のリクエストがバイトをレンダリングしキャッシュします。その後のリクエストはすべてキャッシュから直接提供されます。<img src>にURLをドロップするだけです。

ステータスコード

200 — 成功。常に errornotes を確認してサイレントフォールバックをチェックします。
401 — x-api-key がありませんか、無効です。
403 — ご契約プランでは、リクエストされた機能、フォーマット、またはブランドをご利用いただけません。
404 — そのパスにデータはありません。メッセージは、確認すべき項目を正確に示しています。

慣例

ブランド / モデル / バリアント / トリム名は大文字小文字を区別せず、一般的な別名も受け付けます。
年数は最も近い利用可能な世代にスナップされます
カタログエンドポイントはJSONを返し、画像バイトは署名付きのimage_urlからのみ取得されます。