الانتقال إلى المحتوى الرئيسي

المصادقة

أرسل مفتاح الـ API في الـ Header Authorization بصيغة Bearer مع كل طلب:

Authorization: Bearer ksr_live_3f9a...

يبدأ المفتاح بـ ksr_live_ وبعده 64 حرفاً بالنظام الست عشري (hex)، أما مفتاح الاختبار فيبدأ بـ ksr_test_ ولا يصل إلا إلى بيئة الاختبار (راجع وضع الاختبار). احفظه على السيرفر عندك فقط، لأن أي شخص يحصل عليه يستطيع التصرف باسم التاجر.

الصلاحيات​

يحدد التاجر لكل مفتاح مستوى صلاحية على كل مورد، بالصيغة resource:level:

الصلاحيةماذا تتيح
customers:readعرض قائمة العملاء وبيانات كل عميل
customers:writeكل ما سبق، بالإضافة إلى إنشاء العملاء وتعديلهم
sales_invoices:readعرض فواتير المبيعات وتحميلها بصيغة PDF و XML
sales_invoices:writeكل ما سبق، بالإضافة إلى إصدار فواتير المبيعات
payments:readعرض المدفوعات وبيانات كل دفعة
payments:writeكل ما سبق، بالإضافة إلى تسجيل المدفوعات
credit_notes:readعرض الإشعارات الدائنة وبيانات كل إشعار، مع ملفي PDF و XML
credit_notes:writeكل ما سبق، بالإضافة إلى إصدار الإشعارات الدائنة

صلاحية write تشمل read تلقائياً. إذا أرسلت طلباً لا يملك المفتاح صلاحيته، يرجع الخطأ 403 missing_permission، ويوضح الحقل requiredPermission الصلاحية المطلوبة. ستُضاف موارد أخرى مع توسّع الـ API.

الفروع​

قد يحصر التاجر المفتاح في فروع معيّنة. أي طلب يخص فرعاً خارجها يرجع بالخطأ 403 branch_not_allowed.

متى يُرفض المفتاح​

الكودالحالةالسبب
missing_api_key401الـ Header Authorization: Bearer غير موجود
invalid_api_key401صيغة المفتاح خاطئة أو المفتاح غير موجود
revoked_api_key401ألغى التاجر المفتاح
expired_api_key401انتهت صلاحية المفتاح
tenant_suspended403حساب التاجر في كسور موقوف

إعادة المحاولة لن تحل أياً من هذه الحالات. اطلب من التاجر مفتاحاً جديداً، أو أن يعيد تفعيل حسابه.