Cycle de vie et dépréciation
Statuts de cycle de vie
| Statut | Signification | Usage recommandé |
|---|---|---|
| Beta | API ouverte à des pilotes ou intégrateurs précoces ; évolutions encore possibles | Usage encadré |
| Stable | API publique documentée et utilisable en production | Usage recommandé |
| Deprecated | API encore disponible mais remplacée par une cible | Nouveaux usages à éviter ; migration à planifier |
| Retired | API retirée et non accessible | Aucun nouvel usage possible |
Le statut Draft correspond à une phase de conception interne et n'est pas destiné aux intégrations externes sauf accord explicite.
Dépréciation
Lorsqu'une API Stable est remplacée, BCSolutions vise une trajectoire de migration documentée :
- identifier l'API, la route, le champ ou le comportement concerné ;
- documenter la cible de remplacement ;
- publier la dépréciation dans l'OpenAPI, les guides concernés et les release notes ;
- communiquer l'impact et les échéances ;
- maintenir l'ancienne version pendant la période de transition lorsque cela est possible ;
- retirer l'ancienne version à l'échéance annoncée ou plus tôt en cas d'exception justifiée.
Préavis indicatifs
| Cas | Durée de préavis indiquée |
|---|---|
| API Stable utilisée en production | 12 mois minimum |
| Endpoint Stable peu utilisé | 6 à 12 mois |
| API Beta | Durée adaptée au pilote |
| Faille de sécurité ou contrainte réglementaire | Retrait accéléré possible |
Exceptions
Une faille de sécurité, une contrainte réglementaire ou un accord contractuel spécifique peut imposer une trajectoire différente ou un retrait accéléré.