واجهات API والتكاملات
اربط تطبيقاً باستخدام Inference API الموثقة أو API لتدريب النماذج، وبيانات اعتماد محددة الصلاحيات، ومراجع الاستخدام وAPI الحالية.
- اختيار منتج APIميّز بين طلبات الاستدلال ومسارات تدريب النماذج.
- قراءة العقداستخدم وثائق API ومرجع OpenAPI المناسبين.
- إنشاء مفتاح محدود الصلاحياتأنشئ مفتاح API للعميل واحفظه بأمان.
- الدمج والتحققأرسل طلباً موثقاً وافحص الاستجابة.
- المراقبة والتدويرراجع الاستخدام وألغِ المفاتيح أو دوّرها عند الحاجة.
اختيار مسار API المناسب
تخدم Inference API طلبات استدلال النماذج، بينما توثق API تدريب النماذج مساراً منفصلاً للتدريب يشمل عروض الأسعار والمهام والجلسات والعناصر الناتجة. لا تفترض أن نقطة نهاية الاستدلال تبدأ التدريب أو أن عملية التدريب متاحة عبر عقد الاستدلال. اقرأ وثائق المنتج الذي تريد استخدامه وتأكد من إدراج النموذج أو إمكانية التدريب. التزم ببنية الطلب والاستجابة المنشورة بدلاً من استنتاج أسماء الطرق من SDK مألوف لطرف ثالث.
- حدّد ما إذا كان التطبيق يحتاج إلى الاستدلال أم تدريب النماذج.
- افتح وثائق المنتج ومرجع API المطابقين.
- تحقق من توثيق الإمكانية والنموذج المطلوبين.
إنشاء مفتاح API وحمايته
أنشئ مفتاح API للعميل من صفحة المفاتيح بعد المصادقة، واختر النطاقات التي يتطلبها تكاملك فقط عندما تتيح الواجهة اختيارها. لا يُعرض السر إلا مرة واحدة؛ خزّنه مباشرة في مدير أسرار معتمد، ولا تودعه في التحكم بالمصدر أو تلصقه في السجلات أو تكشفه في شيفرة المتصفح. سمِّ بيانات الاعتماد بحسب التطبيق والبيئة متى أمكن. استخدم بيانات منفصلة للتطوير والإنتاج كي تتمكن من إلغاء أحدها دون تعطيل تكاملات أخرى.
- افتح مفاتيح API من مساحة عمل العملاء بعد تسجيل الدخول.
- أنشئ مفتاحاً بأضيق نطاق مطلوب.
- احفظ السر بأمان وأبعده عن الشيفرة المصدرية والسجلات.
التنفيذ وفق العقد الموثق
اتبع دليل API المناسب للمصادقة ونقطة النهاية وحقول الطلب ومعالجة الاستجابة والأخطاء. احتفظ ببيانات اعتماد الخدمة على خادم موثوق، لا في شيفرة عميل عامة. تحقّق من المدخلات قبل الإرسال، وعالج الاستجابات غير الناجحة صراحة، وتجنب تسجيل ترويسات التفويض أو بيانات المطالبات الحساسة. استخدم مرجع OpenAPI عند الحاجة إلى العقد المنشور بصيغة قابلة للقراءة الآلية. لا تستنتج دعماً للبث أو الوسائط أو عمليات خاصة بموفر الخدمة ما لم تذكرها الوثائق الحالية صراحة.
- نفّذ العمليات والحقول الموثقة للـAPI المختارة فقط.
- أبقِ بيانات الاعتماد على الخادم واحجبها في بيانات التشخيص.
- عالج الأخطاء الموثقة واحتفظ بمعرّفات الطلب عند إتاحتها.
مراقبة الاستخدام وإدارة بيانات الاعتماد
بعد الدمج، راجع صفحة الاستخدام لفهم النشاط المرتبط بحسابك وقارنه بسجلات تطبيقك. تحرّ عن التغييرات غير المتوقعة قبل زيادة الحركة أو إنشاء بيانات اعتماد إضافية. إذا احتمل انكشاف مفتاح، فدوّره ثم حدّث مخزن أسرار التطبيق وتحقق من التكامل قبل إزالة أي بيانات اعتماد قديمة أخرى. ألغِ المفاتيح التي لم تعد مطلوبة. تساعد بيانات الاستخدام في مراجعة العمليات، لكنها لا تضمن الرسوم أو السعة مستقبلاً.
- قارن استخدام المنصة بسجلات طلبات التطبيق.
- دوّر بيانات الاعتماد المكشوفة وتحقق من البديل.
- ألغِ المفاتيح غير المستخدمة وراجع الوصول دورياً.
الأسئلة الشائعة
هل الاستدلال وتدريب النماذج هما API واحد؟
لا. هما منتجان منفصلان ولكل منهما مسار موثق مختلف. اتبع المرجع الخاص بالإمكانية التي تحتاجها.
أين أجد عقد API المدعوم؟
استخدم وثائق المنتج ومرجع OpenAPI المرتبطين بهذا الدليل؛ فهما يصفان الواجهة المنشورة حالياً.
أين أحفظ سر API؟
استخدم مدير أسرار آمن على الخادم. لا تودعه أبداً في مستودع أو تكشفه في شيفرة المتصفح أو السجلات.
ماذا أفعل إذا انكشف مفتاح؟
دوّره أو ألغِه من صفحة مفاتيح API، واستبدله في مخزن أسرار التطبيق، وراجع الاستخدام الحديث بحثاً عن نشاط غير متوقع.