نظرة عامة

المصادقة ومفاتيح API

تتم مصادقة كل طلب بمفتاح API شخصي يُرسَل كرمز Bearer.

إرسال المفتاح#

أضف الترويسة Authorization إلى كل طلب:

GET /open/v1/me HTTP/1.1
Host: api.linework.app
Authorization: Bearer lwk_aBcD1234...

يجب أن تستخدم كل الطلبات HTTPS. لا تُقبل المفاتيح في سلاسل الاستعلام (query strings) أو في جسم الطلب.

الخاصية	التفاصيل
التنسيق	`lwk_` + 40 حرفًا ورقمًا
المالك	حساب Linework الذي أنشأه. يُنفَّذ كل إجراء باسم ذلك الحساب.
الصلاحيات	نطاقات الصلاحية المختارة عند إنشاء المفتاح. لا يمكن تغييرها لاحقًا: أنشئ مفتاحًا جديدًا بدلًا من ذلك.
الظهور	يُعرض مرة واحدة فقط، عند الإنشاء. تحتفظ Linework بقيمة تجزئة (hash) فقط ولا يمكنها عرضه مرة أخرى.
الحد	حتى 5 مفاتيح نشطة لكل حساب.
انتهاء الصلاحية	لا تنتهي صلاحية المفاتيح. تتوقف عن العمل عندما تلغيها أو عند إلغاء وصول المطوّرين.

أنشئ مفتاحًا، وأعطه اسمًا، واختر نطاقات الصلاحية.
ألغِ مفتاحًا: يتوقف عن العمل فورًا، دون إمكانية التراجع. لا تُحتسب المفاتيح الملغاة ضمن حدّ المفاتيح الخمسة.
اطّلع على آخر استخدام لكل مفتاح، لتكتشف المفاتيح التي لم تعد تحتاجها.

احتفظ بالمفاتيح على خادمك. لا تضع مفتاحًا أبدًا في تطبيق جوال، أو صفحة متصفح، أو مستودع عام، أو رسالة دعم.
امنح كل مفتاح نطاقات الصلاحية التي يحتاجها فقط، واستخدم مفتاحًا واحدًا لكل تكامل.
إذا تسرّب مفتاح، فألغِه فورًا وأنشئ مفتاحًا جديدًا. لن يطلب منك فريق Linework مفتاحك أبدًا.

الحالة	الرمز	المعنى
401	`INVALID_API_KEY`	الترويسة مفقودة، أو المفتاح خاطئ، أو تم إلغاؤه.
403	`INSUFFICIENT_SCOPE`	المفتاح صالح لكنه لا يملك نطاق الصلاحية الذي تحتاجه نقطة النهاية هذه.
403	`DEVELOPER_ACCESS_REVOKED`	تم تعليق وصول المطوّرين للحساب أو إلغاؤه. تتوقف كل مفاتيحه عن العمل.
403	`PROFILE_INCOMPLETE`	تحتاج نقاط نهاية الكتابة إلى حساب لديه صورة ملف شخصي وصورة غلاف.

اطّلع على كل الرموز في الأخطاء.