Hurtigstart

Kom i gang med Fenerum API på få minutter. Denne veiledningen går gjennom det grunnleggende om autentisering og hvordan du oppretter dine første ressurser.

Kjernebegreper

Før du går i gang med API-et, bør du forstå disse grunnleggende objektene:

Account

En Account representerer kunden din—enheten du fakturerer for tjenestene dine. Hver account kan ha flere abonnementer, fakturaer og betalingsmetoder.

Viktige attributter:

• code - Din unike identifikator for kunden (f.eks. CUST001)
• name - Kunde- eller selskapsnavn
• email - E-post for faktureringskontakt
• type - Enten company eller person

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 tjeneste som organisasjonen din tilbyr. Tenk på det som en mal for hva du selger.

Eksempler:

• "Professional Plan"
• "Enterprise License"
• "Cloud Storage"

En plan har ikke pris i seg selv—det er her PlanTerms kommer inn.

PlanTerms

PlanTerms definerer konkret pris og faktureringsbetingelser for en Plan. En enkelt plan kan ha flere terms (for eksempel månedlig vs. årlig prising).

Viktige attributter:

• price - Beløpet som skal belastes
• currency - Valutakode (USD, EUR, DKK, osv.)
• interval_type - Faktureringsperiode: day, month eller year
• interval_count - Antall intervaller (f.eks. 1 for månedlig, 12 for årlig)
• backwards_charging - Når false, belastes ved periodestart (vanligst). Når true, belastes ved periodeslutt.

Eksempel:

{
  "uuid": "plan-terms-uuid",
  "price": "99.00",
  "currency": "USD",
  "interval_type": "month",
  "interval_count": 1,
  "backwards_charging": false,
  "active": true
}

Subscription

En Subscription representerer en Accounts aktive bruk av en Plan. Dette er der kunden og planen knyttes sammen.

Viktige attributter:

• account - Hvilken kunde som er abonnent
• terms - Hvilke PlanTerms som brukes
• quantity - Antall enheter (for per-plass-prising)
• collection_method - Hvordan betaling innkreves: invoice, card eller direct_debit
• status - Gjeldende status: active, cancelled, paused, osv.

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"
}

Oppsett

Få din API-token

1. Gå til Settings → Integrations
2. Klikk på Create API user i Fenerum-seksjonen
3. Kopier tokenen din og lagre den sikkert

Hold tokenen hemmelig! Aldri sjekk den inn i versjonskontroll eller eksponer den i klient-side kode.

Hurtigeksempel

Slik oppretter du en kunde og begynner å fakturere dem:

1. Opprett 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. Opprett 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"
}

Neste steg

Nå som du forstår det grunnleggende, kan du utforske disse veiledningene:

• Integration Workflows - Velg riktig integrasjonsmetode for virksomheten din
• Authentication - Lær om påkrevde headere og anbefalte sikkerhetsrutiner
• Accepting Payments - Integrer Stripe eller QuickPay for betalingsinnkreving
• API Reference - Fullstendig endepunktdokumentasjon

Vanlige spørsmål

Hvordan finner jeg Plan-UUID-en min?

Bruk Plans-endepunktet:

curl https://app.fenerum.com/api/v1/plans/ \
  -H "Authorization: Token YOUR_TOKEN" \
  -H "X-Client-System: MyApp"

Responsen inkluderer alle Plan-objekter og deres tilknyttede PlanTerms med UUID-er.

Hva er forskjellen mellom code og uuid?

• code - Din egendefinerte identifikator for ressursen (du velger den)
• uuid - Fenerums unike identifikator (systemgenerert)

Du kan bruke begge i API-forespørsler, men code er ofte mer praktisk siden du kontrollerer den.

Trenger du hjelp?

Kontakt vårt supportteam eller se komplett API-dokumentasjon.