{
"description": null,
"favicon": "https://zylalabs.com/favicon.ico",
"image": null,
"siteName": "zylalabs.com",
"title": "Just a moment...",
"url": "https://zylalabs.com/"
}
curl --location --request GET 'https://zylalabs.com/api/13352/link+preview+-+url+unfurl+api/28457/preview?url=https://zylalabs.com' --header 'Authorization: Bearer YOUR_API_KEY'
{
"results": [
{
"description": "Stripe is a financial services platform that helps all types of businesses accept payments, build flexible billing models, and manage money movement.",
"favicon": "https://images.stripeassets.com/fzn2n1nzq965/1hgcBNd12BfT9VLgbId7By/01d91920114b124fb4cf6d448f9f06eb/favicon.svg",
"image": "https://images.stripeassets.com/fzn2n1nzq965/XtX984S1GJVsVOXFC7kMu/01988281e867728dfb09aa7793a6e3b9/Stripe.jpg?q=80",
"siteName": "stripe.com",
"title": "Stripe | Financial Infrastructure to Grow Your Revenue",
"url": "https://stripe.com/"
},
{
"description": "Join the world's most widely adopted, AI-powered developer platform where millions of developers, businesses, and the largest open source community build software that advances humanity.",
"favicon": "https://github.com/fluidicon.png",
"image": "https://images.ctfassets.net/8aevphvgewt8/4pe4eOtUJ0ARpZRE4fNekf/f52b1f9c52f059a33170229883731ed0/GH-Homepage-Universe-img.png",
"siteName": "GitHub",
"title": "GitHub · Change is constant. GitHub keeps you ahead.",
"url": "https://github.com/"
}
]
}
curl --location --request POST 'https://zylalabs.com/api/13352/link+preview+-+url+unfurl+api/28458/preview+batch' --header 'Authorization: Bearer YOUR_API_KEY'
--data-raw '{
"urls": [
"https://stripe.com",
"https://github.com"
]
}'
注册后,每个开发者都会被分配一个个人 API 访问密钥,这是一个唯一的字母和数字组合,用于访问我们的 API 端点。要使用 链接预览 - URL 展开 API 进行身份验证,只需在 Authorization 标头中包含您的 bearer token。
| 标头 | 描述 |
|---|---|
授权
|
必需
应为 Bearer access_key. 订阅后,请查看上方的"您的 API 访问密钥"。
|
无长期承诺。随时升级、降级或取消。 免费试用包括最多 50 个请求。
(年度计费可节省 2 个月 🎉)
领先企业的信赖之选
为您的应用程序提供用户期望的丰富链接预览 — 当您粘贴 URL 时,Slack、iMessage 和 Twitter 显示的卡片。发送任何 URL,获取包含页面标题、描述、预览图像、网站名称和网站图标的干净 JSON。
工作原理: API 在服务器端获取页面,并首先读取 OpenGraph 标签,然后是 Twitter Card 标签,最后回退到纯 HTML (,meta 描述),因此即使来自没有社交标签的页面也能获得有用的结果。获取是 SSRF 安全的(阻止私有/内部地址),大小和时间有限制,结果可以缓存一个小时。
端点: GET /preview?url=... 用于一个 URL;POST /preview/batch 用于在一次调用中最多处理 10 个 URL。错误使用标准问题详细信息 JSON,并带有清晰的机器可读代码。
为以下应用构建: 聊天和消息应用程序、内容管理系统、社交调度工具、稍后阅读工具、论坛 — 在任何粘贴链接应变为卡片的地方。
GET /preview 端点返回一个丰富的预览卡片,包含提供链接的标题、描述、图片、网站名称、favicon 和 URL POST /preview/batch 端点以结构化格式返回多达 10 个 URL 的类似数据,允许批量处理链接预览
响应数据中的关键字段包括“标题”、“描述”、“图像”、“站点名称”、“网站图标”和“网址”。这些字段提供了有关链接页面的基本信息,使用户能够创建丰富的预览
响应数据以JSON格式组织 对于GET端点,它返回一个包含链接预览的单一对象 POST端点返回一个包含“results”数组的对象,其中每个条目对应一个URL并包括其各自的预览数据
每个端点提供信息,例如页面标题、描述、预览图像、网站名称、网站图标和原始 URL。这些数据帮助用户为各种应用程序生成视觉吸引人的链接预览
用户可以通过在GET请求中指定URL参数或在POST请求中提供URL数组来自定义他们的请求。这种灵活性允许用户在一次调用中检索特定链接或多个链接的预览
该API通过读取OpenGraph标签、Twitter Card标签和HTML元描述从目标网页获取数据。这种多源方法确保用户即使在某些标签缺失的情况下也能获得相关信息
典型的用例包括为聊天和消息应用程序、内容管理系统、社交媒体调度器和论坛生成链接预览。此功能通过为共享链接提供丰富的视觉上下文来增强用户体验
如果一个 URL 返回部分或空结果,API 仍会提供可用字段,例如网站名称和图标。用户可以在他们的应用程序中实现回退逻辑,以优雅地处理这些情况,确保用户体验的一致性