Begin hier
Versiebeheer en uitfasering
Begrijp hoofdversies in de URL, compatibele toevoegingen, uitfaseringsmeldingen en sunsetperiodes.
Stabiele paden per hoofdversie
Klantintegraties gebruiken een hoofdversie in de URL, momenteel /api/v1. De datumgebaseerde OpenAPI-info.version identificeert het exacte gepubliceerde contract binnen die hoofdversie.
Compatibele wijzigingen
SendHQ kan binnen v1 optionele requestvelden, responsvelden, enumwaarden (waar het schema dat toestaat) en nieuwe operaties toevoegen. Clients horen onbekende responsvelden te negeren en een enum niet als definitief gesloten te behandelen, tenzij het schema dat aangeeft.
Brekende wijzigingen
Een brekende wijziging in request, respons, authenticatie of gedrag vereist een nieuw pad voor de hoofdversie, zoals /api/v2, migratiedocumentatie en een aangekondigde overgang. De huidige v1-API is niet uitgefaseerd.
Uitfasering en sunset
Wordt een versie uitgefaseerd, dan documenteert SendHQ de vervanging en het migratiepad en retourneert het waar van toepassing de headers Deprecation en Sunset. Uitgefaseerde versies blijven ten minste 90 dagen na de gepubliceerde uitfaseringsdatum beschikbaar, tenzij verdere werking een urgent beveiligings- of juridisch risico oplevert.