Link Shortening API ของ Linkly

สร้าง อัปเดต และจัดการลิงก์โดยการเขียนโปรแกรมโดยใช้ Link Shortening API ของ Linkly

ที่เกี่ยวข้อง: Analytics API | Webhooks

ก่อนที่คุณจะเริ่มต้น

Linkly สร้างคำขอ API ในอินเตอร์เฟซสำหรับคุณที่จะคัดลอก & วางลงในแอปพลิเคชันของคุณ

สิ่งนี้ใช้ได้กับการสร้างลิงก์และการอัปเดตลิงก์

ประหยัดเวลาและให้เราทำงานหนักแทน:

  1. 1
    ดูด้านล่างสำหรับคำขอ API การสร้างลิงก์
  2. 2
    คัดลอกคำขอทั้งหมด คุณสามารถตรวจสอบว่าทำงานได้สำหรับคุณ
  3. 3
    ขอให้ ChatGPT หรือเทียบเท่าเพื่อปรับตัวคำขอเหล่านี้เป็นโค้ดต้นฉบับสำหรับแอปพลิเคชันของคุณ ไม่จำเป็นต้องใช้เวลาในการทำการรวมที่ซับซ้อน API ของเราสามารถใช้ได้ทั้งหมดโดยเครื่อง

OpenAPI 3.0 spec

คุณสามารถสร้างคำขอ API โดยตรงจากอินเตอร์เฟซผู้ใช้ Linkly

Link Shortening API Builder ของ Linkly

Link Shortening API ของ Linkly สร้างคำขอ API โดยอัตโนมัติตามเนื้อหาของแบบฟอร์ม คุณสามารถวางข้อความที่ให้ไว้ที่นี่ลงใน LLM ใดก็ได้เพื่อสร้างโค้ดสำหรับแอปพลิเคชันของคุณโดยอัตโนมัติ

API ของ Linkly มีการสารสนเทศโดยใช้มาตรฐาน OpenAPI ซึ่งเกินกว่าสิ่งที่ให้ไว้ด้านล่าง จุดปลายทางเดียวกันยังใช้ได้เป็นคอลเลกชัน Postman แบบคลิกเดียว

ดูOpenAPI Spec

เรียกใช้ใน Postman

การอนุญาต

คุณจะต้องมี:

  • API Key ของคุณ
  • Workspace ID

คุณสามารถรับรายละเอียดเหล่านี้ได้จากภายใน Linkly

  1. 1
    เข้าสู่ระบบ Linkly
  2. 2
    คลิก Settings
  3. 3
    คลิก API Keys

การสร้างหรืออัปเดตลิงก์

ในการสร้างลิงก์ สิ่งที่คุณต้องทำคือส่ง POST request ไปที่:

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

พร้อมฟิลด์ต่อไปนี้ในเนื้อหา

ประเภทการเข้ารหัสคือ x-www-form-urlencoded หรือ application/json

หากคุณกำลังส่งฟิลด์ Rules คุณต้องใช้ application/json

เราแนะนำให้คุณใช้ JSON พร้อมกับ Open API spec

ป้ายกำกับคีย์ประเภทหมายเหตุ
Account API Keyapi_keyStringจำเป็น
Workspace IDworkspace_idIntegerจำเป็น
Link IDidIntegerจำเป็นเมื่ออัปเดตลิงก์ที่มีอยู่
DestinationurlStringจำเป็น
ชื่อเล่นnameString
หมายเหตุnoteString
Retargeting tags (head region)head_tagsStringสำหรับ retargeting pixels
Retargeting tags (body region)body_tagsStringสำหรับ retargeting pixels
Forward Paramsforward_paramsBoolean
Hide Referrerhide_referrerBooleanส่ง referrer-policy: no-referrer เพื่อให้ปลายทางไม่เห็น Linkly ในส่วนหัว referer
CloakingcloakingBooleanปกปิด URL ปลายทางหลังเฟรม
Block Botsblock_botsBooleanบล็อกบอต/ตัวรวบรวมข้อมูลที่ทราบ
Skip Social Crawler Trackingskip_social_crawler_trackingBooleanเมื่อ block_bots เปิด ให้ตัวรวบรวมข้อมูลโซเชียลผ่านได้เพื่อให้ OG previews ทำงาน
Public Analyticspublic_analyticsBooleanเปิดใช้งานหน้า /abc123.stats สาธารณะสำหรับลิงก์นี้
PasswordpasswordStringผู้เยี่ยมชมต้องป้อนรหัสผ่านนี้ก่อนการเปลี่ยนเส้นทาง
Publishing StatusenabledBoolean
UTM Sourceutm_sourceStringสำหรับ UTM tracking
UTM Mediumutm_mediumStringสำหรับ UTM tracking
UTM Campaignutm_campaignStringสำหรับ UTM tracking
UTM Termutm_termStringสำหรับ UTM tracking
UTM Contentutm_contentStringสำหรับ UTM tracking
Custom DomaindomainStringจำเป็นหาก slug ได้รับ ดู custom domains
Custom Domain SuffixslugStringหาก domain ได้รับและ slug เป็น null จะถูกสร้างขึ้นโดยอัตโนมัติ
Open Graph Titleog_titleStringสำหรับ social media previews
Open Graph Descriptionog_descriptionStringสำหรับ social media previews
Open Graph Image URLog_imageStringสำหรับ social media previews
Meta Pixel IDfb_pixel_idStringสำหรับ Meta Pixel
TikTok Pixel IDtiktok_pixel_idString
Google Analytics 4 IDga4_tag_idString
Google Tag Manager containergtm_idString
Linkify Wordslinkify_wordsStringวลีคั่นด้วยบรรทัดใหม่ที่ควรย่อลงโดยอัตโนมัติบนหน้าเนื้อหา
ReplacementsreplacementsStringกฎการแทนที่ข้อความที่ใช้กับหน้าปลายทาง
Expiry DateTimeexpiry_datetimeISO8601 DateTime Stringสำหรับ expiring links
Expiry Destinationexpiry_destinationString (URL)สำหรับ expiring links ต้องเริ่มต้นด้วย http
Expiry Clicksexpiry_clicksIntegerหมดอายุลิงก์หลังจากคลิกจำนวนนี้
WebhookswebhooksArray of stringsURL webhook ต่อลิงก์ ดู webhooks
Notify User IDsnotify_user_idsArray of integersID ผู้ใช้พื้นที่ทำงานเพื่อแจ้งเตือนในแต่ละครั้ง
QR Code Stylesqr_stylesJSON objectสำหรับ QR code styling คีย์: fgColor, bgColor, qrStyle, eyeStyle, eyeColorInner, eyeColorOuter, logoImage, logoWidth, logoHeight, logoPadding, logoStyle, quietZone
RulesrulesJSON arrayสำหรับ rotators, geo-redirects, และ device redirects

ตัวอย่างคำขอ using 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 ที่แสดงถึงลิงก์พร้อมกับ link 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 สำหรับลิงก์ที่คุณต้องการอัปเดต พร้อมกับการเปลี่ยนแปลง

การสร้าง rotators ผ่าน API

เพื่อสร้าง rotator ให้ส่งฟิลด์ที่เรียกว่า rules เป็นอาร์เรย์ JSON พร้อมกับโครงสร้างการโหลดลิงก์ด้านบน คุณต้องใช้ application/json เพื่อส่งอาร์เรย์ JSON

ตัวอย่างเช่น:

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

การสร้าง geo-redirects ผ่าน 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 country code

การสร้าง device redirects ผ่าน 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 key ของคุณเป็นส่วนหนึ่งของคำขอดังนี้:

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 วินาที สำหรับคำขอขนาดใหญ่ หากคำขอใช้เวลานานกว่านี้ คำขอจะล้มเหลว และคุณควรพิจารณาแบ่งโหลดงานออกเป็นส่วนที่เล็กกว่า

ข้อจำกัดอัตรา

Link Shortening API จำกัดไว้ที่ 20 คำขอ/วินาที สูงถึง 200/คำขอต่อวินาทีมีอยู่ตามคำขอ คุณสามารถอัปโหลดลิงก์สูงสุด 1000 ลิงก์ในคำขออันเดียว

ที่เกี่ยวข้อง

  • Analytics API - ส่งออกข้อมูลการคลิกและรายงานการรับชม
  • Webhooks - การแจ้งเตือนการคลิกแบบเรียลไทม์
  • Zapier Integration - การรวมโค้ดฟรี

ความพร้อมใช้งานของแผน

รวมอยู่ใน ทุกแพ็กเกจ

เปรียบเทียบแผน →

รับลิงก์สั้น 100 รายการและติดตามจำนวนคลิก 500 ครั้งต่อเดือนได้ฟรี