روابط

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

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

GET 
https://shbbr.com/api/v1/links

طلب مثال: 

curl --location --request GET 'https://shbbr.com/api/v1/links' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
معامل
النوع
وصف
search
اختياري string
استعلام البحث.
by
اختياري string
البحث عن طريق. القيم الممكنة هي :القيم. افتراضات إلى :القيمة.
status
اختياري integer
تصفية حسب الحالة. القيم الممكنة هي :القيم. افتراضات إلى :القيمة.
space
اختياري integer
تصفية حسب مساحة المعرف .
domain
اختياري integer
تصفية حسب معرّف المجال.
sort
اختياري string
فرز. القيم الممكنة هي :القيم. افتراضات إلى :القيمة.
per_page
اختياري int
النتائج لكل صفحه. القيم الممكنة هي :القيم. افتراضات إلى :القيمة.
عرض

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

GET 
https://shbbr.com/api/v1/links/{id}

طلب مثال: 

curl --location --request GET 'https://shbbr.com/api/v1/links/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
محل

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

POST 
https://shbbr.com/api/v1/links

طلب مثال: 

curl --location --request POST 'https://shbbr.com/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
معرف المجال هو الرابط الذي سيتم حفظه تحت.
pixels
اختياري array
The pixel IDs to be integrated in the link.
disabled
اختياري integer
ما إذا كان الرابط معطلاً أم لا. القيم الممكنة هي :القيم. افتراضات إلى :القيمة.
privacy
اختياري integer
ما إذا كانت احصائيات الارتباط عامة أم لا. القيم الممكنة هي :القيم. افتراضات إلى :القيمة.
privacy_password
اختياري string
كلمة المرور لصفحة الإحصائيات. يعمل فقط مع :حقل تعيين إلى :القيمة.
expiration_url
اختياري string
الرابط الذي سيتم إعادة توجيه المستخدم إليه بمجرد انتهاء صلاحية الارتباط.
expiration_date
اختياري string
تاريخ انتهاء الارتباط بتنسيق :شكل شكل.
expiration_time
اختياري string
وقت انتهاء الارتباط بتنسيق :شكل شكل .
expiration_clicks
اختياري integer
عدد النقرات التي يجب أن تنتهي بعدها صلاحية الرابط.
target_type
اختياري integer
نوع الاستهداف. القيم الممكنة هي :القيم.
country[index][key]
اختياري string
رمز البلد المستهدف. يجب أن يكون الرمز في :اساسي اساسي.
country[index][value]
اختياري string
الرابط الذي سيتم إعادة توجيه المستخدم إليه.
platform[index][key]
اختياري string
اسم المنصة المستهدفة. القيم الممكنة هي :القيم.
platform[index][value]
اختياري string
الرابط الذي سيتم إعادة توجيه المستخدم إليه.
language[index][key]
اختياري string
كود اللغة المستهدفة. يجب أن يكون الرمز في :اساسي اساسي.
language[index][value]
اختياري string
الرابط الذي سيتم إعادة توجيه المستخدم إليه.
rotation[index][value]
اختياري string
الرابط الذي سيتم إعادة توجيه المستخدم إليه.
تحديث

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

PUT PATCH 
https://shbbr.com/api/v1/links/{id}

طلب مثال: 

curl --location --request PUT 'https://shbbr.com/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
معرف المجال هو الرابط الذي سيتم حفظه تحت.
pixels
اختياري array
The pixel IDs to be integrated in the link.
disabled
اختياري integer
ما إذا كان الرابط معطلاً أم لا. القيم الممكنة هي :القيم.
privacy
اختياري integer
ما إذا كانت احصائيات الارتباط عامة أم لا. القيم الممكنة هي :القيم.
privacy_password
اختياري string
كلمة المرور لصفحة الإحصائيات. يعمل فقط مع :حقل تعيين إلى :القيمة.
expiration_url
اختياري string
الرابط الذي سيتم إعادة توجيه المستخدم إليه بمجرد انتهاء صلاحية الارتباط.
expiration_date
اختياري string
تاريخ انتهاء الارتباط بتنسيق :شكل شكل.
expiration_time
اختياري string
وقت انتهاء الارتباط بتنسيق :شكل شكل .
expiration_clicks
اختياري integer
عدد النقرات التي يجب أن تنتهي بعدها صلاحية الرابط.
target_type
اختياري integer
نوع الاستهداف. القيم الممكنة هي :القيم.
country[index][key]
اختياري string
رمز البلد المستهدف. يجب أن يكون الرمز في :اساسي اساسي.
country[index][value]
اختياري string
الرابط الذي سيتم إعادة توجيه المستخدم إليه.
platform[index][key]
اختياري string
اسم المنصة المستهدفة. القيم الممكنة هي :القيم.
platform[index][value]
اختياري string
الرابط الذي سيتم إعادة توجيه المستخدم إليه.
language[index][key]
اختياري string
كود اللغة المستهدفة. يجب أن يكون الرمز في :اساسي اساسي.
language[index][value]
اختياري string
الرابط الذي سيتم إعادة توجيه المستخدم إليه.
rotation[index][value]
اختياري string
الرابط الذي سيتم إعادة توجيه المستخدم إليه.
مسح

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

DELETE 
https://shbbr.com/api/v1/links/{id}

طلب مثال: 

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