API 快速上手

五步，从零到一条可用的短链接。所有示例都可以直接用 curl 运行，除了凭据之外不需要任何其他东西。

1. 选择凭据

你需要下面两者之一：

凭据	何时使用
`NUXT_SITE_TOKEN`	你拥有该实例。需要完全访问权限，包括实例配置。
API 密钥（`ink_…`）	你在接入某个工具。权限限定为该密钥对应的角色。

后续示例统一使用你要用的令牌：

export INKPAGE_TOKEN="ink_your_api_key_here"

2. 确认连通性

curl https://your-domain/api/verify \
  -H "Authorization: Bearer $INKPAGE_TOKEN"

成功响应会给出凭据类型、身份以及它携带的权限：

json

{
  "name": "Inkpage Links",
  "url": "https://inkpage.link",
  "authMethod": "api-key",
  "userID": "apikey:3f2a...",
  "userEmail": "apikey:n8n@your-domain",
  "accessEnabled": false,
  "role": "power-user",
  "permissions": ["links:read", "links:write"]
}

authMethod 的取值为 site-token、api-key、session、access-user 或 access-service。

返回 401 表示令牌缺失、格式错误、已过期或已撤销。返回 403 表示凭据有效，但缺少该路由所需的权限。

3. 创建短链接

curl -X POST https://your-domain/api/link/create \
  -H "Authorization: Bearer $INKPAGE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "url": "https://example.com/somewhere", "slug": "first-link" }'

该路由返回 201，包含已保存的链接与解析后的短地址：

json

{
  "link": { "slug": "first-link", "url": "https://example.com/somewhere", "createdAt": 1798761600 },
  "shortLink": "https://your-domain/first-link"
}

短链接现在是 https://your-domain/first-link。

存储必须就绪

如果收到 423（「存储未就绪」），请在浏览器里打开一次 Dashboard → Links。应用会在首次访问时初始化存储。见存储初始化。

4. 读回链接

curl "https://your-domain/api/link/query?slug=first-link" \
  -H "Authorization: Bearer $INKPAGE_TOKEN"

响应包含链接的完整配置，可以据此确认每个字段 —— 密码、过期时间、标签、按国家分流、预览信息。

5. 列表与分页

curl "https://your-domain/api/link/list?limit=20" \
  -H "Authorization: Bearer $INKPAGE_TOKEN"

把返回的 cursor 作为参数传入即可取下一页，list_complete 为 true 时结束。游标是不透明字符串，不要自行构造。

下一步

REST API — 全部端点、错误码与可直接复制的示例。
交互式参考 — 由你的实例生成。
集成 — 面向 AI 客户端的 MCP 服务。
子域名 — 用自定义域名对外提供链接。

API 快速上手 ​

1. 选择凭据 ​

2. 确认连通性 ​

3. 创建短链接 ​

4. 读回链接 ​

5. 列表与分页 ​

下一步 ​