コンテンツへスキップ
最終更新

クイックスタートガイド

まず、https://yce.makeupar.com/ai-api で YouCam API アカウントを無料で登録します。その後、購入またはサブスクリプションに申し込むことでユニットを取得し、サービスを利用できます。https://yce.makeupar.com/api-console/en/api-keys/ で、サブスクリプションプラン、従量課金ユニット、利用記録を確認できます。アカウントページの API Key タブで API キーを生成・管理し、YouCam API の利用を開始します。

ワークフローの手順:

1. 認証

  • リクエストヘッダーに Bearer Token で API キーを含めます:
    Authorization: Bearer YOUR_API_KEY

API キーは https://yce.makeupar.com/api-console/en/api-keys/ で確認できます。

2. ファイルのアップロードまたはパブリック画像 URL の準備。

  • File API を呼び出す
  • File API のレスポンスからアップロード URL requests.url と対応する file_id を取得する。
  • File API のレスポンスの requests.url で画像をアップロードする

3. AI タスクを開始し、タスク ID を取得:

  • アップロードした画像と AI タスク設定を HTTP POST リクエストで /s2s/v2.0/task/skin-analysis に送信します。ここでは例として AI 肌分析タスクを使用します。
  • このインタラクションを識別する一意のタスク ID がレスポンスに含まれるのを待つ。

4. タスクステータスのポーリング(継続的な確認):

  • 取得した task_id を使用して、HTTP GET リクエストで定期的にタスクステータスをポーリングします(例: GET /skin-analysis/${task_id})。ここでは例として AI 肌分析タスクを使用します。
  • 以下を継続的に監視します:
    • Task_status = "success"(処理完了)。
    • Task_status = "error"(該当する場合、解決またはリトライ)。
  • ステータスが success に遷移したら、ワークフローをそれに応じて更新します。

5. 結果の取得

  • 正常なレスポンスには、結果画像のダウンロード URL が含まれます。