Skip to main content

Instruções para conversão de OAuth1 para OAuth2

A partir da versão 22.1, os pontos de extremidade de API OAuth1 públicos herdados foram removidos porque exigem hash SHA1 não compatível com FIPS. Essa remoção inclui os pontos de extremidade WCF (Windows Communication Framework) herdados, o Swagger para esses pontos de extremidade herdados e o middleware de OAuth1. Para substituir os pontos de extremidade OAuth1, você pode usar as versões OAuth2 das APIs herdadas lançadas na versão 21.4, que são compatíveis com FIPS. As APIs OAuth2 oferecem a mesma experiência de funcionalidade das APIs OAuth1. A única exceção é que a chamada GET/workflows/id/package agora retorna um arquivo em vez de um objeto binário na resposta.

Os pontos de extremidade V1 e V2 e de assinatura continuarão sendo compatíveis no OAuth2.

Como converter de OAuth1 para OAuth2

Atualize seus scripts

  • Se você estiver atualmente com a versão 21.4 e atualizando para a 22.1 ou qualquer versão posterior, poderá atualizar os scripts da API sem nenhum tempo de inatividade, pois a versão 21.4 tem as APIs OAuth1 e OAuth2 disponíveis. Recomendamos que você atualize seus scripts de API OAuth1 antes de fazer o upgrade.

  • Se você quiser fazer upgrade para a versão 22.1 a partir de uma versão do Server diferente da 21.4, depois do upgrade será necessário atualizar seus scripts para as APIs OAuth2 antes que seus scripts possam ser operacionais.

  • Você precisa atualizar suas chamadas de API OAuth1 com o novo padrão OAuth2. Para fazer isso, você precisa atualizar dois aspectos dos scripts atuais:

    • Altere o URL base de <hostname>/gallery/api/ para <hostname>/webapi/ .

    • Altere o tipo de autorização de OAuth1 para OAuth2.

  • Se você fizer o upgrade para a versão 22.1 e tentar executar APIs OAuth1 sem atualizar seus scripts de API, esses scripts falharão.

Estima-se que essa atualização leve, no máximo, 4 horas. Essa estimativa se aplica se você estiver seguindo as práticas recomendadas e tiver autenticação em um só local, e o URL base também definido em um único local. Se você autenticar em múltiplos locais e scripts e usar URLs completos e codificados em múltiplos locais e scripts, o processo de atualização poderá ser mais demorado. Para acelerar as coisas, você pode usar o recurso de localizar e substituir .

Teste

Execute um rápido teste de fumaça para garantir que as validações funcionem corretamente. No entanto, como não sabemos como você usa a API, é impossível dizer quanto tempo o teste levará.

Nota

As diferenças entre solicitações e respostas para OAuth1 e OAuth2 são mínimas e estão listadas abaixo:

  • GET v1/jobs/{id} agora inclui quebras de linha e espaços em branco onde não o fazia antes. Dependendo de como você processa a resposta, isso pode exigir ajustes em seus scripts.

  • GET v1/workflows/{id}/package retorna um arquivo em vez de um blob JSON.

  • GET v1/jobs/{id}/output/{id} requer um parâmetro de formato no OAuth2. No Oauth1, esse parâmetro era opcional.

    Format parameter required for Oauth2 version.

Para saber mais sobre a conversão e seus impactos, acesse Instruções para conversão .

Nesta secção: