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

واجهة REST API

البداية

تتيح لك واجهة Shrinkit البرمجية إنشاء وإدارة موارد Shrinkit برمجيًا — الروابط المختصرة والبيانات التي تقوم عليها حملاتك — من خادمك أو من مهمة مجدولة أو من منصة أخرى.

الرابط الأساسي

https://api.shrinkit.me

كل نقطة نهاية مرتبطة بمتجر واحد، ويُحدَّد المتجر بمعرّفه في المسار:

https://api.shrinkit.me/apps/{project_id}/...

{project_id} هو معرّف المتجر (Store ID).

التوثيق

تحتاج قيمتين، كلاهما من لوحة التحكم: افتح إعدادات المتجر ← مفتاح API وانسخ Store ID وAPI Key.

القيمة مكانها
معرّف المتجر جزء {project_id} في المسار
مفتاح API ترويسة الطلب appApiKey
curl --request POST \
  --url https://api.shrinkit.me/apps/{project_id}/smartlinks \
  --header 'appApiKey: YOUR_API_KEY' \
  --header 'content-type: application/json' \
  --data '{ ... }'

احتفظ بمفتاح API على الخادم

تعامل مع مفتاح API كسرّ. نفّذ طلبات REST من خادمك، ولا تضع المفتاح داخل تطبيق جوال أو في مستودع كود عام أو في أي موقع غير متجرك. ما يمكن إعادة توليد المفتاح من لوحة التحكم — إذا تسرّب، تواصل مع الدعم لإعادة تعيينه.

صيغة الطلب

الطلبات التي ترسل محتوى يجب أن تستخدم Content-Type: application/json. أي نوع محتوى آخر يُرفض بالرمز 406 Not Acceptable.

صيغة الاستجابة

كل استجابة بصيغة JSON وتحتوي على الحقل status. استجابات النجاح تضيف ما ترجعه نقطة النهاية:

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

والأخطاء تستخدم نفس الشكل مع "status": "failed" ورسالة مفهومة:

{
  "status": "failed",
  "message": "Conflict, slug not available."
}

رموز الحالة

الرمز المعنى
200 نجح الطلب
201 تم إنشاء المورد
400 فشل التحقق من البيانات — الرسالة توضح القيمة الخاطئة
401 ترويسة appApiKey مفقودة أو المفتاح غير صالح
403 المفتاح صالح لكنه لا يملك صلاحية على هذا المتجر
404 المتجر أو المورد غير موجود
405 هذه الطريقة غير مسموحة على نقطة النهاية
406 نوع المحتوى ليس application/json
409 تعارض — القيمة يجب أن تكون فريدة وهي مستخدمة بالفعل
500 خطأ في الخادم

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


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

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

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