المصادقة
أنشئ مفتاح Direct API في Studio، واختر نطاقاته وحدود رصيده، وأرسله مع كل طلب.
يحمل كل طلب مفتاح API للمؤسسة كرمز حامل.
Authorization: Bearer mor_live_9f2c…ينتمي المفتاح إلى المؤسسة، لا إلى الشخص الذي أنشأه. يستطيع كل مسؤول في المؤسسة رؤيته وإلغاءه، ويستمر في العمل عندما يغادر منشئه الفريق. ويتوقف عن العمل عند إلغائه، أو عند انتهاء صلاحيته، أو عند تعليق حساب منشئه، أو عندما توقف Morphic تفعيل Direct API للمؤسسة.
إنشاء مفتاح
لا تظهر نطاقات Direct API إلا بعد أن تفعّل Morphic واجهة Direct API لمؤسستك. راجع الحصول على الوصول.
- في Morphic Studio، افتح القائمة المنسدلة للمؤسسة (شعار Morphic، أعلى اليسار) واختر 'Settings'.
- في الشريط الجانبي الأيسر، انقر على 'API keys'. لا يرى هذه العلامة إلا المسؤولون.
- انقر على 'New key'.
- أدخل 'Name'، واختر في 'Scopes' النطاقات التي يحتاجها المفتاح، وحدد في 'Expires' موعد انتهاء صلاحيته إن كان لا ينبغي أن يدوم إلى الأبد.
- ضمن 'Credit limits'، حدد الإجمالي الذي يجوز للمفتاح إنفاقه على الإطلاق، واختياريًا حدًا يوميًا وحدًا شهريًا.
- حدد خانة 'I agree to the Morphic Terms of Use, including the Developer API section'. يؤدي ذلك إلى قبول شروط الاستخدام نيابةً عن المؤسسة.
- انقر على 'Create key'، ثم انسخ السر إلى مدير الأسرار لديك. يُعرض مرة واحدة فقط.
يستطيع أي شخص يحمل السر إنفاق أرصدة مؤسستك حتى حدود المفتاح. لا تضع المفتاح أبدًا في متصفح أو تطبيق جوال أو مستودع عام.
صيغة المفتاح
mor_live_<64 hex characters>تخبرك البادئة، وتخبر أدوات فحص الأسرار، بالنشر الذي يخصه المفتاح.
النطاقات
لا يصل المفتاح إلا إلى الأدوات التي تسمح بها نطاقاته. اختر أضيق مجموعة ممكنة.
| النطاق | التسمية في Studio | يمنح |
|---|---|---|
projects:read | Read projects and their files | سرد المشاريع وسير العمل والخطوط الزمنية في Compose |
assets:read | Find and read assets | سرد المكتبة، وقراءة عمليات التوليد وحالتها، والشخصيات |
assets:write | Upload assets and edit them | تمرير الوسائط عبر عنوان URL، وإنشاء خطوط Compose الزمنية |
generations:write | Generate images, video and audio (spends credits) | كل أداة تبدأ الوسائط أو تحررها أو تحللها |
يُجاب استدعاء أداة خارج نطاقات المفتاح بـ 403 insufficient_scope، مع ذكر النطاق الناقص في data.required_scopes. ونقاط النهاية والأدوات التي لا تحتاج إلى نطاق، مثل list_voices و/me، مفتوحة لكل مفتاح. ويسرد كتالوج الأدوات النطاق الذي تحتاجه كل أداة.
حدود الرصيد
يحمل كل مفتاح سقوفًا للإنفاق تُحدَّد عند إنشائه. ويمكن للمسؤول تغييرها لاحقًا عبر 'Edit limits'.
| الحد | إلزامي | النافذة |
|---|---|---|
total_credit_limit | نعم | عمر المفتاح بالكامل |
monthly_credit_limit | لا | الشهر التقويمي بتوقيت UTC |
daily_credit_limit | لا | اليوم التقويمي بتوقيت UTC |
- يُرفض الاستدعاء المدفوع الذي سيتجاوز بالمفتاح أي حد بـ
402 api_key_credit_limit_reachedقبل أن يبدأ أي شيء؛ ويوضحdata.periodأي حد. - يُطبَّق رصيد المؤسسة نفسها فوق ذلك: الاستدعاء الذي لا يستطيع الرصيد تغطيته يُرفض بـ
402 insufficient_credits. - يعيد
GET /v1/direct/meحدود المفتاح وإنفاقه الحالي. راجع الأرصدة والاستخدام.
تدوير المفتاح
- أنشئ المفتاح الجديد.
- انشره.
- ألغِ المفتاح القديم عبر 'Revoke key'.
يجوز للمؤسسة أن تحتفظ بما يصل إلى 10 مفاتيح نشطة، لذا لا يحتاج التدوير أبدًا إلى فترة انقطاع.
إذا واجهت أي مشكلة أو كانت لديك أي أسئلة، فلا تتردد في التواصل معنا. يسعدنا مساعدتك. اكتب لنا على support@morphic.com.