الروابط

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

نقطة نهاية API

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

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

curl --location --request GET 'https://dx.sa/api/v1/links' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'

المعاملات (Parameters)

الاسم
النوع
الوصف
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://dx.sa/api/v1/links/{id}

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

curl --location --request GET 'https://dx.sa/api/v1/links/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
حفظ

نقطة نهاية API

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

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

curl --location --request POST 'https://dx.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}'

المعاملات (Parameters)

الاسم
النوع
الوصف
url
مطلوب string
رابط الوجهة.
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
رابط انتهاء الصلاحية.
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.

بالنسبة لحقل targets_type=operating_systems، القيم الممكنة هي: 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
رابط الوجهة.
تحديث

نقطة نهاية API

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

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

curl --location --request PUT 'https://dx.sa/api/v1/links/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'

المعاملات (Parameters)

الاسم
النوع
الوصف
url
اختياري string
رابط الوجهة.
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
رابط انتهاء الصلاحية.
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.

بالنسبة لحقل targets_type=operating_systems، القيم الممكنة هي: 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
رابط الوجهة.
حذف

نقطة نهاية API

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

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

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