> ## Documentation Index
> Fetch the complete documentation index at: https://docs.aftersell.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Upcart 公共 API 简介

> 了解如何开始使用 Upcart 的 API、添加脚本、测试更改，并轻松自定义你的购物车。

**Upcart Public API** 让你可以自定义购物车、自动化工作流并与第三方应用集成——无论你是开发者还是刚刚入门。\
本指南将带你了解基础知识，帮助你开始在 cart drawer 中构建自定义功能。

👉 [查看完整的 Upcart Public API 文档](https://rokt.notion.site/upcart-public-api)

***

<div id="overview">
  ## 概述
</div>

Public API 是一组 JavaScript 函数和事件监听器，让你可以：

* **响应购物车变化** — 检测商品何时被添加、移除或更新。
* **触发操作** — 例如以编程方式打开或关闭购物车。
* **构建自定义功能** — 直接在 cart drawer 中注入你自己的逻辑或 UI 组件。

当你在 Upcart 编辑器的 **Custom HTML** 部分工作时，它尤其有用，你可以使用这些函数为购物者打造独特的体验。

***

<div id="what-you-need-to-get-started">
  ## 开始前的准备
</div>

在使用 Upcart 的 API 之前，请确保你具备：

* **在你的 Shopify 商店中可以访问 Upcart**\
  确保 Upcart 已在你的商店中安装并处于激活状态。
* **对 JavaScript 的基本了解**\
  许多自定义都使用预先编写的代码片段，但如果你想超越基础用法，掌握基本的 JavaScript 会很有帮助。

***

<div id="adding-your-first-upcart-api-script">
  ## 添加你的第一个 Upcart API 脚本
</div>

你可以直接在 Upcart 编辑器中开始使用 API：

1. 前往 **Upcart Editor → Settings → Custom HTML → Scripts (before load)**

2. 粘贴你的脚本 — 例如：

```
<script>
  window.upcartSubscribeAddedToCart(function(event) {
    console.log("You just added " + event.item.title + " to your cart!");
  });
</script>
```

\*\*注意：\*\*使用 `window.upcartOnAddToCart` 的旧示例仍然有效，但已被弃用，并会在控制台记录一条警告。所有新脚本请使用 `upcartSubscribeAddedToCart`。

3. 保存你的更改，然后在商店中进行测试：

* 打开开发者工具（Windows 上按 `F12` 或 `Ctrl + Shift + J`，Mac 上按 `Cmd + Option + J`）
* 将一个商品添加到购物车
* 在 Console 标签页中查看以下消息：\
  `"You just added [product title] to your cart!"`

🎉 如果你看到这条消息，说明你的第一个 API 脚本已生效！

***

<div id="start-customizing-your-cart">
  ## 开始自定义你的购物车
</div>

现在设置已完成，你可以使用 API 实现各种有趣的功能——例如在添加商品时自动打开购物车、更新自定义小组件或发送分析事件。

有关完整的函数参考和示例，请查看 **[Upcart Public API 文档](https://rokt.notion.site/upcart-public-api)**。

***

<div id="more-resources">
  ## 更多资源
</div>

* 🧩 **[API 常见问题](/zh/upcart/upcart_api_frequently_asked_questions)** — 故障排除技巧和常见问题
* ⚙️ **[Upcart API 的常见用途](/zh/upcart/common_upcart_api_uses)** — 热门代码示例和模板
* 💡 **[自定义文档](/zh/upcart/add_a_mandatory_terms_and_conditions_checkbox_to_your_cart)** — 帮助你快速上手的预写脚本
* 🛍️ **[Shopify 的 Cart API 文档](https://shopify.dev/docs/api/ajax/reference/cart)** — 了解 Shopify 如何在后台处理购物车数据
* 👩💻 需要高级自定义？可以考虑聘请 [Shopify 专家](https://www.shopify.com/ca/partners/directory/services/development-and-troubleshooting/custom-apps-integrations)来完成更复杂的集成。