Formular „Digitale Schnittstelle“.

  • Freigeben Version: Xanadu
  • Aktualisiert 1. August 2024
  • 3 Minuten Lesedauer

    • Digitale Schnittstellen werden als Teil einer Geschäftsanwendung bereitgestellt, können aber auch für sich allein stehen. Schnittstellen bieten anderen Geschäftsanwendungen die Möglichkeit, mit den -Anwendungen zu interagieren.

    Formularfelder für digitale Schnittstelle

    Feld Beschreibung
    Name Eindeutiger und aussagekräftiger Name der digitalen Schnittstelle.
    Nummer Nummer der digitalen Schnittstelle. Dieses Feld wird automatisch mit dem Präfix „DINTF“ generiert und kann nicht bearbeitet werden.
    Geschäftsanwendung des Anbieters Name der Geschäftsanwendung des Anbieters, die die Schnittstelle bereitstellt, verwaltet und besitzt.
    Hinweis:
    Dieses Attribut kann leer sein, wenn in Ihrem Repository keine Geschäftsanwendung vorhanden ist. Wenn Sie offene Schnittstellen wie Wetter oder Finanzdienstleistung verwenden, kennen Sie nur die Schnittstelle und verfolgen sie ohne eine zugehörige Geschäftsanwendung.
    Anbieterunternehmen Name des Anbieterunternehmens
    Schnittstellentyp Typ der von der Schnittstelle verwendeten API. Mit diesem Feld können Sie nachverfolgen, ob die API öffentlich oder offen ist.
    Hinweis:
    Für öffentliche oder offene APIs gibt es keine Geschäftsanwendung des Anbieters, es sei denn, die Organisation stellt sie als offene Schnittstelle bereit.
    Verwenden Sie die folgenden Optionen:
    • Offene API
    • Partner-API
    • Interne API

    Öffentliche oder offene APIs stehen jedem zur Verfügung und können ohne Einschränkungen oder Lizenzvereinbarungen verwendet werden.

    Interne oder private APIs sind nur für autorisierte (technische) Anwender verfügbar und können ohne Nutzungsbeschränkungen und Vorschriften verwendet werden.

    Partner-APIs stehen autorisierten Partnern eines API-Anbieters zur Verfügung. Normalerweise gelten für diese APIs besondere Nutzungsbedingungen.
    Übergeordnet Name der übergeordneten Schnittstelle.

    Häufig sind Schnittstellen gebündelt oder Teil einer Zusammensetzung. Da Sie in der digitalen Integration auf eine digitale Schnittstelle verweisen können, verwenden Sie die übergeordnete Schnittstelle. Die digitalen Schnittstellen der übergeordneten Schnittstelle werden in der zugehörigen Liste der Schnittstelle aufgeführt.
    Version Version der Schnittstelle. Mit diesem Feld können Sie nachverfolgen, welche digitalen Integrationen welche Version einer Schnittstelle verwenden.
    Lebenszyklusphase Lebenszyklusphase der Schnittstelle. Verwenden Sie die folgenden Optionen:
    • Ideation
    • Design
    • Bereitstellen
    • Operativ
    • Ende der Lebensdauer
    Status der Lebenszyklusphase Status der Lebenszyklusphase der Schnittstelle. Jede der Hauptlebenszyklusphasen kann einen oder mehrere Lebenszyklusphasenstatus haben. Beispielsweise kann eine digitale Schnittstelle in der Betriebsphase den Status im Laufe der Zeit von „In Gebrauch“ über „In Wartung“ zu „Ausstehende Stilllegung“ ändern. Verwenden Sie die folgenden Optionen:
    • Ideation: Wird ausgewertet, Versuch
    • Design: Gemietet, Entwerfen, Erstellen
    • Bereitstellen: Test
    • Funktionsfähig: In Gebrauch, In Wartung, Ausstehende Stilllegung
    • Ende der Lebensdauer: Deaktiviert, veraltet
    Modell-ID Modell-ID der Schnittstelle. Dieses Feld hilft Ihnen, das Schnittstellenmodell nachzuverfolgen.

    Dies ist ein Verweis auf die Tabelle „Anwendungsmodell“, in der Sie Ihre eigenen Varianten von API-Modellen oder -Typen verwalten können. Beispiel: Tabellen-API, Anhang-API, Aggregat-API und Prozess-APIs. Dieses optionale Feld kann zum Nachverfolgen des Schnittstellenmodells verwendet werden. Abhängig von Ihrem Anwendungsfall können Sie neue Modelle und Modellkategorien hinzufügen.
    Beschreibung Beschreibung der digitalen Schnittstelle. Geben Sie die allgemeinen Designaspekte der Schnittstelle an.

    Sie können die Details angeben, z. B. wie die digitale Schnittstelle Mehrwert bietet, wie sie gestaltet werden sollte und wie sie verwendet werden soll.

    Sie können auch verschiedene Changes und Fähigkeiten je nach Version der Schnittstelle beschreiben. Es hilft Anwendungsbesitzern und IT-Architekten zu entscheiden, welche Schnittstellenversion sie verwenden möchten.
    Tabelle : 1. Formularfelder des Abschnitts „Besitzer“.
    Feld Beschreibung
    Geschäftsinhaber Der Besitzer der Geschäftsfunktion, der die digitale Schnittstelle besitzt. Es kann sich um dieselbe Person handeln, die Besitzer der übergeordneten Geschäftsanwendung ist.
    IT-Besitzer Der Eigentümer der digitalen Schnittstelle innerhalb der IT-Organisation. Es kann sich um dieselbe Person handeln, die Besitzer der übergeordneten Geschäftsanwendung ist.
    Unterstützt von Name des Fachexperten (SME) oder einer Person, die Unterstützung für die digitale Schnittstelle bietet.
    Supportgruppe Name der Gruppe, die die digitale Schnittstelle unterstützt.
    Tabelle : 2. Formularfelder „Funktionsabschnitt“.
    Feld Beschreibung
    Protokoll Typ des von der Schnittstelle verwendeten Protokolls. API-Protokolle sind die Spezifikationen, die die Anwendung regeln. Diese Protokolle werden verwendet, um Anwendungsprogrammierschnittstellen in ihre Software zu integrieren. Auswahlmöglichkeiten: REST, SOAP, LDAP usw.
    Hinweis:
    Diese Liste ist nicht vollständig und kann erweitert werden, indem Sie Ihre bevorzugten Werte hinzufügen oder die bereitgestellten Werte ausblenden.
    Nachrichtenformat Format der Nachricht in der Schnittstelle. Auswahlmöglichkeiten: JSON, XML, CSV usw.
    Hinweis:
    Diese Liste ist nicht vollständig und kann erweitert werden, indem Sie Ihre bevorzugten Werte hinzufügen oder die bereitgestellten Werte ausblenden.
    Tabelle : 3. Formularfelder des Authentifizierungsabschnitts
    Feld Beschreibung
    Authentifizierungstyp Typ der Authentifizierung, der zum Authentifizieren der Schnittstelle verwendet wird.
    Verwenden Sie die folgenden Optionen:
    • Basisauth.
    • OpenID Connect
    • Zertifikat
    • WS-Sicherheit verwenden
    • LDAP
    • Keine
    • Sonstige

    Sie können die vom System bereitgestellten Authentifizierungstypen verwenden oder eigene hinzufügen.
    Autorisierungstyp Typ der Autorisierung, die zum Autorisieren der Schnittstelle verwendet wird.
    Verwenden Sie die folgenden Optionen:
    • OAuth 2.0-Token
    • JWT Web-Token
    • SAML 2.0-Token
    • Sonstige
    • Keine Autorisierung

    Sie können die vom System bereitgestellten Authentifizierungstypen verwenden oder eigene hinzufügen.
    Tabelle : 4. Formularfelder des Abschnitts „Aktivitäten“.
    Feld Beschreibung
    Arbeitsnotizen Kommentare zur Schnittstelle.