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, https://{yourDomain}/swagger/index.html.

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.

Como obter 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.

   Figure 1. Authorize button
   

   

   
   

2. Select Authorize. The Available authorizations window is displayed.

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

   

   
   
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. Select Authorize. A new window is displayed confirming you have been authorized.
5. Once done, select Close or X to close the Available authorizations window. The Authorize button shows an closed lock meaning you are authorized.

Envio de solicitações

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.
   Figure 3. Unauthorized API resource
   

   

   
   
2. In the expanded method window, select Try it out.
3. Especifique valores de parâmetro, se necessário.
4. Select Execute. The request is executed. A bearer authorization header is automatically used for your requests.
   Figure 4. Bearer authorization header
   

   

   
   

Geração de um 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.
   Figure 5. Authorize button
   

   

   
   
2. Select Authorize and on the displayed Available authorizations page, select Logout to revoke the expired token.
   Figure 6. Available authorizations
   

   

   
   
3. Close the Available authorizations window by selecting Close or X and then obtain an access token as described on the Obtaining an access token section.

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.