Version de l’API

Test Manager fournit deux versions d'API permettant l'intégration. La première version des API n'est pas protégée par un contrôle d'accès basé sur les rôles. La deuxième version des API est protégée par un contrôle d'accès basé sur les rôles dans l'étendue d'un projet donné. Plusieurs API héritées ne sont accessibles qu'aux administrateurs d'organisation. La deuxième version de ces API est désormais également accessible aux propriétaires de projet, même s'ils ne sont pas des administrateurs d'organisation.

Calendrier de version

La version V1 est obsolète et sera supprimée en avril 2023 (version 2023.4) pour l’installation autonome et la version Automation Suite de Test Manager.

API basées sur la version

Version de l'API	Autorisations	Description
V1	• PiècesJointes ()Attachments • ConnecteurAzureDevOps (AzureDevOpsConnector) (obsolète) • Capacités (Capabilities) • Configuration • Connecteurs (Connectors) (obsolète) • DéfinitionsChampPersonnalisé (CustomFieldDefinitions) (obsolète) • ValeursChampPersonnalisé (CustomFieldValues) • Défauts (Defects) • ConnecteurAuthentificationBaseJiraCloud (JiraCloudBasicAuthConnector) (obsolète) • ConnecteurOAuthJiraCloud (JiraCloudOAuthConnector) (obsolète) • WebhooksConnecteurJira (JiraConnectorWebHooks) • ConnecteurJiraServeur (JireaServerConnector) (obsolète) • ICP (KPIs) • LibellésObjet (ObjectLabels) • Orchestrator • RapportsProjet (ProjectReports • Projets (Projects) (obsolète) • ConnecteurRedmine (RedmineConnector) (obsolète) • Exigences (Requirements) (obsolète) • InformationsServeur (ServerInfo) • ConnecteurServiceNow (ServiceNowConnector) (obsolète) • Paramètres (Settings) • Télémétrie (Telemetry) • JournauxCasTest (TestCaseLogs) • CasTest (TestCases) • ExécutionsTest (TestExecutions) • EnsemblesTests (TestSets) • ÉtapesTest ()TestSteps • AutorisationTierce (ThirdPartyAuth) (obsolète) • AuthentificationUtilisateur (UserAuth) • Utilisateurs (Users) • SessionUtilisateur (UserSession) • ParamètresUtilisateur (UserSettings) • ConfigurationWebhook (WebHookConfiguration) (obsolète) • ConnecteurXrayCloud (XrayCloudConnector) (obsolète) • XrayConnectorWebhooks • ConnecteurServeurXray (XrayServerConnector) (obsolète)	Disponible pour les administrateurs d'organisation et les utilisateurs non administrateurs. Non protégé par le contrôle d'accès basé sur les rôles.
V2	• ConnecteurAzureDevOps (AzureDevOpsConnector) • Connecteurs (Connectors) • DéfinitionsChampPersonnalisé (CustomFieldDefinitions) • ConnecteurAuthentificationBaseJiraCloud (JiraCloudBasicAuthConnector) • ConnecteurOAuthJiraCloud (JiraCloudOAuthConnector) • ConnecteurJiraServer (JiraServerConnector) • AutorisationsProjet (ProjectPermissions) • Projets (Projects) • ConnecteurQtest (QtestConnector) • ConnecteurRedmine (RedmineConnector) • Exigences (Requirements) • ConnecteurServiceNow (ServiceNowConnector) • ConfigurationWebhook (WebHookConfiguration) • ConnecteurXrayCloud (XrayCloudConnector) • ConnecteurServeurXray (XrayServerConnector)	Disponible pour les administrateurs et les propriétaires de projet.

Mettre à jour la version de l'API

Mettez à jour la version de l'API à l'aide de Swagger pour effectuer des appels d'accès basés sur les rôles.

1. Ajoutez /swagger/index.html à l'URL de votre instance Test Manager (par exemple, https://testmanager.com/swagger/index.html).

2. Cliquez sur Sélectionner une définition (Select a definition) en haut de la page et sélectionnez V2 dans la liste déroulante.

   Désormais, les demandes incluent le numéro de version, comme vous pouvez le voir dans l'exemple suivant.

   curl -X 'GET' \
     'https://company/testmanager/companyTenant/testmanager_/api/v2/projects' \
     -H 'accept: application/json'
   

   

Articles associés

• Vue d'ensemble (Overview)