واجهة برمجة تطبيقات تقصير الروابط من Linkly
قم بإنشاء وتحديث وإدارة الروابط برمجياً باستخدام واجهة برمجة تطبيقات تقصير الروابط من Linkly.
ذات صلة: واجهة برمجة التطبيقات للتحليلات | Webhooks
قبل البدء
يقوم Linkly بإنشاء طلبات API في الواجهة لتنسخها والصقها في تطبيقاتك.
يعمل هذا لإنشاء الرابط وتحديث الرابط.
وفر الوقت واترك لنا العمل الشاق:
- 1اطلع على ما يلي للحصول على طلبات إنشاء الرابط API.
- 2انسخ الطلبات بالكامل. يمكنك التحقق من أنها تعمل لديك.
- 3اطلب من ChatGPT أو ما يعادله أن يكيف هذه الطلبات مع كود المصدر لتطبيقك. لا توجد حاجة لقضاء الوقت في القيام بتكامل معقد. واجهة برمجة التطبيقات الخاصة بنا قابلة للاستهلاك بالكامل من قبل الآلة.
مواصفات OpenAPI 3.0
يمكنك إنشاء طلبات API مباشرة من واجهة مستخدم Linkly.
منشئ واجهة برمجة تطبيقات تقصير الروابط من Linkly
تقوم واجهة برمجة تطبيقات تقصير الروابط من Linkly بإنشاء طلبات API تلقائياً بناءً على محتويات النموذج. يمكنك لصق النص المعطى هنا في أي نموذج لغة كبير لإنشاء رمز تلقائياً لتطبيقك.
تم توثيق واجهة برمجة التطبيقات من Linkly باستخدام معيار OpenAPI، والذي يتجاوز ما هو مقدم أدناه. نفس نقاط النهاية متاحة أيضاً كمجموعة Postman بنقرة واحدة.
المصادقة
ستحتاج إلى:
- مفتاح API الخاص بك
- معرّف مساحة العمل
يمكنك الحصول على هذه التفاصيل من داخل Linkly.
- 1سجل الدخول إلى Linkly.
- 2انقر على الإعدادات.
- 3انقر على مفاتيح API.
إنشاء أو تحديث رابط
لإنشاء رابط، كل ما تحتاج إلى فعله هو إرسال طلب POST إلى:
https://app.linklyhq.com/api/v1/link
مع الحقول التالية في الهيئة.
نوع الترميز هو x-www-form-urlencoded أو application/json.
إذا كنت تقدم حقل القواعد، يجب عليك استخدام application/json.
نوصيك باستخدام JSON مع مواصفات Open API.
| التسمية | المفتاح | النوع | ملاحظات |
|---|---|---|---|
| مفتاح حساب API | api_key | String | مطلوب |
| معرّف مساحة العمل | workspace_id | Integer | مطلوب |
| معرّف الرابط | id | Integer | مطلوب إذا كان تحديث رابط موجود |
| الوجهة | url | String | مطلوب |
| اسم مستعار | name | String | |
| ملاحظات | note | String | |
| علامات إعادة الاستهداف (منطقة الرأس) | head_tags | String | لـ بكسل إعادة الاستهداف |
| علامات إعادة الاستهداف (منطقة الجسم) | body_tags | String | لـ بكسل إعادة الاستهداف |
| معاملات المتابعة | forward_params | Boolean | |
| إخفاء الإحالة | hide_referrer | Boolean | يرسل referrer-policy: no-referrer بحيث لا تراى الوجهة Linkly في رأس referer |
| التخفية | cloaking | Boolean | يخفي عنوان URL للوجهة خلف إطار |
| حظر الروبوتات | block_bots | Boolean | يحظر الروبوتات/الزحافات المعروفة |
| تخطي تتبع زاحف وسائل التواصل الاجتماعي | skip_social_crawler_tracking | Boolean | عندما يكون block_bots مشغلاً، لا تزال تسمح لزحافات وسائل التواصل الاجتماعي بالمرور حتى تعمل معاينات OG |
| تحليلات عامة | public_analytics | Boolean | يفعّل صفحة /abc123.stats العامة لهذا الرابط |
| كلمة المرور | password | String | يجب على الزوار إدخال كلمة المرور هذه قبل الإعادة |
| حالة النشر | enabled | Boolean | |
| مصدر UTM | utm_source | String | لـ تتبع UTM |
| وسيط UTM | utm_medium | String | لـ تتبع UTM |
| حملة UTM | utm_campaign | String | لـ تتبع UTM |
| مصطلح UTM | utm_term | String | لـ تتبع UTM |
| محتوى UTM | utm_content | String | لـ تتبع UTM |
| مجال مخصص | domain | String | مطلوب إذا تم توفير الخطوة. انظر المجالات المخصصة |
| لاحقة المجال المخصص | slug | String | إذا تم توفير domain وكان slug فارغاً، سيتم إنشاؤه تلقائياً |
| عنوان Open Graph | og_title | String | لـ معاينات وسائل التواصل الاجتماعي |
| وصف Open Graph | og_description | String | لـ معاينات وسائل التواصل الاجتماعي |
| عنوان URL صورة Open Graph | og_image | String | لـ معاينات وسائل التواصل الاجتماعي |
| معرّف Meta Pixel | fb_pixel_id | String | لـ Meta Pixel |
| معرّف TikTok Pixel | tiktok_pixel_id | String | |
| معرّف Google Analytics 4 | ga4_tag_id | String | |
| حاوية Google Tag Manager | gtm_id | String | |
| كلمات قابلة للربط | linkify_words | String | عبارات مفصولة بفاصل أسطر يجب أن تقصر تلقائياً على صفحات الهبوط |
| البدائل | replacements | String | قواعد استبدال النص المطبقة على صفحة الوجهة |
| تاريخ انتهاء الصلاحية | expiry_datetime | ISO8601 DateTime String | لـ الروابط التي تنتهي صلاحيتها |
| وجهة انتهاء الصلاحية | expiry_destination | String (URL) | لـ الروابط التي تنتهي صلاحيتها. يجب أن تبدأ بـ http. |
| نقرات انتهاء الصلاحية | expiry_clicks | Integer | انتهي صلاحية الرابط بعد هذا العدد من النقرات |
| Webhooks | webhooks | Array of strings | عناوين URL لـ webhook لكل رابط. انظر webhooks. |
| معرفات المستخدمين المراد إخطارهم | notify_user_ids | Array of integers | معرفات مستخدمي مساحة العمل المراد إخطارهم عند كل نقرة |
| أنماط رمز الاستجابة السريعة | qr_styles | JSON object | لـ تصميم رمز الاستجابة السريعة. المفاتيح: fgColor, bgColor, qrStyle, eyeStyle, eyeColorInner, eyeColorOuter, logoImage, logoWidth, logoHeight, logoPadding, logoStyle, quietZone |
| القواعد | rules | JSON 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": 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.
إنشاء إعادات التوجيه حسب الجهاز عبر 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/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 ثانية لطلب كبير. إذا استغرقت الطلبات وقتاً أطول من ذلك، فسوف تفشل، ويجب عليك التفكير في تقسيم حملك العملية إلى أجزاء أصغر.
حدود المعدل
تقتصر واجهة برمجة تطبيقات تقصير الروابط على 20 طلباً/ثانية. ما يصل إلى 200/طلب في الثانية متاح عند الطلب. يمكنك تحميل ما يصل إلى 1000 رابط في طلب واحد.
ذات صلة
- واجهة برمجة التطبيقات للتحليلات - تصدير بيانات النقرات وتقارير المرور
- Webhooks - إخطارات النقرات في الوقت الفعلي
- تكامل Zapier - التكاملات بدون كود
توافر الخطة
مشمول في كل خطة
احصل على 100 رابط مختصر وتتبع 500 نقرة شهريًا مجانًا.