跳转到内容
最后更新于

快速上手指南

首先,請在 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

您可以在 https://yce.makeupar.com/api-console/en/api-keys/ 找到您的 API Key。

2. 上傳檔案,或準備一個公開可存取的圖片 URL

  • 呼叫 File API
  • 從 File API 回應中取得上傳網址 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. 取得結果

  • 成功的回應會包含結果圖片的下載網址。