Introdução ao Test Manager SDK

Os métodos de autorização descritos neste tópico fornecem informações sobre como estabelecer uma conexão serviço a serviço entre o Test Manager e seu aplicativo ou outros aplicativos parceiros.

Pré-requisitos

• Habilitar Testar automação no Orchestrator. Para obter mais informações, consulte Habilitando/desabilitando recursos.
• Gere um token de instalação no Orchestrator Identity Management. Você precisará disso para provisionar através da linha de comando.Para obter o token de acesso ao Orchestrator Identity, consulte Gerar um token de acesso de instalação.

Métodos de autorização

Você pode escolher entre dois métodos para provisionar um cliente OAuth externo, com base em casos de uso específicos que dependem das versões usadas em sua infraestrutura de produto UiPath:

• Se você executar o Test Manager e o Orchestrator versão 21.4 ou superior, pode usar Provisionamento por meio de Gerenciamento de identidade.
• Se você executar o Test Manager versão 21.4 e Orchestrator versão 20.10 ou quiser habilitar o acesso entre tenants, você pode usar o Provisionamento por meio do CLI do Test Manager.

Provisionamento por meio do Gerenciamento do Identity

Você pode registrar seu aplicativo no Identity Management, definir os escopos do Test Manager e estabelecer uma conexão entre os aplicativos.

Para configurar e autorizar seu aplicativo, você precisa adicionar um aplicativo externo.

Quando você definir os escopos para a integração, selecione Test Manager como Recurso. Para obter mais informações, consulte Escopos.

Provisionamento por meio do CLI do Test Manager

Por meio da autorização da CLI do Test Manager, você pode provisionar o cliente, atribuir escopos e, em seguida, estabelecer uma conexão serviço a serviço entre os aplicativos.

Para integrar e começar a usar seu aplicativo com Test Manager, você precisa configurar a autorização: Provisionar cliente e escopos e obter ID do cliente e segredo do cliente.

Configurar autorização

Para estabelecer uma conexão serviço a serviço entre o Test Manager e seu aplicativo, você usará a Test Manager Provisioning Tool como a ferramenta CLI principal para obter um cliente, fornecer direitos de acesso e escopos para sua integração. Você pode encontrar esta ferramenta empacotada com cada compilação como testmanager.exe no local de instalação padrão, da seguinte forma:

C:\Program Files (x86)\UiPath\TestManager\Tools\TestManagerProvisioner.

Alternativamente, você pode encontrar o executável em sua pasta de instalação personalizada. Para obter uma lista de comandos e opções que estão fora do escopo da sua integração, consulte Test Manager Provisioning Tool Cheat Sheet.

A seção a seguir lista os parâmetros de linha de comando disponíveis, incluindo opções e valores padrão para que você possa fornecer direitos de acesso e escopos e, em seguida, obter um ID e um segredo do cliente para seu aplicativo.

Observação:

• Você precisará do token de instalação gerado por meio do Orchestrator Identity Management, conforme solicitado na seção de pré-requisitos.
• Você precisa definir os escopos do Test Manager.

Command	Opção	Description
register third-party-s2sclient	-iu, --identityUrl (Necessário)	A URL absoluta onde o Identity Server está localizado.
	-iit, --identityInstallationToken <identityinstallationtoken> (Necessário)	O token de autenticação para provisionar clientes no Identity Server.
	cscopes, --clientScopes <clientscopes> (Necessário)	Mostre os escopos do cliente a serem usados ao criar o cliente.
	`-cid, --clientID <clientid>`	Mostre o ID do cliente a ser usado ao criar o cliente. Isso é gerado automaticamente se você não fornecer um ID do cliente.
	-cname, --clientName <clientname>	Mostre o nome do cliente a ser usado ao criar o cliente. Isso é gerado automaticamente se você não fornecer um nome de cliente.
	-csecret, --clientSecret <clientsecret>	Mostre o segredo do cliente a ser usado ao criar o cliente. Isso é gerado automaticamente se você não fornecer um segredo do cliente
	-lang, --language <language>	Especifique o idioma das mensagens de erro.
	-?, -h?, --help	Mostrar informações de ajuda e uso.

Amostra de Script de Shell

No exemplo a seguir, o comando register third-party-s2sclient é seguido pelo URL do Orchestrator Identity, token de instalação do Identity e os escopos de projeto do Test Manager.

testmanager.exe <code>
register third-party-s2sclient</code>
-iu "https://orchestratorURL/identity" <code>
-iit "e908741iofjikasjijfapuosf09210-012opjawdfsaodgfsadgu90029183i1jiratjapo" </code>
-cscopes "TM.Projects" "TM.Requirements.Read"
Client created successfully. Please note the data below right away. You will not be able to retrieve the secret afterwards.
ClientID: TestManager.ThirdPartyClient.36512487-1rfasdf-11451-321535
ClientName: TestManager.ThirdPartyClient.36512487-1rfasdf-11451-321535
ClientSecret: 43sdgj@efg145!fgdsg53125sfdg12a*gbj9

Exemplos de API

Para executar uma chamada de API para o Test Manager, dê uma olhada no exemplo a seguir para buscar projetos do Test Manager.

Chamada de API para autorização do Identity Management

GANHE https://[test-manager-URL.com]/api/projects

Headers
    Content-Type: application/json
  Authorization: "Bearer [Oauth Access Token]"Content-Type: application/json<code> </code>{
  "data": [
    {
      "projectPrefix": "INS",
      "id": "96a80aa7-5a7f-4117-c342-08d7add64671",
      "name": "Insurance Calculator",
      "description": "\)\)"The virtual insurance calculator creates sample quotes for different types of insurance.\)\)"",
      "created": "2020-02-10T07:07:33.167Z",
      "createdBy": "74dde091-4a16-4225-aea9-5c3a27b2d996",
      "updated": "2020-02-10T07:07:33.167Z",
      "updatedBy": "74dde091-4a16-4225-aea9-5c3a27b2d996"
    },
    {
      "projectPrefix": "ELI",
      "id": "609f7c5b-c798-46b1-c343-08d7add64671",
      "name": "Eligibility",
      "description": "Eligibility for credit",
      "created": "2020-02-10T09:24:18.63Z",
      "createdBy": "74dde091-4a16-4225-aea9-5c3a27b2d996",
      "updated": "2020-02-10T09:24:18.63Z",
      "updatedBy": "74dde091-4a16-4225-aea9-5c3a27b2d996"
    }
  ],
  "paging": {
    "total": 2,
    "page": 1,
    "pages": 1,
    "pageSize": 12,
    "returned": 2,
    "previousPage": false,
    "nextPage": false
  }
}

Chamada de API para autorização CLI do Test Manager

GANHE https://[test-manager-URL.com]/api/projects

Headers
    Content-Type: application/json
  Authorization: "Bearer [Oauth Access Token]"
    X-UiPath-TenantGlobalId: [Tenant ID]Content-Type: application/json
{
  "data": [
    {
      "projectPrefix": "INS",
      "id": "96a80aa7-5a7f-4117-c342-08d7add64671",
      "name": "Insurance Calculator",
      "description": "\)\)"The virtual insurance calculator creates sample quotes for different types of insurance.\)\)"",
      "created": "2020-02-10T07:07:33.167Z",
      "createdBy": "74dde091-4a16-4225-aea9-5c3a27b2d996",
      "updated": "2020-02-10T07:07:33.167Z",
      "updatedBy": "74dde091-4a16-4225-aea9-5c3a27b2d996"
    },
    {
      "projectPrefix": "ELI",
      "id": "609f7c5b-c798-46b1-c343-08d7add64671",
      "name": "Eligibility",
      "description": "Eligibility for credit",
      "created": "2020-02-10T09:24:18.63Z",
      "createdBy": "74dde091-4a16-4225-aea9-5c3a27b2d996",
      "updated": "2020-02-10T09:24:18.63Z",
      "updatedBy": "74dde091-4a16-4225-aea9-5c3a27b2d996"
    }
  ],
  "paging": {
    "total": 2,
    "page": 1,
    "pages": 1,
    "pageSize": 12,
    "returned": 2,
    "previousPage": false,
    "nextPage": false
  }
}