mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-04-18 00:42:40 +00:00
203 lines
7.4 KiB
Plaintext
203 lines
7.4 KiB
Plaintext
---
|
|
title: تكامل Stripe
|
|
description: "معالجة المدفوعات وإدارة الاشتراكات مع تكامل Stripe لـ CrewAI."
|
|
icon: "stripe"
|
|
mode: "wide"
|
|
---
|
|
|
|
## نظرة عامة
|
|
|
|
مكّن وكلاءك من إدارة المدفوعات والاشتراكات وفواتير العملاء عبر Stripe. تعامل مع بيانات العملاء، ومعالجة الاشتراكات، وإدارة المنتجات، وتتبع المعاملات المالية لتبسيط سير عمل المدفوعات باستخدام الأتمتة المدعومة بالذكاء الاصطناعي.
|
|
|
|
## المتطلبات الأساسية
|
|
|
|
قبل استخدام تكامل Stripe، تأكد من توفر ما يلي:
|
|
|
|
- حساب [CrewAI AMP](https://app.crewai.com) مع اشتراك فعّال
|
|
- حساب Stripe بصلاحيات API المناسبة
|
|
- ربط حساب Stripe الخاص بك عبر [صفحة التكاملات](https://app.crewai.com/integrations)
|
|
|
|
## إعداد تكامل Stripe
|
|
|
|
### 1. ربط حساب Stripe الخاص بك
|
|
|
|
1. انتقل إلى [تكاملات CrewAI AMP](https://app.crewai.com/crewai_plus/connectors)
|
|
2. ابحث عن **Stripe** في قسم تكاملات المصادقة
|
|
3. انقر على **Connect** وأكمل عملية OAuth
|
|
4. امنح الصلاحيات اللازمة لمعالجة المدفوعات
|
|
5. انسخ رمز المؤسسة من [إعدادات التكامل](https://app.crewai.com/crewai_plus/settings/integrations)
|
|
|
|
### 2. تثبيت الحزمة المطلوبة
|
|
|
|
```bash
|
|
uv add crewai-tools
|
|
```
|
|
|
|
### 3. إعداد متغير البيئة
|
|
|
|
<Note>
|
|
لاستخدام التكاملات مع `Agent(apps=[])`, يجب تعيين متغير البيئة
|
|
`CREWAI_PLATFORM_INTEGRATION_TOKEN` برمز المؤسسة الخاص بك.
|
|
</Note>
|
|
|
|
```bash
|
|
export CREWAI_PLATFORM_INTEGRATION_TOKEN="your_enterprise_token"
|
|
```
|
|
|
|
أو أضفه إلى ملف `.env`:
|
|
|
|
```
|
|
CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
|
|
```
|
|
|
|
## الأدوات المتاحة
|
|
|
|
### **إدارة العملاء**
|
|
|
|
<AccordionGroup>
|
|
<Accordion title="stripe/create_customer">
|
|
**الوصف:** إنشاء عميل جديد في حساب Stripe.
|
|
|
|
**المعاملات:**
|
|
- `emailCreateCustomer` (string, مطلوب): عنوان البريد الإلكتروني للعميل
|
|
- `name` (string, اختياري): الاسم الكامل للعميل
|
|
- `description` (string, اختياري): وصف العميل للمرجع الداخلي
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="stripe/get_customer_by_id">
|
|
**الوصف:** استرجاع عميل محدد بواسطة معرّف عميل Stripe.
|
|
|
|
**المعاملات:**
|
|
- `idGetCustomer` (string, مطلوب): معرّف عميل Stripe المراد استرجاعه
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="stripe/get_customers">
|
|
**الوصف:** استرجاع قائمة العملاء مع تصفية اختيارية.
|
|
|
|
**المعاملات:**
|
|
- `emailGetCustomers` (string, اختياري): تصفية العملاء حسب البريد الإلكتروني
|
|
- `limitGetCustomers` (string, اختياري): الحد الأقصى لعدد العملاء (الافتراضي: 10)
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="stripe/update_customer">
|
|
**الوصف:** تحديث معلومات عميل موجود.
|
|
|
|
**المعاملات:**
|
|
- `customerId` (string, مطلوب): معرّف العميل المراد تحديثه
|
|
- `emailUpdateCustomer` (string, اختياري): عنوان البريد الإلكتروني المحدّث
|
|
- `name` (string, اختياري): اسم العميل المحدّث
|
|
|
|
</Accordion>
|
|
</AccordionGroup>
|
|
|
|
### **إدارة الاشتراكات**
|
|
|
|
<AccordionGroup>
|
|
<Accordion title="stripe/create_subscription">
|
|
**الوصف:** إنشاء اشتراك جديد لعميل.
|
|
|
|
**المعاملات:**
|
|
- `customerIdCreateSubscription` (string, مطلوب): معرّف العميل الذي سيُنشأ له الاشتراك
|
|
- `plan` (string, مطلوب): معرّف خطة الاشتراك
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="stripe/get_subscriptions">
|
|
**الوصف:** استرجاع الاشتراكات مع تصفية اختيارية.
|
|
|
|
**المعاملات:**
|
|
- `customerIdGetSubscriptions` (string, اختياري): تصفية الاشتراكات حسب معرّف العميل
|
|
- `subscriptionStatus` (string, اختياري): تصفية حسب حالة الاشتراك - الخيارات: incomplete, trialing, active, past_due, canceled, unpaid
|
|
|
|
</Accordion>
|
|
</AccordionGroup>
|
|
|
|
### **إدارة المنتجات**
|
|
|
|
<AccordionGroup>
|
|
<Accordion title="stripe/create_product">
|
|
**الوصف:** إنشاء منتج جديد في كتالوج Stripe.
|
|
|
|
**المعاملات:**
|
|
- `productName` (string, مطلوب): اسم المنتج
|
|
- `description` (string, اختياري): وصف المنتج
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="stripe/get_products">
|
|
**الوصف:** استرجاع قائمة المنتجات مع تصفية اختيارية.
|
|
|
|
**المعاملات:**
|
|
- `limitGetProducts` (string, اختياري): الحد الأقصى لعدد المنتجات (الافتراضي: 10)
|
|
|
|
</Accordion>
|
|
</AccordionGroup>
|
|
|
|
### **العمليات المالية**
|
|
|
|
<AccordionGroup>
|
|
<Accordion title="stripe/get_balance_transactions">
|
|
**الوصف:** استرجاع معاملات الرصيد من حساب Stripe.
|
|
|
|
**المعاملات:**
|
|
- `balanceTransactionType` (string, اختياري): تصفية حسب نوع المعاملة - الخيارات: charge, refund, payment, payment_refund
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="stripe/get_plans">
|
|
**الوصف:** استرجاع خطط الاشتراك من حساب Stripe.
|
|
|
|
**المعاملات:**
|
|
- `isPlanActive` (boolean, اختياري): تصفية حسب حالة الخطة
|
|
|
|
</Accordion>
|
|
</AccordionGroup>
|
|
|
|
## أمثلة الاستخدام
|
|
|
|
### إعداد Agent أساسي لـ Stripe
|
|
|
|
```python
|
|
from crewai import Agent, Task, Crew
|
|
from crewai import Agent, Task, Crew
|
|
|
|
# Create an agent with Stripe capabilities
|
|
stripe_agent = Agent(
|
|
role="Payment Manager",
|
|
goal="Manage customer payments, subscriptions, and billing operations efficiently",
|
|
backstory="An AI assistant specialized in payment processing and subscription management.",
|
|
apps=['stripe'] # All Stripe actions will be available
|
|
)
|
|
|
|
# Task to create a new customer
|
|
create_customer_task = Task(
|
|
description="Create a new premium customer John Doe with email john.doe@example.com",
|
|
agent=stripe_agent,
|
|
expected_output="Customer created successfully with customer ID"
|
|
)
|
|
|
|
# Run the task
|
|
crew = Crew(
|
|
agents=[stripe_agent],
|
|
tasks=[create_customer_task]
|
|
)
|
|
|
|
crew.kickoff()
|
|
```
|
|
|
|
## مرجع حالات الاشتراك
|
|
|
|
فهم حالات الاشتراك:
|
|
|
|
- **incomplete** - الاشتراك يتطلب طريقة دفع أو تأكيد الدفع
|
|
- **trialing** - الاشتراك في فترة تجريبية
|
|
- **active** - الاشتراك نشط وحالي
|
|
- **past_due** - فشل الدفع لكن الاشتراك لا يزال نشطاً
|
|
- **canceled** - تم إلغاء الاشتراك
|
|
- **unpaid** - فشل الدفع والاشتراك لم يعد نشطاً
|
|
|
|
يمكّن هذا التكامل أتمتة شاملة لإدارة المدفوعات والاشتراكات، مما يسمح لوكلاء الذكاء الاصطناعي بالتعامل مع عمليات الفوترة بسلاسة ضمن نظام Stripe البيئي.
|