الميزات
- التحقق من مفتاح الترخيص: يتحقق من مفاتيح الترخيص مقابل Dodo Payments API.
- تنشيط مفتاح الترخيص: ينشّط مفاتيح الترخيص باستخدام اسم مثيل، للمفاتيح التي لها حد للتنشيط.
- دعم البيئات: قابل للتهيئة لكل من وضع الاختبار والوضع المباشر.
- دعم TypeScript: تنفيذ مكتوب بالكامل مع معالجة الأخطاء.
البدء
قبل البدء، تحتاج إلى تطبيق Figma لسطح المكتب ومنتج Dodo Payments يُصدر مفاتيح ترخيص.1
Create Base Plugin
أنشئ مشروع إضافة Figma الخاص بك باستخدام دليل البدء السريع لإضافات Figma. ينشئ Figma هيكلًا أوليًا يتضمن ملف
manifest.json.2
Clone the Example Implementation
استنسخ مستودع dodopayments-figma:في
manifest.json المستنسخ، استبدل name وid بالقيم من manifest.json الخاص بإضافتك التي أنشأتها. هذا المثال هو نقطة البداية لتكامل الخدمة.3
Install Dependencies
في جذر المشروع، شغّل:
4
Configure Environment
عيّن يحدد
API_MODE في src/ui/api.ts:API_MODE مضيف API: https://test.dodopayments.com لـ test_mode، أو https://live.dodopayments.com لـ live_mode.5
Customize Components
خصّص مكوّنات الإضافة في
src/ui/components/ لتناسب احتياجاتك:- حدّث
Authenticated.tsxلإتاحة الوظائف للمستخدمين الذين يملكون مفاتيح ترخيص صالحة. - خصّص
LicenseKeyInput.tsxليتوافق مع تصميمك.
Authenticated.tsx هو المكان الذي تضيف فيه ميزات إضافتك المتميزة. لا تعرض الإضافة هذه الميزات إلا بعد التحقق من مفتاح ترخيص أو تنشيطه.الإعداد
1
Configure Network Access
يرسل المثال كل طلبات مفاتيح الترخيص من خلال وكيل CORS على في
https://dodo-payments-proxy.aagarwal9782.workers.dev، كما يسمح manifest.json بالوصول إلى الشبكة لهذا الوكيل فقط. الوكيل غير متاح، لذا استدعِ Dodo Payments API مباشرةً. تقبل API الطلبات من مصادر متعددة النطاقات من أي مصدر، بما في ذلك مصدر null لواجهة مستخدم المكوّن الإضافي.في manifest.json، استبدل نطاق الوكيل بمضيفي Dodo Payments API:src/ui/api.ts، استبدل fetch(proxyReq) بـ fetch(req) في validateLicenseKey وactivateLicenseKey، بحيث يذهب كل طلب إلى API مباشرةً.يسمح ذلك للمكوّن الإضافي بالتحقق من مفاتيح الترخيص وتنشيطها باستخدام Dodo Payments API.2
Configure API Mode
في
src/ui/api.ts، اضبط وضع API:التطوير
1
Import Plugin
استورد المكوّن الإضافي إلى تطبيق Figma لسطح المكتب:
- افتح ملف تصميم.
- افتح قائمة Figma وحدد المكوّنات الإضافية.
- ضمن التطوير، حدد استيراد مكوّن إضافي جديد من البيان…، ثم حدد ملف
manifest.jsonفي جذر المشروع.
dist/، لذا ابدأ خادم التطوير أو شغّل npm run build قبل تشغيل المكوّن الإضافي.تحتاج إلى تطبيق Figma لسطح المكتب لتطوير المكوّنات الإضافية واختبارها محليًا، لأن Figma يقرأ رمز المكوّن الإضافي من الملفات المحلية.
2
Start Development Server
تُعاد عملية إنشاء المكوّن الإضافي تلقائيًا عند تغيير الرمز المصدر.
أوامر الإنشاء
يتضمن المشروع نصوص npm البرمجية التالية:تكامل مفتاح الترخيص
يتحقق التنفيذ النموذجي من مفتاح الترخيص قبل إلغاء قفل المكوّن الإضافي. يمكنك تخصيص كل خطوة:- إدخال المستخدم: يُدخل المستخدمون مفتاح الترخيص في واجهة مستخدم المكوّن الإضافي.
- التحقق: يتحقق المكوّن الإضافي افتراضيًا من المفتاح باستخدام التحقق من الترخيص (
POST /licenses/validate). - التنشيط: إذا كانت مفاتيح الترخيص لديك تتضمن حدًا للتنشيط، فاضبط
needsActivationعلىtrueفيsrc/ui/components/Unauthenticated.tsx. بعد ذلك ينشّط المكوّن الإضافي المفتاح باستخدام تنشيط الترخيص (POST /licenses/activate) بدلًا من التحقق منه، ويُسمّي المثيلFigma Plugin. - التحكم في الوصول: بالنسبة إلى مفتاح صالح، يحفظ المكوّن الإضافي المفتاح باستخدام
figma.clientStorageويعرضAuthenticated.tsx. عند فتح المكوّن الإضافي في المرة التالية، يتحقق من المفتاح المحفوظ مرة أخرى.
النشر
عندما يصبح المكوّن الإضافي جاهزًا:- أنشئ إصدارًا للإنتاج:
npm run build - اختبره بشكل شامل في وضع الاختبار والوضع المباشر.
- اتبع إرشادات نشر المكوّنات الإضافية في Figma.
- أرسل المكوّن الإضافي للمراجعة من خلال مجتمع Figma.