Crear aplicaciones OAuth2 para integraciones de Workfront
Como administrador de Adobe Workfront, puede crear aplicaciones OAuth2 para la instancia de Workfront, que permiten que otras aplicaciones tengan acceso a Workfront. Los usuarios pueden dar permiso a esas otras aplicaciones para acceder a sus datos de Workfront. De este modo, puede integrar con aplicaciones de su elección, incluidas las propias aplicaciones internas.
Cuando crea una aplicación OAuth2, genera un ID de cliente y un secreto de cliente. A continuación, los usuarios pueden utilizar el ID de cliente en las llamadas de API para integrarse con la aplicación que ha creado.
- Para obtener instrucciones sobre cómo configurar y utilizar la aplicación OAuth2 con credenciales de usuario (flujo de código de autorización), consulte Configure y utilice las aplicaciones OAuth 2 personalizadas de su organización mediante el flujo del código de autorización.
- Para obtener instrucciones sobre cómo configurar y utilizar la aplicación OAuth2 con la autenticación de servidor (flujo JWT), consulte Configurar y utilizar las aplicaciones personalizadas OAuth 2 de su organización mediante el flujo JWT.
- Para instrucciones sobre cómo configurar y usar la aplicación OAuth2 utilizando PKCE, consulta Configure y utilice las aplicaciones OAuth 2 personalizadas de su organización mediante el flujo PKCE.
Requisitos de acceso
| table 0-row-2 1-row-2 2-row-2 layout-auto html-authored no-header | |
|---|---|
| paquete de Workfront | Cualquiera |
| Licencia de Adobe Workfront |
Estándar Plan |
| Configuraciones de nivel de acceso | Debe ser administrador de Workfront. |
Para obtener más información, consulte Requisitos de acceso en la documentación de Workfront.
Información general sobre OAuth2
Imagine que una aplicación debe extraer información específica de Workfront. La aplicación que solicita información se denomina cliente. Para este ejemplo, el nombre de cliente es ClientApp. ClientApp necesita acceder a la información de un usuario en particular y, por lo tanto, debe acceder a Workfront como ese usuario. Si el usuario proporciona a ClientApp su nombre de usuario y contraseña, ClientApp podría acceder a todos los datos a los que el usuario puede acceder. Esto supone un riesgo para la seguridad, ya que ClientApp únicamente necesita un pequeño conjunto específico de información.
Cuando crea una aplicación OAuth2 para ClientApp, básicamente le está diciendo a Workfront que ClientApp tiene permiso para acceder a Workfront, pero únicamente si el usuario a cuya cuenta está accediendo ClientApp da permiso para el acceso.
Creación de una aplicación OAuth2
Al crear una aplicación OAuth2, elija el tipo de aplicación que mejor se adapte a las necesidades de su integración.
Es ideal para CLI, daemons o scripts que se ejecutan en su servidor
Ejemplos:
-
Shell
-
Python
Ideal para aplicaciones móviles o de una sola página
Ejemplos:
-
Javascript
-
Angular
-
React
-
Vue
Ideal para aplicaciones del lado del servidor que administran credenciales y tókenes en el servidor
Ejemplos:
-
Go
-
Java
-
ASP.Net
-
Node.js
-
PHP
Creación de una aplicación OAuth2 con autenticación de servidor (flujo JWT) create-an-oauth2-application-using-server-authentication-jwt-flow
-
Haga clic en el icono Main Menu
-
En el panel de navegación izquierdo, haga clic en Sistema y seleccione Aplicaciones OAuth2.
-
Haga clic en Crear integración de aplicaciones.
Se muestra el cuadro Nueva aplicación OAuth2. -
En el cuadro Nueva aplicación OAuth2, seleccione Aplicación de equipo a equipo.
-
Escriba un nombre para la nueva aplicación, como “Workfront para ClientApp”.
-
Haga clic en Crear.
-
Rellene los campos de la nueva aplicación.
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 layout-auto html-authored no-header Client ID Este campo se genera automáticamente. Client secret Este campo se genera automáticamente
IMPORTANTE:
Copie el contenido de este campo en otro archivo seguro antes de cerrar esta página. No podrá volver a ver esta clave secreta.
Si pierde esta clave, elimínela y cree un Secreto de cliente.
-
Haga clic en el icono Delete
-
Haga clic en Add client secret para generar un nuevo Secreto de cliente.
Public Keys Las aplicaciones de servidor a servidor utilizan claves públicas y privadas para la autenticación. Realice una de las siguientes acciones:
-
Haga clic en Add a public key e introduzca la clave pública desde la otra aplicación.
-
Haga clic en Generate a public/private keypair y comparta la clave pública con la otra aplicación.
Name Este es el mismo nombre que le dio a la aplicación. Esta celda no puede estar vacía. Description Introduzca una descripción para la integración. -
-
Haga clic en Guardar.
Para obtener instrucciones sobre cómo configurar y utilizar la aplicación OAuth2 con credenciales de usuario (flujo de código de autorización), consulte Configurar y utilizar las aplicaciones personalizadas OAuth 2 de la organización mediante el flujo JWT.
Creación de una aplicación OAuth2 con credenciales de usuario (flujo de código de autorización) create-an-oauth2-application-using-user-credentials-authorization-code-flow
https://app.workfrontfusion.com/oauth/cb/workfront-workfronthttps://app-eu.workfrontfusion.com/oauth/cb/workfront-workfront(centro de datos de la UE)https://app-az.workfrontfusion.com/oauth/cb/workfront-workfront(Centro de datos de Azure)
-
Haga clic en el icono Main Menu
-
En el panel de navegación izquierdo, haga clic en Sistema y seleccione Aplicaciones OAuth2.
-
Haga clic en Crear integración de aplicaciones.
Se muestra la Nueva aplicación OAuth2.
-
En el cuadro Nueva aplicación OAuth2, seleccione Aplicación web.
-
Escriba un nombre para la nueva aplicación OAuth2, como “Workfront para ClientApp”.
-
Haga clic en Crear.
-
Rellene los campos de la nueva aplicación.
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 layout-auto html-authored no-header Client ID Este campo se genera automáticamente. Client secret Este campo se genera automáticamente
IMPORTANTE:
Copie el contenido de este campo en otro archivo seguro antes de cerrar esta página. No podrá volver a ver esta clave secreta.
Si pierde esta clave, elimínela y cree un Secreto de cliente.
-
Haga clic en el icono Delete
-
Haga clic en Add client secret para generar un nuevo Secreto de cliente.
Redirect URLs Se redirigirá a los usuarios a esta ruta después de que se hayan autenticado con Workfront. Refresh token rotation Habilite esta opción para emitir un nuevo token de actualización cada vez que se use el token. Su aplicación debe almacenar el nuevo token de actualización después de cada actualización. Absolute refresh token expiration Seleccione la cantidad de tiempo que desea que tenga un token de actualización antes de que venza. Cuando vence, los usuarios deben volver a iniciar sesión en la integración. Seleccione “No expiration” si desea que el token de actualización no venza. Caducidad del token de actualización por inactividad Seleccione la cantidad de tiempo después de la cual, si el usuario no ha estado activo en el sistema, su token de actualización vence.
Por ejemplo, si la caducidad del token de actualización por inactividad es de seis meses y el usuario no inicia sesión durante este periodo, el token de actualización caduca, aunque la caducidad del token de actualización absoluta se pueda establecer para más tiempo.
Logo Puede añadir un logotipo para que sea más sencillo identificar esta aplicación. Name Este es el mismo nombre que le dio a la aplicación. Esta celda no puede estar vacía. Description Introduzca una descripción para la integración. App Description URL Puede ser un vínculo a una página “Acerca de nosotros” o una con más información sobre la integración. -
-
Haga clic en Guardar.
Para obtener instrucciones sobre cómo configurar y utilizar la aplicación OAuth2 con credenciales de usuario (flujo de código de autorización), consulte Configurar y utilizar las aplicaciones personalizadas OAuth 2 de su organización mediante el flujo de código de autorización.
Creación de una aplicación web de una sola página de OAuth2 con PKCE create-an-oauth2-single-page-web-application-using-pkce
-
Haga clic en el icono Main Menu
-
En el panel de navegación izquierdo, haga clic en Sistema y seleccione Aplicaciones OAuth2.
-
Haga clic en Crear integración de aplicaciones.
Se muestra el cuadro Nueva aplicación OAuth2.
-
En el cuadro Nueva aplicación OAuth2, seleccione Aplicación web de una sola página.
-
Escriba un nombre para la nueva aplicación OAuth2, como “Workfront para ClientApp”.
-
Haga clic en Crear.
-
Rellene los campos de la nueva aplicación.
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 10-row-2 layout-auto html-authored no-header Client ID Este campo se genera automáticamente. Redirect URLs Se redirigirá a los usuarios a esta ruta después de autenticarse en Workfront. Rotate refresh token every time it is used Habilite esta opción para emitir un nuevo token de actualización cada vez que se use el token. Su aplicación debe almacenar el nuevo token de actualización después de cada actualización. Absolute expiration Seleccione la cantidad de tiempo que desea que tenga un token de actualización antes de que venza. Cuando vence, los usuarios deben volver a iniciar sesión en la integración. Seleccione “No expiration” si desea que el token de actualización no venza. Inactivity expiration Seleccione la cantidad de tiempo después de la cual, si el usuario no ha estado activo en el sistema, su token de actualización vence.
Por ejemplo, si la caducidad del token de actualización por inactividad es de seis meses y el usuario no inicia sesión durante este periodo, el token de actualización caduca, aunque la caducidad del token de actualización absoluta se pueda establecer para más tiempo.
Logo Puede añadir un logotipo para que sea más sencillo identificar esta aplicación. Name Este es el mismo nombre que le dio a la aplicación. Esta celda no puede estar vacía. Description Introduzca una descripción para la integración. Developer name Este es el nombre del desarrollador que configura la aplicación OAuth2. Developer email address Esta es la dirección de correo electrónico del desarrollador que configura la aplicación OAuth2. Privacy policy URL Este es el vínculo a donde su organización almacena la política de privacidad. -
Haga clic en Guardar.
Configuración y uso de la aplicación OAuth2 creada
La configuración y el uso posteriores de la aplicación OAuth2 creada requieren algunos conocimientos técnicos, incluidas las llamadas de API.
- Para obtener instrucciones sobre cómo configurar y utilizar la aplicación OAuth2 con credenciales de usuario (flujo de código de autorización), consulte Configurar y utilizar las aplicaciones personalizadas OAuth 2 de su organización mediante el flujo de código de autorización.
- Para obtener instrucciones sobre cómo configurar y utilizar la aplicación OAuth2 con la autenticación de servidor (flujo JWT), consulte Configurar y utilizar las aplicaciones personalizadas OAuth 2 de su organización mediante el flujo JWT.
- Para obtener instrucciones sobre cómo configurar y utilizar la aplicación OAuth2 con PKCE, consulte Configurar y utilizar las aplicaciones personalizadas OAuth 2 de su organización mediante el flujo PKCE.
Procesos de OAuth2 para el flujo del código de autorización
Autorización con un código de autorización y un token de acceso authorizing-with-an-authorization-code-and-access-token
-
ClientApp necesita información de Workfront, por lo que envía una solicitud al punto final Workfrontde la API
/authorize. La solicitud incluye response_typecode, que indica que la solicitud debe devolver un código de autorización. -
Esto activa a Workfront para enviar un mensaje de autenticación al usuario. El usuario puede escribir sus credenciales en el mensaje, que da permiso a Workfront para comunicarse con ClientApp. Si el usuario ya ha iniciado sesión en Workfront, se puede omitir este paso.
-
La API de Workfront envía un código de autorización a ClientApp.
-
ClientApp envía la siguiente información en una solicitud al punto final de la API de Workfront
/token:- Código de autorización enviado a ClientApp en el paso 3. Esto identifica la instancia específica del permiso de usuario.
- Secreto de cliente que se generó al configurar la aplicación OAuth2 de ClientApp en Workfront. Esto permite que Workfront sepa que la solicitud proviene de ClientApp.
-
Si el código de autorización y el secreto de cliente son correctos, Workfront enviará un token de acceso a ClientApp. Este token de acceso se envía directamente desde Workfront a ClientApp y ningún otro usuario o aplicación cliente puede verlo, copiarlo o utilizarlo.
-
ClientApp envía el token de acceso a Workfront junto con la solicitud de información específica.
-
Dado que el token de acceso es correcto, Workfront envía la información a ClientApp.
Actualización de tókenes de acceso
Por motivos de seguridad, los tókenes de acceso vencen después de un corto período de tiempo. Para obtener nuevos tókenes de acceso sin tener que escribir credenciales cada vez, OAuth2 utiliza tókenes de actualización. El cliente almacena los tókenes de actualización.
El proceso para adquirir un token de actualización es el mismo que el procedimiento descrito en la sección Autorización con un código de autorización y un token de acceso. La solicitud del código de autorización incluye el ámbito offline_access, que indica que la solicitud debe devolver un token de solicitud junto con el código de autorización.