Atualizar integrações que usam o controle de versão da API padrão

Atualização das integrações para versões de API compatíveis

Se as solicitações de API do Workfront não especificarem uma versão, elas usarão o padrão. Recomendamos suas solicitações de API para especificar uma versão compatível da API, de preferência para a API compatível mais recente.

Por exemplo, a seguinte solicitação de API do Workfront não especifica uma versão da API:

https://davidwhite.my.workfront.com/attask/api/project/metadata

Quando essa solicitação é feita, você recebe uma resposta com texto codificado em JSON que especifica os dados da sua instância do Workfront. Como nenhuma versão da API é especificada nesse URI, a chamada vai para Padrão.

Para transformar uma solicitação de API padrão em uma solicitação de API com versão, basta chamar uma versão de API compatível. Por exemplo, o seguinte URI solicita a versão 15:

https://davidwhite.my.workfront.com/attask/api/v15.0/project/metadata

Ao atualizar suas solicitações de API do Workfront, você pode especificar qualquer versão compatível da nossa API. Para saber mais sobre como fazer referência a uma API específica, consulte Especificar uma Versão da API em suas integrações.

Para garantir a janela de suporte máxima, você deve chamar a versão mais recente. Você pode encontrar uma lista de APIs compatíveis em Controle de versão da API e programação de suporte.

Histórico da versão padrão da API

A intenção original da "API padrão", ou Padrão, era mapeá-la para a versão mais recente da API do Workfront. Isso permitiria que os clientes com integrações básicas chamadas de Padrão nunca precisassem atualizar suas solicitações de API.

Em 2011, o Workfront lançou a versão 3.0 da API. O padrão foi movido automaticamente para a versão 3.0, o que prejudicou muitas integrações de clientes que eram muito complexas para utilizar a versão 3.0 sem serem atualizadas. Como resultado, o Workfront reverteu essa alteração e deixou a versão padrão na Versão 2.

Desde 2011, o Workfront aumentou substancialmente a funcionalidade da API. Por causa disso, substituímos versões mais antigas da API. Em 2017, em vez de atualizar o Padrão, removemos completamente o conceito de uma versão padrão. Isso incentivava nossos clientes a usar versões estáveis de nossas APIs e a manter suas integrações em um ciclo de, no máximo, três anos.

Agora, o Workfront está restabelecendo a versão da API padrão. A API padrão está definida como a versão mais recente da API do Workfront e será atualizada para a versão mais recente sempre que uma nova versão for lançada.