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

FAQ

  1. Q: 'Unit' とは何を意味し、どのように使われますか?
    A: Unit は YouCam API の操作に使用される通貨であることに注意してください。異なる AI 機能では異なる量のユニットが差し引かれます。本ドキュメントでは、Unit のコード名として "Credit" が使用されています。

  2. Q: なぜ InvalidTaskId エラーが発生しますか?
    A: タイムアウトしたタスクのステータスを確認すると、InvalidTaskId エラーが発生します。そのため、AI タスクを実行したら、ステータスが success または error のいずれかになるまで、polling_interval 内で ポーリング してステータスを確認する必要があります。

  3. Q: どのように認証を行いますか?
    A: API キーは、認証プロセスを完了するための Bearer Token です。Bearer Token を使用してリクエストヘッダーに API キーを含めます:

    Authorization: Bearer YOUR_API_KEY

    詳細やご質問については、ブログページおよび API プレイグラウンド を参照してください。または YouCamOnlineEditor_API@perfectcorp.com までメールをお送りください。カスタマーサクセスチームが喜んでお手伝いします。 ;)

  4. Q: curl で画像をアップロードするには?
    A: curl --location --request PUT '{url_api_response}' --header '{headers_in_api_response}' --data-binary @'{local_file_path}'

    curl --location --request PUT 'https://example.com/sample-result-url' --header 'Content-Type: image/jpg' --header 'Content-Length: 50000'  --data-binary @'./test.jpg'



  5. Q: AI API はどのプラットフォームをサポートしていますか?モバイルデバイスで使用できますか?
    A: AI API は異なるプラットフォーム間で動作します。標準的な RESTful API を基盤としているため、サーバー間通信、モバイルデバイス、Web ブラウザなどから使用できます。

  6. Q: Flutter で Android と iOS の両方に AI API を使用できますか?
    A: AI API は標準的な RESTful API なので、Flutter の組み込み HTTP API を使用してリクエストを送信できます。

    ネットワーククエリに関する公式 Flutter ドキュメントをいくつか紹介します。

    • https://docs.flutter.dev/cookbook/networking/fetch-data
    • https://pub.dev/packages/http

    次に、Flutter の http パッケージを使用して Bearer 認証で HTTP GET を呼び出すシンプルな方法です:

    import 'dart:convert';
    import 'package:http/http.dart' as http;
    
    Future<void> fetchData() async {
        String token = "your_bearer_token_here"; // Replace with your actual token
    
        final response = await http.get(
            Uri.parse("https://yce-api-01.makeupar.com/s2s/v2.0/task/ai-task"), // Replace the `ai-task` with the AI feature you intend to use.
            headers: {
            "Content-Type": "application/json",
            "Authorization": "Bearer $token",
            },
        );
    
        if (response.statusCode == 200) {
            print("Data fetched successfully: ${response.body}");
        } else {
            print("Failed to fetch data: ${response.statusCode}");
        }
    }

    認証の主要な手順:

    • トークンの取得 – SharedPreferences または他の安全なストレージ方法を使用して、トークンを保存・取得できます。
    • ヘッダーにトークンを含める – リクエストヘッダーで "Authorization": "Bearer $token" を使用します。
    • 期限切れトークンの処理 – API が 401 InvalidAccessToken エラーを返す場合、必要に応じてトークンを更新してください。

  7. Q: API キーは API キーですが、シークレットキーはどこで見つかりますか?
    A: シークレットキーは最初に生成したときのみ作成されます。そのため、すぐに保存してください。後ではもう表示されません。

  8. Q: Wix を使用して AI API をウェブサイトへ統合できますか?
    A: 現在、Wix で AI API を使用する公式統合ガイドはありません。ただし、RESTful API 自体は、標準的な Web クエリをサポートする限りプラットフォームに制限を課しません。

    まず Wix が提供する公式ドキュメントを読むことを推奨します: https://dev.wix.com/docs/develop-websites/articles/get-started/integrate-with-3rd-parties

    Wix は主にその Velo 開発プラットフォームを通じて、サードパーティ API との統合方法をいくつか提供しています:

    • Fetch API: これは最も一般的な方法で、標準的な JavaScript Fetch API の実装です。Wix サイトのフロントエンドまたはバックエンドコードから外部 API へ HTTP リクエストを送信できます。 バックエンド呼び出し: セキュリティの観点(特にキーを必要とする API)および CORS 問題の回避のために推奨されます。API キーを安全に保存するには Secrets Manager を使用します。 フロントエンド呼び出し: 可能ですがセキュリティが低く、CORS 制限に遭遇する場合があります。

    • npm パッケージ: Velo は承認された npm パッケージの使用をサポートしており、幅広い事前構築の JavaScript モジュールを活用してサードパーティ機能でサイトの機能を拡張できます。

    • サービスプラグイン(旧称 SPI / カスタムエクステンション): これにより、カスタムロジックを注入したり、サードパーティサービスを Wix のビジネスソリューション(例: Wix Stores、Wix Bookings)に直接統合したりできます。サービスプラグインを使用すると、既存のアプリフローの一部をカスタマイズしたり、カスタム送料、動的価格設定、代替決済プロバイダーなどの機能のために外部サービスを統合したりできます。

    • HTTP 関数: サイトの機能を API として公開でき、サードパーティサービスが Wix サイトのバックエンド関数を呼び出し、サイトのデータやロジックとやり取りできるようになります。

    統合の手順(Fetch API を例に):

    • API キーの保存: サードパーティ API が認証を必要とする場合、API キーなどの機密認証情報を Wix の Secrets Manager に安全に保存します。 wix-fetch のインポート: Velo バックエンドまたはフロントエンドコードで wixFetch モジュールをインポートします。

      import { fetch } from 'wix-fetch';
    • API 呼び出しの実行: fetch 関数を使用して、必要なヘッダーとボディデータを含めてサードパーティ API へリクエストを送信します。

      export async function getWeatherData() {
          const apiKey = await getSecret("yourApiKeyName"); // Retrieve from Secrets Manager
          const response = await fetch(`https://api.weatherapi.com/v1/current.json?key=${apiKey}&q=London`, {
              method: 'GET',
              headers: {
                  'Content-Type': 'application/json'
              }
          });
          const data = await response.json();
          return data;
      }
    • レスポンスの処理: API から受信したデータを処理し、サイトのデザインや機能に統合します。

  9. Q: WooCommerce に AI API を統合できますか?
    A: 現在、WooCommerce で AI API を使用する公式統合ガイドはありません。ただし、RESTful API 自体は、標準的な Web クエリをサポートする限りプラットフォームに制限を課しません。

    まず WooCommerce が提供する公式ドキュメントを読むことを推奨します: https://woocommerce.com/document/woocommerce-rest-api/

    サードパーティ API を WooCommerce に統合できます:

    • WooCommerce REST API の活用:

      WooCommerce は、外部アプリケーションがストアデータとやり取りできるようにする堅牢な REST API を提供しています。 WooCommerce > 設定 > 高度な設定 > REST API で、特定の権限(Read、Write、または Read/Write)を持つ API キーを作成できます。 これにより、カスタム統合を構築するか、この API を活用するサードパーティサービスを使用することで、在庫同期、注文処理、顧客データ同期などのタスクを自動化できます。

    • プラグインの利用:

      多くの WordPress および WooCommerce プラグインは、決済ゲートウェイ、配送業者、CRM システム、会計ソフトなどの人気サードパーティサービスとの統合を目的に設計されています。 プラグインには事前構築の統合が提供されることが多く、セットアッププロセスが簡素化され、カスタムコーディングの必要性が減ります。 例としては、特定の決済プロセッサ(Stripe、PayPal など)、配送ソリューション(FedEx、USPS など)のプラグインや、WPGet API のような一般的な API 統合ツールがあります。

    • カスタムコードと Webhook:

      独自の統合ニーズがある場合、または適切なプラグインがない場合は、WordPress テーマやカスタムプラグイン内でカスタムコードを実装できます。 これは、WordPress / WooCommerce のフックとフィルターを使用して特定のイベントで API 呼び出しをトリガーすることを含みます(例: 購入後のアクション用の woocommerce_payment_complete)。 Webhook を使用すると、特定のイベントが発生したときに(例: 新規注文、商品更新)、WooCommerce からサードパーティサービスへリアルタイムデータを送信することもできます。