قم بإدارة موارد Dodo Payments الخاصة بك، وأنشئ جلسات الدفع، واختبر الويب هوك مباشرة من الطرفية. تم إنشاؤه للمطورين الذين يفضلون واجهة سطر الأوامر.
التثبيت
npm install -g dodopayments-cli
التثبيت اليدوي
- قم بتنزيل الإصدار الأحدث من GitHub Releases لنظامك
- فكّ الضغط وأعد تسمية الملف التنفيذي إلى
dodo
- انقل إلى دليل في متغير PATH الخاص بك:
sudo mv ./dodo /usr/local/bin/
المصادقة
قبل استخدام واجهة سطر الأوامر، قم بالمصادقة باستخدام مفتاح واجهة برمجة التطبيقات الخاص بك:
سيقوم ما يلي:
- فتح متصفحك على صفحة مفاتيح واجهة برمجة التطبيقات في Dodo Payments
- مطالبتك بإدخال مفتاح واجهة برمجة التطبيقات
- طلب اختيار البيئة (وضع الاختبار أو الوضع الفعلي)
- تخزين بيانات اعتمادك محليًا في
~/.dodopayments/api-key
يدعم CLI تخزين مفتاح واجهة برمجة تطبيقات واحد لكل بيئة. إذا تم تكوين مفاتيح وضع الاختبار والوضع الفعلي معًا، فسيُطلب منك اختيار البيئة التي تريد استخدامها للجلسة الحالية.
الاستخدام
الصيغة العامة هي:
dodo ‹category› ‹sub-command›
تشغيل dodo بدون وسيطات يعرض جميع الفئات المتاحة. تشغيل dodo <category> بدون أمر فرعي يعرض الأوامر الفرعية المتاحة لتلك الفئة.
المنتجات
قم بإدارة كتالوج المنتجات الخاص بك.
| الأمر | الوصف |
|---|
dodo products list | عرض جميع المنتجات (مقسمة إلى صفحات) |
dodo products create | افتح لوحة التحكم لإنشاء منتج |
dodo products info | عرض تفاصيل منتج محدد |
المدفوعات
عرض معاملات الدفع.
| الأمر | الوصف |
|---|
dodo payments list | عرض جميع الدفعات (مقسمة إلى صفحات) |
dodo payments info | الحصول على معلومات حول دفعة معينة |
العملاء
قم بإدارة قاعدة عملائك.
| الأمر | الوصف |
|---|
dodo customers list | عرض جميع العملاء (مقسمة إلى صفحات) |
dodo customers create | إنشاء ملف تعريف عميل جديد |
dodo customers update | تحديث تفاصيل عميل موجود |
الخصومات
إدارة القسائم والخصومات.
| الأمر | الوصف |
|---|
dodo discounts list | عرض جميع الخصومات (مقسمة إلى صفحات) |
dodo discounts create | إنشاء خصم جديد بنسب مئوية |
dodo discounts delete | إزالة خصم حسب المعرف |
الرخص
إدارة تراخيص البرامج.
| الأمر | الوصف |
|---|
dodo licences list | عرض جميع مفاتيح الترخيص (مقسمة إلى صفحات) |
الإضافات
إدارة الإضافات الخاصة بالمنتجات.
| الأمر | الوصف |
|---|
dodo addons list | عرض جميع الإضافات (مقسمة إلى صفحات) |
dodo addons create | افتح لوحة التحكم لإنشاء إضافة |
dodo addons info | عرض تفاصيل إضافة معينة |
عمليات الاسترداد
عرض معلومات الاسترداد.
| الأمر | الوصف |
|---|
dodo refund list | عرض جميع الاستردادات (مقسمة إلى صفحات) |
dodo refund info | عرض تفاصيل استرداد معين |
صفحة الدفع
إنشاء جلسات الدفع.
| الأمر | الوصف |
|---|
dodo checkout new | إنشاء جلسة دفع جديدة والحصول على رابط الدفع |
يدعم أمر الدفع خيارات متقدمة تشمل جمع أقل قدر من العناوين، عنوان URL للعودة، فرض 3D Secure، رموز الخصم، والبيانات الوصفية.
اختبار الويب هوك
تتضمن واجهة سطر الأوامر أداتين قويتين لاختبار الويب هوك أثناء التطوير: المستمع الذي يعيد توجيه الويب هوك الخاصة بالاختبار المباشر إلى خادمك المحلي، والمشغّل الذي يرسل بيانات وهمية لأي نقطة نهاية.
الاستماع إلى الويب هوك
إعادة توجيه الويب هوك من Dodo Payments مباشرة إلى خادم التطوير المحلي في الوقت الفعلي.
Enter your local endpoint URL
قدّم عنوان URL المحلي الذي ترغب في استلام الويب هوك عليه (على سبيل المثال، http://localhost:3000/webhook).
Automatic setup
يقوم CLI بإنشاء نقطة نهاية للويب هوك على حساب Dodo Payments تلقائيًا إذا لم تكن موجودة بالفعل، ثم يفتح اتصال WebSocket لتلقي الأحداث في الوقت الفعلي.
Receive and forward
عند حدوث حدث ويب هوك (من دفعة اختبار، تغيير اشتراك، إلخ)، يتلقاه CLI، ويسجل نوع الحدث، ويعيد توجيه الطلب الكامل مع رؤوسه ومحتواه إلى نقطة النهاية المحلية الخاصة بك. يتم تسجيل الاستجابة من نقطة النهاية الخاصة بك وإرسالها مرة أخرى.
يعمل مستمع الويب هوك فقط مع مفتاح واجهة برمجة تطبيقات لوضع الاختبار. تأكد من تسجيل الدخول باستخدام مفتاح وضع الاختبار قبل استخدام dodo wh listen.
يحتفظ المستمع بالرؤوس الأصلية للويب هوك (webhook-id, webhook-signature, webhook-timestamp) عند إعادة التوجيه إلى نقطة النهاية المحلية الخاصة بك، حتى تتمكن من اختبار منطق التحقق من التوقيع.
تشغيل ويب هوك اختبارية
أرسل حمولة ويب هوك وهمية إلى أي نقطة نهاية لإجراء اختبار سريع دون الحاجة إلى إنشاء معاملات حقيقية.
هذا الدليل يأخذك عبر:
- تحديد عنوان نقطة النهاية الوجهة
- اختيارياً تكوين معرف العمل، معرف المنتج، والبيانات الوصفية
- اختيار حدث محدد لتفعيله من قائمة تفاعلية
- إرسال الحمولة الوهمية وعرض الاستجابة
بعد كل حدث، يمكنك اختيار حدث آخر لتفعيله أو الخروج — مما يجعل من السهل اختبار عدة معالجات أحداث في جلسة واحدة.
ترسل أداة المشغّل حمولات وهمية بدون توقيعات ويب هوك. قم بإيقاف تشغيل التحقق من توقيعات الويب هوك أثناء الاختبار باستخدام unsafe_unwrap() بدلًا من unwrap() في معالج الويب هوك الخاص بك.
أحداث الويب هوك المدعومة
| الفئة | الأحداث |
|---|
| الاشتراك | subscription.active, subscription.updated, subscription.on_hold, subscription.renewed, subscription.plan_changed, subscription.cancelled, subscription.failed, subscription.expired |
| الدفعة | payment.success, payment.failed, payment.processing, payment.cancelled |
| الاسترداد | refund.success, refund.failed |
| النزاع | dispute.opened, dispute.expired, dispute.accepted, dispute.cancelled, dispute.challenged, dispute.won, dispute.lost |
| الرخصة | licence.created |
متغيرات البيئة
| المتغير | الوصف |
|---|
DODO_WH_TEST_SERVER_URL | استبدال عنوان URL الافتراضي لخادم تمرير الويب هوك المستخدم بواسطة dodo wh listen |
الموارد
الدعم