Digitales Schnittstellenformular

  • Freigeben Version: Zurich
  • Aktualisiert 31. Juli 2025
  • 3 Minuten Lesedauer

    • Digitale Schnittstellen werden als Teil einer Geschäftsanwendung bereitgestellt, können aber auch eigenständig 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.
    Anzahl Nummer der digitalen Schnittstelle. Dieses Feld wird automatisch mit dem DINTF-Präfix generiert und kann nicht bearbeitet werden.
    Geschäftsanwendung von Anbieter Name der Geschäftsanwendung des Anbieters, die die Schnittstelle bereitstellt, Manager und Besitzer ist.
    Hinweis:
    Dieses Attribut kann leer sein, wenn in Ihrem Repository keine Geschäftsanwendung vorhanden ist. Wenn Sie offene Schnittstellen wie Wetter oder Finanzservice verwenden, kennen Sie die Schnittstelle nur und verfolgen sie ohne 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 Anbieter-Geschäftsanwendung, 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 sind für jeden verfügbar 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 sind autorisierten Partnern eines API-Anbieters verfügbar. Normalerweise haben diese APIs spezielle 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, die sich auf die übergeordnete Schnittstelle beziehen, 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
    • Entwurf
    • Bereitstellen
    • Funktionsfähig
    • Ende der Lebensdauer
    Status der Lebenszyklusphase Status der Lebenszyklusphase der Schnittstelle. Jede der Hauptlebenszyklusphasen kann einen oder mehrere Lebenszyklusphasenstatus haben. Beispielsweise kann sich der Status einer digitalen Schnittstelle in der Betriebsphase im Laufe der Zeit von in Gebrauch zu in Wartung zu Ausstehende Stilllegung ändern. Verwenden Sie die folgenden Optionen:
    • Ideation: In Bewertung, Pilot
    • Design: Gechartert, Design, Build
    • Bereitstellen: Test
    • Betriebsbereit: In Gebrauch, In Wartung, Ausstehende Stilllegung
    • Ende der Lebensdauer: Stillgelegt, 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. Zum Beispiel Tabellen-API, Anhang-API, Aggregate-API und Prozess-APIs. Dieses optionale Feld kann verwendet werden, um das Schnittstellenmodell nachzuverfolgen. 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 einen Mehrwert schafft, wie sie entworfen werden soll 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 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 dieselbe Person sein, die die übergeordnete Geschäftsanwendung besitzt.
    IT-Besitzer Der Besitzer innerhalb der IT-Organisation, der die digitale Schnittstelle besitzt. Es kann dieselbe Person sein, die die übergeordnete Geschäftsanwendung besitzt.
    Unterstützt von Name des Fachexperten (SME) oder der Person, die Support für die digitale Schnittstelle bereitstellt.
    Supportgruppe Name der Gruppe, die die digitale Schnittstelle unterstützt.
    Tabelle : 2. Formularfelder des funktionalen Abschnitts
    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 sind REST, SOAP, LDAP usw.
    Hinweis:
    Diese Liste ist eine nicht erschöpfende Liste und kann erweitert werden, indem Sie Ihre bevorzugten Werte hinzufügen oder die angegebenen Werte ausblenden.
    Nachrichtenformat Format der Nachricht in der Schnittstelle. Auswahlmöglichkeiten sind JSON, XML, CSV usw.
    Hinweis:
    Diese Liste ist eine nicht erschöpfende Liste und kann erweitert werden, indem Sie Ihre bevorzugten Werte hinzufügen oder die angegebenen Werte ausblenden.
    Tabelle : 3. Formularfelder des Authentifizierungsabschnitts
    Feld Beschreibung
    Authentifizierungstyp Typ der Authentifizierung, die zur Authentifizierung 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 Ihre 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 Ihre hinzufügen.
    Tabelle : 4. Formularfelder des Abschnitts „Aktivitäten“
    Feld Beschreibung
    Arbeitsnotizen Kommentare zur Schnittstelle.