跳转到内容
最后更新于

常见问题

  1. 问:「点数(Unit)」是什么意思,怎么用?
    答: 请注意,点数是 YouCam API 各项操作的计价单位,不同的 AI 功能扣除的点数不一样。在本文档里,点数的代号写作 "Credit"。

  2. 问:为什么会报 InvalidTaskId 错误?
    答: 一旦您去查询一个已经超时的任务的状态,就会收到 InvalidTaskId 错误。所以,跑起一个 AI 任务之后,您需要轮询——在 polling_interval 之内持续查状态,直到状态变成 success 或 error 为止。

  3. 问:怎么做鉴权?
    答: 您的 API 密钥就是完成鉴权所用的 Bearer Token。用 Bearer Token 把 API 密钥放进请求头:

    Authorization: Bearer YOUR_API_KEY

    想了解更多、有疑问,可以看我们的博客和 API 在线调试台,也可以发信到 YouCamOnlineEditor_API@perfectcorp.com。我们的客户成功团队很乐意帮您。;)

  4. 问:用 curl 怎么上传图片?
    答: 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. 问:AI API 支持哪些平台?能用在移动设备上吗?
    答: AI API 在各个平台上都能顺畅工作。它基于标准 RESTful API,所以服务器对服务器的调用、移动设备上的调用、浏览器里的调用都可以,怎么顺手怎么来。

  6. 问:Android 和 iOS 上能用 Flutter 接 AI API 吗?
    答: 完全可以。AI API 就是标准的 RESTful API,用 Flutter 自带的 HTTP 接口发请求即可。

    下面是几篇官方的 Flutter 网络请求文档。

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

    用 Flutter 的 http 包发一个带 Bearer 鉴权的 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}");
        }
    }

    鉴权要点:

    • 拿到 Token——用 SharedPreferences 或其他安全存储方式保存和读取 Token。
    • 把 Token 放进请求头——在请求头里写 "Authorization": "Bearer $token"。
    • 处理好 Token 过期——API 返回 401 InvalidAccessToken 时,按需刷新 Token。

  7. 问:API key 就是 API key,那 secret key 在哪里找?
    答: secret key 只在您第一次生成时创建一次。所以一定要当场存好,之后再也看不到了。

  8. 问:能用 Wix 把 AI API 接到我的网站上吗?
    答: 我们目前没有关于在 Wix 上使用 AI API 的官方集成指南。不过 RESTful API 本身对平台没有任何限制,只要平台支持标准的网络请求就行。

    我们建议您先读 Wix 的官方文档:https://dev.wix.com/docs/develop-websites/articles/get-started/integrate-with-3rd-parties

    Wix 提供了几种对接第三方 API 的方式,主要靠它的 Velo 开发平台:

    • Fetch API: 这是最常用的方式,是标准 JavaScript Fetch API 的实现。您可以从 Wix 站点的前端或后端代码向外部 API 发 HTTP 请求。 后端调用:出于安全考虑推荐这种(尤其是需要密钥的 API),也能避开 CORS 问题。用 Secrets Manager 安全存放 API 密钥。 前端调用:可以做,但安全性差一些,还可能遇到 CORS 限制。

    • npm 套件: Velo 支持使用经审核的 npm 套件,您可以借助大量现成的 JavaScript 模块,为站点扩展第三方功能。

    • Service Plugins(原名 SPI/Custom Extensions): 这类方式能把自定义逻辑或直接第三方服务接进 Wix 的业务方案里(例如 Wix Stores、Wix Bookings)。Service plugin 可以定制现有应用流程中的某些环节,或为自定义运费、动态定价、备用支付渠道等功能接入外部服务。

    • HTTP Functions: 您可以把站点功能对外发布成 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. 问:能把 AI API 接到 WooCommerce 吗?
    答: 我们目前没有关于在 WooCommerce 上使用 AI API 的官方集成指南。不过 RESTful API 本身对平台没有任何限制,只要平台支持标准的网络请求就行。

    我们建议您先读 WooCommerce 的官方文档:https://woocommerce.com/document/woocommerce-rest-api/

    把第三方 API 接进 WooCommerce,能让店铺功能更强、运营更顺。常见做法有这几种:

    • 用 WooCommerce REST API:

      WooCommerce 提供了一套功能完备的 REST API,外部应用可以通过它读写您的店铺数据。 您可以在 WooCommerce > Settings > Advanced > REST API 里创建带特定权限(Read、Write 或 Read/Write)的 API 密钥。 有了它,自建集成或用第三方服务调用这套 API,就能自动完成库存同步、订单处理、客户数据同步等工作。

    • 用插件:

      很多 WordPress 和 WooCommerce 插件就是为对接主流第三方服务而生的,比如支付网关、物流承运商、CRM 系统、财务软件。 插件通常自带现成的集成方案,省掉配置功夫,也少写不少自定义代码。 常见的有对接特定支付渠道的插件(如 Stripe、PayPal)、物流方案插件(如 FedEx、USPS),以及 WPGet API 这类通用 API 集成工具。

    • 自定义代码与 Webhook:

      需求比较特殊,或者找不到合适的插件时,您可以在 WordPress 主题里或自建插件里写自定义代码。 具体做法是借助 WordPress/WooCommerce 的 hooks 和 filters,在特定事件上触发 API 调用(例如用 woocommerce_payment_complete 做购后动作)。 也可以用 webhook,在特定事件发生时(例如新订单、商品更新)把实时数据从 WooCommerce 推给第三方服务。