디지털 인터페이스 양식

  • 릴리스 버전: Xanadu
  • 업데이트 날짜 2024년 08월 01일
  • 읽기4분
  • 디지털 인터페이스는 비즈니스 애플리케이션의 일부로 제공되지만 독립적으로 사용할 수도 있습니다. 인터페이스는 다른 비즈니스 애플리케이션이 애플리케이션과 상호작용할 수 있는 방법을 제공합니다.

    디지털 인터페이스 양식 필드

    필드 설명
    이름 디지털 인터페이스의 고유하고 의미 있는 이름입니다.
    번호 디지털 인터페이스의 번호입니다. 이 필드는 DINTF 접두사를 사용하여 자동으로 생성되며 편집할 수 없습니다.
    제공자 비즈니스 애플리케이션 인터페이스를 제공, 관리자 및 소유하는 제공자 비즈니스 애플리케이션의 이름입니다.
    주:
    리포지토리에 비즈니스 애플리케이션이 없는 경우 이 속성을 비워 둘 수 있습니다. 날씨 또는 금융 서비스와 같은 개방형 인터페이스를 사용하는 경우 관련 비즈니스 애플리케이션 없이 인터페이스만 인식하고 추적할 수 있습니다.
    제공자 회사 제공자 회사의 이름입니다.
    인터페이스 형식 인터페이스에서 사용하는 API 유형입니다. 이 필드는 API가 공개 또는 공개 상태인지 추적하는 데 도움이 됩니다.
    주:
    퍼블릭 또는 오픈 API의 경우 조직에서 개방형 인터페이스로 노출하지 않는 한 제공자 비즈니스 애플리케이션이 없습니다.
    다음 옵션을 사용합니다.
    • 개방형 API
    • 파트너 API
    • 내부 API

    공개 또는 개방형 API는 누구나 사용할 수 있으며 제한이나 라이선스 계약 없이 사용할 수 있습니다.

    내부 또는 비공개 API는 인증된(기술) 사용자만 사용할 수 있으며 사용 제한 및 규정 없이 사용할 수 있습니다.

    파트너 API는 API 공급자의 승인된 파트너가 사용할 수 있습니다. 일반적으로 이러한 API에는 사용에 대한 특별 약관이 있습니다.

    상위 상위 인터페이스의 이름입니다.

    인터페이스는 번들로 제공되거나 컴퍼지션의 일부인 경우가 많습니다. 디지털 통합에서 디지털 인터페이스를 참조할 수 있으므로 상위 인터페이스를 사용합니다. 상위 인터페이스와 관련된 디지털 인터페이스가 인터페이스의 관련 목록에 나열됩니다.

    버전 인터페이스의 버전입니다. 이 필드는 어떤 디지털 통합에서 어떤 버전의 인터페이스를 사용하는지 추적하는 데 도움이 됩니다.
    수명 주기 스테이지 인터페이스의 수명주기 스테이지입니다. 다음 옵션을 사용합니다.
    • 개념화
    • 설계
    • 배포
    • 운영
    • 수명 종료
    수명 주기 스테이지 상태 인터페이스의 수명주기 스테이지 상태입니다. 각 메인 수명주기 스테이지에는 하나 이상의 수명주기 스테이지 상태가 있을 수 있습니다. 예를 들어, 운영 단계의 디지털 인터페이스는 시간이 지남에 따라 상태가 사용 중(In Use)에서 유지관리 중(In Maintenance), 폐기 보류 중(Pending Retirement)으로 변경될 수 있습니다. 다음 옵션을 사용합니다.
    • 개념화: 평가 중, 파일럿
    • 설계: 공인, 설계, 구축
    • 배포: 테스트
    • 운영: 사용 중, 유지관리 중, 폐기 보류 중
    • 수명 종료: 폐기됨, 사용되지 않음
    모델 ID 인터페이스의 모델 ID입니다. 이 필드는 인터페이스 모델을 추적하는 데 도움이 됩니다.

    이는 API 모델 또는 유형의 고유한 변형을 관리할 수 있는 애플리케이션 모델 테이블에 대한 참조입니다. 예를 들어 테이블 API, 첨부 파일 API, 집계 API 및 프로세스 API입니다. 이 옵션 필드는 인터페이스 모델을 추적하는 데 사용할 수 있습니다. 사용 사례에 따라 새 모델 및 모델 범주를 추가할 수 있습니다.

    설명 디지털 인터페이스에 대한 설명입니다. 인터페이스의 개략적인 디자인 측면을 제공합니다.

    디지털 인터페이스가 가치를 더하는 방법, 설계 방법 및 사용 의도 방법과 같은 세부 정보를 제공할 수 있습니다.

    인터페이스 버전에 따라 다양한 변경 내용과 기능을 설명할 수도 있습니다. 애플리케이션 소유자와 아키텍트가 사용할 인터페이스 버전을 결정하는 데 도움이 됩니다.

    표 1. 소유자 섹션 양식 필드
    필드 설명
    비즈니스 소유자 디지털 인터페이스를 소유하는 비즈니스 기능의 소유자입니다. 상위 비즈니스 애플리케이션을 소유한 동일한 사용자일 수 있습니다.
    IT 소유자 디지털 인터페이스를 소유하는 IT 조직 내의 소유자입니다. 상위 비즈니스 애플리케이션을 소유한 동일한 사용자일 수 있습니다.
    지원처: 디지털 인터페이스에 대한 지원을 제공하는 SME(주제 전문가) 또는 개인의 이름입니다.
    지원 그룹 디지털 인터페이스에 대한 지원을 제공하는 그룹의 이름입니다.
    표 2. 기능 섹션 양식 필드
    필드 설명
    프로토콜 인터페이스에서 사용하는 프로토콜 유형입니다. API 프로토콜은 애플리케이션을 규제하는 사양입니다. 이러한 프로토콜은 애플리케이션 프로그래밍 인터페이스를 소프트웨어와 통합하는 데 사용됩니다. REST, SOAP, LDAP 등을 선택할 수 있습니다.
    주:
    이 목록은 일부 목록이며 기본 설정 값을 추가하거나 제공된 값을 숨겨 확장할 수 있습니다.
    메시지 형식 인터페이스의 메시지 형식입니다. JSON, XML, CSV 등을 선택할 수 있습니다.
    주:
    이 목록은 일부 목록이며 기본 설정 값을 추가하거나 제공된 값을 숨겨 확장할 수 있습니다.
    표 3. 인증 섹션 양식 필드
    필드 설명
    인증 유형 인터페이스 인증에 사용되는 인증 유형입니다.
    다음 옵션을 사용합니다.
    • Basic Auth
    • OpenID Connect
    • 인증서
    • WS-Security
    • LDAP
    • 없음
    • 기타

    시스템 제공 인증 유형을 사용하거나 사용자 인증 유형을 추가할 수 있습니다.

    인증 유형 인터페이스 권한 부여에 사용되는 권한 부여 유형입니다.
    다음 옵션을 사용합니다.
    • OAuth 2.0 토큰
    • JWT 웹 토큰
    • SAML 2.0 토큰
    • 기타
    • 권한 없음

    시스템 제공 인증 유형을 사용하거나 사용자 인증 유형을 추가할 수 있습니다.

    표 4. 활동 섹션 양식 필드
    필드 설명
    작업 메모 인터페이스에 대한 코멘트입니다.