REST API

使用与前端组件一致的参数名，通过 HTTP 获取 LinkFox sites 数据。

接口地址

GET https://linkfox.dev/api/rest/sites

Query 参数

名称	必填	说明
`slug`	是	主站点 slug
`group`	否	分组 slug 过滤
`utm-key`	否	追加到输出链接的 query 参数名
`utm-value`	否	追加到输出链接的 query 参数值
`api-key`	否	可选。需要读取自己私有站点网络时再传

也可以通过以下 header 传递 API Key：

x-api-key
Authorization: Bearer your-linkfox-api-key

请求示例

const url = new URL('https://linkfox.dev/api/rest/sites');
url.searchParams.set('slug', 'game-father');
url.searchParams.set('group', 'game');
url.searchParams.set('utm-key', 'ref');
url.searchParams.set('utm-value', 'sidebar');

const response = await fetch(url);

const json = await response.json();
console.log(json.data.sites);

返回结构

{
  "code": 0,
  "message": "ok",
  "data": {
    "site": {
      "id": "site_123",
      "name": "Game Father",
      "slug": "game-father",
      "url": "https://gamefather.dev?ref=sidebar",
      "description": "Main site context"
    },
    "sites": [
      {
        "id": "site_456",
        "name": "Free Image Converter",
        "slug": "free-image-converter",
        "url": "https://img.gamefather.dev?ref=sidebar",
        "description": "Convert images in the browser",
        "faviconUrl": ""
      }
    ]
  }
}

如果不传 API Key，这个接口只会返回公开站点网络。如果传了 API Key，LinkFox 会按该 Key 对应的用户上下文解析请求，也可以返回该用户自己的私有网络数据。

REST API

接口地址

Query 参数

请求示例

返回结构

On this page