التوثيق

مرجع تقني لتكاملات Deckbase وواجهات البرمجة وأدلة المطورين.

المرجع

البدء السريع

الطرفية
curl -X POST https://www.deckbase.co/api/mcp \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"jsonrpc":"2.0","method":"tools/list","id":1}'

استبدل YOUR_ACCESS_TOKEN برمز OAuth من صفحة الاتصال. للحصول على تعليمات الإعداد، راجع دليل إعداد MCP.

نظرة عامة على واجهة البرمجة

يوفر Deckbase مسارين للتكامل: خادم MCP لإدارة الرزم والبطاقات بمساعدة الذكاء الاصطناعي، ونقاط نهاية واجهة REST مباشرة للوصول البرمجي.

  • إنشاء الرزم والبطاقات وتحديثها وحذفها على دفعات
  • توليد صوت وبيانات مرئية للبطاقات عبر ElevenLabs ونماذج توليد الصور
  • تصدير بيانات الرزمة كاملة بما فيها لقطات الكتل والبيانات الوصفية
  • إنشاء قوالب مخصصة بتخطيطات كتل مرنة
  • استقبال أحداث webhook عند تغيير الرزم أو البطاقات

ابدأ من هنا

أفضل الممارسات

  • تعامل مع إنشاء البطاقات كخط تشغيلي متكامل

    احتفظ بسجلات الطلبات، وتحقق من الحقول المطلوبة في القوالب قبل الكتابة، وأجرِ فحوصاً عشوائية للبطاقات المتولدة قبل زيادة حجم الدفعات.

  • حدد استراتيجية قالب واحدة قياسية

    بالنسبة للفرق، حدد استراتيجية قالب واحدة قياسية وسياسة إعادة محاولة واحدة. يتجنب ذلك انحراف موجهات الاستنساخ ويسرّع الاستجابة للحوادث كثيراً عند تغيير قواعد الربط.

  • اتبع ترتيب القراءة الموصى به

    صفحة الإعداد أولاً، ثم مرجع خادم MCP ثانياً، ثم اختبارات التشغيل في الإنتاج. يقلل هذا المسار أخطاء المصادقة وأخطاء عدم تطابق المخطط أثناء إنشاء البطاقات.

  • وثّق القواعد في مستودعك

    إذا كنت تنفذ سير عمل للفرق، فوثّق قواعد القوالب وحدود قبول الدفعات مباشرة في مستودعك ليبقى التحديث المستقبلي متسقاً.

  • أجرِ مراجعة تشغيلية أسبوعية

    افحص أحدث إخفاقات الكتابة وانحراف القوالب ومعدلات تكرار الموجهات قبل توسيع حجم الأتمتة.

  • استخدم إصدارات لقائمة تحقق التكامل

    احتفظ بقائمة تحقق التكامل متتبعة بالإصدارات حتى لا يحتاج انضمام مساهمين جدد إلى إعادة هندسة قرارات إعداد MCP السابقة.

  • ضمّن دليل استرجاع

    كلما أمكن، ضمّن دليلاً موجزاً للاسترجاع وإعادة معالجة الدفعات الفاشلة لتبقى تحديثات الإنتاج آمنة حتى عند تطور القوالب.

الأسئلة الشائعة

  • يتيح خادم Model Context Protocol (MCP) لأدوات الذكاء الاصطناعي مثل Cursor وClaude Code وVS Code قراءة مستنداتك وإدراج الرزم وإنشاء البطاقات برمجياً. يستخدم بروتوكول JSON-RPC القياسي عبر HTTP.

    اقرأ المزيد

للاطلاع على الأدلة والمقالات، راجع الموارد.