مفاتيح API

تتيح مفاتيح واجهة برمجة التطبيقات (API) Ultralytics الوصول الآمن للبرمجة من أجل التدريب عن بُعد والاستدلال والأتمتة. قم بإنشاء مفاتيح مسماة بتشفير AES-256-GCM لحالات استخدام مختلفة.

إنشاء مفتاح API

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

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

اسم المفتاح

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

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

عرض المفتاح

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

تنسيق المفتاح

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

ul_a1b2c3d4e5f60718293a4b5c6d7e8f90a1b2c3d4

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

الأمن الرئيسي

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

استخدام مفاتيح API

متغير البيئة

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

export ULTRALYTICS_API_KEY="ul_your_key_here"

$env:ULTRALYTICS_API_KEY = "ul_your_key_here"

YOLO CLI

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

yolo settings 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/...

انظر REST API للاطلاع على جميع نقاط النهاية المتاحة.

التدريب عن بُعد

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

pip install "ultralytics>=8.4.14"

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

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

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

عرض المفاتيح

جميع المفاتيح مدرجة في Settings > Profile في قسم مفاتيح API:

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

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

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

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

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

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

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

مفاتيح واجهة برمجة تطبيقات مساحة العمل

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

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

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

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

افعل

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

لا تفعل

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

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

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

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

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

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

Error: Invalid API key

الحلول:

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

تم رفض الإذن

Error: Permission denied for this operation

الحلول:

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

محدود المعدل

Error: Rate limit exceeded

الحلول:

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

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

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

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

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

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

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

نعم، تظهر قيم المفاتيح الكاملة في قائمة المفاتيح على Settings > Profile. تقوم المنصة بفك تشفير مفاتيحك وعرضها حتى تتمكن من نسخها في أي وقت.

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

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

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

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

📅 تم الإنشاء قبل 1 شهر ✏️ تم التحديث قبل 4 أيام

تعليقات