- Introdução
- Sobre este guia
- Recursos disponíveis
- Métodos de autenticação do SQL
- Estrutura do URL do ponto de extremidade da API
- Lista de Enumeração
- Autenticação
- Escopos e permissões
- APIs de gestão de plataforma
Estrutura do URL do ponto de extremidade da API
In this section, you can learn to construct API requests by understanding the URL structure of UiPath® endpoints.
A URL base é o ponto de partida para todas as solicitações de API. Ela serve como base para construir a URL do endpoint. Para o Automation Suite , o URL básico é https://{yourDomain}.
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.
api — demonstra o entry point para os recursos de gerenciamento de plataforma de API, por exemplo, /api/Group/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.
/Group/{partitionGlobalId}/{groupId}partitionGlobalId — o ID da organização.
groupId — o ID do grupo.
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 separado por símbolos &. Por exemplo, você pode usar parâmetros de consulta para especificar critérios de filtragem ou instruções de paginação
https://{yourDomain}/identity_/api/group/{partitionGlobalId}/{groupId}.
https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Assets.
