Demandes d'API externes
Communiquez avec n'importe quelle API et intégrez n'importe quel service.
Les demandes d'API externes vous permettent de définir des modèles de demande, puis de déclencher des appels sortants vers n'importe quelle API à partir des processus métier. Grâce à elles, vous pouvez connecter votre projet à n'importe quel service tiers, même si aucun module n'existe encore pour ce service sur le marché.
Définition
Consultez les spécifications sur la façon dont la demande doit être structurée dans la documentation API du fournisseur de services avec lequel vous souhaitez vous connecter.
- Pour définir un nouveau modèle de demande, allez dans l'onglet "Logique d'entreprise" de la barre latérale (1), passez à l'onglet "Demandes API externes" (2) et cliquez sur "Nouvelle demande API" (3).
3. Sélectionnez la méthode HTTP de la demande et son URL. 4.
4. Définir les paramètres de l'URL, les paramètres de la requête (uniquement pour les requêtes GET), les en-têtes et le corps de la requête en saisissant le nom du paramètre (1), son type (2) et en cliquant sur "Add Param" (3).
La valeur réelle de ces paramètres sera définie au moment de l'exécution du processus métier, où la requête est déclenchée.
Pour comprendre la différence entre les paramètres d'URL et de requête, lisez plus ici. Indépendamment des normes, la documentation de l'API du fournisseur de services avec lequel vous souhaitez vous connecter est la meilleure source d'informations sur la manière de construire la requête.
Vous pouvez également remplir automatiquement les en-têtes et le corps de la requête en saisissant un exemple de JSON, le système créera automatiquement tous les paramètres nécessaires.
Vous n'avez pas besoin d'ajouter de nouveaux paramètres à chaque onglet. Certaines requêtes peuvent ne pas contenir de paramètres d'URL, d'en-têtes ou de corps du tout, par exemple.
Dans le cas où votre demande contient des objets (par exemple, une voiture -> couleur, taille, etc.), vous devrez créer des modèles virtuels pour traiter ces objets plus tard dans vos processus commerciaux. Pour ce faire, sélectionnez "Modèle" dans le sélecteur de type de paramètre et introduisez les éléments enfants dont vous avez besoin. Vous pouvez imbriquer les objets autant de fois que vous le souhaitez (c'est-à-dire un objet dans un autre) et créer des tableaux de modèles virtuels. Si vous avez utilisé la fonction de remplissage automatique, ce processus s'est déroulé automatiquement.
5. Modifiez les paramètres de la demande, tels que la vérification SSL, le délai d'attente et le traitement des erreurs dans l'onglet "Paramètres".
7. Enregistrez le modèle de demande en cliquant sur "Enregistrer la demande".
Utiliser
Après avoir défini et sauvegardé une nouvelle demande, un nouveau bloc sera disponible dans l'éditeur de processus métier pour la déclencher.
Vous devrez lui fournir tous les composants que vous souhaitez ajouter à la demande (URL et paramètres de requête, en-têtes et corps) sous forme de modèles de données, qui peuvent être réalisés à l'aide de ces blocs. En sortie, vous pourrez extraire le corps formaté de la réponse, ses en-têtes et son état. Vous pouvez développer ces modèles à l'aide de ces blocs.
Il n'est pas nécessaire de connecter toutes les entrées de données pour que la demande se déclenche correctement. Par exemple, si vous avez une requête sans paramètres d'URL, vous n'avez pas besoin de créer son modèle et de le connecter.
Pour chaque modèle virtuel que vous avez défini, 2 nouveaux blocs seront ajoutés à votre Business Process Editor pour le réaliser et le développer.
Surveillance de
Chaque fois que vous déclenchez une demande d'API, le système envoie dans les journaux son type et son adresse, le corps de la demande, le code d'état HTTP de la réponse et le corps de la réponse. Vous pouvez envoyer d'autres informations, telles que des champs spécifiques du corps de la réponse, ou la latence aux journaux à l'aide du bloc Write to Log.
