Files
crewAI/docs/edge/ar/enterprise/integrations/stripe.mdx
Lucas Gomide a237ebabba feat: adopt directory-based docs versioning with Edge channel (#6202)
* feat: adopt directory-based docs versioning with Edge channel

Switch docs.crewai.com from navigation-only versioning (every version
selector entry rendered the same docs/<lang>/* source files) to
Mintlify's directory-based versioning so each version selector entry
renders its own snapshot. Add an "Edge" channel under docs/edge/<lang>/*
that always reflects main HEAD for unreleased work, eliminating
pre-release leakage onto frozen release labels. External links to
canonical /<lang>/* URLs are preserved via wildcard redirects that
always land on the current default version.

Layout:
- docs/edge/<lang>/*         rolling source (you edit here)
- docs/edge/enterprise-api.*.yaml
- docs/v<X.Y.Z>/<lang>/*     frozen, immutable snapshots
- docs/v<X.Y.Z>/enterprise-api.*.yaml
- docs/images/               shared, append-only
- docs/docs.json             nav + redirects

URLs follow the Mintlify-idiomatic shape: /edge/<lang>/<page> for
Edge, /v<X.Y.Z>/<lang>/<page> for every frozen snapshot. The wildcard
redirects /<lang>/:slug* -> /<default>/<lang>/:slug* keep stale links
working, and every freeze rewrites them (plus all per-section/per-page
redirects) so destinations always resolve to the current default
without depending on a second redirect hop.

Release flow integration (devtools release):
- New module crewai_devtools.docs_versioning.freeze() materialises
  docs/v<X.Y.Z>/ from docs/edge/, rewrites openapi: refs inside the
  snapshot, inserts the version into every language block in
  docs.json, and refreshes all redirect destinations.
- _update_docs_and_create_pr() in cli.py now calls that freeze during
  Phase 2 of devtools release. Edge changelogs are updated first (so
  the snapshot freeze picks them up), then the snapshot is staged
  alongside docs.json, branched as docs/freeze-v<X.Y.Z>, and the PR
  is titled [docs-freeze] docs: snapshot and changelog for v<X.Y.Z>
  — the title prefix the new CI guard reads.
- The PR still gates tag, GitHub release, PyPI publish, and the
  enterprise release as before; no new PRs are added.
- Pre-releases (1.X.YaN, 1.X.YbN, ...) skip the snapshot — they ride
  Edge — and the docs PR title omits the [docs-freeze] prefix.
- docs_check (AI-generated docs scaffolding) writes to
  docs/edge/<lang>/* so newly-generated unreleased docs land in Edge
  and never accidentally touch a frozen snapshot.

Migration scripts (one-shot):
- scripts/docs/freeze_historical_versions.py reconstructs all 16
  historical snapshots (v1.10.0 .. v1.14.7) from git tags via
  git archive | tar, rewriting openapi: MDX refs so each snapshot
  reads its own enterprise-api YAML rather than the live one.
- scripts/docs/prefix_version_paths.py one-shot-migrates docs.json:
  rewrites every page path in 16 versioned blocks to point under
  docs/v<X.Y.Z>/, inserts a new Edge entry per language, tags
  v1.14.7 as Latest (default), prunes pages whose target file
  doesn't exist in the snapshot (e.g. docs/ar/ didn't exist before
  v1.12.0), and writes the wildcard + per-section redirects.
- scripts/docs/freeze_current_edge.py is now a thin CLI wrapper
  around docs_versioning.freeze for manual one-off freezes (e.g.
  retroactively snapshotting a forgotten release).

CI guards (.github/workflows/docs-snapshots.yml):
- Frozen snapshots under docs/v[0-9]*/ are immutable; only PRs whose
  title contains [docs-freeze] (i.e. release-cut PRs generated by
  devtools release or the manual wrapper) may modify them.
- Images under docs/images/ are append-only since snapshots share a
  single image directory. Deleting or renaming an image breaks every
  historical snapshot that still references it.

Restored docs/images/crewai-otel-export.png from PR #3673; it was
deleted in PR #4908 but v1.10.0 / v1.10.1 snapshots still reference
it. Restoring instead of editing the snapshots preserves historical
rendering fidelity and validates the new append-only rule
retroactively.

Tests:
- lib/devtools/tests/test_docs_versioning.py covers the freeze: file
  copy, openapi rewrite, version insertion, default demotion, redirect
  upserts, per-section redirect rewriting, idempotency, and invalid
  inputs.

Verified locally with mintlify broken-links: 0 broken links across
the full site (Edge + 16 frozen versions, 4 locales).

AGENTS.md (repo root) is the contributor guide for the new model;
RELEASING.md is the release-cut runbook; README's Contribution
section links to both.

Co-authored-by: Cursor <cursoragent@cursor.com>

* style: resolve linter issues

---------

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-06-17 11:56:59 -04:00

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 البيئي.