Cron Jobs

MkSaaS supports integrating Cron Jobs, which is a free and open-source cron job scheduler, for scheduled tasks, allowing you to automate your website's tasks, like distributing credits to users.

If you enable credits system, you must setup cron jobs to distribute credits to users and handle credit expiration.

Setup

Create a new account in Cron Job.
Go to Cron Job Dashboard > Cronjobs, click CREATE CRONJOB.
Set Title and URL in Cron Job Common section, and set Execution schedule to run every day, the time is arbitrary, for example, 00:00. The URL is in the format of https://{your-domain}/api/distribute-credits.

Create Cron Job

Set Username and Password in Cron Job Advance section, and set Timeout to 30 seconds.

The username and password are not the account password of CronJob website, but the basic authentication credentials for the cron job to access the API of the website, please keep them secret.

Cron Job Advance

After creating the cron job, set the Username and Password in the .env file.

.env

CRON_JOBS_USERNAME=your_username
CRON_JOBS_PASSWORD=your_password

If you are setting up the environment, now you can go back to the Environment Setup guide and continue. The rest of this guide can be read later.

Cron Job System Structure

route.ts

The file src/app/api/distribute-credits/route.ts is the cron job API route for distributing credits to users.

There is only one cron job for now, for distributing credits to users, and handling credit expiration. It should be run every day, so you should set the right Execution schedule when creating the cron job.

When the cron job is triggered, it will make a request to the /api/distribute-credits route, with the Username and Password as basic authentication credentials, and distribute credits to users, and handle credit expiration.

You can test the cron job by clicking the TEST RUN button in the cron job page, and check the response in the Response tab in the image below. You can also view the execution history of the cron job.

Test Cron Job

Reference

Cron Job Official Website

Credits

Setup

Environment Setup

Cron Job System Structure

Usage

Reference

Next Steps

Payment

Authentication

Analytics

Storage

Table of Contents