Especificar una versión de API en las integraciones
Todos los URI de Adobe Workfront deben hacer referencia a una versión específica de la API después de la parte "attask/api" del URI. El siguiente ejemplo llama a la versión 15.0:
attask/api/v15.0/<objectName>/<objectId>
Asegúrese de que todas las integraciones llamen a las API de Workfront que admite actualmente.
Programación de versiones y desuso de las API de Workfront
Las nuevas versiones de la API se publican regularmente, generalmente dos veces al año. Cada versión es compatible durante tres años después de la fecha de lanzamiento, con un año adicional en un estado obsoleto en el que la versión está disponible pero no es compatible.
Para obtener más información sobre la cadencia de lanzamiento y la programación de desaprobación de las API de Workfront, consulte Versiones de API y programación de asistencia.
-
La versión predeterminada de la API es la más reciente. Cualquier llamada de API sin la versión especificada utilizará la versión predeterminada. Cada vez que Workfront publica una nueva versión de la API, la versión predeterminada se actualiza a la más reciente. Por lo tanto, después de publicar una nueva versión de la API de Workfront, cualquier llamada de API que utilice la versión predeterminada debe comprobarse para asegurarse de que la funcionalidad sigue siendo compatible.
-
Si su organización utiliza actualmente la API predeterminada, su administrador de Workfront ha recibido un mensaje del Centro de anuncios con más instrucciones sobre la API predeterminada.
Determinación de la versión de la API que está utilizando
Puede determinar la versión de la API que utiliza comprobando el URI de una solicitud HTTP enviada a la API de Workfront. El siguiente ejemplo muestra un URI de solicitud de Workfront que especifica la versión 15 de la API:
https://<domainname>.my.workfront.com/attask/api/v15.0/proj/4c7c08b20000002de5ca1ebc19edf2d5
Si un URI no especifica una versión, está utilizando la versión predeterminada de la API, como se muestra en el siguiente ejemplo:
https://<domainname>.my.workfront.com/attask/api/proj/4c7c08b20000002de5ca1ebc19edf2d5
Actualización de integraciones para utilizar versiones de API compatibles
A medida que crea o mantiene integraciones de Workfront, debe incluir un método para actualizar dinámicamente la versión de la API y otras propiedades sujetas a cambios (como su clave de API).
Para que la actualización de las integraciones sea más eficiente, debe tener en cuenta las siguientes sugerencias para registrar los valores de integración:
- Almacena valores sujetos a cambios futuros en un archivo de propiedades que mantiene actualizado
- Creación de un servicio web para administrar propiedades en tiempo real
- Almacenar valores de propiedades en un almacén de datos que la aplicación pueda leer
El diseño de las integraciones de Workfront con esto en mente alivia la necesidad de realizar un trabajo de desarrollo exhaustivo cuando estos valores cambian inevitablemente.