# ウォッチバーチャル試着

# 概要
AR ウォッチのバーチャル試着を作成します。2D 画像 1 枚でウォッチの試着プレビューを生成します。

## 統合ガイド
本ガイドでは以下内容を説明します:

*   **エンドポイント:** `/s2s/v2.0/task/2d-vto/watch`
*   **認証:** すべてのリクエストに `Authorization: Bearer YOUR_API_KEY` が必要です
*   **ワークフロー:**
    1.  **手首の画像を準備する:** 画像をアップロードするか、手首の有効な画像 URL を提供します
    1.  **ウォッチの画像を準備する:** 画像をアップロードするか、ウォッチ製品の有効な画像 URL を提供します
    1.  **AI タスクを発行しタスク ID を取得する:** レスポンスから `task_id` を取得します。
    1.  **ステータスをポーリングする（`GET`）:** `task_id` を使用してタスクのステータスを確認します。`task_status` が `"success"` または `"error"` になるまでポーリングを続行してください。

---

* API プレイグラウンド

API プレイグラウンドで API を対話的にテストします:

**API プレイグラウンド:**
[http://yce.makeupar.com/api-console/en/api-playground/ai-watch-virtual-try-on/](http://yce.makeupar.com/api-console/en/api-playground/ai-watch-virtual-try-on/)

---

* 認証
- リクエストヘッダーに **Bearer Token** を使用して API キーを含めます:
    ```
    Authorization: Bearer YOUR_API_KEY
    ```
API キーの確認場所: https://yce.makeupar.com/api-console/en/api-keys/.


* 1. 画像のアップロード

ファイルをサーバーに直接アップロードするか、VTO タスクペイロードに有効な画像 URL を提供できます。

   * アップロードエンドポイント

```
POST /s2s/v2.0/file
```

すでにパブリックな画像 URL を持っている場合は、このステップをスキップできます。

File API のレスポンスで提供された URL にファイルを直接アップロードし、その後 File API が返した対応する `src_file_id` を使用して AI タスクを呼び出すことができます。または VTO タスクペイロードに有効な画像 URL を `src_file_url` として提供します。`src_file_id` または `src_file_url` がバーチャル試着の対象となります。

また、`src_file_id` または `src_file_url` に適用するウォッチ製品画像を参照として `ref_file_ids` または `ref_file_urls` で提供する必要があります。

AI エンジンでは、ウォッチ製品画像の自動背景透過に対応しています。ただし、手（`srcmsk_file_id` または `srcmsk_file_url`）またはウォッチ製品（`refmsk_file_ids` または `refmsk_file_urls`）のオクルージョンマスク画像ファイルを提供してセグメンテーションを微調整できます。

---

* 2. ウォッチ VTO タスクの作成と結果のポーリング

画像とテンプレート ID が揃ったら、タスクを作成します。API はリクエストを非同期で処理します。ステータスが `success` または `error` に達するまでタスクステータスをポーリングする必要があります。

   * タスク作成エンドポイント

```
POST /s2s/v2.0/task/2d-vto/watch
```

   * ポーリングエンドポイント

```
GET /s2s/v2.0/task/2d-vto/watch/{task_id}
```

---

## ファイル仕様とエラー

* ウォッチバーチャル試着の仕様

**サポートされるウォッチビュー**
文字盤が遮蔽されていない明瞭な前面ビューのウォッチ画像。ストラップはリアルな装着長さに見えるようにトリミングしてください。

![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/strapi/assets/watch_product_01_aab8053028_50ab7fe9a5.jpg)

**サポートされる手首ビュー**
手首の裏側が完全に、5 つの指がすべて明確に見え、オクルージョン（遮蔽）がない状態である必要があります。

![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/strapi/assets/watch_and_bracelet_user_01_09f16603cb_878dc89179.jpg)

**watch\_wearing\_location: float (−0.3 to 1.0)**
手首に沿った位置を示します:
−0.3 は主要な手首関節に近いことを示します
1.0 は主要な手首関節から遠いことを示します
デフォルト値: null（エンジンのデフォルトを使用）

![watch_wearing_location](https://bcw-media.s3.ap-northeast-1.amazonaws.com/strapi/assets/bracelet_wearing_location_01ac0a048e.jpg)

**watch\_shadow\_intensity: float (0.0 to 1.0)**
影の強さを制御します:
0.0 は影なしを示します
1.0 は最大限の影を示します
デフォルト値: 0.15

**watch\_ambient\_light\_intensity: float (0.0 to 1.0)**
ライティングがターゲットの手画像を参照する度合いを定義します:
0.0 は手画像のライティングを無視します
1.0 は手画像のライティングと影のレンダリングに完全に一致させます
デフォルト値: 1.0

**ウォッチアンカーポイント: ピクセル座標の 4 点の配列（任意）**
最初の 2 点は、装着時のストラップの始まりと終わりをマークします。
残りの 2 点は、ウォッチケースの上端と下端をマークします。

![watch_anchor_point](https://bcw-media.s3.ap-northeast-1.amazonaws.com/strapi/assets/Product_anchors_ece6851c88.jpg)

---

* サポートされる形式と寸法

|AI 機能|サポートされる寸法|サポートされるファイルサイズ|サポートされる形式|
|  ----  | ----  | ----  | ----  |
|ウォッチバーチャル試着|長辺 <= 4096 |< 10MB|jpg/jpeg/png|

* エラーコード

|エラーコード|説明|
|  ----  | ----  |
| RUNTIME_ERROR | ウォッチランタイムで予期しないエラーが発生しました |
| PHOTO_DETECTION_FAIL | ユーザー写真が正しく処理できませんでした（例: 手が検出されなかった） |
| OBJECT_DETECTION_FAIL | オブジェクト写真が正しく処理できませんでした（例: 製品が検出されなかった） |
| PHOTO_CHECK_INVALID | ユーザー写真のポーズまたはサイズが無効です |
| INPUT_ERROR | 入力ファイルの形式が正しくありません |
| INPUT_MAIN_IMAGE_EMPTY | ユーザー画像が必要です |


* 環境と依存関係

| サンプルコードの言語/ツール | 推奨ランタイムバージョン |
|---|---|
| cURL | - bash >= 3.2</br>   - curl >= 7.58（モダンな TLS/HTTP サポート）</br>   - jq >= 1.6（堅牢な JSON パーシング） |
| Node.js (JavaScript) | Node >= 18（グローバル fetch のため） |
| JavaScript | - Chrome / Edge >= 80</br>   - Firefox >= 74</br>   - Safari >= 13.1 |
| PHP | PHP >= 7.4（モダンな TLS/互換性のため）、ext-curl（推奨）または allow_url_fopen=On + ext-openssl, ext-json |
| Python | Python >= 3.10（f-strings のため）、requests >= 2.20.0 |
| Java | Java 11+（HttpClient のため）、Jackson Databind >= 2.12.0 |

---

## JS Camera Kit
{% partial file="/_partials/js-camera-kit.md" /%}

---

## ユニット消費

| AI 機能 | 消費ユニット |
|---|---|
| ウォッチバーチャル試着 V1.0 | シングルアイテム着用で 1 ユニット |

---


License: Privacy policy

## Servers

```
https://yce-api-01.makeupar.com
```

## Security

### BearerAuthenticationV2

[object Object]

Type: http
Scheme: bearer

## Download OpenAPI description

 - [ウォッチバーチャル試着](https://docs.perfectcorp.com/_bundle/@l10n/ja/reference/ai_watch.yaml)

## V1.0

 - [POST /s2s/v2.0/task/2d-vto/watch](https://docs.perfectcorp.com/ja/reference/ai_watch/v1.0/paths/~1s2s~1v2.0~1task~12d-vto~1watch/post.md): このエンドポイントはウォッチバーチャル試着プロセスを開始します。ソースファイルと参照画像（URL または File ID 経由）、およびアライメント、シャドウ、着用位置の特定のパラメータを提供する必要があります。タスクは非同期で処理され、このレスポンスで返される task_id を使用してステータスを確認できます。
 - [GET /s2s/v2.0/task/2d-vto/watch/{task_id}](https://docs.perfectcorp.com/ja/reference/ai_watch/v1.0/paths/~1s2s~1v2.0~1task~12d-vto~1watch~1%7Btask_id%7D/get.md)
