> For the complete documentation index, see [llms.txt](https://docs.luasec.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.luasec.org/licensing/ad-rewards.md).
# Ad rewards
Let users **earn a temporary key** by passing through ad links. They complete a few checkpoints, and on the last one Luasec mints a temporary key and drops them on a page to copy it.
## How it works
1. A user opens your getkey page: `https://luasec.org/getkey/`.
2. They pass ***n***** checkpoints:** each one wraps a callback in an adlink provider.
3. On the **final** checkpoint, the server verifies the provider's anti bypass proof, mints a key valid for `rewardHours`, and shows it.
## Providers
| Provider | Notes |
| --------------- | --------------------------------------------------------------------------------- |
| **Linkvertise** | Needs your Linkvertise account id (and an API token for antibypass verification). |
| **Lootlabs** | Mints a content locker link via the Lootlabs API and needs your API key. |
| **Work.ink** | Needs your Work.ink API key. |
You can chain multiple providers across checkpoints.
## Setting it up
On your project's **ad-reward** settings:
* **Enable** the gateway.
* **Checkpoints:** how many steps (1–10).
* **Providers:** which provider(s) to use across the steps.
* **Reward hours:** how long the minted key lasts.
* **Provider credentials:** your account id / API keys for the providers you use.
* **Work.ink link:** Work.ink has no API for creating links, so create one in your Work.ink dashboard and paste it here. Without it the gateway can't build a link, however valid your API key is. (LootLabs works the same way if you'd rather use your own loot-link than the auto-created one.)
## Notes
* Adreward keys are ordinary keys with an expiry. They're HWID locked and bannable like any other.
* The HWID lock is applied the first time the key runs, not when it's handed out. The get-key page runs in a browser and can't see a device HWID, so there's nothing meaningful to lock to until the script actually starts.
* Keep `rewardHours` modest because users can re-run the flow to renew.
* **House ads:** the get-key page can carry platform ads, with the number of slots set by the hub owner's plan: Free 4, Pro 2, Max 1. A lapsed plan counts as Free from the moment it lapses. For AdSense set `GETKEY_ADSENSE_CLIENT` and `GETKEY_ADSENSE_UNITS` on the API; for any other network set `GETKEY_AD_TAG` to its tag. With none set, no ads are shown.
* **Ad blockers:** `GETKEY_ADBLOCK_MODE` on the API - `off` (default), `warn` (say the page won't earn but let them through) or `block` (hold the run until it's off). Detection combines a bait element and a network probe, so it catches both cosmetic filtering and DNS-level blocking. It is inference rather than fact, so `block` will occasionally turn away someone with a privacy browser or a filtered network.
* **Bot protection:** set `TURNSTILE_SITE_KEY` and `TURNSTILE_SECRET_KEY` on the API (both from the Cloudflare Turnstile dashboard, with your get-key hostname added to the widget's allowed domains) and visitors must clear a challenge before a run can start. This is platform-wide rather than per hub. With no secret set, no challenge is shown.
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://docs.luasec.org/licensing/ad-rewards.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
