توثيق المطوّرين
ابنِ مع Pico
جرّب الـ sandbox، وضمّن مساعد التسوق، وتعرّف على اتفاقيات الـ API لنقاط widget والتاجر.
بدء سريع
- شغّل الـ API
شغّل الـ API على
http://localhost:8000واملأه بـphp artisan migrate --seed. - افتح الـ sandbox
استخدم sandbox أو استدعِ نقاط widget مباشرة.
- سجّل الدخول كتاجر
لوحة التحكم على
http://localhost:3000باستخدامowner@pico.test/password.
تدفق الـ widget العام يستخدم ثلاث استدعاءات:
# 1. Fetch widget configuration (public, no auth)
curl http://localhost:8000/api/v1/widget/config/pw_sandbox_demo_widget_001
# 2. Start a shopper session
curl -X POST http://localhost:8000/api/v1/widget/sessions \
-H "Content-Type: application/json" \
-d '{"public_widget_id":"pw_sandbox_demo_widget_001","locale":"en"}'
# 3. Send a message
curl -X POST http://localhost:8000/api/v1/widget/sessions/<session_id>/messages \
-H "Content-Type: application/json" \
-d '{"message":"Waterproof hiking boots under 150"}'تضمين الـ widget
<script type="module" src="https://cdn.example.com/pico-widget.js"
data-public-widget-id="pw_sandbox_demo_widget_001"
data-api-url="http://localhost:8000/api/v1"></script>يُعرض الـ widget داخل Shadow DOM حتى لا تكسر أنماط موقعك واجهته. يظهر زر الإضافة إلى السلة فقط عندما يبلّغ المتجر المتصل عن القدرة add_to_cart.
دليل Sandbox
Sandbox بيئة مُعلَّمة بوضوح وغير إنتاجية مدعومة بمتجر تجريبي ومنتجات خارجية نموذجية.
- مجهول: أدخل معرّف الـ widget التجريبي
pw_sandbox_demo_widget_001ثم تحدّث. - مسجّل الدخول: يحمّل الـ sandbox متجرك التجريبي عبر
GET /sandbox/config. - يُعرض كل طلب واستجابة كـ JSON حتى ترى بالضبط ما يعيده الـ API.
- لا شيء هنا يلمس طلبات أو مدفوعات أو كتالوجات إنتاج حقيقية.
صيغة الأخطاء
كل خطأ يستخدم حالة HTTP ونفس جسم JSON. سجّل دائماً request_id عند الإبلاغ عن مشكلة.
{
"error": {
"code": "VALIDATION_ERROR",
"message": "The request could not be validated.",
"details": { "message": ["The message field is required."] },
"request_id": "req_01HXYZ..."
}
}| الرمز | HTTP | المعنى |
|---|---|---|
VALIDATION_ERROR | 422 | إدخال غير صالح؛ details يحتوي أخطاء الحقول |
UNAUTHENTICATED | 401 | جلسة/بيانات اعتماد مفقودة أو غير صالحة |
FORBIDDEN | 403 | مصادق عليه لكن غير مسموح |
NOT_FOUND | 404 | المورد غير موجود في نطاقك |
RATE_LIMITED | 429 | طلبات كثيرة جداً |
CONFLICT | 409 | تعارض حالة أو تكرار عملية |
CONNECTOR_ERROR | 502 | فشل منصة التجارة الخارجية |
UNSUPPORTED_CAPABILITY | 400 | الإجراء غير مدعوم لهذا المتجر |
SESSION_EXPIRED | 401 | انتهت جلسة متسوق الـ widget |
AGENT_UNAVAILABLE | 503 | مزوّد النموذج/الوكيل غير متاح |
INTERNAL_ERROR | 500 | خطأ خادم غير متوقع |
details قد يحتوي details على أخطاء حقول، ولا يحتوي أبداً على أسرار أو stack traces.
أدلة التكامل
اربط Pico بمنصة التجارة لديك. تغطي الأدلة بيانات الاعتماد والمزامنة وتضمين الواجهة.
متجر تجريبي
متاحكتالوج sandbox للعروض واختبار الـ API محلياً.
Shopware 6
متاحإعداد Admin API و Store API مع لقطات شاشة رسمية.
Shopify
متاحتثبيت OAuth ومزامنة الكتالوج وتضمين ثيم التطبيق لمساعد Pico.
متجر Laravel
مخططعقد تجارة مشترك لواجهات Laravel مخصصة.