orchestrator
latest
false
- Introdução
- Definição do Swagger
- Leia-me
- Como autorizar chamadas de API no Swagger
- Gerenciamento de recursos lógicos
- 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
- Processar solicitações de política de retenção de dados
- 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
Como autorizar chamadas de API no Swagger
Guia da API do Orchestrator
Last updated 20 de nov de 2024
Como autorizar chamadas de API no Swagger
Se você estiver usando o Swagger para experimentar nossa API, basta fazer login em sua instância do Orchestrator em uma guia separada.
A definição do Swagger da API do Orchestrator pode ser acessada adicionando o sufixo
/swagger/ui/index#/
ao URL do Orchestrator. Por exemplo, https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_ /swagger/ui/index#/
).
Observação: a autenticação Swagger expira de acordo com os parâmetros definidos em sua instância do Orchestrator. Por padrão, é definido como 30 minutos. Você pode alterá-lo modificando o valor do parâmetro
Auth.Cookie.Expire
, no arquivo Web.config
.
Para autorizar chamadas de API por meio da interface gráfica do Swagger para serviços do Orchestrator, execute as seguintes etapas:
-
Consulte o botão Autorizar no canto superior direito da página API do Orchestrator. Se o cadeado estiver aberto, você não está autorizado.
-
Clique em Autorizar. A janela Autorizações disponíveis é exibida.
Observação: atualmente oferecemos suporte a um esquema de autorização chamado OAuth2. - Todos os escopos são pré-selecionados para que você possa experimentar todos os endpoints na API do orquestrador. Limpe-os se quiser restringir o acesso a determinadas APIs.
- Clique em Autorizar. Uma nova janela é exibida confirmando que você foi autorizado.
- Depois de concluído, clique em Fechar ou X para fechar a janela de autorizações disponíveis . O botão Autorizar mostra um cadeado fechado, o que significa que você está autorizado.
Enquanto autorizado, você pode fazer solicitações nos recursos da API do Orchestrator da seguinte maneira:
Quando o token de acesso expira, você recebe uma resposta
401: You are not authenticated!
. O cabeçalho de autorização do portador ainda está presente para suas solicitações, mas o token de acesso expirou. Quando isso acontecer, você precisa invalidar o token expirado e gerar um novo token de acesso:
Quando terminar de trabalhar com a IU Swagger, você deve invalidar o token de acesso que você usou:
- Consulte o botão Autorizar no canto superior direito da página API do Orchestrator. O bloqueio será fechado, ou seja, agora você está autorizado.
- Clique em Autorizar e na página de autorizações disponíveis exibida, clique em Sair.
- Feche a janela de autorizações disponíveis clicando em Fechar ou X. O botão Autorizar mostra um cadeado aberto, o que significa que você não está autorizado.