Utvecklare

    Bygg på CarbonX API.

    Ett REST- och webhook-gränssnitt till CarbonX marknadsplats. Förutsägbara svar, daterade versioner, signerade händelser och en riktig sandlåda för integration och test.

    Produktion
    https://api.carbonx.se
    Sandlåda
    https://sandbox.api.carbonx.se
    Aktuell version
    2026-07-01
    01

    Autentisering

    Alla anrop autentiseras med en API-nyckel från din arbetsyta under Inställningar → API-nycklar. Nycklar har roller (read, trade, admin) och skickas endast över TLS 1.2+ som Bearer-token.

    GET https://api.carbonx.se/v1/orders
    Authorization: Bearer cx_live_sk_...
    CarbonX-Version: 2026-07-01
    Idempotency-Key: 4f1c0f8e-...
    • Nycklar visas en gång vid skapande och lagras som saltade hashar.
    • Rotera nycklar minst var 12:e månad; komprometterade nycklar kan spärras direkt.
    • Muterande anrop bör skicka en Idempotency-Key (UUID v4) giltig i 24h.
    02

    Versionshantering

    CarbonX använder daterade versioner (ÅÅÅÅ-MM-DD). Din arbetsyta har en förvald version; enskilda anrop kan skriva över med headern CarbonX-Version. Brytande ändringar släpps alltid som ny version.

    Aktuell2026-07-01 (stabil)
    2026-01-15Stödd
    2025-07-01Utfasad — stängs 2026-12-31

    Additiva ändringar (nya fält, nya endpoints, nya enum-värden) höjer INTE versionen och kan tillkomma när som helst. Klienter ska ignorera okända fält.

    03

    Anropsgränser

    Läs (per nyckel)600 req / min
    Handel (per nyckel)120 req / min
    Webhook-försök8 försök, exponentiell backoff upp till 24h
    Burst2× i 10s, sedan strypt

    Varje svar innehåller X-RateLimit-Limit, X-RateLimit-Remaining och X-RateLimit-Reset. Vid överskridande får du HTTP 429 med Retry-After — respektera värdet.

    04

    Datafält

    Kärnresurser: Project, Credit, Order, Trade, Settlement, RegistryTransfer, Invoice. Gemensamma konventioner:

    idULID, oföränderlig primärnyckel
    created_at / updated_atRFC 3339 UTC
    currencyISO 4217 (EUR default)
    quantityHeltal tCO₂e, max 100 000
    price_per_unitDecimal €, > 0, ≤ 10 000
    registryverra | gold_standard | acr | car
    vintageFyrsiffrigt år
    statusResursspecifik enum (se referens)
    {
      "id": "01J6X7QK9C3W1YAZR7B4KMD8N2",
      "resource": "trade",
      "project_id": "01J6...",
      "quantity": 500,
      "price_per_unit": "18.40",
      "currency": "EUR",
      "registry": "verra",
      "vintage": 2023,
      "status": "settled",
      "created_at": "2026-07-14T09:12:03Z"
    }
    05

    Webhook-händelser

    CarbonX skickar signerade JSON-händelser till din endpoint. Signatur: HMAC-SHA256 av råkroppen med din endpoint-hemlighet, i headern CarbonX-Signature med tidsstämpel mot replay.

    order.createdNy indikativ order lagd
    order.matchedOrder matchad mot motpart
    trade.executedHandel överenskommen, väntar avveckling
    trade.settledKassa och registerben klara
    registry.transfer.updatedVerra/GS-överföring uppdaterad
    invoice.issuedFakturans PDF tillgänglig
    kyc.status.changedKYC-beslut för motpart

    Returnera HTTP 2xx inom 10 sekunder för att kvittera. Annat än 2xx eller timeout ger nytt försök (8 gånger, exponentiell backoff, upp till 24h).

    06

    Sandlåda

    Sandlådan är en isolerad miljö med seeddata för projekt, motparter och register. Inga riktiga pengar rör sig; inga riktiga krediter makuleras. Testnycklar prefixas cx_test_sk_.

    Bas-URLhttps://sandbox.api.carbonx.se
    Data-återställningVarje vecka, söndagar 02:00 UTC
    GränsSamma som produktion
    Webhook-simulatorTrigga valfri händelse från dashboarden
    07

    Ändringslogg

    2026-07-01

    Lade till Share Engine-endpoints (POST /v1/trades/:id/share), ny händelse registry.transfer.updated, kvantitetstak höjt till 100 000 tCO₂e.

    2026-01-15

    Standardiserad idempotens, ny CarbonX-Signature v2 (tidsstämpel + toleransfönster).

    2025-07-01

    Första publika API:et: orders, trades, projekt, webhooks. Nu utfasad — stängs 2026-12-31.

    08

    Drift & status

    Live-status, historisk drifttid och incidentrapporter publiceras på https://status.carbonx.se.

    SLO tillgänglighet API99.9% / month
    SLO webhook-leverans99.5% / month
    Incidentnotis≤ 15 min från upptäckt
    Post-mortemPubliceras inom 5 arbetsdagar för Sev-1/2
    09

    Utfasningspolicy

    • Minst 12 månaders parallellt stöd mellan utfasningsmeddelande och stängningsdatum.
    • Utfasningar annonseras i ändringsloggen, via e-post till arbetsyteägare och genom Deprecation-header på berörda endpoints.
    • En migreringsguide publiceras för varje brytande ändring, med jämförelser sida vid sida.
    • Säkerhetskritiska ändringar kan gå förbi policyn med så mycket varsel som möjligt.
    10

    Säkerhet & support

    Rapportera sårbarheter privat — öppna inte publika ärenden. Vi bekräftar inom en arbetsdag och åtgärdar kritiska brister inom 7 dagar. Safe-harbour gäller för seriös säkerhetsforskning.

    Allmänna frågor: hello@carbonx.se. Press: press@carbonx.se. Investerarrelationer: ir@carbonx.se.

    Cookies & Integritet

    Vi använder cookies för att säkerställa grundläggande funktionalitet, förbättra din upplevelse och analysera trafik. Autentisering (inklusive OAuth) kräver nödvändiga cookies för att fungera korrekt.