Activer la gestion des versions pour une API REST scriptée

  • Rversion finale: Zurich
  • Mis à jour 31 juil. 2025
  • 1 minute de lecture

    • Activez la gestion des versions d’une API REST scriptée afin de fournir plusieurs versions de l’API tout en maintenant la compatibilité avec les intégrations existantes.

    Avant de commencer

    Une API REST scriptée doit être définie avant de pouvoir activer la gestion des versions.

    Rôle requis : web_service_admin

    Procédure

    1. Accédez à la Tous > Services web du système > API REST basées sur un script.
    2. Sélectionnez une API REST scriptée.
    3. Sous Liens connexes, cliquez sur Activer la gestion des versions.
      La fenêtre contextuelle Activer la gestion des versions s’affiche. La case Rendre la version v1 par défaut est cochée par défaut.
    4. Facultatif : Décochez la case Faire la version v1 par défaut pour activer la gestion des versions sans version par défaut.
      Les API versionnées sans version par défaut ne sont accessibles qu’à l’aide de l’URI spécifique à la version. Faites de la version v1 une version par défaut ou sélectionnez une autre version par défaut après avoir activé la gestion des versions.
    5. Cliquez sur OK.
      La liste incorporée de gestion des versions est ajoutée au formulaire de service REST scripté. Vous pouvez ajouter de nouvelles versions ou contrôler la version par défaut à partir de cette liste.