Hurtigstart
Kom i gang med Fenerum API på få minutter. Denne guide gennemgår det grundlæggende i autentificering og hvordan du opretter dine første ressourcer.
Kernebegreber
Før du går i gang med API'et, bør du kende disse grundlæggende objekter:
Account
En Account repræsenterer din kunde—den enhed, du fakturerer for dine tjenester. Hver konto kan have flere abonnementer, fakturaer og betalingsmetoder.
Vigtige attributter:
code- Din unikke identifikator for kunden (fxCUST001)name- Kunde- eller virksomhedsnavnemail- Faktureringskontaktens e-mailtype- Entencompanyellerperson
Eksempel:
{
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"code": "CUST001",
"name": "Acme Corporation",
"email": "billing@acme.com",
"type": "company"
}Plan
En Plan er et produkt eller en service, din virksomhed tilbyder—tænk på den som en skabelon for det, du sælger.
Eksempler:
- "Professional-pakke"
- "Enterprise-licens"
- "Cloud-lagring"
En pakke har i sig selv ingen prisfastsættelse—det er her, PlanTerms kommer ind.
PlanTerms
PlanTerms definerer de konkrete priser og faktureringsbetingelser for en pakke. En enkelt pakke kan have flere betingelser (fx månedlig vs. årlig prissætning).
Vigtige attributter:
price- Beløbet, der skal opkrævescurrency- Valutakode (USD, EUR, DKK osv.)interval_type- Faktureringsperiode:day,monthelleryearinterval_count- Antal intervaller (fx1for månedligt,12for årligt)backwards_charging- Nårfalse, opkræves ved periodens start (mest almindeligt). Nårtrue, opkræves ved periodens slutning.
Eksempel:
{
"uuid": "plan-terms-uuid",
"price": "99.00",
"currency": "USD",
"interval_type": "month",
"interval_count": 1,
"backwards_charging": false,
"active": true
}Subscription
Et Subscription repræsenterer en Accounts aktive brug af en pakke. Det er her, kunden og pakken bindes sammen.
Vigtige attributter:
account- Hvilken kunde der er tilmeldtterms- Hvilke PlanTerms der anvendesquantity- Hvor mange enheder (for per-seat pricing)collection_method- Hvordan betaling opkræves:invoice,cardellerdirect_debitstatus- Aktuel tilstand:active,cancelled,pausedosv.
Eksempel:
{
"uuid": "sub-uuid",
"account": "CUST001",
"terms": "plan-terms-uuid",
"quantity": 5,
"collection_method": "card",
"status": "active",
"current_period_start": "2025-01-01",
"current_period_end": "2025-02-01"
}Opsætning
Få din API-token
- Gå til Settings → Integrations
- Klik på Create API user i Fenerum-sektionen
- Kopiér din token og opbevar den sikkert
Hold din token hemmelig! Commit den aldrig til versionskontrol eller eksponer den i client-side kode.
Hurtigt eksempel
Sådan opretter du en kunde og begynder at fakturere:
1. Opret en konto
curl -X POST https://app.fenerum.com/api/v1/accounts/ \
-H "Authorization: Token YOUR_TOKEN" \
-H "X-Client-System: MyApp" \
-H "Content-Type: application/json" \
-d '{
"code": "CUST001",
"name": "Acme Corporation",
"email": "billing@acme.com",
"type": "company",
"legal_address": "123 Main Street",
"legal_zipcode": "12345",
"legal_city": "Copenhagen",
"legal_country": "DK"
}'{
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"code": "CUST001",
"name": "Acme Corporation",
"email": "billing@acme.com",
"type": "company"
}2. Opret et abonnement
curl -X POST https://app.fenerum.com/api/v1/subscriptions/ \
-H "Authorization: Token YOUR_TOKEN" \
-H "X-Client-System: MyApp" \
-H "Content-Type: application/json" \
-d '{
"account": "CUST001",
"terms": "YOUR_PLAN_TERMS_UUID",
"quantity": 5,
"collection_method": "invoice",
"start_date": "2025-01-01"
}'{
"uuid": "sub-uuid",
"account": "CUST001",
"terms": "YOUR_PLAN_TERMS_UUID",
"quantity": 5,
"collection_method": "invoice",
"status": "active",
"current_period_start": "2025-01-01",
"current_period_end": "2025-02-01"
}Næste skridt
Nu hvor du forstår det grundlæggende, kan du udforske disse guider:
- Integration Workflows - Vælg den rette integrationsmetode for din virksomhed
- Authentication - Læs om påkrævede headers og best practices for sikkerhed
- Accepting Payments - Integrer Stripe eller QuickPay til opkrævning af betalinger
- API Reference - Komplet endpoint-dokumentation
Ofte stillede spørgsmål
Hvordan finder jeg UUID for min pakke (Plan)?
Brug Plans-endpointet:
curl https://app.fenerum.com/api/v1/plans/ \
-H "Authorization: Token YOUR_TOKEN" \
-H "X-Client-System: MyApp"Svaret indeholder alle pakker og deres tilknyttede PlanTerms med UUID'er.
Hvad er forskellen på code og uuid?
code- Din egen identifikator for ressourcen (du vælger den)uuid- Fenerums unikke identifikator (systemgenereret)
Du kan bruge begge i API-anmodninger, men code er ofte mere praktisk, fordi du selv styrer den.
Brug for hjælp?
Kontakt vores supportteam, eller se den fulde API-dokumentation.