مفاتيح API
تتيح مفاتيح واجهة برمجة التطبيقات (API) Ultralytics الوصول الآمن للبرمجة من أجل التدريب عن بُعد والاستدلال والأتمتة. قم بإنشاء مفاتيح محددة النطاق مع أذونات محددة لحالات الاستخدام المختلفة.
إنشاء مفتاح API
إنشاء مفتاح API جديد:
- انتقل إلى الإعدادات > مفاتيح API
- انقر فوق " إنشاء مفتاح"
- أدخل اسمًا للمفتاح
- تحديد نطاقات الأذونات
- انقر فوق " إنشاء"
اسم المفتاح
أعط مفتاحك اسمًا وصفياً:
training-server- لأجهزة التدريب عن بعدci-pipeline- لتكامل CI/CDmobile-app- للتطبيقات المحمولة
نطاقات الأذونات
حدد النطاقات لتقييد أذونات المفاتيح:
| النطاق | الأذونات |
|---|---|
| تدريب | ابدأ التدريب، قم بتدفق المقاييس |
| النماذج | تحميل، تنزيل، حذف النماذج |
| مجموعات البيانات | الوصول إلى مجموعات البيانات وتعديلها |
| اقرأ | وصول للقراءة فقط إلى جميع الموارد |
| اكتب | حق الوصول الكامل للكتابة |
| المسؤول | إدارة الحساب (استخدم بحذر) |
أقل امتياز
قم بإنشاء مفاتيح تحتوي على الأذونات المطلوبة فقط. استخدم مفاتيح منفصلة للتطبيقات المختلفة.
عرض المفاتيح
بعد الإنشاء، يتم عرض المفتاح مرة واحدة:
انسخ مفتاحك
يتم عرض المفتاح الكامل مرة واحدة فقط. انسخه على الفور واحفظه في مكان آمن. لا يمكنك استعادته لاحقًا.
تنسيق المفاتيح
تتبع مفاتيح API هذا التنسيق:
ul_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0
- البادئة:
ul_يحدد Ultralytics - الجسم: 40 حرفًا عشريًا عشوائيًا
- المجموع: 43 حرفًا
استخدام مفاتيح API
متغير البيئة
اضبط مفتاحك كمتغير بيئي:
export ULTRALYTICS_API_KEY="ul_your_key_here"
$env:ULTRALYTICS_API_KEY = "ul_your_key_here"
في الكود
استخدم المفتاح في Python الخاصة بك:
import os
# From environment (recommended)
api_key = os.environ.get("ULTRALYTICS_API_KEY")
# Or directly (not recommended for production)
api_key = "ul_your_key_here"
رؤوس HTTP
قم بتضمين المفتاح في طلبات API:
curl -H "Authorization: Bearer ul_your_key_here" \
https://platform.ultralytics.com/api/...
التدريب عن بعد
قم بتمكين تدفق المقاييس باستخدام مفتاحك.
متطلبات إصدار الحزمة
يتطلب تكامل المنصة ultralytics>=8.4.0. الإصدارات الأقدم لن تعمل مع المنصة.
pip install "ultralytics>=8.4.0"
export ULTRALYTICS_API_KEY="ul_your_key_here"
yolo train model=yolo11n.pt data=coco.yaml project=username/project name=exp1
إدارة المفاتيح
عرض المفاتيح
جميع المفاتيح مدرجة في الإعدادات > مفاتيح API:
| عمود | الوصف |
|---|---|
| الاسم | المعرف الرئيسي |
| النطاقات | الأذونات المخصصة |
| تم إنشاؤه | تاريخ الإنشاء |
| آخر استخدام | أحدث استخدام |
إلغاء المفتاح
إلغاء مفتاح تم اختراقه أو لم يعد ضروريًا:
- انقر على قائمة المفاتيح
- اختر " إلغاء"
- تأكيد الإلغاء
تأثير فوري
الإلغاء فوري. ستتوقف أي تطبيقات تستخدم المفتاح عن العمل.
إعادة إنشاء المفتاح
إذا تعرض مفتاح للخطر:
- إنشاء مفتاح جديد بنفس النطاقات
- قم بتحديث تطبيقاتك
- إلغاء المفتاح القديم
أفضل الممارسات الأمنية
افعل
- تخزين المفاتيح في متغيرات البيئة
- استخدم مفاتيح منفصلة لبيئات مختلفة
- إلغاء المفاتيح غير المستخدمة على الفور
- استخدم الحد الأدنى المطلوب من النطاقات
- تناوب المفاتيح بشكل دوري
لا
- تسجيل المفاتيح في التحكم في الإصدار
- مشاركة المفاتيح بين التطبيقات
- استخدام نطاق المسؤول دون داعٍ
- تسجيل المفاتيح في مخرجات التطبيق
- تضمين المفاتيح في كود جانب العميل
تناوب المفاتيح
قم بتبديل المفاتيح بشكل دوري لأغراض أمنية:
- إنشاء مفتاح جديد بنفس النطاقات
- تحديث التطبيقات لاستخدام المفتاح الجديد
- التحقق من عمل التطبيقات بشكل صحيح
- إلغاء المفتاح القديم
جدول التناوب
ضع في اعتبارك تبديل المفاتيح كل 90 يومًا للتطبيقات الحساسة.
استكشاف الأخطاء وإصلاحها
خطأ مفتاح غير صالح
Error: Invalid API key
الحلول:
- تحقق من نسخ المفتاح بشكل صحيح
- تحقق من أن المفتاح لم يتم إلغاؤه
- تأكد من أن المفتاح يحتوي على النطاقات المطلوبة
- تأكد من تعيين متغير البيئة
رفض الإذن
Error: Permission denied for this operation
الحلول:
- تحقق من نطاقات المفاتيح بما في ذلك الأذونات المطلوبة
- تحقق من أنك مالك المورد
- إنشاء مفتاح جديد بنطاقات صحيحة
معدل محدود
Error: Rate limit exceeded
الحلول:
- تقليل تكرار الطلبات
- تنفيذ التراجع الأسي
- اتصل بالدعم لزيادة الحد
الأسئلة الشائعة
كم عدد المفاتيح التي يمكنني إنشاؤها؟
لا يوجد حد أقصى لعدد مفاتيح API. يمكنك إنشاء العدد الذي تحتاجه لتطبيقات وبيئات مختلفة.
هل تنتهي صلاحية المفاتيح؟
المفاتيح لا تنتهي صلاحيتها تلقائيًا. تظل صالحة حتى يتم إلغاؤها. ضع في اعتبارك تنفيذ التناوب من أجل الأمان.
هل يمكنني رؤية مفتاحي بعد إنشائه؟
لا، يتم عرض المفتاح الكامل مرة واحدة فقط عند إنشائه. في حالة فقدانه، قم بإنشاء مفتاح جديد وإلغاء المفتاح القديم.
هل المفاتيح خاصة بكل منطقة؟
تعمل المفاتيح في جميع المناطق، ولكنها تتيح الوصول إلى البيانات في منطقة حسابك فقط.
هل يمكنني مشاركة المفاتيح مع أعضاء الفريق؟
الممارسة الأفضل: اجعل كل عضو في الفريق ينشئ مفتاحه الخاص. وهذا يتيح:
- تتبع النشاط الفردي
- الإلغاء الانتقائي
- التحكم السليم في الوصول