Exemple d'interface de service

Un service d'intégration dans IBM® App Connect Enterprise est une application spécialisée avec une interface bien définie et des flux d'implémentation pour chaque opération de service. Cet exemple illustre une interface de service.

Lisez les informations de concept relatives aux services d'intégration.

Dans la capture d'écran qui suit, une interface a été créée pour un rapport de crédit. Il s'agit de l'interface d'un composant qui envoie un solde du compte d'un client et obtient l'approbation d'une transaction, obtient l'historique du compte du client, puis met à jour la cote de crédit du client. getApproval et getHistory sont des opérations de demande-réponse. updateCreditRating est une opération à sens unique.

Capture d'écran montrant les opérations getApproval, getHistory et updateCreditRating telles que décrites ci-dessus.

Les parties suivantes de l'interface de rapport de crédit sont affichées dans l'éditeur d'interface:
Opération demande-réponse
getApproval, lorsqu'il est invoqué, envoie le solde du compte client et obtient l'approbation d'une transaction. getApproval contient les entrées, les sorties et les défauts suivants :
  • Entrée: getApproval envoie en entrée le solde des variables. La variable balance doit avoir un type de données double.
  • Sortie: getApproval renvoie en sortie une variable nommée approbation. La variable approbation contient une chaîne recommandant l'approbation (si les fonds sont suffisants pour justifier l'octroi d'un crédit) ou le rejet (si les fonds ne sont pas suffisants pour accorder un crédit au demandeur).
  • Erreurs: getApproval peut renvoyer l'une des deux erreurs, qui sont toutes deux des chaînes décrivant une condition d'erreur: timeout est renvoyé si le service attend trop longtemps pour déterminer l'approbation ; systemFailure est renvoyé en cas de panne de communication ou d'alimentation.
Opération demande-réponse
getHistory, lorsqu'il est invoqué, envoie le nom d'un compte client et obtient l'historique des transactions du client. getHistory contient les entrées, les sorties et les défauts suivants :
  • Entrée: getHistory envoie en entrée la variable customerName. La variable customerName doit avoir un type de données chaîne.
  • Sortie : getHistory renvoie en sortie une variable nommée customerPastHistory. La variable customerPastHistory contient une chaîne de caractères contenant un enregistrement des transactions passées.
  • Erreur: getHistory peut renvoyer l'une des deux erreurs, qui sont toutes deux des chaînes décrivant une condition d'erreur: timeout est renvoyé si le service attend trop longtemps pour déterminer l'approbation ; systemFailure est renvoyé en cas de panne de communication ou d'alimentation.
Opération unidirectionnelle
updateCreditRating lorsqu'il est invoqué, envoie la cote de crédit actuelle du client. updateCreditRating a les entrées suivantes :
  • Entrée : updateCreditRating envoie comme entrée la variable currentRating. La variable currentRating doit avoir un type de données chaîne.
Par défaut, toutes les entrées et sorties ayant un type simple sont des zones obligatoires. La sélection d'une entrée, d'une sortie ou d'une erreur dans le tableau ouvre des informations supplémentaires sur ces éléments dans la vue des propriétés de l'éditeur d'interface.

Pour un exemple de développement de cette interface à partir de zéro, voir Développement d'une interface de service.