إنشاء رمز واجهة برمجية شخصي وإلغاؤه

الخطوات

1. 1

   افتح صفحة الرموز

   من «الإعدادات» ← «شخصي» ← «حساباتي المرتبطة» ← «رموز الواجهة البرمجية». يظهر التبويب فقط إذا كان وصول API مفعّلًا لحسابك، وهو مفعّل افتراضيًا لكل من سجّل أو قبل دعوة.

2. 2

   أنشئ الرمز

   اضغط «رمز جديد»، واكتب «اسم الرمز» يصف مكان استخدامه، مثل «مزامنة نظام المحاسبة»، ثم «إنشاء».

3. 3

   تجاوز المشكلة المعروفة

   في الإصدار الحالي لا تعرض الشاشة قيمة الرمز الجديد رغم إنشائه. إلى أن تُصلح، يحصل المطوّر على رمز Bearer من الطلب POST /api/token بالبريد الإلكتروني وكلمة المرور واسم الجهاز، كما في المثال أدناه.

4. 4

   استخدم الرمز

   أرسل الرمز في ترويسة Authorization: Bearer مع كل طلب، مثل /api/contacts أو /api/deals، وحدّد مساحة العمل بترويسة X-Tenant-Slug.

5. 5

   ألغِ الرمز عند انتهاء الحاجة

   احذفه من أيقونة الحذف في صفحة الرموز، أو من «حسابي» ← «الجلسات والأمان» حيث تجد «رموز الوصول» مع آخر استخدام لكل رمز، و«إلغاء الرمز» أو «إلغاء الكل».

مثال عملي

استبدل عنوان مساحة العمل والقيم بين الأقواس بقيمك:

# 1) الحصول على رمز
curl -X POST https://<app-address>/api/token \
  -H "Content-Type: application/json" \
  -d '{"email":"integration@company.com","password":"<password>","device_name":"erp-sync"}'

# 1ب) فقط إذا كان التحقق بخطوتين مفعّلًا: أرسل challenge_token من الرد السابق مع رمز التطبيق خلال 5 دقائق ومن الشبكة نفسها
curl -X POST https://<app-address>/api/token/2fa-challenge \
  -H "Content-Type: application/json" \
  -d '{"challenge_token":"<challenge_token>","code":"<6-digit-code>"}'

# 2) قراءة جهات الاتصال بالرمز
curl https://<app-address>/api/contacts \
  -H "Authorization: Bearer <token>" \
  -H "X-Tenant-Slug: <workspace-slug>" \
  -H "Accept: application/json"

يعيد الطلب الأول الرمز في الحقل accessToken. وإذا كان التحقق بخطوتين مفعّلًا للحساب فيعيد بدلًا منه requires_two_factor مع challenge_token، ويصدر الرمز من الطلب 1ب بعد إدخال رمز تطبيق المصادقة.

نصائح أمان مهمة

• الرمز يحمل صلاحيات صاحبه كاملة: لا توجد رموز محدودة النطاق أو للقراءة فقط. أنشئ مستخدمًا مخصصًا للتكامل بدور محدود، واستخدم رمزه هو.
• ينتهي الرمز بعد 14 يومًا افتراضيًا: خطط لتجديده في التكاملات طويلة التشغيل. وإذا كان التحقق بخطوتين مفعّلًا لمستخدم التكامل، فسيحتاج كل تجديد إلى شخص يُدخل رمز التطبيق.
• إيقاف المستخدم يوقف رموزه فورًا، فلا تربط تكاملًا حيويًا بحساب موظف قد يغادر.
• مدير مساحة العمل لا يستطيع تقييد وصول API لكل مستخدم، فاطلب من كل زميل مراجعة رموزه النشطة دوريًا من «الجلسات والأمان» وإلغاء ما لم يعد مستخدمًا.

لا توجد حاليًا وثائق OpenAPI منشورة. لتفاصيل الموارد المتاحة راجع صفحة الواجهة البرمجية، ولإرسال الأحداث إلى نظامك بدل سحبها راجع إعداد Webhooks الصادرة.