Linkly 的链接缩短 API

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

相关： Analytics 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。

如果您提交规则字段，必须使用 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 创建轮转

为了创建轮转，提交一个称为规则的字段作为 JSON 数组，以及上述链接有效负载。您必须使用 application/json 来发送 JSON 数组。

例如：

[
  {"what": "rotator", "url": "https://www.microsoft.com", "percentage": "50"},
  {"what": "rotator", "url": "https://www.apple.com", "percentage": "50"}
]

通过 API 创建地理重定向

为了按国家/地区重定向，提交一个称为规则的字段作为 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 country code**。

通过 API 创建设备重定向

为了按设备重定向，提交一个称为规则的字段作为 JSON 数组，以及上述链接有效负载。

例如：

[
  {"what": "platform", "url": "https://www.google.com", "matches": "windows"},
  {"what": "platform", "url": "https://www.apple.com", "matches": "ios"}
]

其中匹配字段是以下之一：

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

相关

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