View a markdown version of this page

Intégration à Smartsheet - Amazon Quick
Conditions préalablesConfiguration des outils de développement SmartsheetÉtendue d'accès OAuthConfigurer l'intégration dans Amazon QuickActions disponiblesGestion et résolution des problèmes

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Intégration à Smartsheet

Utilisez le connecteur d'action Smartsheet pour gérer les feuilles, les lignes, les rapports et effectuer des recherches dans vos espaces de travail Smartsheet directement dans Amazon Quick en langage naturel. Cette intégration utilise l'API Smartsheet. Pour plus d'informations, consultez l'introduction de l'API Smartsheet dans la documentation Smartsheet.

La configuration de cette intégration comporte deux étapes. Vous devez d'abord configurer les informations d'identification dans Smartsheet pour la méthode d'authentification que vous avez choisie. Ensuite, vous créez l'intégration dans Amazon Quick et vous la connectez à votre compte Smartsheet. Pour plus d'informations sur les méthodes d'authentification prises en charge par Amazon Quick, consultezMéthodes d’authentification.

Conditions préalables

Avant de configurer l'intégration, assurez-vous que vous répondez aux exigences suivantes :

Configuration des outils de développement Smartsheet

Avant de configurer Amazon Quick, configurez les informations d'identification dans Smartsheet. Les étapes que vous effectuez dépendent de la méthode d'authentification que vous prévoyez d'utiliser. Amazon Quick prend en charge deux méthodes d'authentification pour Smartsheet. Pour plus d'informations sur ces méthodes, consultezMéthodes d’authentification.

Pour plus d'informations sur Smartsheet OAuth, consultez OAuth dans la documentation de l'API Smartsheet.

Inscrivez-vous aux outils de développement et créez un profil de développeur

  1. Accédez à la page d'enregistrement des outils de développement et enregistrez le compte Smartsheet que vous souhaitez utiliser avec vos applications. Pour plus d'informations, consultez la section S'inscrire aux outils de développement dans la documentation de l'API Smartsheet.

  2. Une fois que Smartsheet a activé les outils de développement, connectez-vous à l'application Smartsheet et choisissez l'icône de votre compte dans le coin inférieur gauche, puis choisissez Outils de développement.

  3. Choisissez Créer un profil de développeur et entrez un nom de profil. Pour plus d'informations, consultez la section Création de votre profil de développeur dans la documentation de l'API Smartsheet.

Astuce

Smartsheet recommande d'utiliser un compte de service dédié pour les applications OAuth plutôt qu'un compte personnel.

Enregistrez l'application OAuth

  1. Dans Smartsheet Developer Tools, choisissez Create New App.

  2. Complétez le formulaire :

    • Nom de l'application : nom permettant d'identifier votre application auprès des utilisateurs.

    • Description de l'application : brève description de l'intégration.

    • URL de l'application : URL qui lance votre application ou une page de destination.

    • App contact/support — Informations de contact du support.

    • URL de redirection de l'application — https://{region}.quicksight.aws.amazon.com/sn/oauthcallback

      Remplacez {region} par votre AWS région (par exemple,us-east-1).

  3. Choisissez Enregistrer. Smartsheet génère l'ID client de l'application et le secret de l'application.

  4. Copiez les valeurs d'ID client et de secret client. Vous en avez besoin lorsque vous configurez l'intégration dans Amazon Quick.

Pour plus d'informations, consultez Enregistrer une application dans la documentation de l'API Smartsheet.

Générer un jeton d'accès à l'API (authentification de service uniquement)

Si vous envisagez d'utiliser l'authentification de service au lieu d'OAuth, générez un jeton d'accès à l'API. Vous devez disposer d'un plan Business ou Enterprise pour générer des jetons. Pour plus d'informations, voir Générer un jeton d'accès à l'API dans le centre d'aide Smartsheet.

  1. Dans l'application Smartsheet, choisissez votre compte (image de profil) en bas de la barre de navigation de gauche, puis sélectionnez Paramètres personnels.

  2. Choisissez l'onglet Accès à l'API, puis sélectionnez Générer un nouveau jeton d'accès.

  3. Nommez le jeton et cliquez sur OK. Copiez immédiatement la valeur du jeton : c'est la seule fois qu'elle est visible.

Important

Stockez votre jeton d'accès en toute sécurité. Toute personne possédant le jeton peut accéder à toutes les données Smartsheet auxquelles le propriétaire du jeton a accès. N'envoyez pas de jetons aux systèmes de contrôle de version. Pour connaître les meilleures pratiques en matière de stockage de jetons, consultez la section Authentification dans la documentation de l'API Smartsheet.

Étendue d'accès OAuth

Lorsque vous configurez l'authentification utilisateur (OAuth), l'intégration demande les étendues d'accès suivantes à Smartsheet. Ces étendues déterminent ce que l'intégration peut faire pour le compte de l'utilisateur authentifié. Si vous utilisez plutôt l'authentification de service (clé API), l'intégration utilise les autorisations complètes du propriétaire du jeton et les étendues ne s'appliquent pas. Pour plus d'informations, consultez la section Étendue d'accès dans la documentation de l'API Smartsheet.

Étendue d'accès OAuth de Smartsheet
Scope Description
READ_SHEETS Lisez toutes les données de la feuille, y compris les pièces jointes, les discussions et les données des cellules.
WRITE_SHEETS Insérez et modifiez les données de la feuille, y compris les pièces jointes, les discussions et les données des cellules.
Note

Les étendues d'accès ne remplacent pas les autorisations de partage existantes. Par exemple, le fait de disposer de WRITE_SHEETS cette étendue ne permet pas à l'intégration de mettre à jour une feuille à laquelle l'utilisateur n'a accès qu'au niveau du lecteur. Pour plus d'informations, consultez la section Niveaux d'accès aux ressources dans la documentation de l'API Smartsheet.

Configurer l'intégration dans Amazon Quick

Après avoir terminé la configuration des outils de développement Smartsheet, créez l'intégration dans Amazon Quick.

  1. Dans la console Amazon Quick, choisissez Connectors.

  2. Choisissez l'onglet Créer pour votre équipe.

  3. Recherchez et choisissez Smartsheet.

  4. Entrez les détails de l'intégration :

    • Nom : nom descriptif de votre intégration Smartsheet.

    • Description (facultatif) — Objectif de l'intégration.

  5. Choisissez votre type de connexion et renseignez les paramètres de connexion. Pour plus d'informations sur ces méthodes d'authentification, consultezMéthodes d’authentification.

    1. Pour l'authentification utilisateur (OAuth), utilisez l'ID client et le secret client enregistrés lors de votre inscription à l'application Smartsheet Developer Tools. Configurez les champs suivants :

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

      • ID client : ID client de l'application indiqué lors de votre inscription à l'application Smartsheet Developer Tools.

      • Secret client : secret d'application indiqué lors de l'enregistrement de votre application Smartsheet Developer Tools.

      • URL du jeton — https://api.smartsheet.com/2.0/token

      • URL d'authentification — https://app.smartsheet.com/b/authorize

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

    2. Pour l'authentification du service (clé API), utilisez le jeton d'accès à l'API depuis vos paramètres personnels Smartsheet. Configurez les champs suivants :

      • Clé d'API : jeton d'accès à l'API Smartsheet généré à partir de vos paramètres personnels.

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

      • E-mail : adresse e-mail associée au compte Smartsheet qui a généré le jeton.

  6. Choisissez Créer et continuer.

  7. Choisissez les utilisateurs avec lesquels partager l'intégration.

  8. Choisissez Suivant.

Pour l'authentification des utilisateurs, accédez à Connecteurs > le nom de votre connecteur Smartsheet, puis choisissez Se connecter pour terminer le flux d'autorisation OAuth. Dans la fenêtre de consentement de Smartsheet, choisissez Autoriser pour accorder l'accès.

Important

Avec l'authentification de service, toutes les actions sont exécutées à l'aide des autorisations du propriétaire du jeton d'API. Tout utilisateur Amazon Quick ayant accès à cette intégration peut effectuer des actions sur toutes les ressources Smartsheet auxquelles le propriétaire du jeton peut accéder. Définissez les autorisations des jetons en fonction des exigences de sécurité de votre organisation.

Note

Si vous utilisez Smartsheet Gov, Smartsheet Regions Europe ou Smartsheet Regions Australie, utilisez l'URL de base correspondant à votre environnement :

URL de base régionales Smartsheet
Environnement URL de base
Smartsheet https://api.smartsheet.com/2.0
Smartsheet Gov https://api.smartsheetgov.com/2.0
Smartsheet Régions Europe https://api.smartsheet.eu/2.0
Smartsheet Regions Australie https://api.smartsheet.au/2.0

Pour plus d'informations, consultez la section URL de base dans la documentation de l'API Smartsheet.

Actions disponibles

Après avoir configuré l'intégration, les actions suivantes sont disponibles.

Actions disponibles dans Smartsheet
Catégorie Action Description
Recherche Recherche par liste Recherche le texte spécifié dans toutes les feuilles auxquelles l'utilisateur peut accéder.
Feuilles List Sheets Répertorie toutes les feuilles accessibles à l'utilisateur authentifié.
Feuilles Obtenir une feuille Obtient une feuille et ses données en fonction de son identifiant.
Rapports Rapports de liste Répertorie tous les rapports accessibles à l'utilisateur.
Rapports Afficher le rapport Obtient les détails du rapport en fonction de l'ID du rapport.

Gestion et résolution des problèmes

Pour modifier, partager ou supprimer votre intégration, consultezGestion des intégrations existantes.

Problèmes d’authentification

  • L'autorisation OAuth échoue : vérifiez que l'ID client et le secret du client correspondent aux valeurs indiquées dans votre enregistrement à l'application Smartsheet Developer Tools. Vérifiez que l'URL de redirection dans Smartsheet correspond exactement à l'URL de votre configuration Amazon Quick. Pour obtenir la liste des types d'erreurs OAuth, consultez la section Types d'erreurs OAuth dans la documentation de l'API Smartsheet.

  • Outils de développement non disponibles : vérifiez que les outils de développement sont activés pour votre compte Smartsheet. Les comptes gratuits ne sont pas compatibles avec les outils de développement. Si votre demande a été refusée, contactez votre responsable clientèle Smartsheet.

  • L'authentification par clé d'API échoue : vérifiez que le jeton d'accès n'a pas été révoqué. Vous pouvez gérer les jetons depuis Paramètres personnels > Accès aux API dans l'application Smartsheet. Pour plus d'informations, voir Générer un jeton d'accès à l'API dans le centre d'aide Smartsheet.

  • Jeton d'accès expiré — Les jetons d'accès OAuth expirent après environ 7 jours. Amazon Quick gère automatiquement l'actualisation des jetons. Si vous rencontrez des erreurs persistantes liées aux jetons, déconnectez-vous puis reconnectez-vous depuis les paramètres d'intégration. Pour plus d'informations, consultez la section Effectuer des appels d'API dans la documentation de l'API Smartsheet.

Messages d'erreur courants

  • Les actions renvoient des erreurs d'autorisation : vérifiez que l'utilisateur authentifié dispose des autorisations de partage requises sur les feuilles cibles. Les étendues OAuth ne remplacent pas les contrôles d'accès au niveau du partage. Pour plus d'informations, consultez la section Niveaux d'accès aux ressources dans la documentation de l'API Smartsheet.

  • Feuille introuvable : vérifiez que l'identifiant de la feuille est correct et que l'utilisateur authentifié a au moins accès à la feuille en tant que lecteur.

  • Erreurs liées aux limites de débit de l'API — L'API Smartsheet applique les limites de débit. Pour plus d'informations, consultez la section Limitations dans la documentation de l'API Smartsheet.