API - 概览

API - 文件、字体和货币

下载公开文件和受保护文件,获取字体列表及可用货币。

端点概览

方法端点说明访问权限
GET/public-api/v1/file/public/products/:productId/:size返回公共产品预览。尺寸必须为 small.png、medium.png 或 big.png。公开
GET/public-api/v1/file/protected/:key按存储键返回受保护文件。签名 URL 或 files:read
GET/public-api/v1/fonts返回所有可用字体。公开
GET/public-api/v1/currencies返回所有货币。公开

文件、字体和货币

公共预览文件适合在浏览器中使用。受保护文件需要签名 URL 或具有 files:read 权限的 API 凭据。字体和货币是公共读取端点。

端点访问权限详情
/file/public/products/:productId/small.png公开小型产品预览。
/file/public/products/:productId/medium.png公开中型产品预览。
/file/public/products/:productId/big.png公开大型产品预览。
/file/protected/:key签名 URL 或 files:read受保护的对象存储文件。
/fonts公开字体记录数组。
/currencies公开货币记录数组。

请求示例(fetch)

const publicPreview = await fetch(
  'https://alterproduct.com/public-api/v1/file/public/products/4/medium.png'
);

const protectedFile = await fetch(
  'https://alterproduct.com/public-api/v1/file/protected/user_34/381/design/mockup-large.webp',
  {
    headers: authHeaders
  }
);

const fonts = await fetch('https://alterproduct.com/public-api/v1/fonts').then((res) => res.json());
const currencies = await fetch('https://alterproduct.com/public-api/v1/currencies').then((res) => res.json());

响应示例

[
  {
    "id": 1,
    "family": "Inter",
    "source": "google",
    "category": "sans-serif",
    "variants": ["regular", "600", "700"],
    "subsets": ["latin"],
    "version": "v19",
    "menu": "Inter",
    "files": {
      "regular": "https://..."
    }
  }
]
[
  {
    "id": 1,
    "code": "EUR",
    "name": "Euro",
    "symbol": "€",
    "decimalPlaces": 2
  }
]