Como autorizar chamadas de API no Swagger

Acesso ao Swagger

Para acessar a API Swagger do Orchestrator, anexe /swagger/index.html à URL do Orchestrator. Por exemplo, /swagger/index.htmlhttps://{yourDomain}.

A API que você vê no Swagger depende diretamente da instância do Orchestrator que você usa. Para fazer solicitações de forma fácil diretamente no Swagger, faça login no Orchestrator em outra guia.

Obtendo um token de acesso

Para autorizar chamadas de API por meio da interface gráfica do Swagger para serviços do Orchestrator, execute as seguintes etapas:

1. 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.

   
   

   

   
   

2. Clique em Autorizar. A janela Autorizações disponíveis é exibida.

   Observação: atualmente oferecemos suporte a um esquema de autorização chamado OAuth2.
   
   

   

   
   
3. 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.
4. Clique em Autorizar. Uma nova janela é exibida confirmando que você foi autorizado.
5. 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.

Enviando Pedidos

Enquanto autorizado, você pode fazer solicitações nos recursos da API do Orchestrator da seguinte maneira:

1. Expanda um recurso de API do Orchestrator com o qual você deseja executar uma operação. O cadeado fechado significa que você está autorizado.
   
   

   

   
   
2. Na janela do método expandido, clique em Experimente.
3. Especifique valores de parâmetro, se necessário.
4. Clique em Executar. A solicitação é executada. Um cabeçalho de autorização de portador é usado automaticamente para suas solicitações.
   
   

   

   
   

Gerando um novo token de acesso

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:

1. Consulte o botão Autorizar no canto superior direito da página API do Orchestrator. O bloqueio deve ser fechado.
   
   

   

   
   
2. Clique em Autorizar e na página de autorizações disponíveis exibida, clique em Logout para revogar o token expirado.
   
   

   

   
   
3. Feche a janela de autorizações disponíveis clicando em Fechar ou X e obtenha um token de acesso conforme descrito na seção Obtendo um token de acesso.

Revogar acesso

Quando terminar de trabalhar com a IU Swagger, você deve invalidar o token de acesso que você usou:

1. 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.
2. Clique em Autorizar e na página de autorizações disponíveis exibida, clique em Sair.
3. 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.