快速上手

从零到一条可用的短链接只需两分钟。你需要一个带 links:write 权限的工作区 API 密钥——在控制台的 设置 → API 密钥 中创建（完整值只显示一次）。

下面的代码片段从环境变量读取基础 URL 和密钥，因此同一批命令既能用于生产环境，也能用于本地实例：

export LINKPROFIT_API_BASE="https://api.linkprofit.com/v1"
export LINKPROFIT_API_KEY="lp_live_…your key…"

1. 创建短链接

curl -s -X POST "$LINKPROFIT_API_BASE/links" \
  -H "Authorization: Bearer $LINKPROFIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com/summer-sale", "title": "Summer sale"}'

响应是完整的链接对象：

{
  "data": {
    "id": "lnk_2f8k1mVq3xZcW9yTb4Nda",
    "short_url": "https://go.your-brand.com/x7f2q1z",
    "domain": "go.your-brand.com",
    "slug": "x7f2q1z",
    "url": "https://example.com/summer-sale",
    "title": "Summer sale",
    "has_password": false,
    "public_stats": false,
    "created_at": "2026-08-13T10:00:00.000Z"
  }
}

不传 domain_id 时，短链接会落在你的默认域名上；不传 slug 时会生成一个未被占用的 slug。链接模型的全部选项——定向、A/B 分流、过期时间、密码、UTM、pixel——都可以放进同一个请求，详见参考文档。

2. 列出短链接

curl -s "$LINKPROFIT_API_BASE/links?limit=10" \
  -H "Authorization: Bearer $LINKPROFIT_API_KEY"

列表采用游标分页：顺着 pagination.next_cursor 一直翻，直到它变为 null。

3. 读取汇总数据

curl -s "$LINKPROFIT_API_BASE/analytics/summary" \
  -H "Authorization: Bearer $LINKPROFIT_API_KEY"

需要 analytics:read 权限。不传日期时返回最近 30 天的数据。

同样的操作：JavaScript

const base = process.env.LINKPROFIT_API_BASE;
const key = process.env.LINKPROFIT_API_KEY;

const response = await fetch(`${base}/links`, {
  method: "POST",
  headers: {
    Authorization: `Bearer ${key}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ url: "https://example.com/summer-sale" }),
});

if (!response.ok) {
  const { error } = await response.json();
  throw new Error(`${error.code}: ${error.message}`);
}

const { data } = await response.json();
console.log(data.short_url);

同样的操作：Python

import os
import requests

base = os.environ["LINKPROFIT_API_BASE"]
key = os.environ["LINKPROFIT_API_KEY"]

response = requests.post(
    f"{base}/links",
    headers={"Authorization": f"Bearer {key}"},
    json={"url": "https://example.com/summer-sale"},
    timeout=10,
)
response.raise_for_status()
print(response.json()["data"]["short_url"])

可安全重试的创建

在任何写操作上都可以带上 Idempotency-Key 请求头。用同一个幂等键重复发送请求，返回的是已保存的响应，而不会再创建一条短链接——网络超时后可以放心重试：

curl -s -X POST "$LINKPROFIT_API_BASE/links" \
  -H "Authorization: Bearer $LINKPROFIT_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: order-42-launch" \
  -d '{"url": "https://example.com/launch"}'

幂等键会保存 24 小时；同一个幂等键搭配不同的请求体会返回 409 conflict。