الروابط

الملاحظات
مستوى الخبراء
يجب إرسال مفتاح واجهة برمجة التطبيقات كرمز Bearer في ترويسة الطلب. احصل على مفتاح واجهة برمجة التطبيقات الخاص بك.
قائمة

نقطة نهاية واجهة برمجة التطبيقات:

GET 
https://rrc.link/api/v1/links

مثال للطلب: 

curl --location --request GET 'https://rrc.link/api/v1/links' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
المعامل
النوع
الوصف
search
إختياري string
كلمة البحث.
by
إختياري string
البحث بواسطة. القيم المتاحة: title لـ العنوان, alias لـ الاسم المختصر, url لـ الرابط.
status
إختياري integer
تصفية حسب الحالة. القيم المتاحة: 0 لـ الجميع, 1 لـ نشط, 2 لـ منتهي, 3 لـ معطل.
space
إختياري integer
تصفية حسب معرف المساحة.
domain
إختياري integer
تصفية حسب معرف المجال.
sort
إختياري string
فرز بواسطة القيم المتاحة: desc لـ تنازلي, asc لـ تصاعدي, max لـ الأفضل اداء, min لـ الأقل أداء.
عرض

نقطة نهاية واجهة برمجة التطبيقات:

GET 
https://rrc.link/api/v1/links/{id}

مثال للطلب: 

curl --location --request GET 'https://rrc.link/api/v1/links/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
تخزين

نقطة نهاية واجهة برمجة التطبيقات:

POST 
https://rrc.link/api/v1/links

مثال للطلب: 

curl --location --request POST 'https://rrc.link/api/v1/links' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
المعامل
النوع
الوصف
url
مطلوب string
الرابط المطلوب اختصاره.
alias
إختياري string
الاسم المختصر للرابط.
password
إختياري string
كلمة مرور الرابط.
space
إختياري integer
المساحة هو الرابط الذي سيتم حفظه تحته.
domain
إختياري integer
المجال هو الرابط الذي سيتم حفظه تحت.
disabled
إختياري integer
ما إذا كان الرابط معطلاً أم لا. الافتراضي الى: 0.
public
إختياري integer
سواء كانت احصائيات الرابط عامة أم لا. الافتراضي الى: 0.
expiration_url
إختياري string
الرابط الذي سيتم إعادة توجيه المستخدم إليه بمجرد انتهاء صلاحية الرابط.
expiration_date
إختياري string
تاريخ انتهاء صلاحية الرابط بالتنسيق YYYY-MM-DD.
expiration_time
إختياري string
وقت انتهاء صلاحية الرابط بالتنسيق HH:MM.
expiration_clicks
إختياري integer
عدد النقرات التي يجب أن تنتهي بعدها صلاحية الرابط.
target_type
إختياري integer
نوع الاستهداف. القيم المتاحة: 0 لـ غير محدد, 1 لـ المنطقة الحغرافية, 2 لـ المنصة, 3 لـ دوران.
geo[index][key]
إختياري string
رمز البلد المستهدف. يجب أن يكون الرمز ضمن ISO 3166-1 alpha-2 القياسي.
geo[index][value]
إختياري string
رابط البلد الذي سيتم إعادة توجيه المستخدم إليه.
platform[index][key]
إختياري string
اسم المنصة المستهدفة. القيم المتاحة: iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS, HarmonyOS, Huawei.
platform[index][value]
إختياري string
رابط النظام الأساسي الذي سيتم إعادة توجيه المستخدم إليه.
rotation[index][value]
إختياري string
رابط الدوران الذي سيتم إعادة توجيه المستخدم إليه.
تحديث

نقطة نهاية واجهة برمجة التطبيقات:

PUT PATCH 
https://rrc.link/api/v1/links/{id}

مثال للطلب: 

curl --location --request PUT 'https://rrc.link/api/v1/links/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
المعامل
النوع
الوصف
url
إختياري string
الرابط المطلوب اختصاره.
alias
إختياري string
الاسم المختصر للرابط.
password
إختياري string
كلمة مرور الرابط.
space
إختياري integer
المساحة هو الرابط الذي سيتم حفظه تحته.
domain
إختياري integer
المجال هو الرابط الذي سيتم حفظه تحت.
disabled
إختياري integer
ما إذا كان الرابط معطلاً أم لا. الافتراضي الى: 0.
public
إختياري integer
سواء كانت احصائيات الرابط عامة أم لا. الافتراضي الى: 0.
expiration_url
إختياري string
الرابط الذي سيتم إعادة توجيه المستخدم إليه بمجرد انتهاء صلاحية الرابط.
expiration_date
إختياري string
تاريخ انتهاء صلاحية الرابط بالتنسيق YYYY-MM-DD.
expiration_time
إختياري string
وقت انتهاء صلاحية الرابط بالتنسيق HH:MM.
expiration_clicks
إختياري integer
عدد النقرات التي يجب أن تنتهي بعدها صلاحية الرابط.
target_type
إختياري integer
نوع الاستهداف. القيم المتاحة: 0 لـ غير محدد, 1 لـ المنطقة الحغرافية, 2 لـ المنصة, 3 لـ دوران.
geo[index][key]
إختياري string
رمز البلد المستهدف. يجب أن يكون الرمز ضمن ISO 3166-1 alpha-2 القياسي.
geo[index][value]
إختياري string
رابط البلد الذي سيتم إعادة توجيه المستخدم إليه.
platform[index][key]
إختياري string
اسم المنصة المستهدفة. القيم المتاحة: iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS, HarmonyOS, Huawei.
platform[index][value]
إختياري string
رابط النظام الأساسي الذي سيتم إعادة توجيه المستخدم إليه.
rotation[index][value]
إختياري string
رابط الدوران الذي سيتم إعادة توجيه المستخدم إليه.
حذف

نقطة نهاية واجهة برمجة التطبيقات:

DELETE 
https://rrc.link/api/v1/links/{id}

مثال للطلب: 

curl --location --request DELETE 'https://rrc.link/api/v1/links/{id}' \
--header 'Authorization: Bearer {api_key}'