المصادقة

تستخدم طلبات Fish Audio Open API مفاتيح API الحاملة. يحدد المفتاح API الحساب ونطاق الإذن والحصة وسياق الفوترة للطلب.

Authorization: Bearer FISHAUDIO_API_KEY

قم بإنشاء وإدارة مفاتيح API في حسابك:

https://fishaudio.org/en/account?section=api

قواعد الطلب

يجب أن يتضمن كل طلب Open API رأس Authorization. يجب أن تتضمن طلبات JSON أيضًا Content-Type: application/json. يجب أن تسمح نقاط النهاية متعددة الأجزاء لعميل HTTP بتعيين الحدود متعددة الأجزاء.

curl https://fishaudio.org/api/open/v1/profile \
  -H "Authorization: Bearer FISHAUDIO_API_KEY"

لا ترسل مفاتيح API من المتصفح JavaScript أو تطبيقات الهاتف المحمول أو عمليات إعادة الشراء العامة أو السجلات أو أحداث التحليلات أو رسائل الخطأ المرئية للعميل. تعامل مع مفتاح API ككلمة مرور لحساب الإنتاج الخاص بك.

API تخزين المفاتيح

قم بتخزين مفتاح API في مدير سري من جانب الخادم أو متغير بيئة مشفر. قم بتحميله عند بدء العملية وقم بتمريره فقط إلى عميل HTTP الذي يتحدث إلى Fish Audio. إذا كنت تقوم بتشغيل عمال في الخلفية، فامنح العمال نفس السر من خلال نظام النشر الخاص بك بدلاً من نسخه في حمولات الوظائف.

قم بتدوير مفاتيح API عندما يغادر أحد أعضاء الفريق، أو عندما يكون سجل البناء قد كشف سرًا، أو عندما تقوم بنقل التكامل من التدريج إلى الإنتاج. بعد التدوير، قم بنشر مفتاح API الجديد أولاً، وتحقق من حركة المرور، ثم قم بإلغاء مفتاح API القديم.

الاستجابة ومعالجة الأخطاء

تؤدي حالات فشل المصادقة إلى إرجاع أخطاء JSON عندما يصل الطلب إلى طبقة API.

قم بتسجيل requestId من استجابات الأخطاء. فهو يتيح للدعم تحديد موقع الطلب الدقيق دون مطالبتك بمشاركة مفاتيح API أو الحمولات الأولية.

الفواتير والائتمانات

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