تخطي إلى المحتوى

مفاتيح API

تتيح مفاتيح API الخاصة بمنصة Ultralytics Platform وصولاً برمجيًا آمنًا للتدريب عن بُعد، والاستدلال، والأتمتة. أنشئ مفاتيح ذات نطاق محدد بصلاحيات معينة لحالات استخدام مختلفة.

إنشاء مفتاح API

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

  1. انتقل إلى الإعدادات > مفاتيح API
  2. انقر على إنشاء مفتاح
  3. أدخل اسمًا للمفتاح
  4. حدد نطاقات الصلاحيات
  5. انقر على إنشاء

اسم المفتاح

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

  • training-server - لآلات التدريب عن بُعد
  • ci-pipeline - لتكامل CI/CD
  • mobile-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=yolo26n.pt data=coco.yaml project=username/project name=exp1

إدارة المفاتيح

عرض المفاتيح

تُدرج جميع المفاتيح في الإعدادات > مفاتيح الـ API:

العمودالوصف
الاسممعرّف المفتاح
النطاقاتالصلاحيات المخصصة
الإنشاءتاريخ الإنشاء
آخر استخدامأحدث استخدام

إبطال المفتاح

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

  1. انقر على قائمة المفتاح
  2. اختر إلغاء
  3. تأكيد الإلغاء

تأثير فوري

الإلغاء فوري. ستتوقف أي تطبيقات تستخدم المفتاح عن العمل.

إعادة إنشاء المفتاح

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

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

أفضل ممارسات الأمان

افعل

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

لا تفعل

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

تدوير المفاتيح

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

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

جدول التدوير

ينصح بتدوير المفاتيح كل 90 يومًا للتطبيقات الحساسة.

استكشاف الأخطاء وإصلاحها

خطأ: مفتاح غير صالح

Error: Invalid API key

الحلول:

  1. تحقق من نسخ المفتاح بشكل صحيح
  2. تأكد من عدم إلغاء المفتاح
  3. تأكد من أن المفتاح يمتلك النطاقات المطلوبة
  4. تأكد من تعيين متغير البيئة

تم رفض الإذن

Error: Permission denied for this operation

الحلول:

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

محدود المعدل

Error: Rate limit exceeded

الحلول:

  1. قلل من تكرار الطلبات
  2. طبق التراجع الأسي (exponential backoff)
  3. اتصل بالدعم لزيادة الحد

الأسئلة الشائعة

كم عدد المفاتيح التي يمكنني إنشاؤها؟

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

هل تنتهي صلاحية المفاتيح؟

لا تنتهي صلاحية المفاتيح تلقائيًا. تظل صالحة حتى يتم إبطالها. فكر في تطبيق التدوير للأمان.

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

لا، يتم عرض المفتاح الكامل مرة واحدة فقط عند الإنشاء. إذا فُقد، أنشئ مفتاحًا جديدًا وابطِل المفتاح القديم.

هل المفاتيح خاصة بمنطقة معينة؟

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

هل يمكنني مشاركة المفاتيح مع أعضاء الفريق؟

ممارسة أفضل: اجعل كل عضو في الفريق ينشئ مفتاحه الخاص. هذا يتيح:

  • تتبع النشاط الفردي
  • الإلغاء الانتقائي
  • التحكم السليم في الوصول


📅 تم الإنشاء قبل 20 أيام ✏️ تم التحديث قبل 19 أيام
Laughing-qglenn-jocher

تعليقات