المصادقة ومفاتيح الربط
Authentication & API Keys
المفاهيم الأساسية
- كل مطعم/مشروع له API Key خاص فيه.
- كل فرع له Branch ID.
- موقعك يستخدم الـ API Key ليرسل الطلبات بأمان إلى OrderGer.
- لا تكشف الـ API Key أبداً في كود الـ frontend / المتصفح.
- الطلبات يجب أن تُرسل من backend / server / API route فقط.
- المفاتيح تُنشأ من داخل مركز الربط بعد تسجيل الدخول.
- تقدر تعيد إنشاء المفتاح أو تعطّله في أي وقت.
- المفتاح يمكن أن يكون عاماً للمطعم أو مخصصاً لفرع واحد.
الـ Headers المطلوبة
Authorization: Bearer YOUR_ORDERGER_API_KEY
Content-Type: application/json
X-OrderGer-Branch-ID: YOUR_BRANCH_ID
كيف يظهر المفتاح؟
عند الضغط على "Generate new key" داخل مركز الربط، يظهر المفتاح كاملاً مرة واحدة فقط. احفظه فوراً في مكان آمن. بعد ذلك يُحفظ مهشّراً في قواعد بياناتنا ولن يظهر مرة أخرى. إذا فقدته، أنشئ مفتاحاً جديداً وعطّل القديم.
أمان: Treat your API Key like a password. لا ترفعه على Git، لا تكتبه في كود JavaScript يعمل في المتصفح، ولا تشاركه في القنوات العامة.
Sandbox vs Live
تقدر تعلّم المفتاح كـ Test/Sandbox من مركز الربط. الطلبات التي تأتي عبر مفتاح Sandbox:
- لا تخصم من رصيدك مهما كان عددها.
- تصل التطبيق بعلامة "TEST" واضحة.
- لا تخضع لقاعدة "الرصيد الصفري".
أو يمكنك إرسال "test": true في جسم أي طلب لتمييزه كطلب تجريبي.
عرض عام لـ Public API
الـ public docs تستخدم placeholders مثل YOUR_ORDERGER_API_KEY و YOUR_BRANCH_ID. القيم الحقيقية ولا أي بيانات سرية لا تظهر إلا بعد تسجيل الدخول.