Formulaire Créer une interface digitale

Créer une interface digitale pour une intégration dans Architecture d'entreprise (anciennement Gestion des portefeuilles d'applications).

Champs de formulaire Interface digitale

Champ	Description
Nom	Nom unique et significatif de l’interface digitale.
Numéro	Numéro de l’interface digitale. Ce champ est généré automatiquement avec le préfixe DINTF et n’est pas modifiable.
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 si votre référentiel ne contient aucune application d’entreprise. Si vous utilisez des interfaces ouvertes telles que Météo ou Services financiers, vous connaissez uniquement l’interface et la suivez sans application d’entreprise connexe.
Type d'interface	Type d’API utilisée par l’interface. Il 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 : Ouvrir l'API API partenaire API interne Les API publiques ou ouvertes sont accessibles à tous et peuvent être utilisées sans aucune restriction ni accord de licence. Les API internes ou privées ne sont disponibles que pour les utilisateurs (techniques) autorisés et peuvent être utilisées sans aucune restriction d’utilisation ni réglementation. Les API partenaires sont disponibles pour les partenaires autorisés d’un fournisseur d’API. Habituellement, ces API ont des conditions d’utilisation spéciales.
Parent	Nom de l’interface parente. Souvent, les interfaces sont regroupées ou font partie d’une composition. Comme vous pouvez référencer une interface digitale sur l’intégration digitale, utilisez l’interface parente. Les interfaces digitales liées à l’interface parent sont répertoriées dans la liste connexe de l’interface.
Version	Version de l’interface. Ce champ vous aide à suivre quelles intégrations digitales utilisent quelle version d’une interface.
Statut de l'étape du cycle de vie	Étape du cycle de vie de l’interface. Utilisez les options suivantes : Idées Conception Déployer Opérationnel Fin de vie
État de l'étape du cycle de vie	Statut de l’étape du cycle de vie de l’interface. Chacune des principales étapes du cycle de vie peut avoir un ou plusieurs états d’étape du cycle de vie. Par exemple, une interface digitale en phase opérationnelle peut changer d’état au fil du temps, passant de En cours d’utilisation à En cours de maintenance puis En attente de mise hors service. Utilisez les options suivantes : Idéation : En cours d’évaluation, pilote Conception : Avec charte, Conception, Construire Déployer : tester Opérationnel : En cours d’utilisation, En cours de maintenance, En attente de mise hors service Fin de vie : Mis hors service, obsolète
ID de modèle	ID de 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 dans laquelle 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èle.
Description	Description de l’interface digitale. Fournir les aspects de conception de haut niveau de l’interface. Vous pouvez fournir des détails tels que la façon dont l’interface numérique ajoute de la valeur, comment elle doit être conçue et comment elle est censée être utilisée. Vous pouvez également décrire les différentes modifications et fonctionnalités 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.

Tableau 1. Champs de la section Propriétaires

Champ	Description
Propriétaire de l'entreprise	Le propriétaire de la fonction commerciale, qui possède l’interface digitale. Il peut s’agir de la même personne que celle qui possède l’application d’entreprise parente.
Propriétaire IT	Le propriétaire au sein de l’organisation informatique, qui détient l’interface digitale. Il peut s’agir de la même personne que celle qui possède l’application d’entreprise parente.
Pris en charge par	Nom de l’expert technique ou de la personne qui fournit une assistance à l’interface digitale.
Groupe de support	Nom du groupe qui assure la prise en charge de l’interface digitale.

Tableau 2. Champs des sections fonctionnelles

Champ	Description
Protocole	Type de protocole utilisé par l’interface. Les protocoles API sont les spécifications qui régissent l’application. Ces protocoles permettent d’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.

Tableau 3. Champs de la section Authentification

Champ	Description
Type d'authentification	Type d’authentification utilisé pour authentifier l’interface. Utilisez les options suivantes : Authentification de base Connexion OpenID Certificat Utiliser pour la sécurité WS LDAP Aucun Autre 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 : Jeton OAuth 2.0 Jeton JWT Web Jeton SAML 2.0 Autre Aucune autorisation Vous pouvez utiliser les types d’authentification fournis par le système ou ajouter les vôtres.

Tableau 4. Champs de la section Activités

Champ	Description
Notes de travail	Commentaires sur l’interface.

Créer ou mettre à jour une interface digitale