View a markdown version of this page

Integración con Smartsheet - Amazon Quick

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Integración con Smartsheet

Use el conector de acciones de Smartsheet para administrar hojas, filas, informes y búsquedas en sus espacios de trabajo de Smartsheet directamente en Amazon Quick mediante lenguaje natural. Esta integración usa la API de Smartsheet. Para obtener más información, consulte la introducción a la API de Smartsheet en la documentación de Smartsheet.

La configuración de esta integración consta de dos pasos. En primer lugar, debe configurar las credenciales en Smartsheet para el método de autenticación que elija. Luego, crea la integración en Amazon Quick y la conecta a su cuenta de Smartsheet. Para obtener información sobre los métodos de autenticación que admite Amazon Quick, consulteMétodos de autenticación.

Requisitos previos

Antes de configurar la integración, asegúrese de cumplir los siguientes requisitos:

Configure las herramientas para desarrolladores de Smartsheet

Antes de configurar Amazon Quick, configure las credenciales en Smartsheet. Los pasos que complete dependerán del método de autenticación que planee usar. Amazon Quick admite dos métodos de autenticación para Smartsheet. Para obtener más información acerca de estos métodos, consulte Métodos de autenticación.

Para obtener más información sobre OAuth de Smartsheet, consulte OAuth en la documentación de la API de Smartsheet.

Regístrese en las herramientas para desarrolladores y cree un perfil de desarrollador

  1. Vaya a la página de registro de las herramientas para desarrolladores y registre la cuenta de Smartsheet que desee usar con sus aplicaciones. Para obtener más información, consulte el tema sobre cómo registrarse en las herramientas para desarrolladores en la documentación de la API de Smartsheet.

  2. Después de que Smartsheet active las Herramientas para desarrolladores, inicie sesión en la aplicación de Smartsheet, elija el ícono de su cuenta en la esquina inferior izquierda y, a continuación, elija Herramientas para desarrolladores.

  3. Elija Crear perfil de desarrollador e ingrese un nombre de perfil. Para obtener más información, consulte Crear su perfil de desarrollador en la documentación de la API de Smartsheet.

sugerencia

Smartsheet recomienda usar una cuenta de servicio dedicada para las aplicaciones de OAuth en lugar de una cuenta personal.

Registre la aplicación OAuth

  1. En las Herramientas para desarrolladores de Smartsheet, elija Crear nueva aplicación.

  2. Complete el formulario:

    • Nombre de la aplicación: un nombre para identificar la aplicación ante los usuarios.

    • Descripción de la aplicación: una breve descripción de la integración.

    • URL de la aplicación: la URL que abre la aplicación o la página de destino.

    • Aplicación contact/support: información de contacto de Support.

    • URL de redireccionamiento de la aplicación: https://{region}.quicksight.aws.amazon.com/sn/oauthcallback

      {region}Sustitúyala por tu AWS región (por ejemplo,us-east-1).

  3. Seleccione Save. Smartsheet genera el ID de cliente de la aplicación y el secreto de la aplicación.

  4. Copie los valores de ID de cliente y secreto de cliente. Los necesitará cuando configure la integración en Amazon Quick.

Para obtener más información, consulte Registrar una aplicación en la documentación de la API de Smartsheet.

Genere un token de acceso a la API (solo para la autenticación del servicio)

Si planeas usar la autenticación de servicio en lugar de OAuth, genera un token de acceso a la API. Debes tener un plan Business o Enterprise para generar los tokens. Para obtener más información, consulte Generar un token de acceso a la API en el Centro de ayuda de Smartsheet.

  1. En la aplicación Smartsheet, elija su cuenta (imagen de perfil) en la parte inferior de la barra de navegación izquierda y, a continuación, elija Configuración personal.

  2. Elija la pestaña Acceso a la API y elija Generar un nuevo token de acceso.

  3. Asigne un nombre al token y seleccione Aceptar. Copia el valor del token inmediatamente; esta es la única vez que está visible.

importante

Guarde su token de acceso de forma segura. Cualquier persona que posea el token puede acceder a todos los datos de Smartsheet a los que tiene acceso el propietario del token. No deposite los tokens en los sistemas de control de versiones. Para conocer las mejores prácticas sobre el almacenamiento de los tokens, consulte la autenticación en la documentación de la API de Smartsheet.

Ámbitos de acceso a OAuth

Al configurar la autenticación de usuario (OAuth), la integración solicita los siguientes ámbitos de acceso a Smartsheet. Estos ámbitos determinan lo que la integración puede hacer en nombre del usuario autenticado. Si, en su lugar, utilizas la autenticación de servicio (clave de API), la integración utiliza todos los permisos del propietario del token y no se aplican los ámbitos. Para obtener más información, consulte los ámbitos de acceso en la documentación de la API de Smartsheet.

Ámbitos de acceso a OAuth de Smartsheet
Alcance Description (Descripción)
READ_SHEETS Lea todos los datos de la hoja, incluidos los archivos adjuntos, los debates y los datos de las celdas.
WRITE_SHEETS Inserte y modifique los datos de la hoja, incluidos los archivos adjuntos, las discusiones y los datos de las celdas.
nota

Los ámbitos de acceso no anulan los permisos de uso compartido existentes. Por ejemplo, tener el WRITE_SHEETS ámbito no permite que la integración actualice una hoja a la que el usuario solo tiene acceso a nivel de espectador. Para obtener más información, consulte los niveles de acceso a los recursos en la documentación de la API de Smartsheet.

Configurar la integración en Amazon Quick

Después de completar la configuración de las herramientas para desarrolladores de Smartsheet, cree la integración en Amazon Quick.

  1. En la consola Amazon Quick, selecciona Connectors.

  2. Selecciona la pestaña Crear para tu equipo.

  3. Busque y elija Smartsheet.

  4. Introduzca los detalles de la integración:

    • Nombre: nombre descriptivo de su integración con Smartsheet.

    • Descripción (opcional): propósito de la integración.

  5. Elija el tipo de conexión y rellene la configuración de conexión. Para obtener más información sobre estos métodos de autenticación, consulteMétodos de autenticación.

    1. Para la autenticación de usuarios (OAuth), utilice el ID de cliente y el secreto del cliente que figuran en el registro de la aplicación Smartsheet Developer Tools. Configure los siguientes campos:

      • URL base: https://api.smartsheet.com/2.0

      • ID de cliente: ID de cliente de la aplicación que aparece en el registro de la aplicación Smartsheet Developer Tools.

      • Secreto de cliente: el secreto de la aplicación que figura en el registro de la aplicación Smartsheet Developer Tools.

      • URL del token: https://api.smartsheet.com/2.0/token

      • URL de autenticación: https://app.smartsheet.com/b/authorize

      • URL de redireccionamiento — https://{region}.quicksight.aws.amazon.com/sn/oauthcallback

    2. Para la autenticación del servicio (clave de API), use el token de acceso a la API que se encuentra en la configuración personal de Smartsheet. Configure los siguientes campos:

      • Clave de API: token de acceso a la API de Smartsheet generado a partir de su configuración personal.

      • URL base: https://api.smartsheet.com/2.0

      • Correo electrónico: dirección de correo electrónico asociada a la cuenta de Smartsheet que generó el token.

  6. Seleccione Crear y continuar.

  7. Elija los usuarios con los que compartir la integración.

  8. Elija Siguiente.

Para la autenticación de los usuarios, vaya a Conectores > el nombre de su conector de Smartsheet y elija Iniciar sesión para completar el flujo de autorización de OAuth. En la ventana de consentimiento de Smartsheet, elija Permitir para conceder el acceso.

importante

Con la autenticación del servicio, todas las acciones se ejecutan con los permisos del propietario del token de API. Cualquier usuario de Amazon Quick con acceso a esta integración puede realizar acciones en todos los recursos de Smartsheet a los que pueda acceder el propietario del token. Defina los permisos del token de manera adecuada a los requisitos de seguridad de su organización.

nota

Si usa Smartsheet Gov, Smartsheet Regions Europe o Smartsheet Regions Australia, use la URL base correspondiente para su entorno:

URL base regionales de Smartsheet
Entorno URL base
Smartsheet https://api.smartsheet.com/2.0
Gobierno de Smartsheet https://api.smartsheetgov.com/2.0
Regiones de Smartsheet en Europa https://api.smartsheet.eu/2.0
Regiones de Smartsheet: Australia https://api.smartsheet.au/2.0

Para obtener más información, consulte la URL base en la documentación de la API de Smartsheet.

Acciones disponibles

Después de configurar la integración, estarán disponibles las siguientes acciones.

Acciones disponibles de Smartsheet
Categoría Action Description (Descripción)
Search Búsqueda de listas Busca el texto especificado en todas las hojas a las que el usuario puede acceder.
Hojas Listar hojas Muestra todas las hojas a las que puede acceder el usuario autenticado.
Hojas Obtenga Sheet Obtiene una hoja y sus datos en función del identificador de la hoja.
Informes Enumere los informes Muestra todos los informes a los que puede acceder el usuario.
Informes Ver informe Obtiene los detalles del informe en función del identificador del informe.

Administra y soluciona problemas

Para editar, compartir o eliminar tu integración, consultaAdministrar las integraciones existentes.

Problemas de autenticación

  • Error en la autorización de OAuth: compruebe que el ID de cliente y el secreto del cliente coincidan con los valores que figuran en el registro de la aplicación Smartsheet Developer Tools. Confirme que la URL de redireccionamiento en Smartsheet coincida exactamente con la URL de su configuración de Amazon Quick. Para obtener una lista de los tipos de errores de OAuth, consulte los tipos de error de OAuth en la documentación de la API de Smartsheet.

  • Las herramientas para desarrolladores no están disponibles: compruebe que las herramientas para desarrolladores estén activadas en su cuenta de Smartsheet. Las cuentas gratuitas no son compatibles con las herramientas para desarrolladores. Si su solicitud fue rechazada, comuníquese con su gerente de atención al cliente de Smartsheet.

  • Se produce un error en la autenticación de la clave de API: compruebe que el token de acceso no se haya revocado. Puede administrar los tokens desde la configuración personal > Acceso a la API en la aplicación Smartsheet. Para obtener más información, consulte Generar un token de acceso a la API en el Centro de ayuda de Smartsheet.

  • El token de acceso ha caducado: los tokens de acceso de OAuth caducan después de aproximadamente 7 días. Amazon Quick gestiona la actualización automática de los tokens. Si encuentra errores persistentes en el token, cierre la sesión y vuelva a iniciarla desde la configuración de integración. Para obtener más información, consulte Realizar llamadas a la API en la documentación de la API de Smartsheet.

Mensajes de error comunes

  • Las acciones devuelven errores de permisos: verifique que el usuario autenticado tenga los permisos de uso compartido necesarios en las hojas de destino. Los ámbitos de OAuth no anulan los controles de acceso a nivel de uso compartido. Para obtener más información, consulte los niveles de acceso a los recursos en la documentación de la API de Smartsheet.

  • No se encontró la hoja: verifique que el ID de la hoja sea correcto y que el usuario autenticado tenga al menos acceso a la hoja como espectador.

  • Errores de límite de velocidad de la API: la API de Smartsheet impone los límites de velocidad. Para obtener más información, consulte las limitaciones en la documentación de la API de Smartsheet.