Formulaire d’interface numérique
Les interfaces numériques sont fournies dans le cadre d’une application d’entreprise, mais elles peuvent également se suffire à elles-mêmes. Les interfaces permettent à d’autres applications d’entreprise d’interagir avec les applications.
Champs de formulaire d’interface numérique
| Champ | Description |
|---|---|
| Nom | Nom unique et significatif de l’interface numérique. Entrez un nom descriptif qui reflète l’objectif de l’interface. Par exemple, une application Gestion des clients peut exposer plusieurs interfaces numériques, telles que :
Même si toutes les interfaces sont fournies par la même application, chaque interface représente un contrat d’interaction différent et peut être consommée indépendamment par plusieurs applications. |
| Numéro | Numéro de l’interface numérique. Ce champ est généré automatiquement avec le préfixe DINTF et ne peut pas être modifié. |
| Application d'entreprise du fournisseur | Nom de l’application d’entreprise du fournisseur qui fournit, gère et possède l’interface. Remarque : Cet attribut peut être vide s’il n’y a aucune application d’entreprise dans votre référentiel. Si vous utilisez des interfaces ouvertes telles que Météo ou Services financiers, vous ne connaissez que l’interface et vous la suivez sans application d’entreprise associée. |
| Entreprise fournisseur | Nom de la société fournisseur. |
| Type d'interface | Type d’API utilisée par l’interface. Ce champ permet de savoir si l’API est publique ou ouverte. Remarque : Pour les API publiques ou ouvertes, il n’y aura pas d’application d’entreprise du fournisseur, sauf si l’organisation l’expose en tant qu’interface ouverte. Utilisez les options suivantes :
Les API publiques ou ouvertes sont accessibles à tous et peuvent être utilisées sans aucune restriction ni contrat de licence. Les API internes ou privées sont disponibles uniquement pour les utilisateurs (techniques) autorisés et peuvent être utilisées sans aucune restriction ni réglementation d’utilisation. Les API partenaires sont disponibles pour les partenaires autorisés d’un fournisseur d’API. Habituellement, ces API ont des termes et conditions d’utilisation spéciaux. |
| Société parente | Nom de l’interface parent. Souvent, les interfaces sont regroupées ou font partie d’une composition. Étant donné que vous pouvez référencer une interface numérique sur l’intégration digitale, utilisez l’interface parente. Les interfaces numériques associées à l’interface parent sont répertoriées dans la liste connexe de l’interface. |
| Version | Version de l’interface. Ce champ vous permet de suivre quelles intégrations digitales utilisent quelle version d’une interface. |
| Étape du cycle de vie | Étape du cycle de vie de l’interface. Utilisez les options suivantes :
|
| État de l'étape du cycle de vie | État de l’étape du cycle de vie de l’interface. Chacune des étapes principales du cycle de vie peut avoir un ou plusieurs états d’étape du cycle de vie. Par exemple, une interface numérique à l’étape opérationnelle peut changer d’état au fil du temps, passant de En cours d’utilisation à En cours de maintenance et en attente de mise hors service. Utilisez les options suivantes :
|
| ID de modèle | ID du modèle de l’interface. Ce champ vous aide à suivre le modèle d’interface. Il s’agit d’une référence à la table Modèle d’application où vous pouvez gérer vos propres variantes de modèles ou de types d’API. Par exemple, API de table, API de pièce jointe, API d’agrégat et API de processus. Ce champ facultatif peut être utilisé pour suivre le modèle d’interface. En fonction de votre cas d’utilisation, vous pouvez ajouter de nouveaux modèles et catégories de modèles. |
| Description | Description de l’interface numérique. Fournissez les aspects de conception de haut niveau de l’interface. Vous pouvez fournir des détails tels que la valeur ajoutée de l’interface numérique, la manière dont elle doit être conçue et la manière dont elle est destinée à être utilisée. Vous pouvez également décrire les différentes modifications et options en fonction de la version de l’interface. Elle aide les propriétaires d’applications et les architectes à décider de la version d’interface qu’ils souhaitent utiliser. |
| Champ | Description |
|---|---|
| Propriétaire de l'entreprise | Le propriétaire de la fonction business, qui est propriétaire de l’interface numérique. Il peut s’agir de la même personne qui est propriétaire de l’application d’entreprise parente. |
| Propriétaire IT | Le propriétaire au sein de l’organisation informatique, qui détient l’interface numérique. Il peut s’agir de la même personne qui est propriétaire de l’application d’entreprise parente. |
| Pris en charge par | Nom de l’expert en la matière (SME) ou de la personne qui fournit une assistance à l’interface numérique. |
| Groupe de support | Nom du groupe qui fournit un support pour l’interface numérique. |
| Champ | Description |
|---|---|
| Protocole | Type de protocole utilisé par l’interface. Les protocoles API sont les spécifications qui régissent l’application. Ces protocoles sont utilisés pour intégrer des interfaces de programmation d’applications à leurs logiciels. Vous avez le choix entre REST, SOAP, LDAP, etc. Remarque : Cette liste n’est pas exhaustive et peut être étendue en ajoutant vos valeurs préférées ou en masquant les valeurs fournies. |
| Format du message | Format du message dans l’interface. Vous avez le choix entre JSON, XML, CSV, etc. Remarque : Cette liste n’est pas exhaustive et peut être étendue en ajoutant vos valeurs préférées ou en masquant les valeurs fournies. |
| Champ | Description |
|---|---|
| Type d'authentification | Type d’authentification utilisé pour authentifier l’interface. Utilisez les options suivantes :
Vous pouvez utiliser les types d’authentification fournis par le système ou ajouter les vôtres. |
| Type d'autorisation | Type d’autorisation utilisé pour autoriser l’interface. Utilisez les options suivantes :
Vous pouvez utiliser les types d’authentification fournis par le système ou ajouter les vôtres. |
| Champ | Description |
|---|---|
| Notes de travail | Commentaires sur l’interface. |