مفاتيح API — IngevoraMirage

مفاتيح APIيتيح مفتاح API لخادمك جلب عدسات الوجه وتأثيرات الشاشة المنشورة في مساحة عملك من واجهة التسليم (delivery API). وهو بيانات الاعتماد الوحيدة التي تقبلها واجهة التسليم.من يستطيع إدارة المفاتيحالمالكون (Owner) والمطوّرون (Developer). لا يرى المصمّمون (Designer) صفحة API keys (مفاتيح API)؛ فاطلب مفتاحًا من Owner أو Developer.إنشاء مفتاح

افتح API keys ضمن Workspace في قائمة التنقل.

اكتب في New key name اسمًا يدل على مكان استخدام المفتاح، مثل "production server" أو "staging server".

اختر Issue key (إصدار المفتاح).

يعرض مربع الحوار New API key المفتاح. اختر Copy، واحفظ المفتاح في مكان آمن، ثم اختر I have stored it.

تبدأ المفاتيح بـ mk_.

Important: يُعرض المفتاح مرة واحدة فقط. لا يحتفظ IngevoraMirage إلا ببصمة (hash) له، لذا لا يستطيع أحد عرضه لك مرة أخرى. إذا فقدت مفتاحًا، فألغِه وأصدِر مفتاحًا جديدًا.

استخدام مفتاحأرسل المفتاح في الترويسة X-Api-Key مع كل طلب تسليم:

http

GET /v1/lenses/8f3c2a10-… HTTP/1.1
Host: mirage-api.ingevora.com
X-Api-Key: mk_…

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

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

لا تضع المفتاح في صفحة ويب ولا في نظام إدارة الشيفرة المصدرية.

لا يحمل تطبيق iPhone مفتاحه إلا من خلال iOS SDK، وبمفتاح خاص به. وإلى أن يصدر Android SDK، أبقِ المفاتيح خارج تطبيقات Android.

مفتاح لكل تطبيقأصدِر مفتاحًا منفصلًا لكل تطبيق ولكل خادم. وبذلك لا يكلّفك التسرّب، أو الخادم الذي تتوقف عن استخدامه، إلا مفتاحًا واحدًا بينما تواصل المفاتيح الأخرى العمل. ويساعدك الاسم الواضح على التمييز بين المفاتيح.قائمة المفاتيحتعرض القائمة لكل مفتاح اسمه، وأحرفه الأولى (مثل mk_AbCdEfGh…)، وتاريخ إنشائه، وحالته: Active (نشط) أو Revoked (ملغى). ولا يُعرض المفتاح الكامل مرة أخرى أبدًا.إلغاء مفتاحألغِ المفتاح فور اشتباهك في تسرّبه، أو عندما تتوقف عن استخدامه.

اختر Revoke في صف المفتاح.

يحذّرك مربع الحوار من أن الطلبات التي تستخدم المفتاح ستتوقف عن العمل فورًا، وأنه لا يمكن التراجع عن ذلك. اختر Revoke key.

لا يمكن استخدام المفتاح الملغى مرة أخرى أبدًا، ولا سبيل إلى التراجع.استبدال مفتاح

مفتاح تسرّب: ألغِه أولًا، ثم أصدِر مفتاحًا جديدًا وضعه على خادمك. ستفشل الطلبات في الفترة الفاصلة، لكن لن يستطيع أحد آخر استخدام المفتاح القديم.

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

صفحات ذات صلة

واجهة التسليم — المسارات التي يتيحها مفتاحك.

الأخطاء والحدود — معنى 401 و403 وما يجب فعله.

مساحات العمل والأدوار — من يستطيع فعل ماذا.