Transformers FME: 2025.0
Transformers FME: 2025.0
OpenAPICaller
Accède à un point de terminaison API défini par une spécification OpenAPI via HTTP ou HTTPS.
Importer une spécification depuis OpenAPI
Ce Transformer doit être configuré en important un fichier JSON ou YAML de spécification OpenAPI. Pour ce faire, il faut
- Télécharger le fichier de spécification
- Utilisez le bouton Sélectionner pour accéder à la boîte de dialogue d'importation
- Fournir l'emplacement du fichier dans le paramètre Spécification
- Sélectionnez l'un des points de terminaison disponibles et la boîte de dialogue OpenAPICaller sera remplie comme spécifié, y compris l'URL complète de la requête, la méthode d'authentification et les détails de la requête tels que les paramètres de la chaîne de requête et les en-têtes.
Notez que toute sélection effectuée ici remplacera les valeurs actuelles des paramètres.
Exemples

Dans cet exemple, nous allons configurer un OpenAPICaller pour récupérer une liste d'emojis disponibles sur Trello via leur spécification OpenAPI.
Notez que le fichier de spécification doit être téléchargé avant d'être utilisé ici - il ne peut pas être lu via une URL. Il s'agit d'un fichier JSON ou YAML.
Dans la boîte de dialogue des paramètres, utilisez le bouton Sélectionner pour accéder à la boîte de dialogue d'importation.
Dans la boîte de dialogue d'importation, naviguez jusqu'au fichier de spécification précédemment téléchargé.
Une fois le fichier de spécification sélectionné, les options de point de terminaison disponibles sont renseignées.
Nous sélectionnons le point de terminaison emoji et sa méthode GET. Notez que les paramètres de requête applicables sont également récupérés.
Importer des paramètres de requête appliquera les sélections aux paramètres OpenAPICaller appropriés.
Les paramètres applicables ont été configurés.
Pour tester la configuration, nous utilisons le bouton Envoyer une demande de test.
Dans la boîte de dialogue de la demande de test, un aperçu de la requête est affiché.
Notez que s'il y avait des paramètres utilisateur dans la requête, ils seraient disponibles et modifiables pour les tests.
L'option Envoyer une demande de test permet d'exécuter la requête.
Les résultats du test de la requête sont renvoyés dans l'aperçu de la réponse du test.
Ces résultats (et toute modification de configuration apportée aux paramètres utilisateur, le cas échéant) sont enregistrés pour référence ultérieure, mais n'affectent pas les paramètres actuels du Transformer.
Configuration
Ports en 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

Authentification |
Si l'option est activée, fournir les détails d'authentification nécessaires.
|
||||||||||||||||
URL par paramètres |
Ce groupe divise l'URL de la requête complète en plusieurs composants qui peuvent être édités séparément. Toute modification apportée à ces paramètres sera répercutée sur la valeur du paramètre URL de la requête complète.
|
||||||||||||||||
URL de la requête complète |
Ce paramètre identifie l'URL à laquelle le transformateur accède. L'URL peut être modifiée directement dans ce paramètre ou en modifiant les paramètres du groupe URL par paramètres ci-dessus. Toute modification apportée à ce paramètre sera répercutée dans le groupe URL par paramètres. |
||||||||||||||||
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.
|

Méthode de gestion de la réponse |
Ce paramètre utilise l'utilisateur à déterminer comment le corps de la réponse HTTP doit être traité. |
||||||||||||||||||||||
Produire des fragments JSON en tant qu'entités |
Lorsque le mode de traitement de la réponse est Générer des fragments JSON en tant qu'entités , ce mode effectue un post-traitement JSON sur le corps de la réponse, ce qui équivaut à insérer les transformateurs JSONFlattener et JSONFragmenter après l'OpenAPICaller. Les clés et valeurs d'objet contenues dans le corps de la réponse seront extraites dans des entités FME. Le corps de la réponse peut éventuellement être divisé en plusieurs entités à l'aide du paramètre Requête JSON à Fragment. Si le corps de la réponse ne contient pas de json valide, l'entité sera émise via le port <Rejected>.
|
||||||||||||||||||||||
Enregistrer le corps de la réponse complet |
Lorsque le mode de traitement des réponses est Enregistrer le corps de la réponse complet, ce paramètre permet aux utilisateurs de définir la destination du corps de la réponse HTTP.
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é.
|
||||||||||||||||||||||
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 qui commence par « multipart », tel que « multipart/mixed ». L'OpenAPICaller dispose de l'option Entité en sortie qui permet de diviser de telles réponses en plusieurs entités. Comme les réponses multipart sont très rares, le comportement par défaut est de ne pas diviser les réponses multipart 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 OpenAPICaller tente de relancer les demandes qui ont échoué ou qui ont renvoyé une erreur HTTP.
|
||||||||||
Limitation du débit |
|
||||||||||
Options clients HTTP |
|||||||||||
Certificat client HTTPS |
Dans une connexion HTTPS classique, le serveur fournit un certificat qui est authentifié par le client. Cela garantit la sécurité de la connexion. Il est également possible pour le client de s'authentifier auprès du serveur par le biais d'un certificat, appelé certificat client. C'est ce qu'on appelle le « TLS mutuel », qui permet au serveur de n'accepter que les connexions des clients disposant d'un certificat valide. Ce type d'authentification est rare et n'est généralement utilisé que lorsqu'une sécurité avancée est requise. Lors de l'utilisation d'un certificat client, une clé privée est également nécessaire.
|
||||||||||
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
Les paramètres du Transformer peuvent être définis en saisissant directement des valeurs, en utilisant des expressions ou en faisant référence à d'autres éléments de l'espace de travail tels que des valeurs d'attributs ou des paramètres utilisateur. Divers éditeurs et menus contextuels sont disponibles pour vous aider. Pour voir ce qui est disponible, cliquez sur à côté du paramètre concerné.

Définir les valeurs
Il existe plusieurs façons de définir une valeur à utiliser dans un Transformer. La plus simple consiste à saisir simplement une valeur ou une chaîne de caractères, qui peut inclure des fonctions de différents types telles que des références d'attributs, des fonctions mathématiques et de chaînes de caractères, et des paramètres traitement.
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. |

Outils de tableau
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.
Pour plus d'information, consulter la section Options des Transformers.
Références
Comportement |
Les angles de ligne et de texte peuvent être ajoutés en tant qu'attribut de sortie. |
Stockage des entités |
Non |
Dépendances | Aucun |
Alias | |
Historique | Ce Transformer remplace l'option Importer depuis OpenAPI du HTTPCaller. |
FME Community
FME Community dispose d'une mine de connaissances sur FME, avec plus de 20 000 membres actifs dans le monde entier. Obtenez de l'aide sur FME, partagez vos connaissances et entrez en contact avec des utilisateurs du monde entier.
Voir tous les résultats à propos de ce Transformer sur FME Community.
Examples may contain information licensed under the Open Government Licence – Vancouver, Open Government Licence - British Columbia, and/or Open Government Licence – Canada.