# Unlockfy

> Monetize links with an unlock gate. Visitors complete short ad steps, then get a destination URL and/or unlock text. Creators earn a share of ad revenue.

Base URL: https://unlockfy.cc
Human docs: https://unlockfy.cc/en/docs
AI prompt page: https://unlockfy.cc/en/docs/ai/prompt

## Auth

- Dashboard cookie `unlockfy_session` — browser / settings
- API key `uf_…` — secret; Links API via `Authorization: Bearer uf_…` or `X-Api-Key`
- User ID — public; Full Script embed only. Never treat as a secret.

Creators do not need Adsterra API keys. Ads are platform-side on Unlockfy.

## Link sources

| source | Created by | Expiration |
|---|---|---|
| `dashboard` | Dashboard UI | Optional temporary |
| `api` | Links API (`uf_…`) | Never expires |
| `script` | Full Script | Never expires |

Dashboard tabs: My links · API links · Expired (reactivate; purged after 14 days).

## Full Script

```html
<script src="https://unlockfy.cc/api/script/YOUR_USER_ID.js" async></script>
```

Redirect helper: `GET /api/script/redirect?uid=USER_ID&url=ENCODED_URL` → `/u/{slug}` (`source: script`, no expiry).

## Links API

- `GET /api/links` — includes `source`, `expiresAt`
- `POST /api/links` — need `destinationUrl` and/or `contentText`
- `PATCH /api/links/{id}`
- `DELETE /api/links/{id}`
- `POST /api/links/bulk-delete`

Unlock URL shape: `https://unlockfy.cc/u/{slug}`

Expiration (`expiresIn` / `expiresUnit` / `expiresAt`) applies only to dashboard/session creates. With an API key, links never expire.

## Unlock gate

Public visitor flow at `/{locale}/u/{slug}`. Server-enforced steps; destination revealed only after unlock. Platform serves Adsterra (banner/native + social bar/popunder). Expired dashboard links → `410 expired`.

## Payouts

**Dashboard only.** Not part of the public API. Request PayPal / LTC / BTC from the Unlockfy Dashboard UI. API keys cannot request payouts (`403 dashboard_only`).

## Optional machine prompt

Full copy-paste context for Claude / Cursor / other AIs:
https://unlockfy.cc/en/docs/ai/prompt