Estrutura do URL do ponto de extremidade da API

Estrutura de URL para a construção de solicitações de APIs do Test Cloud, incluindo URLs de base para Test Cloud, Test Cloud para o Setor Público e Test Cloud Dedicado.

Nesta seção, você pode aprender a criar solicitações de API entendendo a estrutura de URL dos endpoints da UiPath®.

URL base

O URL de base é o ponto de partida para todas as solicitações de API. Ele serve como a base para criar o URL do ponto de extremidade. Dependendo da plataforma de nuvem que você está usando, use o URL base correspondente:

• Test Cloud: https://cloud.uipath.com
• Test Cloud Public Sector: https://govcloud.uipath.us
• Test Cloud Dedicado: https://<customURL>.dedicated.uipath.com

Ponto de entrada

api — significa o ponto de entrada para os recursos de gerenciamento de plataforma de API, por exemplo, ​/api​/Group​/

CaminhoDoRecurso

O caminho de recurso especifica o recurso ou operação exata que você deseja realizar. Pode incluir palavras-chave como Grupo, RobotAccount, Configuração, dependendo da finalidade da solicitação.

Parâmetros do caminho

Os parâmetros de caminho são usados para passar valores dinâmicos para um ponto de extremidade de API. Esses valores ajudam a identificar recursos específicos que são relevantes para a solicitação de API. Por exemplo, ​/Group​/{partitionGlobalId}​/{groupId}

partitionGlobalId — o ID da organização.

groupId — o ID do grupo.

Parâmetros de Consulta

Os parâmetros de consulta são parâmetros adicionais anexados ao URL para fornecer mais contexto ou filtros para os dados solicitados. Estes são frequentemente precedidos por um símbolo ? e separados por símbolos & . Por exemplo, você pode usar parâmetros de consulta para especificar critérios de filtragem ou instruções de paginação.

Exemplo

Ao unir todos os componentes, um URL para um recurso específico da organização pode ser parecido com isso: https://cloud.uipath.com/{organizationName}/identity_/api/group/{partitionGlobalId}​/{groupId}.

Um URL para recurso específico de tenant pode ser parecido com isso: https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/Assets.