- Dokumentasjon
- Grunnlag
Versjonering
Datoversjoner, hva som regnes som en brytende endring, hvor lenge gamle versjoner støttes, og hvordan du oppgraderer trygt.
API-et er versjonert med datoer, for eksempel 2026-09-01. Kontoen din er låst til én versjon til du selv bytter. Det betyr at koden din fortsetter å virke uansett hva vi slipper.
Hvordan versjonen velges
- Hodet
Spire-Versionpå kallet, hvis satt. - Ellers kontoens standardversjon, som er versjonen som var nyeste da kontoen ble opprettet. Den kan endres i dashbordet.
Sett hodet eksplisitt i produksjon. Da er det synlig i koden hvilken versjon du bruker, og dashbordets standard kan endres uten overraskelser.
Spire-Version: 2026-09-01
Svaret har alltid hodet Spire-Version med versjonen som ble brukt.
Hva som er brytende
Disse endringene kommer bare i nye versjoner:
- Fjerne eller gi nytt navn til et felt, et endepunkt eller en feilkode
- Endre typen eller formatet på et felt
- Endre betydningen av et felt eller en standardverdi
- Gjøre et valgfritt felt påkrevd
- Endre HTTP-status for en situasjon
Disse endringene kan komme når som helst, i alle versjoner, og koden din må tåle dem:
- Nye felt i svar
- Nye endepunkter
- Nye valgfrie parametre
- Nye feilkoder (ha alltid en
default) - Nye hendelsestyper for webhooks (du får bare de du abonnerer på)
- Nye verdier i lister som i praksis er åpne, som
naering.kode
Støttetid
Hver versjon støttes i minst 24 måneder etter at neste versjon er sluppet. Vi varsler 6 måneder før en versjon slås av, på e-post til alle som har brukt den siste 90 dager, og i endringsloggen.
| Versjon | Sluppet | Støttes til |
|---|---|---|
2026-09-01 | 1. sep 2026 | Gjeldende |
2026-03-01 | 1. mar 2026 | Minst 1. sep 2028 |
2025-10-01 | 1. okt 2025 | Minst 1. mar 2028 |
v0 (uversjonert) | 2023 | 1. des 2026 (migreringsguide) |
Oppgradere
- Les endringene for alle versjoner mellom din og den nye i endringsloggen. Oppføringer av typen «API-versjon» lister alt som er brytende.
- Sett
Spire-Versionpå ett kall om gangen i sandkassen, og se at svaret ser ut som forventet. - Rull ut med hodet satt i koden. Dashbordets standardversjon bør oppdateres til slutt, som en opprydding.
Du kan bruke forskjellige versjoner på forskjellige kall samtidig. Det gjør det mulig å oppgradere én integrasjon av gangen.
Webhooks og versjoner
Hver webhook har sin egen versjon, satt da den ble opprettet. data i hendelsene følger den versjonen. Oppgrader en webhook ved å endre den (PATCH /v1/webhooks/{id} med api_versjon), eller opprett en ny og slett den gamle.
SDK-ene
Hver SDK-utgivelse har en standardversjon. Oppgraderer du SDK-et, kan standardversjonen endre seg. Sett versjonen eksplisitt i konfigurasjonen hvis du vil skille SDK-oppgraderinger fra API-oppgraderinger. Se SDK-er.