انتقل إلى المحتوى

إنشاء رابط مختصر عبر API

أنشئ رابطًا مختصرًا من خادمك بدل لوحة التحكم: طلب واحد لكل رابط، مع وجهات مختلفة لكل منصة، ومعرّف مخصص، وتتبّع بكسل اختياري.

نقطة النهاية

POST https://api.shrinkit.me/apps/{project_id}/smartlinks
الترويسة القيمة
appApiKey مفتاح API الخاص بمتجرك
content-type application/json

{project_id} هو معرّف المتجر. القيمتان من إعدادات المتجر ← مفتاح API — راجع واجهة REST API.

المعاملات المطلوبة

المعامل النوع ملاحظات
name نص من 1 إلى 150 حرفًا. اسم الرابط في لوحة التحكم.
description نص من 2 إلى 500 حرف.
targates كائن وجهة الرابط. يتطلب web وios وandroid. انتبه للإملاء — اسم الحقل فعليًا targates.
launch_page كائن يتطلب header، وهو النص الظاهر أثناء فتح الرابط.

الكائن targates

المفتاح النوع ملاحظات
web نص وجهة سطح المكتب والمتصفحات غير المعروفة. من 5 إلى 500 حرف.
ios كائن يتطلب primary، وfallback اختياري.
android كائن يتطلب primary، وfallback اختياري.

في ios وandroid، القيمة primary هي الرابط العميق الذي يُفتح عند وجود التطبيق، وfallback هي الوجهة عند عدم وجوده.

المعاملات الاختيارية

المعامل النوع ملاحظات
slug نص من 2 إلى 50 حرفًا. الجزء الأخير من الرابط المختصر. يُولَّد تلقائيًا إذا لم تُرسله.
image نص رابط صورة المعاينة.
status نص reserve أو active أو disable.
tags مصفوفة وسوم للتصفية والتقارير.
web_push_subscription منطقي طلب إذن إشعارات المتصفح في صفحة الانتظار. القيمة الافتراضية false.
primary_text، primary_textcolor، primary_bgcolor نص تنسيق الزر الأساسي في صفحة الانتظار.
fallback_text، fallback_textcolor، fallback_bgcolor نص تنسيق الزر البديل في صفحة الانتظار.

بكسلات إعادة الاستهداف

لكل شبكة مفتاح منطقي (افتراضيًا false) وحقل معرّف. فعّل الاثنين معًا ليعمل البكسل عند فتح الرابط.

المفتاح حقل المعرّف
FBpixel_tracking FBpixel_tracking_code
twitter_pixel_tracking twitter_pixel_id
google_ads_pixel_tracking google_ads_id
linkedIn_pixel_tracking linkedIn_id
snapchat_pixel_tracking snapchat_id
tiktok_pixel_tracking tiktok_pixel_id

الطلب

curl --request POST \
  --url https://api.shrinkit.me/apps/574ad3de1ffdbfa835465e39/smartlinks \
  --header 'appApiKey: YOUR_API_KEY' \
  --header 'content-type: application/json' \
  --data '{
    "name": "test",
    "description": "test Facebook Browser",
    "slug": "TreMp",
    "image": "https://techcrunch.com/",
    "targates": {
      "web": "https://techcrunch.com/",
      "ios": {
        "primary": "http://techcrunch.com",
        "fallback": "https://techcrunch.com/"
      },
      "android": {
        "primary": "http://techcrunch.com",
        "fallback": "https://techcrunch.com/"
      }
    },
    "launch_page": {
      "header": "Please Wait..."
    }
  }'

الاستجابة

201 Created:

{
  "status": "success",
  "message": "successfully created",
  "smartlink": "https://yourstore.shrinkit.me/s/TreMp"
}

الأخطاء

الرمز مثال على message السبب
400 this value is invalid, 't' is too short فشل التحقق من أحد الحقول — الرسالة تحدده
400 slug is invalid , choose another slug. المعرّف ضمن قائمة الأسماء المحجوزة
400 domain doesn't exist النطاق المُرسل غير مُعرَّف على هذا المتجر
401 NotAuthorized ترويسة appApiKey مفقودة أو غير صالحة
409 Conflict, slug not available. المعرّف مستخدم بالفعل
500 Server Error خطأ في الخادم — أعد المحاولة ثم تواصل مع الدعم

مواضيع ذات صلة


ثبّت Shrinkit على متجرك

Shrinkit يشتغل مع سلة وزد وشوبيفاي. ثبّت التطبيق على متجرك، وطلباتك وسلاتك ومنتجاتك وعملاؤك تظهر في لوحة التحكم تلقائيًا — بدون برمجة وبدون استيراد بيانات.

متجرك على منصة ثانية؟ كلّمنا على واتساب.