Estrutura do URL do ponto de extremidade da API

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. A URL base é https://{yourDomain}.

Caminho de serviço

O caminho de serviço identifica o serviço específico com o qual você deseja interagir.

Para APIs que operam no nível da organização, o caminho de serviço geralmente vem logo após o URL de base. Essas APIs fornecem funcionalidades que são aplicáveis a toda a organização, independentemente dos tenants específicos dentro dessa organização.

/identity_ — para interagir com funcionalidades relacionadas à criação, atualização ou exclusão de contas e gerenciamento de configurações da organização.

/audit_ — para interagir com funcionalidades relacionadas a logs de auditoria na organização.

/lrm — para interagir com funcionalidades relacionadas à alocação de licenciamento para tenants e serviços na organização.

/la — para rastrear o uso de licença (unidades de robôs, tenants e serviços provisionados, etc.)

Ao lidar com APIs específicas para um determinado tenant dentro de uma organização, o URL deve incluir parâmetros adicionais para especificar tanto a organização quanto o tenant antes do caminho de serviço. Por exemplo:

/{orgName}/{tenantName}/orchestrator_ — para interagir com recursos do Orchestrator em um tenant e organização específicos.

/{orgName}/{tenantName}/dataservice_ — para interagir com recursos de Data Service em um tenant e organização específicos.

Para obter detalhes sobre recursos de API de tenant, consulte a documentação específica do produto.

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://{yourDomain}/{organizationName}/identity_/api/group/{partitionGlobalId}​/{groupId}.

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