روابط

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

نقطة نهاية API:

GET 
https://kilo.site/api/v1/links

طلب مثال: 

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

نقطة نهاية API:

GET 
https://kilo.site/api/v1/links/{id}

طلب مثال: 

curl --location --request GET 'https://kilo.site/api/v1/links/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
متجر

نقطة نهاية API:

POST 
https://kilo.site/api/v1/links

طلب مثال: 

curl --location --request POST 'https://kilo.site/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.
privacy
اختياري integer
ما إذا كانت إحصائيات الارتباط عامة أم لا. القيم الممكنة هي: :قيمة لـ عام, :قيمة لـ خاص, :قيمة لـ كلمة المرور. الإعدادات الافتراضية إلى: 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
نوع الاستهداف. القيم الممكنة هي: :قيمة لـ لا أحد, :قيمة لـ جغرافية, :قيمة لـ منصة, :قيمة لـ دوران.
country[index][key]
اختياري string
رمز الدولة المستهدفة. يجب أن يكون الرمز في: المعيار القياسي.
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
رمز اللغة المستهدفة. يجب أن يكون الرمز في: المعيار القياسي.
language[index][value]
اختياري string
الرابط الذي سيتم إعادة توجيه المستخدم إليه.
rotation[index][value]
اختياري string
الرابط الذي سيتم إعادة توجيه المستخدم إليه.
تحديث

نقطة نهاية API:

PUT PATCH 
https://kilo.site/api/v1/links/{id}

طلب مثال: 

curl --location --request PUT 'https://kilo.site/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
سواء تم تعطيل الرابط أم لا. القيم الممكنة هي: :قيمة لـ نشيط, :قيمة لـ تعطيل.
privacy
اختياري integer
ما إذا كانت إحصائيات الارتباط عامة أم لا. القيم الممكنة هي: :قيمة لـ عام, :قيمة لـ خاص, :قيمة لـ كلمة المرور.
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
نوع الاستهداف. القيم الممكنة هي: :قيمة لـ لا أحد, :قيمة لـ جغرافية, :قيمة لـ منصة, :قيمة لـ دوران.
country[index][key]
اختياري string
رمز الدولة المستهدفة. يجب أن يكون الرمز في: المعيار القياسي.
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
رمز اللغة المستهدفة. يجب أن يكون الرمز في: المعيار القياسي.
language[index][value]
اختياري string
الرابط الذي سيتم إعادة توجيه المستخدم إليه.
rotation[index][value]
اختياري string
الرابط الذي سيتم إعادة توجيه المستخدم إليه.
حذف

نقطة نهاية API:

DELETE 
https://kilo.site/api/v1/links/{id}

طلب مثال: 

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