تخطَّ إلى المحتوى

المصادقة ومفاتيح واجهة برمجة التطبيقات

أنشئ مفتاح واجهة برمجة تطبيقات sk_ في مركز API . يُعرض المفتاح الكامل مرة واحدة فقط، عند إنشائه أو تدويره.

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

موصى به:

X-API-Key: sk_your_key

يعمل النموذج القياسي Bearer أيضًا:

Authorization: Bearer sk_your_key

أرسل واحدًا فقط من الاثنين في الطلب.

Terminal window
curl https://omnidoc.top/api/v1/jobs \
-H "X-API-Key: $OMNIDOC_API_KEY"

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

حدود اختيارية:

  • allowed_engines: فقط إعدادات الترجمة المدرجة؛ فإن كانت المصفوفة فارغة، فلا يُضاف أي حد على مستوى المفتاح.
  • expires_at: وقت الانتهاء.
  • quota_limit: ميزانية عمر المفتاح بالميليكريدات الكاملة؛ 0 لا يحدد أي ميزانية على مستوى المفتاح، ويتم تسوية رصيد الحساب كالمعتاد.

إنشاء المفاتيح، وتغيير حدودها، وتدويرها أو إلغاؤها في مركز واجهة برمجة التطبيقات . بمجرد إلغاء مفتاح أو تعطيله أو انتهاء صلاحيته، أو تعطيل حسابه، تفشل الطلبات الجديدة فورًا.

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

  • احتفظ بالمفاتيح فقط على الخادم أو في بيئة تشغيل خاضعة للرقابة.
  • استخدم متغيرات البيئة أو مدير الأسرار؛ ولا تضع المفاتيح أبدًا في كود المصدر، أو السجلات، أو حزم المتصفح، أو المستودعات العامة.
  • لا ترسل مطلقًا المفتاح إلى عناوين الرفع أو التنزيل التي تُرجعها واجهة برمجة التطبيقات.
  • سجّل معرّف المفتاح ومعرّف الطلب ومعرّف العملية؛ ولا تسجّل المفتاح الكامل أبداً.
  • إذا تسرب مفتاح، قم بتدويره فورًا وراجع وظائفه ورسومه.