Versão da API

O Test Manager fornece duas versões de API que você pode usar na integração. A primeira versão das APIs não é protegida com controle de acesso baseado em função. A segunda versão das APIs é protegida com controle de acesso baseado em função no escopo de cada projeto. Diversas APIs legadas são acessíveis apenas por Administradores da Organização. A segunda versão dessas APIs agora também pode ser acessada por Proprietários do Projeto, mesmo se não forem Administradores da Organização.

Agendamento de versões

A V1 está operacional até setembro de 2022 para a versão Cloud e até 2023 (versão 2023.4) para as versões Independente e do Automation Suite do Test Manager.

APIs baseadas em versão

Versão da API	Permissões	Description
V1	• Anexos • AzureDevOpsConnector (obsoleto) • Recursos • Configuração • Conectores (descontinuados) • CustomFieldDefinitions (obsoleto) • CustomFieldValues • Defeitos • JiraCloudBasicAuthConnector (obsoleto) • JiraCloudOAuthConnector (descontinuado) • JiraConnectorWebHooks • JireServerConnector (obsoleto) • KPIs • ObjectLabels • Orchestrator • ProjectReports • Projetos (obsoleto) • RedmineConnector (obsoleto) • Requisitos (obsoleto) • ServerInfo • ServiceNowConnector (obsoleto) • Configurações • Telemetria • TestCaseLogs • TestCases • TestExecutions • TestSets • TestSteps • ThirdPartyAuth (obsoleto) • UserAuth • Usuários • UserSession • Configurações do Usuário • WebHookConfiguration (obsoleto) • XrayCloudConnector (obsoleto) • XrayConnectorWebhooks • XrayServerConnector (descontinuado)	Disponível para Administradores da Organização e usuários não administradores. Não protegido pelo controle de acesso baseado em função.
V2	• AzureDevOpsConnector • Conectores • Definições de campo personalizado • JiraCloudBasicAuthConnector • JiraCloudOAuthConnector • JiraServerConnector • Permissões do projeto • Projetos • QtestConnector • Redmine Connector • Requisitos • ServiceNow Connector • Configuração do WebHook • XrayCloudConnector • XrayServerConnector	Disponível para Administradores e Proprietários do Projeto.

Atualizar versão da API

Atualize a versão da API usando o Swagger para fazer chamadas de acesso baseadas em função.

1. Adicione /swagger/index.html ao URL da sua instância do Test Manager (por exemplo, https://testmanager.com/swagger/index.html).
2. Clique em Selecionar uma definição no topo da página e selecione V2 na lista suspensa.

   Agora as solicitações incluem o número da versão como pode ser visto no exemplo a seguir.

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

   
   

   

   
   

Artigos relacionados

• Visão geral
• Permissões