الروابط

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

نقطة نهاية API:

GET 
https://297.avascript.net/api/v1/links

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

curl --location --request GET 'https://297.avascript.net/api/v1/links' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
معامل
النوع
الوصف
search
اختياري string
استعلام البحث.
search_by
اختياري string
البحث حسب. القيم الممكنة هي: title لـ العنوان, alias لـ الاسم المستعار, 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 لـ الرابط. القيمة الافتراضية: id.
sort
اختياري string
ترتيب. القيم الممكنة هي: desc لـ تنازلي, asc لـ تصاعدي. القيمة الافتراضية: desc.
per_page
اختياري integer
عدد النتائج في كل صفحة. القيم الممكنة هي: 10, 25, 50, 100. القيمة الافتراضية: 10.
عرض

نقطة نهاية API:

GET 
https://297.avascript.net/api/v1/links/{id}

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

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

نقطة نهاية API:

POST 
https://297.avascript.net/api/v1/links

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

curl --location --request POST 'https://297.avascript.net/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
الرابط المراد اختصاره.
domain_id
مطلوب integer
معرف النطاق لحفظ الرابط ضمنه.
alias
اختياري string
الاسم المستعار للرابط.
password
اختياري string
كلمة مرور الرابط.
space_id
اختياري integer
معرف المساحة لحفظ الرابط ضمنها.
pixel_ids
اختياري array
The pixel IDs to be integrated in the link.
disabled
اختياري integer
ما إذا كان الرابط معطلًا أم لا. القيم الممكنة هي: 0 لـ نشط, 1 لـ معطل. القيمة الافتراضية: 0.
privacy
اختياري integer
ما إذا كانت إحصاءات الرابط عامة أم لا. القيم الممكنة هي: 0 لـ عام, 1 لـ خاص, 2 لـ كلمة المرور. القيمة الافتراضية: 0.
privacy_password
اختياري string
كلمة مرور صفحة الإحصاءات. يعمل فقط عندما يتم تعيين privacy إلى 2.
expiration_url
اختياري string
الرابط الذي سيتم توجيه المستخدم إليه عند انتهاء صلاحية الرابط.
expiration_date
اختياري string
تاريخ انتهاء صلاحية الرابط بصيغة YYYY-MM-DD.
expiration_time
اختياري string
وقت انتهاء صلاحية الرابط بصيغة HH:MM.
expiration_clicks
اختياري integer
عدد النقرات بعده يجب أن تنتهي صلاحية الرابط.
target_type
اختياري integer
نوع الاستهداف. القيم الممكنة هي: 0 لـ لا شيء, 1 لـ جغرافي, 2 لـ المنصة, 4 لـ تناوب.
country[index][key]
اختياري string
رمز البلد المستهدف. يجب أن يكون الرمز بمعيار ISO 3166-1 alpha-2.
country[index][value]
اختياري string
الرابط الذي سيتم توجيه المستخدم إليه.
platform[index][key]
اختياري string
اسم المنصة المستهدفة. القيم الممكنة هي: iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.
platform[index][value]
اختياري string
الرابط الذي سيتم توجيه المستخدم إليه.
language[index][key]
اختياري string
رمز اللغة المستهدفة. يجب أن يكون الرمز بمعيار ISO 639-1 alpha-2.
language[index][value]
اختياري string
الرابط الذي سيتم توجيه المستخدم إليه.
rotation[index][value]
اختياري string
الرابط الذي سيتم توجيه المستخدم إليه.
تحديث

نقطة نهاية API:

PUT PATCH 
https://297.avascript.net/api/v1/links/{id}

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

curl --location --request PUT 'https://297.avascript.net/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_id
اختياري integer
معرف المساحة لحفظ الرابط ضمنها.
pixel_ids
اختياري array
The pixel IDs to be integrated in the link.
disabled
اختياري integer
ما إذا كان الرابط معطلًا أم لا. القيم الممكنة هي: 0 لـ نشط, 1 لـ معطل.
privacy
اختياري integer
ما إذا كانت إحصاءات الرابط عامة أم لا. القيم الممكنة هي: 0 لـ عام, 1 لـ خاص, 2 لـ كلمة المرور.
privacy_password
اختياري string
كلمة مرور صفحة الإحصاءات. يعمل فقط عندما يتم تعيين privacy إلى 2.
expiration_url
اختياري string
الرابط الذي سيتم توجيه المستخدم إليه عند انتهاء صلاحية الرابط.
expiration_date
اختياري string
تاريخ انتهاء صلاحية الرابط بصيغة YYYY-MM-DD.
expiration_time
اختياري string
وقت انتهاء صلاحية الرابط بصيغة HH:MM.
expiration_clicks
اختياري integer
عدد النقرات بعده يجب أن تنتهي صلاحية الرابط.
target_type
اختياري integer
نوع الاستهداف. القيم الممكنة هي: 0 لـ لا شيء, 1 لـ جغرافي, 2 لـ المنصة, 4 لـ تناوب.
country[index][key]
اختياري string
رمز البلد المستهدف. يجب أن يكون الرمز بمعيار ISO 3166-1 alpha-2.
country[index][value]
اختياري string
الرابط الذي سيتم توجيه المستخدم إليه.
platform[index][key]
اختياري string
اسم المنصة المستهدفة. القيم الممكنة هي: iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.
platform[index][value]
اختياري string
الرابط الذي سيتم توجيه المستخدم إليه.
language[index][key]
اختياري string
رمز اللغة المستهدفة. يجب أن يكون الرمز بمعيار ISO 639-1 alpha-2.
language[index][value]
اختياري string
الرابط الذي سيتم توجيه المستخدم إليه.
rotation[index][value]
اختياري string
الرابط الذي سيتم توجيه المستخدم إليه.
حذف

نقطة نهاية API:

DELETE 
https://297.avascript.net/api/v1/links/{id}

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

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