Link to this sectionمفاتيح API#

تتيح مفاتيح API الخاصة بـ Ultralytics Platform وصولاً برمجياً آمناً للتدريب عن بُعد، والاستنتاج، والأتمتة. يمكنك إنشاء مفاتيح مسمّاة بتشفير AES-256-GCM لحالات استخدام مختلفة.

Link to this sectionإنشاء مفتاح API#

إنشاء مفتاح API جديد:

1. اذهب إلى الإعدادات > مفاتيح API
2. انقر على إنشاء مفتاح (Create Key)
3. أدخل اسماً للمفتاح (على سبيل المثال، "خادم التدريب")
4. انقر على إنشاء مفتاح (Create Key)

Link to this sectionاسم المفتاح#

امنح مفتاحك اسماً وصفياً:

• training-server - لأجهزة التدريب عن بُعد
• ci-pipeline - لتكامل CI/CD
• local-dev - للتطوير المحلي

Link to this sectionعرض المفتاح#

بعد الإنشاء، يتم عرض المفتاح مرة واحدة فقط:

Link to this sectionتنسيق المفتاح#

تتبع مفاتيح API هذا التنسيق:

• البادئة (Prefix): ul_ تُحدد مفاتيح Ultralytics
• الجسم (Body): 40 حرفاً ست عشرياً عشوائياً
• الإجمالي: 43 حرفاً

Link to this sectionأمان المفتاح#

• يتم تخزين المفاتيح باستخدام تشفير AES-256-GCM
• تستخدم عملية المصادقة تجزئة SHA-256 للبحث السريع والمفهرس
• لا يتم تخزين قيم المفاتيح الكاملة كنص عادي أبداً

Link to this sectionاستخدام مفاتيح API#

Link to this sectionمتغير البيئة#

قم بتعيين مفتاحك كمتغير بيئة:

export ULTRALYTICS_API_KEY="YOUR_API_KEY"

Link to this sectionYOLO CLI#

قم بتعيين المفتاح باستخدام YOLO CLI:

yolo settings api_key="YOUR_API_KEY"

Link to this sectionفي الكود#

استخدم المفتاح في نصوص Python البرمجية الخاصة بك:

import os

# From environment (recommended)
api_key = os.environ.get("ULTRALYTICS_API_KEY")

# Or directly (not recommended for production)
api_key = "YOUR_API_KEY"

Link to this sectionرؤوس HTTP#

أدرج المفتاح في طلبات API:

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://platform.ultralytics.com/api/...

راجع مرجع REST API للحصول على كافة نقاط النهاية المتاحة.

Link to this sectionالتدريب عن بُعد#

قم بتمكين بث المقاييس باستخدام مفتاحك.

pip install "ultralytics>=8.4.60"

export ULTRALYTICS_API_KEY="YOUR_API_KEY"
yolo train model=yolo26n.pt data=coco.yaml project=username/project name=exp1

راجع التدريب السحابي للحصول على دليل التدريب عن بُعد الكامل.

Link to this sectionإدارة المفاتيح#

Link to this sectionعرض المفاتيح#

All keys are listed on the Settings > API Keys tab:

تُظهر بطاقة كل مفتاح اسم المفتاح، وقيمة المفتاح الكاملة والمفككة (قابلة للنسخ)، ووقت الإنشاء النسبي، وزر للإلغاء.

Link to this sectionإلغاء المفتاح#

إلغاء مفتاح تم اختراقه أو لم تعد بحاجة إليه:

1. اعثر على المفتاح في قسم مفاتيح API
2. انقر على زر إلغاء (Revoke) (سلة المهملات)
3. تأكيد الإلغاء

Link to this sectionإعادة إنشاء المفتاح#

إذا تم اختراق مفتاح ما:

1. أنشئ مفتاحاً جديداً بنفس الاسم
2. قم بتحديث تطبيقاتك
3. ألغِ المفتاح القديم

Link to this sectionمفاتيح API لمساحة العمل#

ترتبط مفاتيح API بمساحة العمل النشطة حالياً:

• مساحة العمل الشخصية: تعمل المفاتيح للمصادقة كحسابك الشخصي
• مساحة عمل الفريق: تعمل المفاتيح للمصادقة ضمن سياق الفريق

عند التبديل بين مساحات العمل في الشريط الجانبي، يعرض قسم مفاتيح API المفاتيح الخاصة بمساحة العمل تلك. يلزم وجود دور "محرر" أو أعلى لإدارة مفاتيح API لمساحة العمل. راجع الفرق للحصول على تفاصيل الأدوار.

Link to this sectionأفضل ممارسات الأمان#

Link to this sectionافعل#

• قم بتخزين المفاتيح في متغيرات البيئة
• استخدم مفاتيح منفصلة لبيئات مختلفة
• قم بإلغاء المفاتيح غير المستخدمة على الفور
• قم بتدوير المفاتيح بشكل دوري
• استخدم أسماء وصفية لتحديد أغراض المفاتيح

Link to this sectionلا تفعل#

• لا تقم برفع المفاتيح إلى نظام التحكم في الإصدار
• لا تشارك المفاتيح بين التطبيقات
• لا تسجل المفاتيح في مخرجات التطبيق
• لا تضمن المفاتيح في كود جانب العميل

Link to this sectionتدوير المفتاح#

قم بتدوير المفاتيح بشكل دوري لأغراض أمنية:

1. أنشئ مفتاحاً جديداً بنفس الاسم
2. حدث التطبيقات لاستخدام المفتاح الجديد
3. تحقق من عمل التطبيقات بشكل صحيح
4. ألغِ المفتاح القديم

Link to this sectionاستكشاف الأخطاء وإصلاحها#

Link to this sectionخطأ مفتاح غير صالح#

الحلول:

1. تحقق من نسخ المفتاح بشكل صحيح (بما في ذلك البادئة ul_)
2. تأكد من أن المفتاح لم يتم إلغاؤه
3. تأكد من تعيين متغير البيئة
4. تأكد من أنك تستخدم ultralytics>=8.4.60

Link to this sectionتم رفض الإذن#

الحلول:

1. تحقق من أنك مالك المورد أو لديك صلاحية وصول مناسبة لمساحة العمل
2. تأكد من أن المفتاح ينتمي إلى مساحة العمل الصحيحة
3. أنشئ مفتاحاً جديداً إذا لزم الأمر

Link to this sectionمعدل الاستخدام محدود#

الحلول:

1. قلل من تكرار الطلبات — راجع جدول حدود المعدل لمعرفة الحدود الخاصة بكل نقطة نهاية
2. قم بتنفيذ التراجع الأسي (exponential backoff) باستخدام رأس Retry-After
3. استخدم نقطة نهاية مخصصة للحصول على إنتاجية استنتاج غير محدودة

Link to this sectionالأسئلة الشائعة#

Link to this sectionكم عدد المفاتيح التي يمكنني إنشاؤها؟#

لا يوجد حد صارم لعدد مفاتيح API. يمكنك إنشاء العدد الذي تحتاجه للتطبيقات والبيئات المختلفة.

Link to this sectionهل تنتهي صلاحية المفاتيح؟#

لا تنتهي صلاحية المفاتيح تلقائياً. تظل صالحة حتى يتم إلغاؤها. فكر في تنفيذ التدوير لأغراض أمنية.

Link to this sectionهل يمكنني رؤية مفتاحي بعد الإنشاء؟#

Yes, full key values are visible in the key list on Settings > API Keys. The Platform decrypts and displays your keys so you can copy them anytime.

Link to this sectionهل المفاتيح خاصة بمنطقة جغرافية معينة؟#

تعمل المفاتيح عبر المناطق الجغرافية، لكنها تصل فقط إلى البيانات الموجودة في منطقة حسابك.

Link to this sectionهل يمكنني مشاركة مفاتيح API مع أعضاء الفريق؟#

الممارسة الأفضل: اجعل كل عضو في الفريق ينشئ مفتاحه الخاص. بالنسبة لمساحات عمل الفريق، يمكن لكل عضو لديه دور محرر (Editor) أو أعلى إنشاء مفاتيح مخصصة لنطاق مساحة العمل تلك.