Royal Finance

Versionning de l’API

L’API est versionnée par préfixe URL. La version courante est v1.

https://api.royalstack.com/api/v1

Politique de breaking change

Nous considérons comme breaking :

  • Suppression d’un endpoint, champ ou code d’erreur.
  • Modification du type d’un champ.
  • Changement de la sémantique d’un champ existant.
  • Ajout d’un champ requis sur un endpoint existant.

Nous considérons comme non-breaking :

  • Ajout d’un nouvel endpoint.
  • Ajout d’un champ optionnel.
  • Ajout d’une valeur d’enum (préparez vos clients à recevoir des valeurs inconnues).
  • Élargissement des contraintes (maxLength, pattern).

Cycle de vie

  • Une version est active jusqu’à 18 mois après la sortie de la suivante.
  • Pendant les 6 derniers mois, elle passe en dépréciée : un header Royal-Deprecation: true est ajouté à toutes les réponses.
  • À expiration, la version est sunset et tous les appels renvoient 410 Gone.

Versionning par compte

Royal-Version: 2026-05-30

Le format est YYYY-MM-DD correspondant à la date de la release. Utile pour figer un comportement le temps de votre migration.