SDK الفوترة

​

نظرة عامة

• مكونات React: مكونات فوترة جاهزة وقابلة للتخصيص لتطبيقات React.
• أدوات CLI: واجهة سطر أوامر تهيّئ المشاريع وتضيف المكونات.
• دعم أطر العمل: قوالب لـ Next.js وExpress.js وHono وFastify وNestJS وReact.
• موفر الدفع: تكامل كامل مع Dodo Payments.

​

بدء سريع

npx @billingsdk/cli --help

npm install -g @billingsdk/cli

npx @billingsdk/cli init

npx @billingsdk/cli add pricing-table-one
npx @billingsdk/cli add subscription-management

​

الأطر المدعومة

​

أوامر CLI

​

@billingsdk/cli init

1. اختيار إطار العمل: تختار إطار العمل وموفر الدفع.
2. تثبيت القالب: ينزّل CLI القالب الخاص بإطار العمل وموفر الدفع من سجل Billing SDK، ثم يثبّت ملفاته.
3. إدارة التبعيات: يثبّت CLI تبعيات القالب، مثل dodopayments وstandardwebhooks وzod، باستخدام npm أو pnpm أو Yarn أو Bun.
4. إنشاء الملفات: يكتب CLI ملفات الإعدادات والتعليمات البرمجية التمهيدية. بالنسبة إلى Express.js وFastify وHono وNestJS، يكتبها ضمن src/.

npx @billingsdk/cli init

​

@billingsdk/cli add

# Add a pricing table
npx @billingsdk/cli add pricing-table-one

# Add subscription management
npx @billingsdk/cli add subscription-management

# Add usage monitoring
npx @billingsdk/cli add usage-meter-circle

1. ينزّل CLI الخاص بـ shadcn إعدادات المكوّن من السجل.
2. يثبّت ملفات المكوّن في دليل components/billingsdk/.
3. يحدّث إعدادات مشروعك عند الحاجة.
4. يثبّت أي تبعيات إضافية.

​

بنية الملفات المُنشأة

• مسارات API: نقاط نهاية للدفع وإتمام الشراء والعملاء ومدفوعات العملاء والمنتجات والاشتراكات وwebhooks. لا يحتوي قالب React على مسارات API.
• Hooks: React hook باسم useBilling لعمليات الفوترة، وذلك لـ React وNext.js.
• ملفات المكتبة: إعداد عميل Dodo Payments والدوال المساعدة ضمن lib/dodopayments.ts.
• إعدادات البيئة: ملف بيئة نموذجي باسم .env.example.

​

مثال على بنية Next.js

your-project/
├── app/api/
│   ├── checkout/route.ts
│   ├── customer/route.ts
│   ├── customer/payments/route.ts
│   ├── customer/subscriptions/route.ts
│   ├── product/route.ts
│   ├── products/route.ts
│   └── webhook/route.ts
├── hooks/
│   └── useBilling.ts
├── lib/
│   └── dodopayments.ts
└── .env.example

​

إعدادات البيئة

# DodoPayments
DODO_PAYMENTS_API_KEY=your_api_key_here
DODO_PAYMENTS_ENVIRONMENT=test_mode
DODO_PAYMENTS_WEBHOOK_KEY=your_webhook_key_here

# App URL
NEXT_PUBLIC_APP_URL=http://localhost:3000

​

المكونات المتاحة

• جداول الأسعار: ثمانية أشكال، من pricing-table-one إلى pricing-table-eight، لعرض أسعار المنتجات.
• إدارة الاشتراكات: subscription-management، بالإضافة إلى بطاقات ومربعات حوار لإلغاء الاشتراك أو تحديث الخطة.
• مراقبة الاستخدام: عدادات استخدام دائرية وخطية، وجداول استخدام للفوترة المستندة إلى الاستخدام.
• مكونات الدفع: محدد طريقة الدفع، ونماذج تفاصيل الدفع، وبطاقة فشل الدفع.
• Customer Portal: إعدادات الفوترة، وشاشة الفوترة، وسجل الفواتير، والرسوم القادمة، لتمكين العملاء من الخدمة الذاتية.

​

مفتوح المصدر

• الشفافية: يمكنك قراءة طريقة عمل كل مكوّن.
• المجتمع: يطوّره المطورون لمطورين آخرين.
• الأمان: يمكن لأي شخص مراجعة التعليمات البرمجية بحثًا عن مشكلات أمنية.
• الابتكار: تساهم مشاركات المجتمع في تسريع التطوير.

​

الحصول على المساعدة

• مشكلات GitHub: افتح مشكلة
• الوثائق: زُر billingsdk.com/docs
• الوثائق الكاملة لنماذج اللغة الكبيرة: billingsdk.com/llms-full.txt

​

المساهمة

• الإبلاغ عن الأخطاء
• طلب الميزات
• إرسال pull requests
• إضافة مكونات جديدة
• تحسين الوثائق

​

تعلّم المزيد