Skip to main content

简介

要在 Square Cloud 上开发和托管 ,遵循一套结构化的配置和前置条件流程至关重要。本技术指南将涵盖整个过程,从初始设置到生产环境部署。

前置条件

  • Square Cloud 账户:通过注册页面使用你的邮箱进行注册。
  • 有效的付费套餐:为你的应用提供专属资源和优化的性能。查看我们可用的套餐,选择最适合你需求的方案。

创建项目

身份验证和机器人操作需要一个有效的 X (Twitter) 账户。如果你还没有账户,请在 X 官方网站 注册。
访问 API 还需要一个 X 开发者账户。请通过 X 开发者门户 申请访问权限。

在 X 上创建机器人应用

1

访问开发者门户

  1. 前往 X 开发者门户
  2. 使用你的 X (Twitter) 账户登录。
  3. 如果这是你第一次使用,请完成开发者访问申请流程。
2

创建项目

  1. 在控制面板中,点击 “Create Project”。
  2. 为你的项目选择一个名称(例如 “Square Cloud Bot”)。
  3. 选择最合适的用例(例如 “Making a bot”)。
  4. 提供机器人的详细描述。
  5. 确认创建项目。
3

设置应用

  1. 在已创建的项目中,点击 “Create App”。
  2. 为你的应用定义一个唯一的名称。
  3. 确认创建应用。
  4. 记下生成的 App ID 以备后续参考。
4

生成 API 密钥

  1. 导航到应用的 “Keys and tokens” 部分。
  2. 在 “Consumer Keys” 部分,点击 “Regenerate” 以生成:
    • API Key (Consumer Key)
    • API Secret Key (Consumer Secret)
  3. 重要:请立即复制并保存这些密钥,因为你将无法再次查看它们。
5

配置权限

  1. 前往 “App permissions” 部分。
  2. 点击 “Edit” 以修改权限。
  3. 选择 “Read and write” 以允许你的机器人发布推文。
  4. 如有必要,选择 “Read and write and Direct message” 以启用私信功能。
  5. 保存更改。
6

生成访问令牌

  1. 返回 “Keys and tokens” 部分。
  2. 在 “Access Token and Secret” 部分,点击 “Generate”。
  3. 确认生成令牌。
  4. 复制并保存:
    • Access Token
    • Access Token Secret
  5. 警告:关闭页面后,这些令牌将无法再次查看。
7

验证凭据

  1. 确认你拥有全部 4 个所需凭据:
    • API Key (Consumer Key)
    • API Secret Key (Consumer Secret)
    • Access Token
    • Access Token Secret
  2. 将这些凭据存储在安全的位置
  3. 重要:切勿公开分享或暴露这些凭据

开发项目

  1. Node.js 检查:确认你的系统已安装 Node.js。如果没有,请从 Node.js 官方网站 下载。
  2. 项目初始化:运行以下命令创建一个新的 Node.js 项目:
Terminal
  1. 安装依赖:安装机器人所需的库:
Terminal
  1. 设置环境变量:创建一个 .env 文件以安全地存储你的凭据:
.env
  1. 创建主文件:编写包含机器人基础结构的 index.js 文件:
index.js

部署

准备好项目文件后,你现在可以将它们上传到 Square Cloud 并托管你的项目。 为此,请创建一个包含所有项目文件的 ZIP 文件。
安全提示:切勿将 API 凭据直接写入代码中。始终在 Square Cloud 上使用环境变量。
在 Square Cloud 上,通过控制面板配置以下环境变量:
  • API_KEY:你的 X API 密钥
  • API_SECRET_KEY:你的 X API 密钥密文
  • ACCESS_TOKEN:你的访问令牌
  • ACCESS_TOKEN_SECRET:你的访问令牌密文

通过控制面板

1

访问上传页面

访问上传页面并上传你的项目 zip 文件。
2

配置你的环境

上传 zip 后,你需要为项目配置名称、主文件或运行时环境以及其他设置。
如果你上传的是 Web 项目,请务必选择 “Web Publication” 并为项目设置子域名。
3

部署你的项目

最后,点击 “Deploy” 按钮,即可将项目托管到 Square Cloud。
部署完成后,你可以在控制面板中监控项目的状态和日志。
正在上传应用到 Square Cloud
4

确认你的应用已上线

首次部署通常在一分钟内完成。在控制面板中,等待你的应用状态显示为运行中,并检查日志中是否有启动错误。
如果你部署的是网站或 API,请在浏览器中打开 https://<your-subdomain>.squareweb.app,你应该能看到应用正常响应。如果你部署的是机器人,发送一条命令确认它已上线。
应用无法启动?请参见故障排除指南,了解最常见的原因和解决方法。

通过 CLI

要使用此方法,你需要在项目根目录中创建一个名为 squarecloud.app 的配置文件。该文件将包含项目所需的配置。

配置文件指南

了解如何创建定义你应用环境的 squarecloud.app 配置文件。
1

安装 CLI

首先,你的环境中需要已安装 CLI。如果尚未安装,请在终端中运行以下命令:
如果你已经安装,我们建议对其进行更新。为此,请在终端中运行以下命令:
2

进行身份验证

现在,要进行身份验证并使用其他 CLI 命令,你可以在此处点击 “Request API Key” 找到你的授权密钥。获取授权密钥后,运行以下命令:
3

上传你的项目

最后,要使用 CLI 将应用部署到 Square Cloud,你需要运行以下命令:
或者,如果你手动创建了 zip 文件,可以使用:
4

确认你的应用已上线

首次部署通常在一分钟内完成。直接在终端中检查你的应用状态和日志:
如果你部署的是网站或 API,请在浏览器中打开 https://<your-subdomain>.squareweb.app,你应该能看到应用正常响应。如果你部署的是机器人,发送一条命令确认它已上线。
应用无法启动?请参见故障排除指南,了解最常见的原因和解决方法。

测试机器人

部署完成后,在 Square Cloud 控制面板中检查应用日志,确认出现 Bot successfully initialized! 消息,以确认机器人已正确通过身份验证。然后回复机器人发布的其中一条推文,内容为 !ping,并确认它在几分钟内在 X 上回复 Pong! 🤖 X Bot working correctly!

更多资源

要深入了解使用 twitter-api-v2 开发 X 机器人,请查阅 twitter-api-v2 官方库文档。该文档提供了详细的指南、进阶教程以及完整的 API 参考,以最大化你的实现潜力。 另请参阅:

话题标签监控

定时发布

速率限制

X (Twitter) 有严格的速率限制。请实现相应的控制以避免超出这些限制:

错误处理

联系我们

如果你仍然遇到技术问题,我们的专业支持团队可以为你提供帮助。联系我们,我们很乐意协助你解决任何问题 —— 支持质量正是开发者给予 Square Cloud 4.9/5 评分(共 402 条评价)(Google 与 Trustpilot)的重要原因之一。