Exabase Link Preview icon

Exabase Link Preview

Exabase Link Preview 是一款开发者 API,可为任意 URL 获取标题、描述、图片、favicon 等预览元数据,并返回结构化 JSON,便于构建富链接卡片和实时预览。

Exabase Link Preview

概述

Exabase Link Preview 是一款开发者 API,可从 URL 中获取丰富元数据,并以结构化 JSON 的形式返回。它旨在为链接卡片和其他预览展示提供支持,而无需您的应用抓取网页或单独创建资源。

该 API 返回预览通常所需的字段:页面标题、描述、预览图片、favicon、站点名称、规范 URL、语言区域,以及相关图片或图标元数据。产品页将其定位为一个可实时工作的单次 GET 请求,包括对使用 JavaScript 渲染的页面。

功能

结构化预览元数据

返回一个紧凑的 JSON 对象,其中包含渲染富链接卡片所需的字段,包括标题、描述、图片、favicon、站点名称、规范 URL、语言区域和源 URL。

单次 GET 请求工作流

一次请求即可抓取页面并提取 Open Graph 标签及相关元数据,因此应用无需自己解析 HTML。

支持 JavaScript 渲染页面

文档说明该 API 可以实时抓取页面,包括使用 JavaScript 渲染的内容。

丰富的资源详情

在可用时提供图片和 favicon 的详细信息,包括尺寸、MIME 类型和文件大小,这有助于布局和校验。

即时 JSON 响应

返回同步响应,适合在应用中立即渲染链接卡片或预览。

清晰的无预览处理

文档注明当某个 URL 无法获取预览数据时会返回 404,为不受支持的页面提供清晰的失败信号。

使用场景

  • 聊天和消息预览

    当用户在聊天、消息或协作软件中粘贴 URL 时,显示丰富预览。该 API 提供卡片式展示所需的标题、描述、图片和 favicon。

  • CMS 链接卡片

    当编辑在编辑工具或 CMS 工作流中添加链接时,自动生成预览卡片。这可免去手动输入标题和缩略图数据的需要。

  • 书签管理器

    当用户保存 URL 时,用页面元数据填充书签库。返回的标题、描述和图片可用于以可视化方式整理已保存的链接。

  • 发布前链接校验

    在社交排程工具中发布之前,检查 URL 的渲染效果。API 返回的图片尺寸可帮助识别可能不符合预期宽高比的预览。

  • 仅元数据工作流

    当你只需要预览信息而不需要完整页面正文时,将响应用作轻量级元数据来源。产品页会在用户需要完整内容提取时引导他们使用 Exabase Extract。

Pros and Cons

Pros

  • 可从单个 URL 返回渲染链接卡片所需的核心字段。
  • 根据产品页和文档,支持使用 JavaScript 渲染的页面。
  • 不仅包含文本字段,还包含图片和 favicon 元数据。
  • 提供清晰的 API 合约,字段和错误处理均有文档说明。
  • 无需为该 URL 创建单独资源即可使用。

Cons

  • 文档说明某些 URL 没有可用的预览数据,在这种情况下端点会返回 404。
  • 落地页说明超出每月免费额度后会收取名义费用,因此使用并非无限。
  • 该产品专注于链接元数据而非整页提取;网站会引导用户在需要完整内容时使用 Exabase Extract。

FAQ

Link Preview API 会返回什么?

它是一个单次请求 API,接收一个 URL,并返回结构化的链接元数据,例如标题、描述、图片、favicon、站点名称、规范 URL 和语言区域。文档将响应描述为同步返回。

如何对请求进行身份验证?

开发者指南展示了通过在 X-Api-Key 请求头中发送 Exabase API 密钥来使用该 API。通用文档还指出,API 密钥不应暴露在客户端代码中。

端点格式是什么?

文档将该端点描述为 GET /v2/link,并展示了带有 url 查询参数的示例请求。落地页也将其呈现为返回 JSON 的 GET 请求。

Link Preview 是免费使用的吗?

落地页说明该服务每月最多可免费使用 20,000 次链接预览,超出部分按 0.01 credits 收取象征性费用。定价页也表明 Exabase 有免费套餐和付费使用模式,但 Link Preview 页面给出了最明确的使用上限。

它能处理依赖 JavaScript 的页面吗?

是的。落地页说明该 API 会实时抓取并解析页面,包括使用 JavaScript 渲染的页面,文档也说明响应是同步返回的。如果无法获取任何预览数据,则会返回 404。

Quick Facts

类别
开发者工具
产品类型
链接预览 API
端点
GET /v2/link
身份验证
通过 X-Api-Key 使用 API 密钥
免费使用
落地页显示每月 20,000 次链接预览
输出
JSON 预览元数据