LogoMkSaaS文档

定时任务

了解如何在 MkSaaS 中设置和使用定时任务

MkSaaS 支持集成 Cron Jobs,这是一个免费且开源的定时任务调度器,用于定时执行任务,例如发放积分给用户。

如果您的网站满足以下条件之一,那么您需要设置定时任务来发放积分给用户。

  • 您的网站有免费计划,并且免费用户每个月都可以领取积分。
  • 您的网站有终身制计划,并且终身制用户每个月都可以领取积分。
  • 您的网站有按年订阅计划,并且订阅用户每个月都可以领取积分。

积分

了解更多关于积分的信息

设置

  1. Cron Job 创建一个新账户。
  2. 进入 Cron Job Dashboard > Cronjobs,点击 CREATE CRONJOB
  3. Cron Job Common 部分设置 TitleURL,并将 Execution schedule 设置为每天 00:00 执行。

URL 的格式为 https://{your-domain}/api/distribute-credits

Create Cron Job

  1. Cron Job Advance 部分设置 UsernamePassword,并将 Timeout 设置为 30 秒。

用户名和密码是定时任务访问网站后端 API 的基本认证凭证,请务必妥善保管。

Cron Job Advance

  1. 创建定时任务后,将 UsernamePassword 设置到 .env 文件中。
.env
CRON_JOBS_USERNAME=your_username
CRON_JOBS_PASSWORD=your_password

如果您正在设置环境,现在可以回到环境配置文档并继续。本文档的其余部分可以稍后阅读。

环境配置

设置环境变量


定时任务系统结构

route.ts
  • src/app/api/distribute-credits/route.ts: 定时任务 API 路由,用于发放积分给用户。

使用方法

目前只有一个定时任务,作用是发放积分给用户。它应该每天执行一次,所以您在创建定时任务时需要设置正确的 Execution schedule,确保每天执行一次。

当定时任务被触发时,它将向网站的 /api/distribute-credits 路由发送请求,并使用 UsernamePassword 作为基本认证凭证,发放积分给用户。

您可以点击定时任务页面中的 TEST RUN 按钮来测试定时任务,并查看 Response 标签下的响应是否正常。您还可以查看定时任务的执行历史。

Test Cron Job


参考资料

后续操作

启用定时任务后,您还可以探索以下相关集成: