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 de la connexion à l'API REST
Grâce à l'intégration de la connexion API REST dans Amazon Quick, vous pouvez effectuer des actions avec des API REST et des services Web personnalisés. Cette intégration prend uniquement en charge l'exécution d'actions.
Actions possibles
Grâce à l'intégration de la connexion aux API REST, vous pouvez effectuer des actions avec des API REST personnalisées et des services Web via le connecteur d'action.
- Connecteur Action
-
Effectuez des requêtes HTTP, récupérez des données et interagissez avec les API à l'aide d'options d'authentification flexibles.
Note
L'intégration de la connexion à l'API REST ne prend pas en charge l'accès aux données ni la création de bases de connaissances. Il est spécialement conçu pour l'exécution de tâches et les interactions d'API avec des services Web personnalisés.
Avant de commencer
Avant de configurer l'intégration de l'API REST, assurez-vous de disposer des éléments suivants :
-
Point de terminaison de l'API REST doté des autorisations d'accès appropriées.
-
Identifiants d'authentification de l'API (OAuth, clé d'API ou autre).
-
Documentation de l'API pour le service Web cible.
Préparer le point de terminaison et l'authentification des API
Avant de configurer l'intégration dans Amazon Quick, préparez le point de terminaison et les informations d'authentification de votre API REST. L'intégration de la connexion à l'API REST prend en charge plusieurs méthodes d'authentification. Choisissez la méthode qui correspond aux exigences de votre API :
- Authentification utilisateur (OAuth)
-
Rassemblez les informations suivantes auprès de votre fournisseur d'API :
URL de base : URL de base de l'API REST.
ID client : ID du client de l'application OAuth.
Secret du client : secret du client de l'application OAuth.
URL du jeton : point de terminaison du jeton OAuth.
URL d'authentification : point de terminaison d'autorisation OAuth.
URL de redirection : URI de redirection OAuth.
- Authentification de service (Service-to-service OAuth)
-
Rassemblez les informations suivantes auprès de votre fournisseur d'API :
Type d'authentification : les informations d'identification du client OAuth 2.0 permettent le flux d'authentification de service à service.
URL de base : URL de base de l'API REST.
ID client : identifiant du client de l'application OAuth pour l'authentification du service.
Secret du client : secret du client de l'application OAuth pour l'authentification du service.
URL du jeton : point de terminaison du jeton OAuth pour obtenir des jetons d'accès.
En-têtes et paramètres personnalisés
Vous pouvez utiliser des en-têtes et des paramètres personnalisés pour une authentification flexible et une interaction avec les API :
En-têtes d'authentification personnalisés.
En-têtes de version de l'API.
Content-Type spécifications.
Paramètres de requête personnalisés.
Configurer l'intégration de l'API REST
Après avoir préparé votre point de terminaison d'API et vos informations d'authentification, procédez comme suit pour créer votre intégration d'API REST :
-
Dans la console Amazon Quick, choisissez Connectors.
-
Choisissez l'onglet Créer pour votre équipe.
-
Recherchez et choisissez REST API Connection.
-
Renseignez les détails de l'intégration :
-
Nom : nom descriptif de votre intégration d'API REST.
-
Description (facultatif) - Objectif de l'intégration.
-
-
Choisissez votre type de connexion :
-
Authentification utilisateur : OAuth-based authentification pour l'accès utilisateur individuel.
-
Authentification du service : authentification basée sur une clé API pour l'accès au service.
-
-
Renseignez les paramètres de connexion en fonction de la méthode d'authentification que vous avez sélectionnée (utilisateur ou service).
-
Sélectionnez Suivant.
-
Passez en revue les actions disponibles.
-
Sélectionnez Créer et continuer.
Actions de tâche disponibles
Après avoir créé votre intégration d'API REST, vous pouvez consulter les actions disponibles pour interagir avec l'API REST. Les actions courantes de l'API REST sont les suivantes :
Requêtes HTTP GET pour la récupération de données.
Requêtes HTTP POST pour la création de données.
PUT/PATCH Requêtes HTTP pour les mises à jour des données.
Requêtes HTTP DELETE pour la suppression de données.
Interactions personnalisées avec les terminaux.
Traitement des données JSON et XML.
Gestion des paramètres de requête et des en-têtes.
Note
Les actions spécifiques disponibles dépendent des points de terminaison de l'API REST et des autorisations d'authentification configurées pour votre intégration.
Options de configuration de l'API
Vous pouvez configurer différents aspects de l'intégration de votre API REST en fonction de vos besoins spécifiques.
Configuration du point de terminaison
Configurez ces paramètres de point de terminaison :
URL de base et chemins des points de terminaison.
Spécifications de la méthode HTTP.
Gestion du format des demandes et des réponses.
Gestion des erreurs et logique des nouvelles tentatives.
Manipulation des données
Configurez la façon dont votre intégration traite les différents formats de données :
Traitement des demandes et des réponses JSON.
Transformation de données XML.
Données de formulaire et téléchargements partitionnés.
Gestion des données binaires.
Gérer les intégrations d'API REST
Après avoir créé votre intégration d'API REST, vous pouvez la gérer à l'aide des options suivantes :
-
Modifier l'intégration : mettez à jour les paramètres d'authentification, l'URL de base ou la configuration de l'API.
-
Partager l'intégration : mettez l'intégration à la disposition des autres utilisateurs de votre organisation.
-
Surveillez l'utilisation : consultez l'activité d'intégration et les statistiques des appels d'API.
-
Actions de révision : consultez la liste complète des actions d'API REST disponibles.
-
Tester les points de terminaison : validez la connectivité et l'authentification des API.
-
Supprimer l'intégration : supprimez l'intégration et révoquez l'authentification associée.
Important
Les intégrations d'API REST dépendent de la disponibilité et de la configuration du service Web cible. Les modifications apportées à l'API ou aux exigences d'authentification peuvent affecter les fonctionnalités d'intégration.
