Funktioner
- Validering av licensnyckel: Validerar licensnycklar mot Dodo Payments API.
- Aktivering av licensnyckel: Aktiverar licensnycklar med ett instansnamn för nycklar som har en aktiveringsgräns.
- Stöd för miljöer: Kan konfigureras för både testläge och live-läge.
- TypeScript-stöd: Fullständigt typad implementation med felhantering.
Komma igång
Innan du börjar behöver du Figma-skrivbordsappen och en Dodo Payments-produkt som utfärdar licensnycklar.1
Create Base Plugin
Skapa ditt eget Figma-pluginprojekt med Figma’s plugin quickstart guide. Figma genererar ett skelett med en
manifest.json-fil.2
Clone the Example Implementation
Klona dodopayments-figma-repositoryt:I det klonade
manifest.json ersätter du name och id med värdena från ditt genererade plugins manifest.json. Det här exemplet är din utgångspunkt för integrationen.3
Install Dependencies
Kör följande i projektroten:
4
Configure Environment
Ange
API_MODE i src/ui/api.ts:API_MODE väljer API-värd: https://test.dodopayments.com för test_mode eller https://live.dodopayments.com för live_mode.5
Customize Components
Anpassa pluginets komponenter i
src/ui/components/ efter dina behov:- Uppdatera
Authenticated.tsxför att exponera funktioner för användare med giltiga licensnycklar. - Anpassa
LicenseKeyInput.tsxefter din design.
Authenticated.tsx är platsen där du lägger till pluginets premiumfunktioner. Pluginet visar dem först efter att en licensnyckel har validerats eller aktiverats.Konfiguration
1
Configure Network Access
Exemplet skickar varje licensnyckelbegäran via en CORS-proxy på I
https://dodo-payments-proxy.aagarwal9782.workers.dev, och dess manifest.json tillåter nätverksåtkomst endast till den proxyn. Proxyn är inte tillgänglig, så anropa Dodo Payments API direkt. API:et accepterar cross-origin-begäranden från alla origins, inklusive null-originen för pluginets UI.I din manifest.json ersätter du proxydomänen med Dodo Payments API-värdarna:src/ui/api.ts ersätter du fetch(proxyReq) med fetch(req) i validateLicenseKey och activateLicenseKey, så att varje begäran går direkt till API:et.Detta gör att pluginet kan validera och aktivera licensnycklar med Dodo Payments API.2
Configure API Mode
I
src/ui/api.ts konfigurerar du API-läget:Utveckling
1
Import Plugin
Importera pluginet i Figma-appen för datorer:
- Öppna en designfil.
- Öppna Figma-menyn och välj Plugins.
- Under Development väljer du Import new plugin from manifest… och väljer sedan filen
manifest.jsoni projektets rotkatalog.
dist/, så starta utvecklingsservern eller kör npm run build innan du kör pluginet.Du behöver Figma-appen för datorer för att utveckla och testa plugins lokalt, eftersom Figma läser pluginets kod från lokala filer.
2
Start Development Server
Pluginet byggs automatiskt om när du ändrar källkoden.
Byggkommandon
Projektet innehåller följande npm-skript:Integration av licensnyckel
Exempelimplementeringen kontrollerar en licensnyckel innan pluginet låses upp. Du kan anpassa varje steg:- Användarinmatning: Användare anger sin licensnyckel i pluginets UI.
- Validering: Som standard validerar pluginet nyckeln med Validate License (
POST /licenses/validate). - Aktivering: Om dina licensnycklar har en aktiveringsgräns anger du
needsActivationtilltrueisrc/ui/components/Unauthenticated.tsx. Pluginet aktiverar då nyckeln med Activate License (POST /licenses/activate) i stället för att validera den och namnger instansenFigma Plugin. - Åtkomstkontroll: För en giltig nyckel sparar pluginet nyckeln med
figma.clientStorageoch visarAuthenticated.tsx. Nästa gång pluginet öppnas validerar det den sparade nyckeln igen.
Publicering
När pluginet är klart:- Bygg för produktion:
npm run build - Testa noggrant i både testläge och live-läge.
- Följ Figmas riktlinjer för publicering av plugins.
- Skicka in pluginet för granskning via Figma Community.