HTTPCaller
Accède à une URL via HTTP ou HTTPS, en utilisant une variété de méthodes HTTP.
Les méthodes disponibles sont les suivantes :
HEAD
GET
PUT
POST
DELETE
OPTIONS
PATCH
COPY
LOCK
MKCOL
MOVE
PROPFIND
PROPPATCH
UNLOCK
CHECKOUT
CHECKIN
UNCHECKOUT
LINK
UNLINK
Importer une spécification depuis OpenAPI
Les requête peuvent être importées à partir d'API qui fournissent un fichier JSON ou YAML de la spécification OpenAPI. Pour ce faire, il faut
-
Télécharger le fichier de spécification
-
Utiliser le bouton Importer > Importer depuis une spécification OpenAI pour accéder à la fenêtre de paramètres.
-
Fournir l'emplacement du fichier dans le paramètre Spécification
-
Sélectionnez l'un des points de terminaison disponibles et la fenêtre HTTPCaller sera remplie comme spécifié, y compris l'URL de la requête, la méthode d'authentification et les détails de la requête tels que la méthode HTTP et les Paramètres complémentaires de la requête.
Notez que toute sélection effectuée ici remplacera les valeurs actuelles des paramètres.
Exemples
Cet exemple utilise un exemple de spécification OpenAPI pour remplir le HTTPCaller.
Le fichier JSON d'exemple a été téléchargé à partir d'OpenAPI.
Utiliser le bouton d'importation, Importer depuis OpenAPI.
Après avoir indiqué l'emplacement du fichier, la spécification est chargée et les points de terminaison disponibles sont répertoriés.
Notre sélection fournit une URL de requête, définit la méthode HTTP sur GET et renseigne certains paramètres complémentaires de la requête. L'authentification n'était pas requise.
Configuration
Ports d'entrée
Ce Transformer accepte tous types d'entités.
Ports de sortie
Le corps de la réponse HTTP peut être enregistré dans un attribut ou dans un fichier. Par défaut, le corps est enregistré dans l'attribut identifié par le paramètre Attribut Réponse.
Le code d'état de la réponse HTTP sera stocké dans l'attribut nommé par le paramètre Attribut du code de statut. Par défaut, il s'agit de l'attribut _http_status_code. Pour plus d'informations sur les codes d'état HTTP, veuillez vous reporter à https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html.
De plus, les en-têtes de la réponse HTTP seront enregistrés dans l'attribut de liste spécifié par le paramètre Attribut de liste d'en-têtes multipartites. Par défaut, les en-têtes sont stockés dans l'attribut de liste _headers{}. Pour obtenir une liste des en-têtes de réponse HTTP courants, veuillez consulter https://en.wikipedia.org/wiki/List_of_HTTP_header_fields.
Si une erreur se produit lors de l'accès à l'URL, l'entité sera émise via le port <Rejected>. En outre, un message d'erreur sera défini dans l'attribut nommé par le paramètre Attribut Erreur.
Gestion des entités rejetées : ce paramètre permet d'interrompre la traduction ou de la poursuivre lorsqu'elle rencontre une entité rejetée. Ce paramètre est disponible à la fois comme option par défaut de FME et comme paramètre de traitement.
Paramètres
URL |
Ce paramètre identifie l'URL qui sera accédée par le Transformer. Le Transformer peut accéder aux URLs http et https. L'URL peut être saisie directement dans le Transformer, ou être construite à partir des valeurs des attributs. |
||||||||||||||||
Méthode HTTP |
Sélectionner une méthode HTTP pour accéder au serveur. La plupart des demandes utilisent la méthode GET. Les demandes de téléchargement de données utilisent généralement la méthode PUT, POST ou PATCH, bien qu'un corps de téléchargement puisse également être fourni avec la méthode DELETE. Les méthodes HEAD , DELETE et OPTIONS peuvent être utiles pour accéder à une API REST. Des méthodes supplémentaires sont disponibles. |
||||||||||||||||
Paramètres d'authentification |
Si l'option est activée, fournir les détails d'authentification nécessaires.
|
||||||||||||||||
Paramètres complémentaires de la requête |
Ce tableau peut être utilisé pour créer des paramètres de requête d'URL supplémentaires. Les paramètres seront ajoutés à l'URL indiquée dans le paramètre URL de la section Requête. Cela peut être utile pour accéder à un point de terminaison d'API REST qui nécessite de nombreux paramètres. Les noms et valeurs des paramètres peuvent être saisis directement ou construits à partir de valeurs d'attributs. |
||||||||||||||||
En-têtes |
Cette table peut être utilisée pour créer des en-têtes HTTP personnalisés qui seront envoyés avec la requête. Cela peut être utilisé pour personnaliser la demande que FME fera au serveur. Les noms et les valeurs des en-têtes peuvent être saisis directement ou construits à partir de valeurs d'attributs. De plus, la colonne Nom fournit une liste de noms d'en-têtes couramment utilisés. |
||||||||||||||||
Corps |
Ces paramètres sont activement uniquement lorsque la Méthode HTTP est PUT, POST, DELETE, ou PATCH. Un corps de téléchargement n'est pas obligatoire ; par exemple, les demandes DELETE n'ont souvent pas de corps de téléchargement.
|
Enregistrer le corps de la réponse dans |
Ce paramètre permet aux utilisateurs de définir la destination du corps de la réponse HTTP. Le corps peut être enregistré dans un attribut, dans un fichier spécifié par l'utilisateur, ou dans un nouveau fichier dans un répertoire spécifié par l'utilisateur. Note Si vous téléchargez un corps de réponse très volumineux avec le HTTPCaller, il est recommandé de l'enregistrer dans un fichier. Cela évite de créer un grand attribut sur l'entité.
|
||||||
Enregistrer le corps de la réponse dans un attribut |
Lorsque cette option est sélectionnée, chaque corps de réponse HTTP est enregistré dans un attribut de l'entité qui a fait la demande. Les paramètres suivants sont activés pour cette option.
|
||||||
Enregistrement de la réponse dans un fichier |
Lorsque cette option est sélectionnée, chaque réponse HTTP sera enregistrée dans un fichier. Les paramètres suivants sont activés pour cette option.
|
||||||
Enregistrer le corps de la réponse dans un dossier |
Lorsque cette option est sélectionnée, HTTPCaller crée un nouveau fichier pour chaque entité traitée.
|
||||||
Attributs d'en-tête et de statut de la réponse |
|
||||||
Traitement des réponses multipartites |
Il est rare, mais possible, qu'un serveur HTTP renvoie une réponse en plusieurs parties. En d'autres termes, une requête HTTP unique donnera lieu à une réponse HTTP contenant plusieurs parties différentes. Une réponse multipartite aura un en-tête Content-Type commençant par "multipart", tel que "multipart/mixed". HTTPCaller dispose de l'option Entité générée pour diviser de telles réponses en plusieurs entités. Les réponses multipartites étant très rares, le comportement par défaut est de ne pas diviser les réponses multipartites en plusieurs entités. Ces paramètres ne sont activés que lorsque les corps de réponse sont enregistrés dans des attributs ou dans un dossier.
|
Requêtes concurrentes |
|
||||||
Répéter les requêtes échouées |
Lorsqu'il est activé, le HTTPCaller tente de relancer les demandes qui ont échoué ou qui ont renvoyé une erreur HTTP.
|
||||||
Limitation du débit |
|
||||||
Options clients HTTP |
|||||||
Sécurité avancée |
|
Spécification |
Spécifiez un fichier de spécification OpenAPI JSON ou YAML à utiliser. Ce fichier doit être téléchargé (les URL ne sont pas prises en charge). |
Sélectionner un point de terminaison |
Sélectionnez une option disponible pour que ses détails s'affichent dans la fenêtre principale des paramètres. |
Éditer les paramètres des Transformers
À l'aide d'un ensemble d'options de menu, les paramètres du Transformer peuvent être attribués en faisant référence à d'autres éléments de traitement. Des fonctions plus avancées, telles qu'un éditeur avancé et un éditeur arithmétique, sont également disponibles dans certains Transformers. Pour accéder à un menu de ces options, cliquez sur à côté du paramètre applicable. Pour plus d'informations, voir Options de menus et paramètres de Transformer.
Définir les valeurs
Il existe plusieurs façons de définir une valeur à utiliser dans un Transformer. La plus simple est de simplement taper une valeur ou une chaîne de caractères, qui peut inclure des fonctions de différents types comme des références d'attributs, des fonctions mathématiques et de chaînes de caractères, et des paramètres de traitement. Il existe un certain nombre d'outils et de raccourcis qui peuvent aider à construire des valeurs, généralement disponibles dans le menu contextuel déroulant adjacent au champ de valeur.
Utilisation de l'éditeur de texte
L'éditeur de texte fournit un moyen efficace de construire des chaînes de textes (dont les expressions régulières) à partir de données source diverses, telles que des attributs, des paramètres et des constantes, et le résultat est directement utilisé dans le paramètre.
Utilisation de l'éditeur arithmétique
L'éditeur arithmétique fournit un moyen simple de construire des expressions mathématiques à partir de plusieurs données source, telles que des attributs et des fonctions, et le résultat est directement utilisé dans un paramètre.
Valeur conditionnelle
Définit des valeurs selon un ou plusieurs tests.
Fenêtre de définition de conditions
Contenu
Les expressions et chaînes de caractères peuvent inclure des fonctions, caractères, paramètres et plus.
Lors du paramétrage des valeurs - qu'elles soient entrées directement dans un paramètre ou construites en utilisant l'un des éditeurs - les chaînes de caractères et les expressions contenant des fonctions Chaîne de caractères, Math, Date et heure ou Entité FME auront ces fonctions évaluées. Par conséquent, les noms de ces fonctions (sous la forme @<nom_de_fonction>) ne doivent pas être utilisés comme valeurs littérales de chaîne de caractères.
Ces fonctions manipulent les chaînes de caractères. | |
Caractères spéciaux |
Un ensemble de caractères de contrôle est disponible dans l'éditeur de texte. |
Plusieurs fonctions sont disponibles dans les deux éditeurs. | |
Fonctions Date/heure | Les fonctions de dates et heures sont disponibles dans l'Editeur texte. |
Ces opérateur sont disponibles dans l'éditeur arithmétique. | |
Elles retournent des valeurs spécifiques aux entités. | |
Les paramètres FME et spécifiques au traitement peuvent être utilisés. | |
Créer et modifier un paramètre publié | Créer ses propres paramètres éditables. |
Options - Tables
Les Transformers avec des paramètres de style table possèdent des outils additionnels pour remplir et manipuler des valeurs.
Réordonner
|
Activé une fois que vous avez cliqué sur un élément de ligne. Les choix comprennent :
|
Couper, Copier et Coller
|
Activé une fois que vous avez cliqué sur un élément de ligne. Les choix comprennent :
Copier, copier et coller peuvent être utilisés au sein d'un Transformer ou entre Transfromers. |
Filtre
|
Commencez à taper une chaîne de caractères, et la matrice n'affichera que les lignes correspondant à ces caractères. Recherche dans toutes les colonnes. Cela n'affecte que l'affichage des attributs dans le Transformer - cela ne change pas les attributs qui sont sortis. |
Importer
|
Le bouton d'import remplit la table avec un jeu de nouveaux attributs lus depuis un jeu de données. L'application spécifique varie selon les Transformers. |
Réinitialiser/Rafraîchir
|
Réinitialise la table à son état initial, et peut fournir des options additionnelles pour supprimer des entrées invalides. Le comportement varie d'un Transformer à l'autre. |
Note : Tous les outils ne sont pas disponibles dans tous les Transformers.
Ce Transformer remplace les Transformers HTTPFetcher, HTTPUploader, HTTPFileUploader, HTTPMultipartUploader, HTTPDeleter and HTTPHeader.
FME Community
FME Community est l'endroit où trouver des démos, des tutoriaux, des articles, des FAQ et bien plus encore. Obtenez des réponses à vos questions, apprenez des autres utilisateurs et suggérez, votez et commentez de nouvelles entités.
Voir tous les résultats à propos de ce Transformer sur FME Community.
Mots clefs : URLFetcher