HTTP > Make an API Key Authorization request

Credentials

Sélectionnez la clé contenant vos informations d’authentification de clé API. Pour ajouter une nouvelle clé, cliquez sur Add et configurez les informations suivantes :

• Key name

  Saisissez un nom pour cet ensemble d’informations d’identification d’API.

• Key

  Saisissez la clé API.

• API Key placement

  Indiquez si la clé API doit être placée dans l’en-tête ou dans la requête de l’appel API.

• API Key parameter name

  Saisissez le nom sous lequel l’appel API identifie la clé API, par exemple « apiKey » ou « X-API-Key ». Vous trouverez ces informations dans la documentation du service web auquel le module se connecte.

Evaluate all states as errors (except for 2xx and 3xx)

Utilisez cette option pour configurer la gestion des erreurs.

Pour plus d’informations, voir Gestion des erreurs.

URL

Saisissez l’URL à laquelle vous souhaitez envoyer une requête, par exemple un point d’entrée API, un site web, etc.

Method

Sélectionnez la méthode de requête HTTP dont vous avez besoin pour configurer l’appel API. Pour plus d’informations, voir Méthodes de requête HTTP.

Headers

Ajoutez les en-têtes de la requête sous la forme d’un objet JSON standard. Par exemple, {"Content-type":"application/json"}

Query String

Saisissez les paires clé-valeur de requête souhaitées.

Body type

Le corps du message HTTP est constitué des octets de données transmis dans un message de transaction HTTP, immédiatement après les en-têtes, le cas échéant.

• Raw

  Le type de corps Raw convient généralement à la plupart des requêtes HTTP, même dans les cas où la documentation de développement ne spécifie pas les données à envoyer.

  Spécifiez un formulaire d’analyse des données dans le champ Content type .

  Malgré le type de contenu sélectionné, le module saisit les données dans n’importe quel format stipulé ou exigé par la documentation destinée à l’équipe de développement.

• Application/x-www-form-urlencoded

  Ce type de corps permet de POST des données à l’aide de application/x-www-form-urlencoded.

  Pour application/x-www-form-urlencoded, le corps du message HTTP envoyé au serveur est essentiellement une chaîne de requête. Les clés et les valeurs sont encodées dans des paires clé-valeur séparées par & et avec un = entre la clé et la valeur.

  Pour les données binaires, utilisez plutôt multipart/form-data.

  Exemple :

  Exemple du format de requête HTTP obtenu :

  field1=value1&field2=value2

• Multipart/form-data

  Le Multipart/form-data est une requête HTTP multipartie utilisée pour envoyer des fichiers et des données. Elle est fréquemment utilisée pour charger des fichiers sur le serveur.

  Ajouter des champs à envoyer dans la requête. Chaque champ doit contenir une paire clé-valeur.

  • Text

    Saisissez la clé et la valeur à envoyer dans le corps de la requête.

  • File

    Saisissez la clé et indiquez le fichier source à envoyer dans le corps de la requête.

    Mappez le fichier que vous souhaitez charger à partir du module précédent (par exemple HTTP > Get a File ou Google Drive > Download a File) ou saisissez manuellement le nom et les données du fichier.

Parse response

Activez cette option pour analyser automatiquement les réponses et convertir les réponses JSON et XML, de sorte que vous n’ayez pas besoin d’utiliser les modules JSON > Parse JSON ou XML > Parse XML.

Avant de pouvoir utiliser du contenu JSON ou XML analysé, exécutez le module une fois manuellement afin qu’il puisse reconnaître le contenu de la réponse et vous permettre de le mapper dans les modules suivants.

Timeout

Spécifiez le délai d’expiration de la requête en secondes (1 à 300). La valeur par défaut est de 40 secondes.

Share cookies with other HTTP modules

Activez cette option pour partager les cookies du serveur avec tous les modules HTTP de votre scénario.

Self-signed certificate

Pour ajouter un certificat auto-signé :

1. Cliquez sur Extract.

2. Sélectionnez le type de fichier que vous extrayez.

3. Sélectionnez le fichier contenant le certificat ou .

4. Saisissez le mot de passe du fichier.

5. Cliquez sur Save pour extraire le fichier et revenir à la configuration du module.

Reject connections that are using unverified (self-signed) certificates

Activez cette option pour rejeter les connexions qui utilisent des certificats TLS non vérifiés.

Follow redirect

Activez cette option pour suivre les redirections d’URL avec les réponses 3xx.

Follow all redirects

Activez cette option pour suivre les redirections d’URL avec tous les codes de réponse.

Disable serialization of multiple same query string keys as arrays

Par défaut, Workfront Fusion traite les valeurs multiples de la même clé de paramètre de chaîne de requête URL comme des tableaux. Par exemple, www.test.com?foo=bar&foo=baz sera converti en www.test.com?foo[0]=bar&foo[1]=baz. Activez cette option pour désactiver cette fonction.

Request compressed content

Activez cette option pour demander une version compressée du site web.

Ajoute un en-tête Accept-Encoding pour demander un contenu compressé.

Use Mutual TLS

Activez cette option pour utiliser le protocole TLS mutuel dans la requête HTTP.

Pour plus d’informations sur le protocole TLS mutuel, voir Utiliser le protocole TLS mutuel dans les modules HTTP dans Adobe Workfront Fusion.