Linkly的链接缩短API构建器
Linkly的链接缩短API根据表单的内容自动构建API请求。 您可以将此处提供的文本粘贴到任何LLM中,以自动为您的应用程序生成代码。
Linkly的API使用OpenAPI标准进行文档化,超出了下面提供的内容。相同的端点也可作为一键式Postman集合使用。
授权
您需要:
- 您的API密钥
- 工作区ID
您可以从Linkly内部获得这些详细信息。
- 1登录到Linkly。
- 2单击设置。
- 3单击API密钥。
创建或更新链接
要创建链接,您只需向以下地址发送POST请求:
https://app.linklyhq.com/api/v1/link
在请求体中包含以下字段。
编码类型为x-www-form-urlencoded或application/json。
如果您提交Rules字段,必须使用application/json。
我们建议您使用带有Open API规范的JSON。
| 标签 | 密钥 | 类型 | 说明 |
|---|---|---|---|
| 账户API密钥 | api_key | 字符串 | 必需 |
| 工作区ID | workspace_id | 整数 | 必需 |
| 链接ID | id | 整数 | 更新现有链接时必需 |
| 目标地址 | url | 字符串 | 必需 |
| 昵称 | name | 字符串 | |
| 注释 | note | 字符串 | |
| 元数据 | metadata | 对象 | 您自己的键值数据,例如来自您系统的ID。请参阅元数据 |
| 重新定位标签(head区域) | head_tags | 字符串 | 用于重新定位像素 |
| 重新定位标签(body区域) | body_tags | 字符串 | 用于重新定位像素 |
| 转发参数 | forward_params | 布尔值 | |
| 隐藏引荐来源 | hide_referrer | 布尔值 | 发送referrer-policy: no-referrer,使目标地址看不到引荐来源头中的Linkly |
| 隐藏链接 | cloaking | 布尔值 | 在框架后面隐藏目标URL |
| 阻止机器人 | block_bots | 布尔值 | 阻止已知的机器人/爬虫 |
| 跳过社交爬虫跟踪 | skip_social_crawler_tracking | 布尔值 | 当block_bots打开时,仍让社交爬虫通过,使OG预览可以工作 |
| 公共分析 | public_analytics | 布尔值 | 为此链接启用公共/abc123.stats页面 |
| 密码 | password | 字符串 | 访问者必须在重定向前输入此密码 |
| 发布状态 | enabled | 布尔值 | |
| UTM来源 | utm_source | 字符串 | 用于UTM跟踪 |
| UTM介质 | utm_medium | 字符串 | 用于UTM跟踪 |
| UTM活动 | utm_campaign | 字符串 | 用于UTM跟踪 |
| UTM术语 | utm_term | 字符串 | 用于UTM跟踪 |
| UTM内容 | utm_content | 字符串 | 用于UTM跟踪 |
| 自定义域 | domain | 字符串 | 如果提供了slug,则为必需。请参阅自定义域 |
| 自定义域后缀 | slug | 字符串 | 如果提供了domain且slug为null,将自动生成 |
| Open Graph标题 | og_title | 字符串 | 用于社交媒体预览 |
| Open Graph描述 | og_description | 字符串 | 用于社交媒体预览 |
| Open Graph图像URL | og_image | 字符串 | 用于社交媒体预览 |
| Meta像素ID | fb_pixel_id | 字符串 | 用于Meta像素 |
| TikTok像素ID | tiktok_pixel_id | 字符串 | |
| Google Analytics 4 ID | ga4_tag_id | 字符串 | |
| Google Tag Manager容器 | gtm_id | 字符串 | |
| 链接化单词 | linkify_words | 字符串 | 在登陆页面上应自动缩短的换行符分隔的短语 |
| 替换 | replacements | 字符串 | 应用于目标页面的文本替换规则 |
| 过期日期时间 | expiry_datetime | ISO8601日期时间字符串 | 用于过期链接 |
| 过期目标 | expiry_destination | 字符串(URL) | 用于过期链接。必须以http开头。 |
| 过期点击数 | expiry_clicks | 整数 | 在此次点击后使链接过期 |
| Webhooks | webhooks | 字符串数组 | 每个链接的webhook URL。请参阅webhooks。 |
| 通知用户ID | notify_user_ids | 整数数组 | 工作区用户ID,在每次点击时通知 |
| 二维码样式 | qr_styles | JSON对象 | 用于二维码样式。键:fgColor、bgColor、qrStyle、eyeStyle、eyeColorInner、eyeColorOuter、logoImage、logoWidth、logoHeight、logoPadding、logoStyle、quietZone |
| 规则 | rules | JSON数组 | 用于轮转器、地理重定向和设备重定向 |
使用curl的示例请求
下面的代码说明了如何发送API请求来创建链接。
curl -X POST https://app.linklyhq.com/api/v1/link
-H 'cache-control: no-cache'
-d 'api_key=your_secret_key&workspace_id=1&url=http%3A%2F%2Fwww.wikijob.co.uk&name=Test%20Link'
成功的响应将返回一个代表该链接的JSON对象,以及一个链接ID。
{
"id": 9512,
"url": "https://www.wikijob.co.uk",
"name": "Test Link",
"note": null,
"metadata": {},
"head_tags": null,
"body_tags": null,
"linkify_words": null,
"replacements": null,
"enabled": true,
"cloaking": false,
"forward_params": false,
"hide_referrer": false,
"block_bots": false,
"skip_social_crawler_tracking": false,
"public_analytics": false,
"password": null,
"domain": null,
"slug": null,
"utm_source": null,
"utm_medium": null,
"utm_campaign": null,
"utm_term": null,
"utm_content": null,
"og_title": null,
"og_description": null,
"og_image": null,
"fb_pixel_id": null,
"tiktok_pixel_id": null,
"ga4_tag_id": null,
"gtm_id": null,
"full_url": "https://l.linklyhq.com/l/2TQ",
"rules": [],
"expiry_datetime": null,
"expiry_destination": null,
"expiry_clicks": null,
"qr_styles": null,
"webhooks": [],
"notify_user_ids": [],
"workspace_id": 1448,
"deleted": false
}
更新链接
为了更新链接,发送与创建链接相同的请求,但包括要更新的链接的id字段,以及更改内容。
将您自己的数据附加到链接(元数据)
使用元数据将您自己的标识符存储在链接中,例如订单ID、CRM联系ID或来自您自己系统的活动参考。它是一组键值对,每当您获取链接时和每个webhook有效负载(点击和链接事件)中都会返回它,因此您可以将点击匹配到其所属的记录。
在JSON请求体中以对象形式发送它:
curl -X POST https://app.linklyhq.com/api/v1/link
-H 'Content-Type: application/json'
-d '{"api_key": "your_secret_key", "workspace_id": 1, "url": "https://example.com", "metadata": {"order_id": "A-10293", "crm_contact_id": "3f2b8c1e-9a47-4d0e-b6a5-1c2d3e4f5a6b"}}'
响应中的链接包括"metadata": {"order_id": "A-10293", "crm_contact_id": "3f2b8c1e-9a47-4d0e-b6a5-1c2d3e4f5a6b"}。
工作原理:
- 更新已合并。 更新链接时,您发送的键被添加到链接的现有元数据中,您未提及的键保持不变。要删除一个键,请将其设置为
null(例如{"metadata": {"order_id": null}})。 - 值是字符串。 数字和布尔值存储为文本,所以
42作为"42"返回。不允许嵌套对象和数组。 - 限制。 每个链接最多20个键,键最多40个字符,值最多500个字符,足以满足UUID。
- 对您来说是私密的。 元数据永远不会显示给点击链接的人,不用于构建重定向,也不会添加到目标URL中。
- 在应用程序中。 您也可以在链接的自动化设置中的元数据下查看和编辑元数据。
元数据、注释和UTM参数
元数据、注释字段和UTM参数都描述链接,但它们执行不同的任务:
- 元数据是您自己系统的结构化键值数据。它由API返回并在webhooks中发送,因此软件可以读取它。
- 注释是一个供人员在应用程序中阅读的单一自由文本字段。
- UTM参数被添加到目标URL,因此您发送访问者的页面及其分析可以看到它们。元数据永远不会。要将值传递到目标页面,请使用UTM参数,或打开转发参数,以便短链接上的查询参数被传递。
元数据和分析
元数据不包括在点击分析或点击导出中,您无法按元数据分组、过滤点击或搜索链接。要将点击与您自己的记录绑定,请使用链接的id。它出现在webhook有效负载中、按链接分解的分析中和链接响应中。要么从您的链接id查找您的记录,要么获取链接以读取其元数据。
通过API创建轮转器
为了创建轮转器,提交一个名为rules的字段作为JSON数组,以及上面的链接有效负载。您必须使用application/json来发送JSON数组。
例如:
[
{"what": "rotator", "url": "https://www.microsoft.com", "percentage": "50"},
{"what": "rotator", "url": "https://www.apple.com", "percentage": "50"}
]
通过API创建地理重定向
为了按国家重定向,提交一个名为rules的字段作为JSON数组,以及上面的链接有效负载。您必须使用application/json编码来发送JSON数组。
例如:
[
{"what": "country", "url": "https://www.microsoft.com", "matches": "UK"},
{"what": "country", "url": "https://www.apple.com", "matches": "US"}
]
国家代码是**alpha-2 ISO 3166国家代码**。
通过API创建设备重定向
为了按设备重定向,提交一个名为rules的字段作为JSON数组,以及上面的链接有效负载。
例如:
[
{"what": "platform", "url": "https://www.google.com", "matches": "windows"},
{"what": "platform", "url": "https://www.apple.com", "matches": "ios"}
]
其中字段matches是以下之一:
- ios
- android
- windows
- linux
- mac
在一个请求中创建或更新多个链接
Linkly支持在一个请求中创建/修改最多1000个链接。
要这样做,请按如下方式提交您的API密钥作为请求的一部分:
https://app.linklyhq.com/api/v1/links?api_key=XXXXXXXXXXX
然后,对个别链接情况使用与上面相同的架构,但将链接请求包装在数组中,形式为:
[{link}, {link}]
以下是完整的请求,将更新两个链接:
wget --no-check-certificate \
--method POST \
--timeout=0 \
--header 'Content-Type: application/json' \
--body-data '[
{
"workspace_id": "WORKSPACE_ID",
"url": "https://nature.com",
"name": "Test",
"id": LINK_ID
},
{
"workspace_id": "WORKSPACE_ID",
"url": "https://science.com",
"id": LINK_ID
}
]' \
'https://app.linklyhq.com/api/v1/links?api_key=API_KEY'
这适用于创建和更新操作。
请注意,大型请求最多可能需要60秒。如果请求耗时超过此时间,它们将失败,您应该考虑将工作负载分解为更小的块。
速率限制
链接缩短API的限制是每秒20个请求。根据要求,可提供高达200个/每秒的请求。您可以在单个请求中上传最多1000个链接。
相关
每月追踪500次点击,包含所有功能。