تخطَّ إلى المحتوى
المطوّرقراءة 6 دقائقالتوثيق

البدء مع API

أنشئ رمز وصول شخصيًا وأرسل أول طلب مصادَق إلى /api/v1.

فريق ChatinFlow

دليل رسمي

نظرة عامة

استخدم رمز وصول شخصيًا (PAT) لاستدعاء ChatinFlow من البرامج النصية أو البرمجيات الوسيطة أو الخادم الخلفي الخاص بك. أما تطبيقات المتصفح المسجلة في لوحة التحكم فتستخدم ملفات cookie لجلسة Sanctum.

في نهاية هذا الدليل سيكون لديك PAT، وطلب مصادَق ناجح، ومسار واضح لعرض موارد مساحة العمل أو تعديلها.

قبل أن تبدأ

حساب ChatinFlow موثّق

يلزم التحقق من البريد الإلكتروني

العضوية في مساحة العمل

يُنصح بأن ينشئ المالك أو المشرف رمز PAT

خطة تتضمن الوصول إلى API إن كان مقيّدًا

تحقّق من صلاحياتك في الإعدادات ← الفوترة

أول استدعاء API

01

إنشاء رمز وصول شخصي

افتح لوحة التحكم ← الإعدادات ← المطورون. سمِّ الرمز وأنشئه وانسخ السر مرة واحدة. احفظه خارج ChatinFlow.

الإعدادات ← المطورونيُنسخ مرة واحدة
02

استدعاء نقطة نهاية ذات إصدار

أرسل الرمز في ترويسة Authorization Bearer إلى `/api/v1/...`. أضف Accept: application/json. تحمل كل استجابة معرّف X-Request-Id لفريق الدعم.

curl -sS https://api.example.com/api/v1/workspaces \
  -H "Authorization: Bearer cif_pat_..." \
  -H "Accept: application/json"
Authorization: BearerX-Request-Id
03

التعديل بأمان

تتطلب طلبات POST وPUT وPATCH وDELETE مفتاح Idempotency-Key (UUIDv4). تُزال التكرارات لإعادة المحاولة بالمفتاح نفسه لمدة 24 ساعة.

curl -sS -X POST https://api.example.com/api/v1/... \
  -H "Authorization: Bearer cif_pat_..." \
  -H "Idempotency-Key: 550e8400-e29b-41d4-a716-446655440000" \
  -H "Content-Type: application/json" \
  -d '{}'
Idempotency-KeyUUIDv4

نصائح

نصيحة

فضّل ترقيم الصفحات بالمؤشر

تُعيد نقاط نهاية القوائم `{ data, meta: { nextCursor, hasMore } }`. لا تتوقّع عددًا إجماليًا ما لم يوجد include مخصص له.

تنبيه

لا تسجّل رموز PAT في السجلات أبدًا

تعامل مع الرموز كما تتعامل مع كلمات المرور. ألغِ فورًا أي رمز مخترق من الإعدادات ← المطوّرون.

ملاحظة

أدلة المنتج

للأتمتة وصندوق الوارد وإعداد القنوات، استخدم مركز المساعدة لا وثائق المطوّرين هذه.

هل كان هذا الدليل مفيدًا؟

تصفح المزيد في المكتبة

كل المستندات
ChatinFlow

مستعد لتطبيق
ذلك عمليًا؟

ابدأ بناء أول أتمتة مجانًا. دون بطاقة ائتمان. فقط اربط قناتك وانطلق خلال دقائق.