Como autorizar chamadas de API no Swagger

Acesso ao Swagger

Se você estiver usando o Swagger para experimentar nossa API, basta fazer login em sua instância do Orchestrator em uma guia separada.

The Orchestrator API Swagger definition can be accessed by adding the /swagger/ui/index#/ suffix to your Orchestrator URL. For example, https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_ /swagger/ui/index#/.

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.

   Figura 1. Botão Autorizar
   

   

   
   

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

   Observação: atualmente oferecemos suporte a um esquema de autorização chamado OAuth2.
   Figura 2. Autorizações disponíveis
   

   

   
   
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. Selecione Autorizar. Uma nova janela é exibida confirmando que você foi autorizado.
5. Depois de terminar, selecione Fechar ou 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.
   Figura 3. Recurso de API não autorizado
   

   

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

   

   
   

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.
   Figura 5. Botão Autorizar
   

   

   
   
2. Selecione Autorizar e, na página Autorizações disponíveis exibida, selecione Logoff para revogar o token expirado.
   Figura 6. Autorizações disponíveis
   

   

   
   
3. Feche a janela Autorizações disponíveis selecionando 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 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.