Introducción al SDK de Test Manager

Los métodos de autorización descritos en este tema proporcionan información sobre cómo establecer una conexión de servicio a servicio entre Test Manager y tu aplicación u otras aplicaciones de socios.

Requisitos previos

• Habilita Probar automatización en Orchestrator. Para obtener más información, consulta Habilitar/deshabilitar características.
• Genera un token de instalación en Orchestrator Identity Management. Necesitarás esto para aprovisionar a través de la línea de comandos. Para obtener el token de acceso de Orchestrator Identity, consulta Generar un token de acceso de instalación.

Métodos de autorización

Puede elegir entre dos métodos para aprovisionar un cliente OAuth externo, en función de los casos prácticos específicos que dependen de las versiones utilizadas en la infraestructura de su producto UiPath:

• Si ejecutas Test Manager y Orchestrator versión 21.4 o posterior, puedes utilizar Aprovisionamiento a través de Identity Management.
• Si ejecutas Test Manager versión 21.4 y Orchestrator versión 20.10, o deseas habilitar el acceso entre tenant, puedes utilizar el aprovisionamiento a través de CLI.

Aprovisionamiento a través de la gestión de la identidad

Puedes registrar tu aplicación en Identity Management, definir los ámbitos de Test Manager y establecer una conexión entre las aplicaciones.

Para configurar y autorizar tu aplicación, debes añadir una aplicación externa.

Cuando defines los ámbitos para la integración, selecciona Test Manager como Recurso. Para obtener más información, consulta Funciones.

Aprovisionamiento a través de CLI de Test Manager

A través de la autorización de la CLI de Test Manager, puedes aprovisionar el cliente, asignar ámbitos y luego establecer una conexión de servicio a servicio entre las aplicaciones.

Para integrar y empezar a utilizar tu aplicación con Test Manager, debes configurar la autorización: Aprovisionar el cliente y los ámbitos y luego obtener un ID del cliente y un secreto del cliente.

Configurar la autorización

Para establecer una conexión de servicio a servicio entre Test Manager y tu aplicación, utilizarás la herramienta de aprovisionamiento de Test Manager como herramienta CLI principal para obtener un cliente, proporcionar derechos de acceso y ámbitos para tu integración. Puedes encontrar esta herramienta empaquetada con cada compilación como testmanager.exe en la ubicación de instalación predeterminada, de la siguiente manera:

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

Alternativamente, puedes encontrar el ejecutable en tu carpeta de instalación personalizada. Para obtener una lista de comandos y opciones que están fuera del alcance de tu integración, consulta Hoja de trucos de aprovisionamiento de la herramienta de Test Manager.

La siguiente sección enumera los parámetros de línea de comandos disponibles, incluidas las opciones y los valores predeterminados, para que puedas aprovisionar derechos de acceso y ámbitos, y luego obtener un ID y un secreto de cliente para tu aplicación.

Nota:

• Necesitarás el token de instalación generado a través de Orchestrator Identity Management, como se solicita en la sección de requisitos previos.
• Es necesario definir los ámbitos de Test Manager.

Comando	Opción	Descripción
register third-party-s2sclient	-iu, --identityUrl (obligatorio)	La URL absoluta donde se encuentra Identity Server.
	-iit, --identityInstallationToken <identityinstallationtoken> (obligatorio)	El token de autenticación para aprovisionar clientes en Identity Server.
	cscopes, --clientScopes <clientscopes> (obligatorio)	Muestra los ámbitos de cliente que se utilizarán al crear el cliente.
	`-cid, --clientID <clientid> `	Muestra el ID de cliente que se utilizará al crear el cliente. Esto se genera automáticamente si no proporcionas un ID de cliente.
	-cname, --clientName <clientname>	Muestra el nombre de cliente que se utilizará al crear el cliente. Esto se genera automáticamente si no proporcionas un nombre de cliente.
	-csecret, --clientSecret <clientsecret>	Muestra el secreto de cliente que se utilizará al crear el cliente. Esto se genera automáticamente si no proporcionas un secreto de cliente
	-lang, --language <language>	Especifica el idioma del mensaje de error.
	-?, -h?, --help	Muestra la información de ayuda y uso.

Script de Shell de ejemplo

En el siguiente ejemplo, el comando register third-party-s2sclient es seguido por la URL de Orchestrator Identity, el token de instalación de identidad y los ámbitos de proyecto de 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

Ejemplos de API

Para realizar una llamada de API a Test Manager, puedes echar un vistazo al siguiente ejemplo para buscar proyectos de Test Manager.

Llamada de API para la autorización de Identity Management

OBTENER 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
  }
}

Llamada de la API para la autorización de la CLI de Test Manager

OBTENER 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
  }
}