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. Look for the Authorize button at the top right corner of the Orchestrator API page. If the lock is open, you are unauthorized.
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. Assim que terminar, clique em Fechar ou em X para fechar a janela Autorizações disponíveis . O botão Autorizar mostra um cadeado fechado, significando que você está autorizado.

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.
   
2. Na janela do método expandido, clique em Experimente.
3. Especifique valores de parâmetro, se necessário.
4. Click Execute. The request is executed. A bearer authorization header is automatically used for your requests.
   

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. Look for the Authorize button at the top right corner of the Orchestrator API page. The lock should be closed.
2. Click Authorize and on the displayed Available authorizations page, click Logout to revoke the expired token.
   
3. Feche a janela Autorizações disponíveis clicando em Fechar ou X e, em seguida, obtenha um token de acesso conforme descrito na seção Obtenção de 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 Autorizações disponíveis exibida, clique em Fazer logout.
3. Feche a janela Autorizações disponíveis clicando em Fechar ou no X. O botão Autorizar mostra um cadeado aberto, o que significa que você não tem autorização.