Integraatiotyönkulut
Yleiskatsaus
Fenerum tarjoaa joustavia integraatiovaihtoehtoja liiketoimintasi tarpeisiin. Valitse käyttötapaukseesi parhaiten sopiva malli:
Valitse integraatiomalli:
Käytä Fenerum UI:ta, vie data BI-työkaluihin
Self-Service + API taustajärjestelmälle
Täysin headless-integraatio (suositeltu B2B SaaS -yrityksille)
<a id="ui-first-integration"></a>
UI-lähtöinen integraatio
Sopii parhaiten: Pienille tiimeille, startupeille tai yrityksille, jotka haluavat hyödyntää Fenerumin sisäänrakennettuja ominaisuuksia minimaalisella kehitystyöllä.
Näin se toimii
Hallitse kaikkea Fenerum UI:ssa
- Luo accountit, tilaukset (subscriptions) ja planit verkkokäyttöliittymän kautta
- Luo laskuja ja hallitse laskutusta manuaalisesti tai automaatiosäännöillä
- Seuraa mittareita sisäänrakennetuilla koontinäytöillä
Vie dataa analytiikkaa varten API:n kautta
- Käytä read-only API -endpointeja datan hakemiseen BI-työkaluihin
- Yleiset endpointit:
/api/v1/accounts/,/api/v1/invoices/,/api/v1/subscriptions/ - Synkronoi data tietovarastoon räätälöityä raportointia varten
Keskeiset hyödyt
- Nopea käyttöönotto - Ei integraatiokoodausta
- Täydet ominaisuudet käytössä - Käytä kaikkia Fenerumin ominaisuuksia UI:n kautta
- Yksinkertainen analytiikka - Vie dataa tarpeen mukaan
Esimerkki: Laskujen vienti
curl https://app.fenerum.com/api/v1/invoices/?created_date__gte=2025-01-01 \
-H "Authorization: Token your-token-here" \
-H "X-Client-System: BIExport"<a id="hybrid-integration"></a>
Hybridi-integraatio
Sopii parhaiten: Yrityksille, jotka haluavat automatisoida taustaprosessit ja tarjota asiakkaille itsepalveluportaalin.
Näin se toimii
Asiakaspinta: Fenerum Self-Service
- Asiakkaat hallitsevat omia maksutapojaan Self-Service -portaalissa
- Lisää/poista kortteja, päivitä laskutustiedot, tarkastele laskuja
- Ei kehitystyötä sinun puoleltasi
Tausta: API-integraatio
- Luo accountit ja tilaukset automaattisesti API:n kautta, kun asiakkaat rekisteröityvät
- Synkronoi usage-data, päivitä määrät, hallitse elinkaaritapahtumia
- Hoida monimutkainen liiketoimintalogiikka sovelluksessasi
Integraatiokulku
Your App (Backend) Fenerum API Customer
│ │ │
│ Create Account │ │
├──────────────────────────► │ │
│ │ │
│ Create Subscription │ │
├──────────────────────────► │ │
│ │ │
│ Generate Self-Service Link │ │
├──────────────────────────► │ │
│ ◄────────────────────────┤ │
│ │ │
│ Redirect Customer to Self-Service │
├──────────────────────────────────────────────────► │
│ │ │
│ │ Add Payment Card │
│ │ ◄──────────────────── │Esimerkki: Luo Self-Service-linkki
curl -X POST https://app.fenerum.com/api/self-service/initiate-organization/ \
-H "Authorization: Token your-token-here" \
-H "X-Client-System: YourApp" \
-H "Content-Type: application/json" \
-d '{
"email": "customer@example.com"
}'{
"url": "https://yourcompany.hostedsignup.com/auth/login?token=..."
}Katso täydelliset asennusohjeet: Self-Service-ohje.
<a id="full-api-integration"></a>
Täysi API-integraatio
Sopii parhaiten: B2B SaaS -yrityksille, jotka haluavat täyden kontrollin ja täysin brändätyn kokemuksen.
✨ Suositeltu B2B SaaS -yrityksille - Asiakkaasi eivät näe tai käytä Fenerumia suoraan. Kaikki tapahtuu sovelluksessasi, ja Stripe tai QuickPay hoitaa maksujen keruun.
Näin se toimii
Täysin headless-integraatio, jossa kaikki laskutustoiminnot hallitaan ohjelmallisesti:
- Asiakashallinta - Luo/päivitä accountit API:n kautta
- Tilauksen elinkaari - Aloita, päivitä, alenna, peruuta tilauksia
- Maksujen keruu - Käytä suoraan Stripea tai QuickPayta (katso Maksujen vastaanotto)
- Käytön seuranta - Raportoi käyttötiedot metered billing -mallia varten
- Laskutus - Laskujen automaattinen luonti ja toimitus
Tärkeää: Luontijärjestys
Luo resurssit aina tässä järjestyksessä:
- Account - Asiakkaasi
- Sopimukset (Contracts) (valinnainen) - Erikoishinnoittelu tai volyymialennukset tasoilla
- Maksutapa - Stripe- tai QuickPay-kortin rekisteröinti
- Tilaus (Subscription) - Aktiivisen planin käyttö
Vaihe 1: Luo asiakas (Account)
curl -X POST https://app.fenerum.com/api/v1/accounts/ \
-H "Authorization: Token your-token-here" \
-H "X-Client-System: YourApp" \
-H "X-User: admin@yourapp.com" \
-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"
}Vaihe 2: Lisää sopimukset (Contracts) (valinnainen)
Jos asiakkaalla on sovittu erikoishinnoittelu tai volyymialennukset, luo sopimus (contract) alennustasoilla:
# First, create the contract
curl -X POST https://app.fenerum.com/api/v1/accounts/CUST001/contracts/ \
-H "Authorization: Token your-token-here" \
-H "X-Client-System: YourApp" \
-H "Content-Type: application/json" \
-d '{
"plan_terms": "plan-terms-uuid",
"start_date": "2025-01-01",
"end_date": "2025-12-31"
}'{
"uuid": "contract-uuid-here",
"plan_terms": "plan-terms-uuid",
"start_date": "2025-01-01",
"end_date": "2025-12-31"
}Lisää sen jälkeen alennustasot sopimukseen:
# Add a tier: 15% discount when quantity >= 10
curl -X POST https://app.fenerum.com/api/v1/accounts/CUST001/contracts/contract-uuid-here/tiers/ \
-H "Authorization: Token your-token-here" \
-H "X-Client-System: YourApp" \
-H "Content-Type: application/json" \
-d '{
"minimum_quantity": 10,
"discount": "15.00",
"discount_type": "percentage"
}'Vaihe 3: Rekisteröi maksutapa
Käytä Stripea tai QuickPayta maksukorttitietojen keräämiseen, ja rekisteröi token Fenerumiin:
Stripea varten:
curl -X POST https://app.fenerum.com/api/v1/paymentcards/ \
-H "Authorization: Token your-token-here" \
-H "X-Client-System: YourApp" \
-H "Content-Type: application/json" \
-d '{
"account": "123e4567-e89b-12d3-a456-426614174000",
"token": "pm_1234567890",
"gateway": "stripe"
}'QuickPayta varten:
curl -X POST https://app.fenerum.com/api/v1/paymentcards/ \
-H "Authorization: Token your-token-here" \
-H "X-Client-System: YourApp" \
-H "Content-Type: application/json" \
-d '{
"account": "123e4567-e89b-12d3-a456-426614174000",
"token": "12345678",
"gateway": "quickpay"
}'Katso kattavat maksuintegraatioesimerkit: Maksujen vastaanotto -ohje.
Vaihe 4: Luo tilaus (Subscription)
Lopuksi luo tilaus laskutuksen käynnistämiseksi:
curl -X POST https://app.fenerum.com/api/v1/subscriptions/ \
-H "Authorization: Token your-token-here" \
-H "X-Client-System: YourApp" \
-H "X-User: admin@yourapp.com" \
-H "Content-Type: application/json" \
-d '{
"account": "CUST001",
"terms": "plan-terms-uuid",
"quantity": 5,
"collection_method": "card",
"start_date": "2025-01-01"
}'{
"uuid": "sub-uuid-here",
"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"
}Täydellinen integraatioesimerkki
Koko kulku oikeassa järjestyksessä:
<!-- focus-start -->
import requests
# Configuration
FENERUM_TOKEN = 'your-token-here'
FENERUM_BASE_URL = 'https://app.fenerum.com/api/v1'
headers = {
'Authorization': f'Token {FENERUM_TOKEN}',
'X-Client-System': 'YourApp',
'X-User': 'admin@yourapp.com',
'Content-Type': 'application/json'
}
# Step 1: Create Account
account_response = requests.post(
f'{FENERUM_BASE_URL}/accounts/',
headers=headers,
json={
'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'
}
)
account = account_response.json()
account_uuid = account['uuid']
# Step 2: Add Contract with discount tiers (optional)
contract_response = requests.post(
f'{FENERUM_BASE_URL}/accounts/CUST001/contracts/',
headers=headers,
json={
'plan_terms': 'plan-terms-uuid',
'start_date': '2025-01-01',
'end_date': '2025-12-31'
}
)
contract = contract_response.json()
# Add a discount tier: 15% off when quantity >= 10
tier_response = requests.post(
f'{FENERUM_BASE_URL}/accounts/CUST001/contracts/{contract["uuid"]}/tiers/',
headers=headers,
json={
'minimum_quantity': 10,
'discount': '15.00',
'discount_type': 'percentage'
}
)
# Step 3: Register Payment Method
# (After collecting card via Stripe/QuickPay)
card_response = requests.post(
f'{FENERUM_BASE_URL}/paymentcards/',
headers=headers,
json={
'account': account_uuid,
'token': 'pm_1234567890', # From Stripe
'gateway': 'stripe'
}
)
# Step 4: Create Subscription
subscription_response = requests.post(
f'{FENERUM_BASE_URL}/subscriptions/',
headers=headers,
json={
'account': 'CUST001',
'terms': 'plan-terms-uuid',
'quantity': 5,
'collection_method': 'card',
'start_date': '2025-01-01'
}
)
subscription = subscription_response.json()
<!-- focus-end -->
print(f"Created subscription: {subscription['uuid']}")Keskeiset hyödyt
- Täysi kontrolli - Täysi ohjelmallinen hallinta laskutuksesta
- Brändätty kokemus - Asiakkaat eivät poistu sovelluksestasi
- Joustavat työnkulut - Toteuta tarvitsemiasi liiketoimintasääntöjä
- Skaalautuva - Automatisoi kaikki onboardingista peruutukseen
Seuraavat askeleet
- Autentikointi - Määritä API-tunnisteet
- Maksujen vastaanotto - Integroi Stripe tai QuickPay
- Virheenkäsittely - Käsittele API-virheet hallitusti
- API-viite - Täydellinen päätetason dokumentaatio
Tarvitsetko apua valinnassa?
Aloita pienesti, skaalaa tarpeen mukaan:
- Aloita UI-lähtöisellä integraatiolla tutustuaksesi Fenerumiin
- Lisää Hybridi-integraatio, kun tarvitset asiakkaiden itsepalvelun
- Siirry Täyteen API-integraatioon, kun liiketoiminta kasvaa
Ota yhteyttä tukitiimiimme, jos tarvitset apua sinulle sopivimman lähestymistavan valinnassa.