البداية

المصادقة

يحمل كل طلب أحد مفاتيح الشركة البرمجية في ترويسة.

أرسل المفتاح مع كل طلب، في إحدى الترويستين. كلتاهما للمفتاح نفسه؛ استخدم الأسهل في عميل HTTP لديك.

http

X-Api-Key: kwn_live_…
# or, the same key:
Authorization: Bearer kwn_live_…

يبدأ المفتاح بـ kwn_live_. وأي قيمة لا تبدأ بذلك تُرفض قبل البحث عنها.
لا يصل المفتاح إلا إلى /api/v1، وإلى شركته فقط. تسجيل دخول المستخدم إلى تطبيق KWN لا يفتح الواجهة البرمجية، والمفتاح لا يفتح التطبيق.
يجب أن تستخدم الطلبات HTTPS.

عندما يُرفض المفتاح

الحالة	الرمز	المعنى
401	`API_KEY_INVALID`	لا يوجد مفتاح، أو المفتاح خاطئ، أو أُلغي.
401	`MERCHANT_INACTIVE`	حساب الشركة غير نشط، فتتوقف كل مفاتيحها معه.
403	`ROLE_TOO_LOW`، `APP_NOT_GRANTED`، `APP_LOCKED`	المفتاح صالح لكن نطاقاته أو خطة الشركة لا تسمح بهذا الطلب. راجع النطاقات.

لا تحفظ KWN من المفتاح إلا قيمة SHA-256 المجزّأة؛ ويظهر المفتاح كاملًا مرة واحدة عند إنشائه. المفتاح المفقود يُستبدل ولا يُسترجع.
احفظ المفاتيح في مخزن أسرار أو متغير بيئة على خادمك. لا تضعها أبدًا في تطبيق جوال أو صفحة متصفح أو مستودع شيفرة.
استخدم مفتاحًا لكل نظام، باسمه، ليمكن إلغاء أحدها دون المساس بالبقية.
ألغِ المفتاح من الإعدادات ← التكاملات ← مفاتيح الواجهة البرمجية فيتوقف فورًا. وتعرض القائمة آخر استخدام لكل مفتاح.
للتدوير: أنشئ المفتاح الجديد، وانشره، ثم ألغِ القديم.