Action d'API personnalisée

Effectuez un appel HTTP personnalisé et authentifié à l'API Advanced Server Access.

Cette carte d'action vous permet d'effectuer des appels API arbitraires auprès de l'API Advanced Server Access. Utilisez cette carte principalement pour générer des flux pour des opérations où aucune des cartes d'action prédéfinies ne correspond à votre cas d'utilisation. Utilisez ce connecteur à la place du connecteur API Workflows natif, car il utilise l'objet Connexion ASAv2 qui est utilisé par d'autres cartes d'action.

La carte Action d'API personnalisée construit automatiquement l'URL vers l'API Advanced Server Access à l'aide des identifiants fournis. Le champ URL relative ne doit contenir que le chemin d'accès au point de terminaison/à la ressource vers lequel/laquelle vous souhaitez envoyer la requête.

L'action d'API personnalisée n'effectue aucune validation logique pour les opérations (par exemple, elle n'empêche pas une requête DELETE de contenir un corps HTTP). Assurez-vous de consulter la documentation de l'API Advanced Server Access pour vérifier que vous appelez l'API correctement.

Options

Champ Définition Type Obligatoire

Type de requête

Il s'agit de méthodes de requête HTTP prises en charge, ou de verbes HTTP, dans un appel d'API personnalisé (consultez Méthodes de requête HTTP).

  • 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 produire un résultat différent de celui d'une seule requête 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é.
  • 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éponse 200 (OK) est renvoyé.
Liste déroulante TRUE

Entrée

Champ Définition Type Obligatoire

Entrées

URL relative

L'adresse (URL) du serveur Web que vous essayez d'appeler. Spécifiez l'URL liée comme suit : /{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 de clés de l'objet dans l'entrée de requête.

Ce champ est relatif à l' URL complète, par exemple, https://app.scaleft.com/v1/:teams/:teamname.

 Texte TRUE

Requête

Indiquez tout paramètre de requête supplémentaire qui doit être inclus dans le format de l'objet (paires clé-valeur).

 Objet FALSE

En-têtes

Spécifiez les en-têtes requis en plus de l'autorisation ou du type de contenu (ceux-ci sont déjà gérés par ce connecteur).

 Objet FALSE

Corps

Indiquez un corps de requête au format JSON. Pris en charge uniquement pour les requêtes POST et PUT.

 Objet FALSE

Sortie

Champ Définition Type

Sorties

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, voir Codes de statut HTTP.

 Nombre

En-têtes

Contexte détaillé du code de statut, sans lien avec le corps de la sortie. Les en-têtes de réponse dépendent de l'option de requête HTTP que vous avez sélectionnée.

 Objet

Corps

Les données renvoyées par la requête HTTP que vous avez sélectionnée.

Par exemple, les données d'une requête GET.

 Objet