|
| 1 | +--- |
| 2 | +title: "مقدمة" |
| 3 | +description: "المرجع الكامل لواجهة برمجة تطبيقات CrewAI AMP REST" |
| 4 | +icon: "code" |
| 5 | +mode: "wide" |
| 6 | +--- |
| 7 | + |
| 8 | +# واجهة برمجة تطبيقات CrewAI AMP |
| 9 | + |
| 10 | +مرحبًا بك في مرجع واجهة برمجة تطبيقات CrewAI AMP. تتيح لك هذه الواجهة التفاعل برمجيًا مع الأطقم المنشورة، مما يمكّنك من دمجها مع تطبيقاتك وسير عملك وخدماتك. |
| 11 | + |
| 12 | +## البدء السريع |
| 13 | + |
| 14 | +<Steps> |
| 15 | + <Step title="الحصول على بيانات اعتماد API"> |
| 16 | + انتقل إلى صفحة تفاصيل طاقمك في لوحة تحكم CrewAI AMP وانسخ رمز Bearer من علامة تبويب الحالة. |
| 17 | + </Step> |
| 18 | + |
| 19 | +<Step title="اكتشاف المدخلات المطلوبة"> |
| 20 | + استخدم نقطة النهاية `GET /inputs` لمعرفة المعاملات التي يتوقعها طاقمك. |
| 21 | +</Step> |
| 22 | + |
| 23 | +<Step title="بدء تنفيذ الطاقم"> |
| 24 | + استدعِ `POST /kickoff` مع مدخلاتك لبدء تنفيذ الطاقم واستلام |
| 25 | + `kickoff_id`. |
| 26 | +</Step> |
| 27 | + |
| 28 | + <Step title="مراقبة التقدم"> |
| 29 | + استخدم `GET /status/{kickoff_id}` للتحقق من حالة التنفيذ واسترجاع النتائج. |
| 30 | + </Step> |
| 31 | +</Steps> |
| 32 | + |
| 33 | +## المصادقة |
| 34 | + |
| 35 | +تتطلب جميع طلبات API المصادقة باستخدام رمز Bearer. أدرج رمزك في ترويسة `Authorization`: |
| 36 | + |
| 37 | +```bash |
| 38 | +curl -H "Authorization: Bearer YOUR_CREW_TOKEN" \ |
| 39 | + https://your-crew-url.crewai.com/inputs |
| 40 | +``` |
| 41 | + |
| 42 | +### أنواع الرموز |
| 43 | + |
| 44 | +| نوع الرمز | النطاق | حالة الاستخدام | |
| 45 | +| :-------------------- | :------------------------ | :----------------------------------------------------------- | |
| 46 | +| **Bearer Token** | وصول على مستوى المؤسسة | عمليات الطاقم الكاملة، مثالي للتكامل بين الخوادم | |
| 47 | +| **User Bearer Token** | وصول محدد بالمستخدم | صلاحيات محدودة، مناسب للعمليات الخاصة بالمستخدم | |
| 48 | + |
| 49 | +<Tip> |
| 50 | + يمكنك العثور على كلا نوعي الرموز في علامة تبويب الحالة من صفحة تفاصيل طاقمك في |
| 51 | + لوحة تحكم CrewAI AMP. |
| 52 | +</Tip> |
| 53 | + |
| 54 | +## عنوان URL الأساسي |
| 55 | + |
| 56 | +لكل طاقم منشور نقطة نهاية API فريدة خاصة به: |
| 57 | + |
| 58 | +``` |
| 59 | +https://your-crew-name.crewai.com |
| 60 | +``` |
| 61 | + |
| 62 | +استبدل `your-crew-name` بعنوان URL الفعلي لطاقمك من لوحة التحكم. |
| 63 | + |
| 64 | +## سير العمل النموذجي |
| 65 | + |
| 66 | +1. **الاكتشاف**: استدعِ `GET /inputs` لفهم ما يحتاجه طاقمك |
| 67 | +2. **التنفيذ**: أرسل المدخلات عبر `POST /kickoff` لبدء المعالجة |
| 68 | +3. **المراقبة**: استعلم عن `GET /status/{kickoff_id}` حتى الاكتمال |
| 69 | +4. **النتائج**: استخرج المخرجات النهائية من الاستجابة المكتملة |
| 70 | + |
| 71 | +## معالجة الأخطاء |
| 72 | + |
| 73 | +تستخدم الواجهة أكواد حالة HTTP القياسية: |
| 74 | + |
| 75 | +| الكود | المعنى | |
| 76 | +| ----- | :----------------------------------------- | |
| 77 | +| `200` | نجاح | |
| 78 | +| `400` | طلب غير صالح - تنسيق مدخلات غير صحيح | |
| 79 | +| `401` | غير مصرّح - رمز bearer غير صالح | |
| 80 | +| `404` | غير موجود - المورد غير موجود | |
| 81 | +| `422` | خطأ في التحقق - مدخلات مطلوبة مفقودة | |
| 82 | +| `500` | خطأ في الخادم - تواصل مع الدعم | |
| 83 | + |
| 84 | +## الاختبار التفاعلي |
| 85 | + |
| 86 | +<Info> |
| 87 | + **لماذا لا يوجد زر "إرسال"؟** نظرًا لأن كل مستخدم CrewAI AMP لديه عنوان URL |
| 88 | + فريد للطاقم، نستخدم **وضع المرجع** بدلاً من بيئة تفاعلية لتجنب |
| 89 | + الالتباس. يوضح لك هذا بالضبط كيف يجب أن تبدو الطلبات بدون |
| 90 | + أزرار إرسال غير فعالة. |
| 91 | +</Info> |
| 92 | + |
| 93 | +تعرض لك كل صفحة نقطة نهاية: |
| 94 | + |
| 95 | +- **تنسيق الطلب الدقيق** مع جميع المعاملات |
| 96 | +- **أمثلة الاستجابة** لحالات النجاح والخطأ |
| 97 | +- **عينات الكود** بلغات متعددة (cURL، Python، JavaScript، إلخ) |
| 98 | +- **أمثلة المصادقة** بتنسيق رمز Bearer الصحيح |
| 99 | + |
| 100 | +### **لاختبار واجهتك الفعلية:** |
| 101 | + |
| 102 | +<CardGroup cols={2}> |
| 103 | + <Card title="نسخ أمثلة cURL" icon="terminal"> |
| 104 | + انسخ أمثلة cURL واستبدل العنوان URL + الرمز بقيمك الحقيقية |
| 105 | + </Card> |
| 106 | + <Card title="استخدام Postman/Insomnia" icon="play"> |
| 107 | + استورد الأمثلة في أداة اختبار API المفضلة لديك |
| 108 | + </Card> |
| 109 | +</CardGroup> |
| 110 | + |
| 111 | +**مثال على سير العمل:** |
| 112 | + |
| 113 | +1. **انسخ مثال cURL هذا** من أي صفحة نقطة نهاية |
| 114 | +2. **استبدل `your-actual-crew-name.crewai.com`** بعنوان URL الحقيقي لطاقمك |
| 115 | +3. **استبدل رمز Bearer** برمزك الحقيقي من لوحة التحكم |
| 116 | +4. **نفّذ الطلب** في طرفيتك أو عميل API |
| 117 | + |
| 118 | +## هل تحتاج مساعدة؟ |
| 119 | + |
| 120 | +<CardGroup cols={2}> |
| 121 | + <Card |
| 122 | + title="دعم المؤسسات" |
| 123 | + icon="headset" |
| 124 | + href="mailto:support@crewai.com" |
| 125 | + > |
| 126 | + احصل على مساعدة في تكامل API واستكشاف الأخطاء وإصلاحها |
| 127 | + </Card> |
| 128 | + <Card |
| 129 | + title="لوحة تحكم المؤسسات" |
| 130 | + icon="chart-line" |
| 131 | + href="https://app.crewai.com" |
| 132 | + > |
| 133 | + إدارة أطقمك وعرض سجلات التنفيذ |
| 134 | + </Card> |
| 135 | +</CardGroup> |
0 commit comments