GetQR API في مرحلة تجريبية (beta) ومتاحة لمساحات عمل مختارة. قد تتغير التفاصيل قبل الإصدار العام.
قبل أن تبدأ
- يجب أن تكون مالك مساحة العمل أو Editor. لا يمكن لمستخدمي Viewer إنشاء مفتاح API أو استخدامه.
- يجب أن يكون لدى مالك مساحة العمل اشتراك نشط.
إنشاء مفتاح API
1
افتح إعدادات حسابك
افتح إعدادات حسابك وانتقل إلى API.
2
أنشئ المفتاح
انقر على Generate API key.
3
انسخ المفتاح
اعرض المفتاح وانسخه. تبدأ المفاتيح بـ
sk_live_.مصادقة الطلبات
أرسل المفتاح كرمز Bearer في الترويسةAuthorization لكل طلب:
فحص الحالة هو نقطة النهاية الوحيدة التي تعمل دون مفتاح.
الوصول والأدوار
- الأدوار. لا يمكن إنشاء مفتاح API واستخدامه إلا لمالك مساحة العمل ومستخدمي Editor. لا يمكن ذلك لمستخدمي Viewer.
- مساحة العمل. ينتمي كل مفتاح إلى مساحة عمل واحدة، ويُنفَّذ كل طلب في مساحة العمل تلك. لا تحتاج إلى تمرير معرّف مساحة العمل.
- فحوصات فورية. يُتحقق من الوصول في كل طلب وفق دورك الحالي واشتراك مالك مساحة العمل. لا يُحتسب اشتراكك الشخصي. إذا تغيّر دورك إلى Viewer أو انتهى اشتراك المالك، تُرجع الطلبات
403حتى يُستعاد الوصول. لا تحتاج إلى مفتاح جديد. - الإزالة. إذا أُزلت من مساحة العمل، يُحذف مفتاح API الخاص بك. إذا أُضفت مرة أخرى، فأنشئ مفتاحًا جديدًا.
إعادة إنشاء المفتاح
أعد إنشاء المفتاح إذا تسرّب أو وصل إليه شخص لا ينبغي أن يملكه.1
انقر على Regenerate
في إعدادات حسابك، انتقل إلى API وانقر على Regenerate.
2
أكّد
انقر على Regenerate key.
3
حدّث تطبيقاتك
انسخ المفتاح الجديد واستبدل به القديم في كل مكان تستخدمه فيه.
حافظ على أمان مفتاحك
تعامل مع المفتاح ككلمة مرور: يستطيع أي شخص يملكه إنشاء رموز QR وتغييرها وحذفها في مساحة عملك.- احفظه في متغير بيئة أو في مدير أسرار، وليس في الشيفرة المصدرية.
- استدعِ الواجهة من خادمك فقط. لا تضع المفتاح أبدًا في موقع ويب أو تطبيق جوال أو أي شيء آخر يمكن للمستخدمين فحصه.
- شاركه فقط مع المطورين الذين يحتاجون إليه.
- أعد إنشاءه فور اشتباهك في تسرّبه.
المشكلات الشائعة
أحصل على 401 بمفتاح كان يعمل من قبل
أحصل على 401 بمفتاح كان يعمل من قبل
أُعيد إنشاء المفتاح، أو أُزلت من مساحة العمل فحُذف المفتاح. انسخ المفتاح الحالي من إعدادات حسابك، أو أنشئ مفتاحًا جديدًا.
أحصل على 403 في كل طلب
أحصل على 403 في كل طلب
تحقّق من أن دورك هو المالك أو Editor، وأن اشتراك مالك مساحة العمل نشط. يعمل المفتاح مجددًا بمجرد استعادة الوصول.
أحصل على 404 "This endpoint is not available."
أحصل على 404 "This endpoint is not available."
الواجهة في مرحلة تجريبية ولم تُفعَّل لمساحة عملك بعد.
لا أرى إعدادات API
لا أرى إعدادات API
تظهر فقط لمالك مساحة العمل ومستخدمي Editor، وفقط في مساحات العمل التي فُعِّلت فيها الواجهة.