نظرة عامة

البدء

من الصفر إلى أول استدعاء لـ API في دقائق قليلة (بالإضافة إلى الوقت الذي نحتاجه للموافقة على وصولك).

1. اطلب وصول المطوّرين#

الواجهة مفتوحة لكل مستخدمي Linework، لكن طلبات الوصول تُراجَع يدويًا لكي تبقى الروبوتات مفيدة وتبقى الرسائل المزعجة بعيدة.

1. سجّل الدخول إلى تطبيق الويب وافتح web.linework.app ← الإعدادات ← المطوّرون.
2. املأ الطلب:
   • حالة الاستخدام — ما الذي يفعله تكاملك، في بضع جمل (مثلًا: «نشر قائمة الطعام اليومية لمطعمي والرد على الأسئلة في الدردشة»).
   • الموقع الإلكتروني — موقعك أو صفحة المشروع، إن وُجدت.
   • اسم الروبوت — اسم تطبيقك أو روبوتك، يظهر لنا وفي قائمة مفاتيحك.
3. أرسله. سترى الحالة (قيد المراجعة، أو تمت الموافقة، أو مرفوض) في الصفحة نفسها.

2. أنشئ مفتاح API#

عند الموافقة على الوصول، تتيح لك صفحة المطوّرون إنشاء مفاتيح API:

1. اضغط إنشاء مفتاح، وأعطه اسمًا (مثلًا «store-sync production»).
2. اختر فقط نطاقات الصلاحية التي يحتاجها التكامل.
3. انسخ المفتاح. يبدو على شكل lwk_ متبوعًا بـ 40 حرفًا ويُعرض مرة واحدة فقط.

احفظه في متغيّر بيئة أو في أداة لإدارة الأسرار، وليس أبدًا في الشيفرة المصدرية:

export LINEWORK_API_KEY="lwk_your_key_here"

المزيد عن المفاتيح والحدود والإلغاء في المصادقة ومفاتيح API.

3. أرسل أول استدعاء#

يعيد GET /me الحساب الذي ينتمي إليه المفتاح. إنه أسرع طريقة للتحقق من أن كل شيء يعمل.

curl -i https://api.linework.app/open/v1/me \
  -H "Authorization: Bearer $LINEWORK_API_KEY"

const res = await fetch("https://api.linework.app/open/v1/me", {
  headers: { Authorization: `Bearer ${process.env.LINEWORK_API_KEY}` },
});
if (!res.ok) throw new Error(JSON.stringify(await res.json()));
console.log(await res.json());

import os, requests

r = requests.get(
    "https://api.linework.app/open/v1/me",
    headers={"Authorization": f"Bearer {os.environ['LINEWORK_API_KEY']}"},
    timeout=30,
)
r.raise_for_status()
print(r.json())

الاستجابة الناجحة هي كائن JSON يصف ملفك الشخصي. إذا حصلت على 401 INVALID_API_KEY، فتحقق من أن الترويسة هي بالضبط Authorization: Bearer lwk_… وأن المفتاح لم يُلغَ. الحقول الدقيقة للاستجابة مذكورة في مرجع API.

4. ابنِ شيئًا#

قبل الإطلاق الفعلي#

• استخدم مفتاحًا واحدًا لكل تكامل، حتى تتمكن من إلغاء أحدها دون إيقاف الأخرى.
• احترم حدود المعدّل والحصص اليومية وتعامل مع 429 بإعادة المحاولة.
• تعامل مع الأخطاء حسب قيمة code، لا حسب نص الرسالة.
• اقرأ شروط استخدام API.