Linkly的链接缩短API

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

相关： 分析API | Webhooks

开始之前

Linkly在界面中为您生成API请求，供您复制并粘贴到应用程序中。

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

节省时间，让我们做繁重的工作：

1. 1
   请参阅下面的链接创建API请求。
2. 2
   完整复制请求。您可以验证它们对您有效。
3. 3
   询问ChatGPT或等效工具，将这些请求改编为应用程序源代码。无需花费时间进行复杂的集成。我们的API完全可机器消费。

---

OpenAPI 3.0规范

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

Linkly的API使用OpenAPI标准文档记录，超出了下面提供的内容。相同的端点也可作为一键式Postman集合使用。

查看OpenAPI规范

在Postman中运行

授权

您将需要：

• 您的API密钥
• 工作区ID

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

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

创建或更新链接

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

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

请求体中包含以下字段。

编码类型为x-www-form-urlencoded或application/json。

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

我们建议您使用JSON与Open API规范。

使用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,
    "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字段，以及更改。

通过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"}
]

国家代码是**ISO 3166 alpha-2国家代码。**

通过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

然后，对于单个链接情况使用与上面相同的schema，但将链接请求包装在一个数组中，形式为：

[{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个链接。

相关

• 分析API - 导出点击数据和流量报告
• Webhooks - 实时点击通知
• Zapier集成 - 无代码集成