mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-02 13:48:09 +00:00
a237ebabba
* 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>
197 lines
7.4 KiB
Plaintext
197 lines
7.4 KiB
Plaintext
---
|
|
title: تكامل Shopify
|
|
description: "إدارة التجارة الإلكترونية والمتجر الإلكتروني مع تكامل Shopify لـ CrewAI."
|
|
icon: "shopify"
|
|
mode: "wide"
|
|
---
|
|
|
|
## نظرة عامة
|
|
|
|
مكّن وكلاءك من إدارة عمليات التجارة الإلكترونية عبر Shopify. تعامل مع العملاء والطلبات والمنتجات والمخزون وتحليلات المتجر لتبسيط أعمالك التجارية عبر الإنترنت باستخدام الأتمتة المدعومة بالذكاء الاصطناعي.
|
|
|
|
## المتطلبات الأساسية
|
|
|
|
قبل استخدام تكامل Shopify، تأكد من توفر ما يلي:
|
|
|
|
- حساب [CrewAI AMP](https://app.crewai.com) مع اشتراك فعّال
|
|
- متجر Shopify بصلاحيات المسؤول المناسبة
|
|
- ربط متجر Shopify الخاص بك عبر [صفحة التكاملات](https://app.crewai.com/integrations)
|
|
|
|
## إعداد تكامل Shopify
|
|
|
|
### 1. ربط متجر Shopify الخاص بك
|
|
|
|
1. انتقل إلى [تكاملات CrewAI AMP](https://app.crewai.com/crewai_plus/connectors)
|
|
2. ابحث عن **Shopify** في قسم تكاملات المصادقة
|
|
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="shopify/get_customers">
|
|
**الوصف:** استرجاع قائمة العملاء من متجر Shopify.
|
|
|
|
**المعاملات:**
|
|
- `customerIds` (string, اختياري): قائمة معرّفات العملاء مفصولة بفواصل
|
|
- `limit` (string, اختياري): الحد الأقصى لعدد العملاء (الافتراضي: 250)
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="shopify/create_customer">
|
|
**الوصف:** إنشاء عميل جديد في متجر Shopify.
|
|
|
|
**المعاملات:**
|
|
- `firstName` (string, مطلوب): الاسم الأول للعميل
|
|
- `lastName` (string, مطلوب): اسم العائلة للعميل
|
|
- `email` (string, مطلوب): عنوان البريد الإلكتروني للعميل
|
|
- `phone` (string, اختياري): رقم الهاتف
|
|
- `tags` (string, اختياري): الوسوم كمصفوفة أو قائمة مفصولة بفواصل
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="shopify/update_customer">
|
|
**الوصف:** تحديث عميل موجود في متجر Shopify.
|
|
|
|
**المعاملات:**
|
|
- `customerId` (string, مطلوب): معرّف العميل المراد تحديثه
|
|
- `firstName` (string, اختياري): الاسم الأول
|
|
- `lastName` (string, اختياري): اسم العائلة
|
|
- `email` (string, اختياري): عنوان البريد الإلكتروني
|
|
|
|
</Accordion>
|
|
</AccordionGroup>
|
|
|
|
### **إدارة الطلبات**
|
|
|
|
<AccordionGroup>
|
|
<Accordion title="shopify/get_orders">
|
|
**الوصف:** استرجاع قائمة الطلبات من متجر Shopify.
|
|
|
|
**المعاملات:**
|
|
- `orderIds` (string, اختياري): قائمة معرّفات الطلبات مفصولة بفواصل
|
|
- `limit` (string, اختياري): الحد الأقصى لعدد الطلبات (الافتراضي: 250)
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="shopify/create_order">
|
|
**الوصف:** إنشاء طلب جديد في متجر Shopify.
|
|
|
|
**المعاملات:**
|
|
- `email` (string, مطلوب): عنوان البريد الإلكتروني للعميل
|
|
- `lineItems` (object, مطلوب): عناصر سطر الطلب بصيغة JSON
|
|
- `fulfillmentStatus` (string, اختياري): حالة التنفيذ - الخيارات: fulfilled, null, partial, restocked
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="shopify/get_abandoned_carts">
|
|
**الوصف:** استرجاع سلال التسوق المهجورة من متجر Shopify.
|
|
|
|
**المعاملات:**
|
|
- `status` (string, اختياري): عرض عمليات الدفع بالحالة المحددة - الخيارات: open, closed (الافتراضي: open)
|
|
- `limit` (string, اختياري): الحد الأقصى لعدد السلال (الافتراضي: 250)
|
|
|
|
</Accordion>
|
|
</AccordionGroup>
|
|
|
|
### **إدارة المنتجات**
|
|
|
|
<AccordionGroup>
|
|
<Accordion title="shopify/get_products">
|
|
**الوصف:** استرجاع قائمة المنتجات من متجر Shopify.
|
|
|
|
**المعاملات:**
|
|
- `title` (string, اختياري): تصفية حسب عنوان المنتج
|
|
- `status` (string, اختياري): تصفية حسب الحالة - الخيارات: active, archived, draft
|
|
- `limit` (string, اختياري): الحد الأقصى لعدد المنتجات (الافتراضي: 250)
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="shopify/create_product">
|
|
**الوصف:** إنشاء منتج جديد في متجر Shopify.
|
|
|
|
**المعاملات:**
|
|
- `title` (string, مطلوب): عنوان المنتج
|
|
- `productType` (string, مطلوب): نوع/فئة المنتج
|
|
- `vendor` (string, مطلوب): مورد المنتج
|
|
- `productDescription` (string, اختياري): وصف المنتج
|
|
- `price` (string, اختياري): سعر المنتج
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="shopify/update_product">
|
|
**الوصف:** تحديث منتج موجود في متجر Shopify.
|
|
|
|
**المعاملات:**
|
|
- `productId` (string, مطلوب): معرّف المنتج المراد تحديثه
|
|
- `title` (string, اختياري): عنوان المنتج
|
|
- `price` (string, اختياري): سعر المنتج
|
|
|
|
</Accordion>
|
|
</AccordionGroup>
|
|
|
|
## أمثلة الاستخدام
|
|
|
|
### إعداد Agent أساسي لـ Shopify
|
|
|
|
```python
|
|
from crewai import Agent, Task, Crew
|
|
from crewai import Agent, Task, Crew
|
|
|
|
# Create an agent with Shopify capabilities
|
|
shopify_agent = Agent(
|
|
role="E-commerce Manager",
|
|
goal="Manage online store operations and customer relationships efficiently",
|
|
backstory="An AI assistant specialized in e-commerce operations and online store management.",
|
|
apps=['shopify'] # All Shopify actions will be available
|
|
)
|
|
|
|
# Task to create a new customer
|
|
create_customer_task = Task(
|
|
description="Create a new VIP customer Jane Smith with email jane.smith@example.com and phone +1-555-0123",
|
|
agent=shopify_agent,
|
|
expected_output="Customer created successfully with customer ID"
|
|
)
|
|
|
|
# Run the task
|
|
crew = Crew(
|
|
agents=[shopify_agent],
|
|
tasks=[create_customer_task]
|
|
)
|
|
|
|
crew.kickoff()
|
|
```
|
|
|
|
### الحصول على المساعدة
|
|
|
|
<Card title="تحتاج مساعدة؟" icon="headset" href="mailto:support@crewai.com">
|
|
تواصل مع فريق الدعم للحصول على المساعدة في إعداد تكامل Shopify أو
|
|
استكشاف الأخطاء وإصلاحها.
|
|
</Card>
|