来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 TTS Open Toolkit: Make your AI assistant fluent in TTS integration!
TTS Open Toolkit is a CLI for TikTok Shop OpenAPI developers. The official release installs and updates TTS OpenAPI skills for your AI coding agent, connects App and Shop context, helps complete required scopes, and validates supported API calls after authorization so you can integrate and troubleshoot faster.
For more details, please refer to: TTS Open Toolkit Developer Tools
§2 如何安装 // Getting started
#§3 Agent 直接安装（推荐）// Let your agent install it (recommended)
Agent 直接安装（推荐）// Let your agent install it (recommended)
目前已经支持 Codex、Claude Code 、 Trae 。如果你同时使用多个 Agent，可以分别执行对应命令。后续如果希望支持 Cursor、Windsurf、Cline 或其他 Agent，欢迎反馈给维护同学。 Currently, Codex, Claude Code, and Trae are supported. If you use multiple agents at the same time, you can execute corresponding commands separately. If you'd like to see support for Cursor, Windsurf, Cline, or other agents in the future, just let us know.
直接与 Agent 对话：
Directly communicate with the agent:
帮助我安装npm install -g @tts-open-toolkit/cli，和对应所有 skill。
Help me install npm install -g @tts-open-toolkit/cli, and all corresponding skills.
§4 手动快速安装 // Manual quick install
手动快速安装 // Manual quick install
全局安装 CLI：
Global installation of CLI:
npm install -g @tts-open-toolkit/cli
验证安装成功：
Verify successful installation:
tts_open_toolkit version
安装必要的 skill：
Install the necessary skills :
| Agent | 推荐命令 // Recommended command | 说明 // Explanation |
|---|---|---|
| Codex | tts_open_toolkit skill add --agent codex | 安装到 Codex 技能目录，适合在 Codex 中使用 TTS OpenAPI 知识技能 // Install to Codex skills directory, suitable for using TTS OpenAPI knowledge skills in Codex |
| Claude Code | tts_open_toolkit skill add --agent cc | 安装到 Claude Code 技能目录，也支持 claude / claude-code 等别名 // Install to Claude Code skill directory, also supports claude / claude-code aliases |
| Trae | tts_open_toolkit skill add --agent trae | 安装到 Trae 技能目录 // Install to Trae Skills Directory |
| Trae CN | tts_open_toolkit skill add --agent trae-cn | 安装到 Trae CN 技能目录 // Install to Trae CN Skills Directory |
§5 从 Beta 升级到正式版 // Upgrade from Beta to the official release
从 Beta 升级到正式版 // Upgrade from Beta to the official release
如果你已经安装过 Beta 版，先升级 CLI ：
If you previously installed the beta, update the CLI first, then refresh the skills for your agent:
tts_open_toolkit update
§6 正式版能帮你做什么 // What the official release can do
#§7 正式版新增 // New in the official release
正式版新增 // New in the official release
| 你要完成的事 // Developer goal | 正式版如何帮助你 // How the official release helps |
|---|---|
| 在常用 AI Agent 中快速开始 // Start in your preferred AI agent | 支持 Codex、Claude Code、Trae 和 Trae CN，方便在现有开发环境中接入。// Works with Codex, Claude Code, Trae, and Trae CN, for your existing development setup. |
| 获取最新 API 与 Webhook 信息 // Use current API and webhook definitions | Agent 可查询在线 schema 与 webhook 定义，减少依赖旧文档或手工查找。// Your agent can query online schema and webhook definitions instead of relying on stale local references. |
| 连接正确的 App 与 Shop // Connect the right App and Shop | 通过 SSO 登录后选择 App / Shop，安全保存凭证并切换上下文，避免在多个应用和店铺之间反复手工配置。// Sign in with SSO, select an App and Shop, store credentials securely, and switch context without repeated manual setup. |
| 补齐权限并验证调用 // Complete scopes and validate API calls | 根据目标 API 辅助补齐所需 Scope，并在授权后验证受支持的真实 API 调用。// Get help completing the required scopes and validate supported API calls after authorization. |
§8 5 分钟开始用 // Core use cases to try first
5 分钟开始用 // Core use cases to try first
把下面的 Prompt 直接发给你的 AI Agent；涉及真实 App / Shop 或 API 调用时，先完成登录与授权。// Send any prompt below directly to your AI agent. Sign in and authorize first when the task needs a real App, Shop, or API call.
| 业务用例 // Use case | 可直接复制的 Prompt // Prompt to copy |
|---|---|
| Partner Platform Changelog 更新提醒 // Changelog update reminder | Act as a TikTok Shop OpenAPI integration engineer. Review the latest Partner Platform Changelog and compare all changes since [DATE] with this repository. For each API or webhook change, identify the change type, effective date, affected endpoint, event, field, scope, code location, business flow, severity, and required action. Use current official sources, link or name each source, separate confirmed impact from assumptions, and do not invent missing details. If this AI agent supports scheduled tasks, repeat every two weeks and notify me only when action is required. |
| 生成可运行 Demo // Generate a runnable demo | Create a runnable [LANGUAGE / FRAMEWORK] demo for [BUSINESS SCENARIO] using the current TikTok Shop OpenAPI. Confirm the endpoint version, required scopes, prerequisites, and request fields from the official schema before writing code. Include authentication and context setup, request construction, pagination or webhook handling when relevant, error handling, test data, run commands, and objective success checks. Keep credentials in environment variables. Cite the official source used and list assumptions or unsupported steps instead of fabricating them. |
| 真实 API 调用验证 // Validate a supported API call | Using the selected App and Shop context, validate the supported API call for [BUSINESS SCENARIO]. First confirm the endpoint version, required scopes, request fields, and prerequisites from the current official schema. Use the safest read-only call available unless I explicitly approve a write action. Return the prerequisite checklist, a sanitized request summary, response result, pass or fail decision, and the exact next action for each failure. Never expose credentials or claim success without response evidence. |
| 新 API 影响比对 // Assess the impact of an API change | Compare [NEW API OR WEBHOOK CHANGE] with the implementation in this repository. Identify affected endpoints, events, versions, fields, scopes, data mappings, retries, idempotency, and downstream business flows. Classify each item as breaking, behavioral, or no action. Cite official evidence and produce a prioritized migration plan with code locations, tests, rollout order, and rollback checks. Mark unknowns explicitly. |
| App / Shop 接入就绪检查 // Check App and Shop readiness | Assess whether the selected App and Shop are ready for [BUSINESS SCENARIO]. Check login and context, App and Shop selection, credential availability, required scopes, API prerequisites, and the safest supported validation call. Return a concise pass or fail table with evidence, blocking or non-blocking status, owner, and next action. Do not change configuration or call a write API without confirmation. |
| 接入方案与 Onboarding // Plan an integration | Design an implementation-ready integration plan for [BUSINESS SCENARIO] in [MARKET]. Using the current official TikTok Shop OpenAPI schema and guides, specify the APIs and webhooks, versions, scopes, App and Shop setup, sequence and data flow, error and retry strategy, test plan, success criteria, rollout steps, and known constraints. Separate mandatory steps from optional recommendations, cite the sources used, and flag every item that still requires confirmation. |
§9 使用示例 // Examples
使用示例 // Examples
§10 接入问题咨询 // Integration Q&A
接入问题咨询 // Integration Q&A
Image
§11 生成可调试 Demo // Runnable demo
生成可调试 Demo // Runnable demo
Image
§12 一起把它做得更好 // Help us make it better
遇到安装、升级、登录授权、API 调用、回答质量或功能需求问题，请通过英文反馈表提交。为了帮助我们复现，请说明环境、操作目标、实际结果和复现步骤；Request ID、错误码、日志或截图可作为补充证据。请勿提交 token、secret 或其他凭证。// For installation, upgrade, authorization, API call, answer-quality, or feature-request feedback, use the English form below. Include your environment, goal, actual result, and reproduction steps. Request IDs, error codes, logs, and screenshots are optional evidence. Never submit credentials. Feedback form: TTS Open Toolkit Feedback Form For urgent access or security issues, contact: huangheqing.97@bytedance.com