Versie 1
De API staat onder /api/v1/. Zolang je dat pad gebruikt, breekt een wijziging van ons je integratie niet.
Wat binnen v1 niet breekt
- Een bestaand veld of bestaande tabel verdwijnt of krijgt een andere naam niet zonder aankondiging.
- Het type van een bestaand veld verandert niet.
- De vorm van het antwoord (
connections,data,next_cursor,sync_watermark), de parameters en de foutcodes blijven gelijk.
Wat er wel zonder aankondiging kan bijkomen
- Nieuwe velden in bestaande tabellen.
- Nieuwe tabellen en nieuwe koppelingen.
- Nieuwe optionele parameters en nieuwe waarden in codevelden, bijvoorbeeld een extra status.
Laat je integratie daarom velden negeren die hij niet kent, en ga er niet van uit dat een codeveld alleen de waarden heeft die nu in de referentie staan.
Verwijderen of hernoemen: minimaal 90 dagen van tevoren
Willen we een veld of tabel toch verwijderen of hernoemen, dan kondigen we dat minimaal 90 dagen van tevoren aan:
- in de Changelog, met de datum waarop de wijziging ingaat;
- per e-mail aan de beheerders van organisaties die op dat moment een actieve API-sleutel hebben.
Op de hoogte blijven
Alle wijzigingen staan in de Changelog. Beheerders van organisaties met een actieve API-sleutel krijgen aankondigingen van brekende wijzigingen bovendien per e-mail.
Was dit artikel behulpzaam?