الروابط

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

نقطة نهاية API:

GET
https://us.sa/api/v1/links

مثال على الطلب:

curl --location --request GET 'https://us.sa/api/v1/links' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
المعلمة
النوع
الوصف
search
اختياري string
استعلام البحث.
search_by
اختياري string
البحث بواسطة. القيم الممكنة هي: title لـ العنوان, alias لـ الاسم المستعار, url لـ عنوان URL. الافتراضي هو: title.
status
اختياري integer
الحالة. القيم الممكنة هي: 0 لـ الكل, 1 لـ نشط, 2 لـ منتهي الصلاحية, 3 لـ معطل. الافتراضي هو: 0.
space_id
اختياري integer
معرف المساحة.
domain_id
اختياري integer
معرف النطاق.
pixel_id
اختياري integer
معرف البكسل.
sort_by
اختياري string
الفرز حسب. القيم الممكنة هي: id لـ تاريخ الإنشاء, clicks لـ النقرات, title لـ العنوان, alias لـ الاسم المستعار, url لـ عنوان URL. الافتراضي هو: id.
sort
اختياري string
فرز. القيم الممكنة هي: desc لـ تنازلي, asc لـ تصاعدي. الافتراضي هو: desc.
per_page
اختياري integer
النتائج لكل صفحة. القيم الممكنة هي: 10, 25, 50, 100. الافتراضي هو: 10.
عرض

نقطة نهاية API:

GET
https://us.sa/api/v1/links/{id}

مثال على الطلب:

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

نقطة نهاية API:

POST
https://us.sa/api/v1/links

مثال على الطلب:

curl --location --request POST 'https://us.sa/api/v1/links' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}' \
--data-urlencode 'domain={id}'
المعلمة
النوع
الوصف
url
مطلوب string
عنوان URL الوجهة.
domain_id
مطلوب integer
معرف النطاق.
alias
اختياري string
الاسم المستعار.
space_id
اختياري integer
معرف المساحة.
pixel_ids[]
اختياري array
معرفات البكسل.
redirect_password
اختياري string
كلمة مرور إعادة التوجيه.
sensitive_content
اختياري integer
محتوى حساس. القيم الممكنة هي: 0 لـ لا, 1 لـ نعم. الافتراضي هو: 0.
privacy
اختياري integer
خصوصية الإحصائيات. القيم الممكنة هي: 0 لـ عام, 1 لـ خاص, 2 لـ كلمة المرور. الافتراضي هو: 0.
password
اختياري string
كلمة مرور الإحصائيات. يعمل فقط مع حقل privacy المعين على 2.
active_period_start_at
اختياري string
تاريخ بدء الفترة النشطة بتنسيق Y-m-dTH:i:s.
active_period_end_at
اختياري string
تاريخ انتهاء الفترة النشطة بتنسيق Y-m-dTH:i:s.
clicks_limit
اختياري integer
حد النقرات.
expiration_url
اختياري string
عنوان URL لانتهاء الصلاحية.
targets_type
اختياري string
الاستهداف. القيم الممكنة هي: continents لـ Continents, countries لـ Countries, operating_systems لـ Operating systems, browsers لـ Browsers, languages لـ Languages, devices لـ Devices, rotations لـ Rotations.
targets[index][key]
اختياري string
بالنسبة لـ targets_type=country، يجب أن تكون القيمة بتنسيق ISO 3166-1 alpha-2.
For targets_type=operating_systems, the possible values are iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.
بالنسبة لـ targets_type=browsers، القيم الممكنة هي: Chrome, Chromium, Firefox, Firefox Mobile, Edge, Internet Explorer, Mobile Internet Explorer, Vivaldi, Brave, Safari, Opera, Opera Mini, Opera Mobile, Opera Touch, Yandex Browser, UC Browser, Samsung Internet, QQ Browser, BlackBerry Browser, Maxtho.
بالنسبة لـ targets_type=devices، القيم الممكنة هي: Desktop, Mobile, Tablet, Watch, Television.
بالنسبة لـ targets_type=languages، يجب أن تكون القيمة بتنسيق ISO 639-1 alpha-2.
بالنسبة لـ targets_type=continents، القيم الممكنة هي: AF لـ Africa, AN لـ Antarctica, AS لـ Asia, EU لـ Europe, NA لـ North America, OC لـ Oceania, SA لـ South America.
targets[index][value]
اختياري string
عنوان URL الوجهة.
تحديث

نقطة نهاية API:

PUT PATCH
https://us.sa/api/v1/links/{id}

مثال على الطلب:

curl --location --request PUT 'https://us.sa/api/v1/links/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
المعلمة
النوع
الوصف
url
اختياري string
عنوان URL الوجهة.
alias
اختياري string
الاسم المستعار.
space_id
اختياري integer
معرف المساحة.
pixel_ids[]
اختياري array
معرفات البكسل.
redirect_password
اختياري string
كلمة مرور إعادة التوجيه.
sensitive_content
اختياري integer
محتوى حساس. القيم الممكنة هي: 0 لـ لا, 1 لـ نعم.
privacy
اختياري integer
خصوصية الإحصائيات. القيم الممكنة هي: 0 لـ عام, 1 لـ خاص, 2 لـ كلمة المرور.
password
اختياري string
كلمة مرور الإحصائيات. يعمل فقط مع حقل privacy المعين على 2.
active_period_start_at
اختياري string
تاريخ بدء الفترة النشطة بتنسيق Y-m-dTH:i:s.
active_period_end_at
اختياري string
تاريخ انتهاء الفترة النشطة بتنسيق Y-m-dTH:i:s.
clicks_limit
اختياري integer
حد النقرات.
expiration_url
اختياري string
عنوان URL لانتهاء الصلاحية.
targets_type
اختياري string
الاستهداف. القيم الممكنة هي: continents لـ Continents, countries لـ Countries, operating_systems لـ Operating systems, browsers لـ Browsers, languages لـ Languages, devices لـ Devices, rotations لـ Rotations.
targets[index][key]
اختياري string
بالنسبة لـ targets_type=country، يجب أن تكون القيمة بتنسيق ISO 3166-1 alpha-2.
For targets_type=operating_systems, the possible values are iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.
بالنسبة لـ targets_type=browsers، القيم الممكنة هي: Chrome, Chromium, Firefox, Firefox Mobile, Edge, Internet Explorer, Mobile Internet Explorer, Vivaldi, Brave, Safari, Opera, Opera Mini, Opera Mobile, Opera Touch, Yandex Browser, UC Browser, Samsung Internet, QQ Browser, BlackBerry Browser, Maxtho.
بالنسبة لـ targets_type=devices، القيم الممكنة هي: Desktop, Mobile, Tablet, Watch, Television.
بالنسبة لـ targets_type=languages، يجب أن تكون القيمة بتنسيق ISO 639-1 alpha-2.
بالنسبة لـ targets_type=continents، القيم الممكنة هي: AF لـ Africa, AN لـ Antarctica, AS لـ Asia, EU لـ Europe, NA لـ North America, OC لـ Oceania, SA لـ South America.
targets[index][value]
اختياري string
عنوان URL الوجهة.
حذف

نقطة نهاية API:

DELETE
https://us.sa/api/v1/links/{id}

مثال على الطلب:

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