API Rút gọn Liên kết của Linkly

Tạo, cập nhật và quản lý các liên kết theo chương trình bằng API Rút gọn Liên kết của Linkly.

Liên quan: API Phân tích | Webhooks

Trước khi bạn bắt đầu

Linkly tạo các yêu cầu API trong giao diện để bạn sao chép và dán vào các ứng dụng của mình.

Điều này hoạt động cho cả việc tạo liên kết và cập nhật liên kết.

Tiết kiệm thời gian và để chúng tôi làm công việc nặng:

  1. 1
    Xem bên dưới để biết các yêu cầu API tạo liên kết.
  2. 2
    Sao chép các yêu cầu toàn bộ. Bạn có thể xác minh chúng hoạt động cho bạn.
  3. 3
    Hỏi ChatGPT hoặc tương đương để điều chỉnh các yêu cầu này thành mã nguồn cho ứng dụng của bạn. Không cần phải dành thời gian thực hiện tích hợp phức tạp. API của chúng tôi hoàn toàn có thể xử lý bằng máy.

Thông số kỹ thuật OpenAPI 3.0

Bạn có thể tạo các yêu cầu API trực tiếp từ giao diện người dùng Linkly.

Trình tạo API Rút gọn Liên kết của Linkly

API rút gọn liên kết của Linkly tự động xây dựng các yêu cầu API dựa trên nội dung của biểu mẫu. Bạn có thể dán văn bản được cung cấp ở đây vào bất kỳ LLM nào để tự động tạo mã cho ứng dụng của bạn.

API của Linkly được ghi chép bằng tiêu chuẩn OpenAPI, vượt quá những gì được cung cấp dưới đây. Các điểm cuối tương tự cũng có sẵn dưới dạng bộ sưu tập Postman chỉ cần một cú nhấp chuột.

Xem Thông số kỹ thuật OpenAPI

Chạy trong Postman

Xác thực

Bạn sẽ cần:

  • Khóa API của bạn
  • ID Không gian làm việc

Bạn có thể lấy các chi tiết này từ bên trong Linkly.

  1. 1
    Đăng nhập vào Linkly.
  2. 2
    Nhấp vào Cài đặt.
  3. 3
    Nhấp vào Khóa API.

Tạo hoặc cập nhật một liên kết

Để tạo một liên kết, tất cả những gì bạn cần làm là gửi yêu cầu POST đến:

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

với các trường sau trong nội dung.

Loại mã hóa là x-www-form-urlencoded hoặc application/json.

Nếu bạn đang gửi trường Quy tắc, bạn phải sử dụng application/json.

Chúng tôi khuyên bạn nên sử dụng JSON với thông số kỹ thuật API Mở.

NhãnKhóaLoạiGhi chú
Khóa API Tài khoảnapi_keyChuỗiBắt buộc
ID Không gian làm việcworkspace_idSố nguyênBắt buộc
ID Liên kếtidSố nguyênBắt buộc nếu cập nhật liên kết hiện có
Đích đếnurlChuỗiBắt buộc
Biệt danhnameChuỗi
Ghi chúnoteChuỗi
Siêu dữ liệumetadataĐối tượngDữ liệu cặp khóa-giá trị của riêng bạn, chẳng hạn như ID từ hệ thống của bạn. Xem siêu dữ liệu
Thẻ Retargeting (vùng đầu)head_tagsChuỗiDành cho pixel theo dõi retargeting
Thẻ Retargeting (vùng thân)body_tagsChuỗiDành cho pixel theo dõi retargeting
Chuyển tiếp Tham sốforward_paramsBoolean
Ẩn Người giới thiệuhide_referrerBooleanGửi referrer-policy: no-referrer để điểm đích không thấy Linkly trong tiêu đề referer
Che giấucloakingBooleanẨn URL đích phía sau một khung
Chặn Botblock_botsBooleanChặn các bot/crawler được biết đến
Bỏ qua Theo dõi Crawler Mạng xã hộiskip_social_crawler_trackingBooleanKhi block_bots bật, vẫn cho phép crawler mạng xã hội qua để xem trước OG hoạt động
Phân tích công khaipublic_analyticsBooleanBật trang /abc123.stats công khai cho liên kết này
Mật khẩupasswordChuỗiKhách truy cập phải nhập mật khẩu này trước khi chuyển hướng
Trạng thái Xuất bảnenabledBoolean
Nguồn UTMutm_sourceChuỗiDành cho theo dõi UTM
Phương tiện UTMutm_mediumChuỗiDành cho theo dõi UTM
Chiến dịch UTMutm_campaignChuỗiDành cho theo dõi UTM
Thuật ngữ UTMutm_termChuỗiDành cho theo dõi UTM
Nội dung UTMutm_contentChuỗiDành cho theo dõi UTM
Miền tùy chỉnhdomainChuỗiBắt buộc nếu slug được cung cấp. Xem miền tùy chỉnh
Hậu tố Miền tùy chỉnhslugChuỗiNếu domain được cung cấp và slug rỗng, sẽ được tự động tạo
Tiêu đề Biểu đồ Mởog_titleChuỗiDành cho bản xem trước mạng xã hội
Mô tả Biểu đồ Mởog_descriptionChuỗiDành cho bản xem trước mạng xã hội
URL Hình ảnh Biểu đồ Mởog_imageChuỗiDành cho bản xem trước mạng xã hội
ID Pixel Metafb_pixel_idChuỗiDành cho Pixel Meta
ID Pixel TikToktiktok_pixel_idChuỗi
ID Google Analytics 4ga4_tag_idChuỗi
Vùng chứa Google Tag Managergtm_idChuỗi
Linkify Từlinkify_wordsChuỗiCác cụm từ được phân tách bằng dòng mới sẽ được tự động rút ngắn trên các trang đích
Thay thếreplacementsChuỗiQuy tắc thay thế văn bản được áp dụng cho trang đích
Ngày giờ Hết hạnexpiry_datetimeChuỗi Ngày giờ ISO8601Dành cho liên kết hết hạn
Đích đến Hết hạnexpiry_destinationChuỗi (URL)Dành cho liên kết hết hạn. Phải bắt đầu bằng http.
Nhấp Hết hạnexpiry_clicksSố nguyênLiên kết hết hạn sau số lần nhấp này
WebhookswebhooksMảng chuỗiURL webhook cho mỗi liên kết. Xem webhooks.
Thông báo ID Người dùngnotify_user_idsMảng số nguyênID người dùng không gian làm việc để thông báo trên mỗi lần nhấp
Kiểu Mã QRqr_stylesĐối tượng JSONDành cho tạo kiểu mã QR. Khóa: fgColor, bgColor, qrStyle, eyeStyle, eyeColorInner, eyeColorOuter, logoImage, logoWidth, logoHeight, logoPadding, logoStyle, quietZone
Quy tắcrulesMảng JSONDành cho rotators, chuyển hướng địa lý, và chuyển hướng thiết bị

Yêu cầu ví dụ sử dụng curl

Mã dưới đây minh họa cách thực hiện yêu cầu API để tạo một liên kết.

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'

Phản hồi thành công sẽ trả về một đối tượng JSON đại diện cho liên kết, cùng với một id liên kết.

{
    "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
}

Cập nhật một liên kết

Để cập nhật một liên kết, hãy gửi yêu cầu tương tự như những gì bạn sẽ sử dụng để tạo liên kết, nhưng bao gồm trường id cho liên kết bạn muốn cập nhật, cũng như các thay đổi.

Đính kèm dữ liệu của riêng bạn vào một liên kết (siêu dữ liệu)

Sử dụng metadata để lưu trữ các định danh của riêng bạn so với một liên kết, chẳng hạn như ID đơn hàng, ID liên hệ CRM hoặc tham chiếu chiến dịch từ hệ thống của riêng bạn. Nó là một tập hợp các cặp khóa-giá trị, và nó quay trở lại bất cứ khi nào bạn tìm nạp liên kết và trong mọi webhook payload (sự kiện nhấp và liên kết), vì vậy bạn có thể khớp một lần nhấp với bản ghi mà nó thuộc về.

Gửi nó như một đối tượng 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"}}'

Liên kết trong phản hồi bao gồm "metadata": {"order_id": "A-10293", "crm_contact_id": "3f2b8c1e-9a47-4d0e-b6a5-1c2d3e4f5a6b"}.

Cách nó hoạt động:

  • Cập nhật được hợp nhất. Khi bạn cập nhật một liên kết, các khóa bạn gửi được thêm vào siêu dữ liệu hiện có của liên kết, và các khóa bạn không đề cập được bỏ qua. Để xóa một khóa, hãy đặt nó thành null (ví dụ {"metadata": {"order_id": null}}).
  • Giá trị là chuỗi. Các số và boolean được lưu trữ dưới dạng văn bản, vì vậy 42 quay trở lại dưới dạng "42". Các đối tượng lồng nhau và mảng không được phép.
  • Giới hạn. Tối đa 20 khóa mỗi liên kết, khóa tối đa 40 ký tự và giá trị tối đa 500 ký tự, đủ cho UUID.
  • Riêng tư cho bạn. Siêu dữ liệu không bao giờ được hiển thị cho những người nhấp vào liên kết và không được sử dụng để xây dựng chuyển hướng.
  • Trong ứng dụng. Bạn cũng có thể xem và chỉnh sửa siêu dữ liệu trong cài đặt Tự động hóa của liên kết, dưới Siêu dữ liệu.

Tạo rotators thông qua API

Để tạo rotator, hãy gửi một trường gọi là rules dưới dạng mảng JSON, cùng với tải trọng liên kết ở trên. Bạn phải sử dụng application/json để gửi mảng JSON.

Ví dụ:

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

Tạo chuyển hướng địa lý thông qua API

Để chuyển hướng theo quốc gia, hãy gửi một trường gọi là rules dưới dạng mảng JSON, cùng với tải trọng liên kết ở trên. Bạn phải sử dụng mã hóa application/json để gửi mảng JSON.

Ví dụ:

[
  {"what": "country", "url": "https://www.microsoft.com", "matches": "UK"},
  {"what": "country", "url": "https://www.apple.com", "matches": "US"}
]

Quốc gia là mã quốc gia ISO 3166 alpha-2.

Tạo chuyển hướng thiết bị thông qua API

Để chuyển hướng theo thiết bị, hãy gửi một trường gọi là rules dưới dạng mảng JSON, cùng với tải trọng liên kết ở trên.

Ví dụ:

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

Trong đó trường matches là một trong những điều sau:

  • ios
  • android
  • windows
  • linux
  • mac

Tạo hoặc cập nhật nhiều liên kết trong một yêu cầu

Linkly hỗ trợ tạo/sửa đổi tối đa 1000 liên kết trên mỗi yêu cầu.

Để làm như vậy, hãy gửi khóa API của bạn như một phần của yêu cầu như sau:

https://app.linklyhq.com/api/v1/links?api_key=XXXXXXXXXXX

Sau đó, sử dụng cùng một lược đồ như trên cho các trường hợp liên kết riêng lẻ, nhưng bao bọc các yêu cầu liên kết trong một mảng, có dạng:

[{link}, {link}]

Đây là một yêu cầu hoàn chỉnh sẽ cập nhật hai liên kết:

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'

Điều này hoạt động cho cả hành động tạo và cập nhật.

Vui lòng lưu ý rằng có thể mất tới 60 giây cho một yêu cầu lớn. Nếu các yêu cầu mất lâu hơn thời gian này, chúng sẽ không thành công và bạn nên cân nhắc chia khối lượng công việc của mình thành các phần nhỏ hơn.

Giới hạn tỷ lệ

API rút gọn liên kết được giới hạn ở 20 yêu cầu/giây. Tối đa 200/yêu cầu mỗi giây có sẵn theo yêu cầu. Bạn có thể tải lên tối đa 1000 liên kết trong một yêu cầu duy nhất.

Liên quan

Tính khả dụng của gói dịch vụ

Bao gồm trong mọi gói dịch vụ

So sánh các gói cước →

Nhận ngay 100 liên kết rút gọn và theo dõi 500 lượt nhấp chuột mỗi tháng hoàn toàn miễn phí.