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} /swagger/ui/index#/.

Obtendo um token de acesso

Para autorizar chamadas de API por meio da IU do Swagger em sua instância do Orchestrator, execute as seguintes etapas:

1. Look for the Authorize button at the top right corner of the Orchestrator API page (OrchestratorURL/swagger). 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.

   Figure 1. Unauthorized API resource

   

2. Na janela método expandido, selecione Experimentar.

3. Especifique valores de parâmetro, se necessário.

4. Selecionar Executar. A solicitação é executada. Um cabeçalho de autorização do portador é usado automaticamente para suas solicitações.

   Figure 2. Bearer authorization header

   

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. Look for the Authorize button at the top right corner of the Orchestrator API page (OrchestratorURL/swagger). The lock should be closed.

   

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

   

3. Close the Available authorizations window by clicking 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. Look for the Authorize button at the top right corner of the Orchestrator API page (OrchestratorURL/swagger). The lock should be closed, meaning you are authorized.
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.