Caratteristiche
- Convalida della chiave di licenza: convalida le chiavi di licenza tramite l’API di Dodo Payments.
- Attivazione della chiave di licenza: attiva le chiavi di licenza con un nome di istanza, per le chiavi che hanno un limite di attivazione.
- Supporto per gli ambienti: configurabile sia per la modalità di test che per la modalità live.
- Supporto TypeScript: implementazione completamente tipizzata con gestione degli errori.
Iniziare
Prima di iniziare, ti servono l’app desktop Figma e un prodotto Dodo Payments che emetta chiavi di licenza.1
Create Base Plugin
Crea il tuo progetto plugin Figma con la guida introduttiva ai plugin di Figma. Figma genera uno scaffold con un file
manifest.json.2
Clone the Example Implementation
Clona il repository dodopayments-figma:Nel file
manifest.json clonato, sostituisci name e id con i valori del file manifest.json del plugin generato. Questo esempio è il punto di partenza per l’integrazione.3
Install Dependencies
Nella radice del progetto, esegui:
4
Configure Environment
Imposta
API_MODE in src/ui/api.ts:API_MODE seleziona l’host API: https://test.dodopayments.com per test_mode oppure https://live.dodopayments.com per live_mode.5
Customize Components
Personalizza i componenti del plugin in
src/ui/components/ in base alle tue esigenze:- Aggiorna
Authenticated.tsxper rendere disponibili le funzionalità agli utenti con chiavi di licenza valide. - Personalizza
LicenseKeyInput.tsxin modo che corrisponda al tuo design.
Authenticated.tsx è il punto in cui aggiungere le funzionalità premium del plugin. Il plugin le mostra solo dopo che una chiave di licenza è stata convalidata o attivata.Configurazione
1
Configure Network Access
L’esempio invia ogni richiesta della chiave di licenza tramite un proxy CORS all’indirizzo In
https://dodo-payments-proxy.aagarwal9782.workers.dev e il suo manifest.json consente l’accesso di rete solo a quel proxy. Il proxy non è disponibile, quindi chiama direttamente l’API di Dodo Payments. L’API accetta richieste cross-origin da qualsiasi origine, inclusa l’origine null dell’interfaccia utente del plugin.Nel tuo manifest.json, sostituisci il dominio del proxy con gli host dell’API di Dodo Payments:src/ui/api.ts, sostituisci fetch(proxyReq) con fetch(req) in validateLicenseKey e activateLicenseKey, in modo che ogni richiesta venga inviata direttamente all’API.Questo consente al plugin di convalidare e attivare le chiavi di licenza tramite l’API di Dodo Payments.2
Configure API Mode
In
src/ui/api.ts, configura la modalità dell’API:Sviluppo
1
Import Plugin
Importa il plugin nell’app desktop di Figma:
- Apri un file di progettazione.
- Apri il menu di Figma e seleziona Plugin.
- In Sviluppo, seleziona Importa nuovo plugin dal manifest…, quindi seleziona il file
manifest.jsonnella radice del progetto.
dist/, quindi avvia il server di sviluppo o esegui npm run build prima di eseguire il plugin.Per sviluppare e testare i plugin localmente è necessaria l’app desktop di Figma, perché Figma legge il codice del plugin dai file locali.
2
Start Development Server
Il plugin viene ricompilato automaticamente quando modifichi il codice sorgente.
Comandi di build
Il progetto include questi script npm:Integrazione delle chiavi di licenza
L’implementazione di esempio controlla una chiave di licenza prima di sbloccare il plugin. Puoi personalizzare ogni passaggio:- Input dell’utente: gli utenti inseriscono la propria chiave di licenza nell’interfaccia utente del plugin.
- Convalida: per impostazione predefinita, il plugin convalida la chiave con Validate License (
POST /licenses/validate). - Attivazione: se le tue chiavi di licenza hanno un limite di attivazione, imposta
needsActivationsutrueinsrc/ui/components/Unauthenticated.tsx. Il plugin attiva quindi la chiave con Activate License (POST /licenses/activate) invece di convalidarla e assegna all’istanza il nomeFigma Plugin. - Controllo degli accessi: per una chiave valida, il plugin salva la chiave con
figma.clientStoragee mostraAuthenticated.tsx. Alla successiva apertura del plugin, convalida nuovamente la chiave salvata.
Pubblicazione
Quando il plugin è pronto:- Compila per la produzione:
npm run build - Esegui test approfonditi sia in modalità di test che in modalità live.
- Segui le linee guida di Figma per la pubblicazione dei plugin.
- Invia il plugin per la revisione tramite Figma Community.