Connector Builder Documentation sur les cartes d'API personnalisée

Aide de référence pour les cartes d'action d'API personnalisée

Incluez une rubrique d'aide de référence pour la carte d'action d'API personnalisée de votre connecteur.

Utilisez la phrase suivante pour introduire votre rubrique :

Utilisez la carte Action d'API personnalisée pour effectuer une requête API personnalisée authentifiée auprès de l'API REST <your service>.

Options

Pour le champ Type de requête de votre rubrique d'aide, indiquez les méthodes prises en charge par votre carte d'action d'API personnalisée. Utilisez ces définitions selon les besoins :

GET Récupère des données d'un serveur Web en fonction des paramètres. Cette méthode demande une représentation de la ressource spécifiée. Si une requête aboutit, un message de réponse 200 (OK) est renvoyé avec le contenu demandé.
POST Envoie des données à un serveur Web en fonction des paramètres (par exemple, le chargement d'un fichier). Plusieurs requêtes POST peuvent aboutir à un résultat différent d'un seul POST. Il faut être prudent pour éviter d'envoyer plusieurs requêtes POST par inadvertance. Si une requête aboutit, un message de réponse 200 (OK) est renvoyé.
PUT Envoie des données à stocker à un emplacement spécifique sur un serveur Web en fonction des paramètres (par exemple, le chargement d'un fichier). Contrairement aux requêtes POST, les requêtes PUT sont idempotentes. Pour les requêtes réussies, le résultat d'une seule requête PUT est le même que plusieurs requêtes PUT identiques. Si une requête aboutit, un message de réponse 200 (OK), 201 (Created) ou 204 (No Content) est renvoyé.
PATCH Applique des modifications partielles à une ressource sur un serveur Web en fonction des paramètres. PATCH n'est pas idempotent. Plusieurs requêtes PATCH pourraient avoir des conséquences non souhaitées. Si une requête PATCH réussit, un message de réponse 200 (OK) ou 204 (No Content) est retourné.
DELETE Supprime la ressource spécifiée (si elle existe) du serveur Web en fonction des paramètres. Si une requête DELETE aboutit, un message de réponse200 (OK) est renvoyé.

Entrées

Pour la section des champs de saisie, fournissez les définitions des champs suivants :

  • URL liée

  • En-têtes

  • Requête

  • Corps

En guise d'exemple, voici une définition du champ URL relative sur le connecteur Google Calendar  :

URL liée

Adresse URL du serveur Web avec lequel vous essayez d'interagir. Spécifiez l' URL liée comme suit : /{version}/{insert_remaining_URL}.

Vous pouvez spécifier les paramètres de la requête dans l'URL liée en utilisant ?, ou spécifier les paramètres de la requête comme une paire objet-clé dans l'entrée Requête.

Par exemple, le point de terminaison de l'API Google Calendar est : https://www.googleapis.com/calendar/v3/users/{userId}/calendarList, l'URL liée est donc : /v3/users/{userId}/calendarList.

Sorties

Pour la section des champs de résultat, fournissez les définitions des champs suivants :

  • Code de statut

  • En-têtes

  • Corps

Par exemple, pour le champ Code de statut  :

Code de statut

Résultat de l'opération. Le connecteur retourne un code de statut HTTP qui indique si l'action effectuée par la carte a réussi ou échoué. Par exemple :

Un code de statut 201 Created indique un succès où une nouvelle ressource a été créée.

Une erreur 403 Forbidden indique que la requête HTTP n'a pas été traitée parce que les permissions nécessaires étaient manquantes.

Pour une liste complète des codes de statut possibles, consultez Codes de statut HTTP.

Exemples

À titre de référence, consultez les rubriques suivantes sur les cartes Action d'API personnalisée  :