CLI

Kommandoradsgränssnitt för att interagera med Dodo Payments API från din terminal

Hantera dina Dodo Payments-resurser, skapa checkout-sessioner och testa webhooks direkt från terminalen. Byggt för utvecklare som föredrar kommandoraden.

​

Installation

npm (Recommended)

npm install -g dodopayments-cli

​

Manuell installation

1. Ladda ner den senaste versionen från GitHub Releases för ditt system
2. Packa upp och döp om binärfilen till dodo
3. Flytta till en katalog i din PATH:

Linux

sudo mv ./dodo /usr/local/bin/

​

Autentisering

Innan du använder CLI:n, autentisera med din API-nyckel:

dodo login

Detta kommer att:

1. Öppna din webbläsare till Dodo Payments API Keys-sidan
2. Be dig ange din API-nyckel
3. Fråga dig vilken miljö (Testläge eller Live-läge) du vill välja
4. Lagra dina uppgifter lokalt till ~/.dodopayments/api-key

CLI:n stöder att lagra en API-nyckel per miljö. Om både test- och live-lägesnycklar är konfigurerade blir du ombedd välja vilken miljö som ska användas för den aktuella sessionen.

​

Användning

Den allmänna syntaxen är:

dodo ‹category› ‹sub-command›

Att köra dodo utan argument visar alla tillgängliga kategorier. Att köra dodo <category> utan underkommando visar de tillgängliga underkommandona för den kategorin.

​

Produkter

Hantera din produktkatalog.

Kommando	Beskrivning
dodo products list	Lista alla produkter (paginering)
dodo products create	Öppna instrumentpanelen för att skapa en produkt
dodo products info	Visa detaljer för en specifik produkt

​

Betalningar

Visa betalningstransaktioner.

Kommando	Beskrivning
dodo payments list	Lista alla betalningar (paginering)
dodo payments info	Hämta information om en specifik betalning

​

Kunder

Hantera din kundbas.

Kommando	Beskrivning
dodo customers list	Lista alla kunder (paginering)
dodo customers create	Skapa en ny kundprofil
dodo customers update	Uppdatera en befintlig kunds uppgifter

​

Rabatter

Hantera kuponger och rabatter.

Kommando	Beskrivning
dodo discounts list	Lista alla rabatter (paginering)
dodo discounts create	Skapa en ny rabatt baserad på procent
dodo discounts delete	Ta bort en rabatt via ID

​

Licenser

Hantera programvarulicenser.

Kommando	Beskrivning
dodo licences list	Lista alla licensnycklar (paginering)

​

Tillägg

Hantera produkttillägg.

Kommando	Beskrivning
dodo addons list	Lista alla tillägg (paginering)
dodo addons create	Öppna instrumentpanelen för att skapa ett tillägg
dodo addons info	Visa detaljer för ett specifikt tillägg

​

Återbetalningar

Visa återbetalningsinformation.

Kommando	Beskrivning
dodo refund list	Lista alla återbetalningar (paginering)
dodo refund info	Visa detaljer för en specifik återbetalning

​

Checkout

Skapa checkout-sessioner.

Kommando	Beskrivning
dodo checkout new	Skapa en ny checkout-session och få checkout-URL:en

Checkout-kommandot stöder avancerade alternativ inklusive minimal adressinsamling, återvändnings-URL, tvång av 3D Secure, rabattkoder och metadata.

​

Webhook-testning

CLI:n innehåller två kraftfulla verktyg för att testa webhooks under utveckling: en lyssnare som vidarebefordrar live testwebhooks till din lokala server och en trigger som skickar mock-webhook-payloads till vilken endpoint som helst.

​

Lyssna efter Webhooks

Vidarebefordra webhooks från Dodo Payments direkt till din lokala utvecklingsserver i realtid.

dodo wh listen

1. Enter your local endpoint URL

   Ange den lokala URL du vill ta emot webhooks på (t.ex. http://localhost:3000/webhook).

2. Automatic setup

   CLI:n skapar automatiskt en webhook-endpoint på ditt Dodo Payments-konto om ingen redan finns, och öppnar sedan en WebSocket-anslutning för att ta emot händelser i realtid.

3. Receive and forward

   När en webhook-händelse utlöses (från en testbetalning, prenumerationsförändring osv.) tar CLI:n emot den, loggar händelsetypen och vidarebefordrar hela förfrågan med headers och kropp till din lokala endpoint. Svaret från din endpoint loggas och skickas tillbaka.

Webhook-lyssnaren fungerar endast med en API-nyckel för testläge. Se till att du är inloggad med en testlägesnyckel innan du använder dodo wh listen.

Lyssnaren bevarar de ursprungliga webhook-headersen (webhook-id, webhook-signature, webhook-timestamp) när den vidarebefordrar till din lokala endpoint, så att du kan testa din signaturverifieringslogik.

​

Trigga testwebhooks

Skicka mock-webhook-payloads till vilken endpoint som helst för snabb testning utan att behöva skapa riktiga transaktioner.

dodo wh trigger

Detta guidar dig genom:

1. Att ange en destinations-endpoint-URL
2. Valfritt konfigurera Business ID, Product ID och Metadata
3. Att välja en specifik händelse att trigga från en interaktiv meny
4. Att skicka den mockade payloaden och visa svaret

Efter varje händelse kan du välja en annan händelse att trigga eller avsluta – vilket gör det enkelt att testa flera händelsehanterare i en session.

Trigger-verktyget skickar mock-payloads utan webhook-signaturer. Inaktivera verifiering av webhook-signaturer under testning genom att använda unsafe_unwrap() istället för unwrap() i din webhook-hanterare.

​

Stödda webhook-händelser

Kategori	Händelser
Subscription	subscription.active, subscription.updated, subscription.on_hold, subscription.renewed, subscription.plan_changed, subscription.cancelled, subscription.failed, subscription.expired
Payment	payment.success, payment.failed, payment.processing, payment.cancelled
Refund	refund.success, refund.failed
Dispute	dispute.opened, dispute.expired, dispute.accepted, dispute.cancelled, dispute.challenged, dispute.won, dispute.lost
License	licence.created

​

Miljövariabler

Variabel	Beskrivning
DODO_WH_TEST_SERVER_URL	Åsidosätt standard-URL:en för webhook-reläservern som används av dodo wh listen

​

Resurser

GitHub Repository

Visa källkod och utgåvor

npm Package

Visa på npm-registret

​

Support

• Discord: Gå med i vår community-server
• GitHub: Öppna ett issue i arkivet
• E-post: Kontakta oss på [e-mail]