التوثيق / البدء
مفاتيح الواجهة
أنشئ المفاتيح التي توثّق استدعاءاتك إلى Gurdx، وحدّد نطاقها، وبدّلها، واحمِها.
المفاتيح الفعلية والتجريبية#
| المفتاح | البادئة | الاستخدام |
|---|---|---|
| فعلي | gx_live_ |
حركة الإنتاج. يُحتسب من الحصة ويمكن أن يولّد أحداثاً. |
| تجريبي | gx_test_ |
التطوير والتكامل المستمر. مجاني، بيانات وهمية سليمة الشكل، ولا يولّد أحداثاً. |
يمكنك امتلاك عدة مفاتيح للحساب الواحد، مثلاً مفتاح لكل تطبيق أو بيئة، حتى لا يجبرك تسرّب في مكان واحد على تغيير كل شيء. راجع بيئة التطوير.
إنشاء مفتاح#
- سجّل الدخول إلى لوحة التحكم على https://gurdx.cretip.com/app.
- افتح صفحة مفاتيح الواجهة وأنشئ مفتاحاً، واختر فعلياً أو تجريبياً.
- انسخه فوراً واحفظه في مدير أسرار أو متغير بيئة.
استخدم المفتاح كما في المصادقة.
المضيفون المصرّح لهم#
يمكنك حصر حسابك في قائمة مضيفين. حين لا تكون القائمة فارغة يُقبل الطلب فقط إذا:
- كان مضيف الترويسة
OriginأوRefererضمن القائمة، أو - كان عنوان IP للمتصل ضمن القائمة.
وإلا أعادت الواجهة الخطأ 113 domain_not_whitelisted. طلبات الخوادم لا تحمل عادةً Origin، لذا أدرج عناوين IP لخوادمك. والقائمة الفارغة تسمح بكل شيء.
| السيناريو | القائمة |
|---|---|
| خادم خلفي بعناوين ثابتة | عناوين IP للخوادم |
| استدعاءات من المتصفح بمفتاح تجريبي | نطاق الموقع |
حماية مفتاحك#
Warning: من يملك مفتاحاً فعلياً يستطيع استهلاك حصتك وقراءة بياناتك. عامله كأنه كلمة مرور.
- لا تضمّن مفتاحاً فعلياً في جافاسكربت أو تطبيقات الجوال أو HTML. استدعِ Gurdx من خادمك الخلفي.
- لا ترفع المفاتيح إلى Git. استخدم ملفات
.envالمتجاهَلة أو مدير أسرار. - فضّل ترويسة
Authorization: Bearerعلى?key=ليبقى المفتاح خارج السجلات وترويسات الإحالة. - استخدم مفاتيح منفصلة لكل بيئة ولكل خدمة.
- قيّد المضيفين المصرّح لهم كلما كان مصدر حركتك معروفاً.
تدوير المفتاح#
دوّر المفتاح وفق جدول، أو عند مغادرة أحد أعضاء الفريق، أو فور الاشتباه بتسرّب:
- أنشئ مفتاحاً جديداً.
- انشره في تطبيقاتك.
- تأكد من لوحة التحكم أن وقت آخر استخدام للمفتاح القديم لم يعد يتقدّم.
- احذف المفتاح القديم.
الطلبات بمفتاح محذوف تعيد الخطأ 101 invalid_key.
إذا تسرّب مفتاح#
احذفه فوراً وأنشئ بديلاً وراجع الاستخدام الأخير في لوحة التحكم بحثاً عن حركة غير متوقعة. حد الإغراق (الخطأ 106) والحصة (الخطأ 103) يحدّان الضرر لكن لا تعتمد عليهما.
أخطاء شائعة#
| الخطأ | السبب |
|---|---|
| 101 | مفتاح مفقود أو مكتوب خطأ أو محذوف |
| 102 | الحساب غير فعّال |
| 113 | المضيف أو عنوان IP ليس ضمن المصرّح لهم |
| 127 | لا تجربة ولا اشتراك فعّال |
القائمة الكاملة في رموز الأخطاء.
وجدت خطأ؟ أخبرنا عبر صفحة التواصل. تواصل معنا