Linkly 的链接缩短 API

使用 Linkly 的链接缩短 API 以编程方式创建、更新和管理链接。

相关:分析 API | Webhooks

开始之前

Linkly 在界面中为您生成 API 请求,您可以直接复制并粘贴到您的应用程序中。

这适用于链接创建和链接更新。

节省时间,让我们来完成繁重的工作:

  1. 1请参阅下面的链接创建 API 请求。
  2. 2完整复制请求。您可以验证它们是否适用于您。
  3. 3请求 ChatGPT 或类似工具将这些请求改编为您应用程序的源代码。无需花时间进行复杂的集成。我们的 API 完全可供机器使用。

OpenAPI 3.0 规范

您可以直接从 Linkly 用户界面生成 API 请求。

Linkly 的链接缩短 API 构建器

Linkly 的链接缩短 API 会根据表单内容自动构建 API 请求。 您可以将此处提供的文本粘贴到任何 LLM 中,以自动为您的应用程序生成代码。

Linkly 的 API 使用 OpenAPI 标准进行文档化,其内容超出以下提供的范围。

授权

您将需要:

  • 您的 API 密钥
  • 工作区 ID

您可以从 Linkly 内部获取这些详细信息。

  1. 1登录到 Linkly。
  2. 2点击设置
  3. 3点击 API 密钥

创建或更新链接

要创建链接,您只需向以下地址发送 POST 请求:

https://app.linklyhq.com/api/v1/link

并在请求正文中包含以下字段。

编码类型为 x-www-form-urlencodedapplication/json

如果您要提交 Rules 字段,则必须使用 application/json

我们建议您使用 JSON 配合 Open API 规范

标签类型说明
账户 API 密钥api_keyString必需
工作区 IDworkspace_idInteger必需
链接 IDidInteger更新现有链接时必需
目标地址urlString必需
昵称nameString
备注noteString
重定向标签(头部区域)head_tagsString用于重定向像素
重定向标签(主体区域)body_tagsString用于重定向像素
转发参数forward_paramsBoolean
发布状态enabledBoolean
UTM Sourceutm_sourceString用于 UTM 跟踪
UTM Mediumutm_mediumString用于 UTM 跟踪
UTM Campaignutm_campaignString用于 UTM 跟踪
UTM Termutm_termString用于 UTM 跟踪
UTM Contentutm_contentString用于 UTM 跟踪
自定义域domainString如果提供了 slug 则必需。请参阅自定义域
自定义域后缀slugString如果提供了 domain 但 slug 为空,将自动生成
Open Graph 标题og_titleString用于社交媒体预览
Open Graph 描述og_descriptionString用于社交媒体预览
Open Graph 图片 URLog_imageString用于社交媒体预览
Meta Pixel IDfb_pixel_idString用于 Meta Pixel
Google Analytics 4 IDga4_tag_idString
Google Tag Manager 容器gtm_idString
过期日期时间expiry_datetimeISO8601 DateTime String用于过期链接
过期目标expiry_destinationString用于过期链接
规则rulesJSON array用于轮换器地理重定向设备重定向

使用 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,
    "alias": null,
    "url": "https://www.wikijob.co.uk",
    "name": "Test Link",
    "note": null,
    "head_tags": null,
    "body_tags": null,
    "linkify_words": null,
    "enabled": true,
    "cloaking": false,
    "replacements": 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,
    "full_url": "https://l.linklyhq.com/l/2TQ",
    "block_bots": false,
    "rules": [],
    "workspace_id": 1448,
    "referer_mode": null,
    "custom_referer": null,
    "click_fraud_mode": null,
    "deleted": false
}

更新链接

为了更新链接,发送与创建链接相同的请求,但包含要更新的链接的 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/link?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/workspace/WORKSPACE_ID/links?api_key=API_KEY'

这适用于创建和更新操作。

请注意,大型请求可能需要最多 60 秒。如果请求时间超过此时间,它们将失败,您应该考虑将工作负载分解为更小的块。

速率限制

链接缩短 API 限制为每秒 20 个请求。应要求可提供每秒最多 200 个请求。您可以在单个请求中上传最多 1000 个链接。

相关

Track 1000 monthly clicks with all features included.

No credit card required