orchestrator
2024.10
true
- Introdução
- Autenticação
- Métodos de autenticação do SQL
- Aplicativos externos (OAuth)
- ROPC (não recomendado)
- Definição do Swagger
- APIs do Orchestrator
- Solicitações de alertas
- Solicitações de ativos
- Solicitações de calendários
- Solicitações de ambientes
- Solicitações de pastas
- Solicitações de Tarefas Genéricas
- Solicitações de trabalhos
- Solicitações de bibliotecas
- Solicitações de licenças
- Solicitações de pacotes
- Solicitações de permissões
- Solicitações de espaços de trabalho pessoais
- Solicitações de processos
- Solicitações de itens de fila
- Solicitações da política de retenção de filas
- Solicitações de robôs
- Solicitações de funções
- Solicitações de agendamentos
- Solicitações de configurações
- Solicitações de bucket de armazenamento
- Solicitações de tarefas
- Solicitações de catálogos de tarefas
- Solicitações de formulários de tarefas
- Solicitações de tenants
- Solicitações de Transações
- Solicitações de usuários
- Solicitações de webhooks
- APIs de gestão de plataforma
ROPC (não recomendado)
Guia da API do Orchestrator
Última atualização 4 de dez de 2024
ROPC (não recomendado)
Importante:
Apenas os administradores de host devem se autenticar usando o ponto de extremidade
/api/account/authenticate/
.
Os usuários de negócios devem se autenticar usando aplicativos externos.
Para recuperar o token de acesso, faça uma solicitação POST para o terminal
/api/account/authenticate
com a seguinte carga útil:
{
"TenancyName": "{account_tenant_name}",
"UsernameOrEmailAddress": "{account_username}",
"Password": "{account_password}"
}
{
"TenancyName": "{account_tenant_name}",
"UsernameOrEmailAddress": "{account_username}",
"Password": "{account_password}"
}
Onde:
{account_tenant_name}
- é o nome do tenant em sua conta do Automation Suite{account_username}
- é o nome de usuário da sua conta do Automation Suite{account_password}
- é a senha usada para fazer login na sua conta do Automation Suite
Dica:
Para encontrar o valor de TenancyName de sua instância do Orchestrator, faça uma solicitação GET para o
/odata/Users/UiPath.Server.Configuration.OData.GetCurrentUser
.
O corpo da resposta retorna o token do portador, usado por seu aplicativo para autorizar outras chamadas de API. Portanto, no cabeçalho de autorização de uma chamada de API, anexe
Bearer xxxx
e substitua xxxx
pelo valor {access_token}
(por exemplo, Authorization: Bearer eyJhbG ... LnVxjA
).
{
"result": "{access_token}",
"targetUrl": null,
"success": true,
"error": null,
"unAuthorizedRequest": false,
"__abp": true
}
{
"result": "{access_token}",
"targetUrl": null,
"success": true,
"error": null,
"unAuthorizedRequest": false,
"__abp": true
}
Importante:
- Por padrão, o token de acesso é válido por 30 minutos. Para gerar um novo, faça outra chamada para o terminal
api/account/authenticate
.