📌 인터페이스 설계 - 인터페이스 방법 명세화

 

목차

 

 

인터페이스 방법 명세화의 개념

📌 인터페이스 방법 명세화는 내, 외부 시스템이 연계하여 작동할 때 인터페이스 별 송, 수신 방법, 송, 수신 데이터, 오류 식별 및 처리 방안에 대한 내용을 문서로 명확하게 정리하는 것이다.

 

• 인터페이스 별로 송, 수신 방법을 명세화하기 위해서는 시스템 연계 기술, 인터페이스 통신 유형, 처리 유형, 발생 주기 등에 대한 정보가 필요한다.

 

시스템 연계 기술

📌 시스템 연계 기술은 개발할 시스템과 내, 외부 시스템을 연계할 때 사용되는 기술을 의미한다.

 

• 주요 시스템 연계 기술에는 DB Link, API/Open API, 연계 솔루션, Socket, Web Service등이 있다.
  • DB Link : DB에서 제공하는 DB Link 객체를 이용하는 방식이다.
  • API/Open API : 송신 시스템의 데이터베이스(DB)에서 데이터를 읽어와 제공하는 애플리케이션 프로그래밍 인터페이스 프로그램이다.
  • 연계 솔루션 : EAI 서버와 송, 수신 시스템에 설치되는 클라이언트(Client)를 이용하는 방식이다.
  • Socket : 서버는 통신을 위한 소켓(Socket)을 생성하여 포트를 할당하고 클라이언트의 통신 요청시 클라이언트와 연결하여 통신하는 네트워크 기술이다.
  • Web Service : 웹 서비스(Web Service)에서 WSDL과, UDDI, SOAP 프로토콜을 이용하여 연계하는 서비스이다.

 

인터페이스 통신 유형

📌 인터페이스 통신 유형은 개발할 시스템과 내, 외부 시스템 간 데이터를 송, 수신하는 형태를 의미한다.

 

• 인터페이스 통신 유형에는 단방향, 동기, 비동기 방식 등이 있다.
  • 단방향 시스템에서 거래를 요청만 하고 응답이 없는 방식이다.
  • 동기 : 시스템에서 거래를 요청하고 응답이 올 때까지 대기(Request-Reply)하는 방식이다.
  • 비동기 : 시스템에서 거래를 요청하고 다른 작업을 수행하다 응답이 오면 처리하는 방식(Send-Receive, Send-Receive-Acknowledge, Publish-Subscribe)이다.

 

인터페이스 처리 유형

📌 인터페이스 처리 유형은 송, 수신 데이터를 어떤 형태로 처리할 것인지에 대한 방식을 의미한다.

 

• 업무의 성격과 송, 수신 데이터 전송량을 고려하여 실시간, 지연 처리, 배치 방식 등으로 구분한다.
  • 실시간 방식 : 사용자가 요청한 내용을 바로 처리해야 할 때 사용하는 방식이다.
  • 지연 처리 방식 : 데이터를 매건 단위로 처리할 경우 비용이 많이 발생할 때 사용하는 방식이다.
  • 배치 방식 : 대량의 데이터를 처리할 때 사용하는 방식이다.

 

인터페이스 발생 주기

📌 인터페이스 발생 주기는 개발할 시스템과 내, 외부 시스템 간 송, 수신 데이터가 전송되어 인터페이스가 사용되는 주기를 의미한다.

 

• 인터페이스 발생 주기는 업무의 성격과 송, 수신 데이터 전송량을 고려하여 매일, 수시, 주 1회 등으로 구분한다.

 

 

송, 수신 방법 명세화

📌 송, 수신 방법 명세화는 내, 외부 인터페이스 목록에 있는 각각의 인터페이스에 대해 연계 방식, 통신 및 처리 유형, 발생 주기 등의 송, 수신 방법을 정의하고 명세를 작성하는 것이다.

 

• 연계 방식, 통신 유형, 연계 처리 형태는 시스템 인터페이스 설계 시 작성한 아키텍처 정의서를 기반으로 하여 업무 및 데이터의 성격, 연계 데이터 발생 건수, 연계 시스템의 기술 구조, 시스템 간의 성능 등을 고려하여 작성한다.

 

🔔 예) 인터페이스 송, 수신 명세화

인터페이스 ID	인터페이스명	송신 시스템	수신 시스템	연계 방식	통신 유형	연계처리 형태	연계 주기
IFID-001	지급 정보 전송	회계	토스 뱅크	EAI	요청/응답	실시간	매일
IFID-002	은행 수금 내역 수신	회계	토스 뱅크	EAI	요청/응답	실시간	매일
IFID-003	은행 계좌 잔액 수신	회계	토스 뱅크	Socket	요청/응답	실시간	수시
IFID-004	예금주 조회	회계	토스 뱅크	Socket	요청/응답	실시간	수시
IFID-005	고객 로그인	홈페이지	고객	EAI	단방향	배치	매일
IFID-006	고객 계약 조회	홈페이지	고객	DB Link	단방향	배치	매일

 

 

송, 수신 데이터 명세화

📌 송, 수신 데이터 명세화는 내, 외부 인터페이스 목록에 있는 각각의 인터페이스에 대해 인터페이스에 대해 필요한 송, 수신 데이터에 대한 명세를 작성하는 것이다.

 

• 인터페이스 별로 테이블 정의서와 파일 레이아웃에서 연계하고자 하는 테이블 또는 파일 단위로 송, 수신 데이터에 대한 명세를 작성한다.

 

인터페이스 ID	IFID-006
송, 수신 구분	수신
시스템 명	고객 시스템
업무	고객 정보 관리
서비스 명	고객 정보 저장

 

데이터 항목
Seq	Field	Key	Type	Size	Null허용	Description	Condition
1	CON_NO	Y	varchar	13	N	고객 번호
2	REQ_CNT	Y	varchar	2	N	반복 회차
3	SEQ		varchar	2	N	순번
4	SSN		char	13	N	주빈 번호	암호화

 

💡 암호화 ? 보안이 중요한 데이터 항목의 경우 법률적 근거와 기업의 개인정보 규정 등을 참ㅁ고하여 암호화 대상을 선택하고 암호화 적용 여부를 기재한다. 법률에서 정한 암호화 필수 적용 대상 항목에는 주민등록번호, 패스워드, 계좌번호 공개에 동의하지 않은 개인정보 등이 있다.

 

 

 

오류 식별 및 처리 방안 명세화

📌 오류 식별 및 처리 방안 명세화는 내, 외부 인터페이스 목록에 있는 각각의 인터페이스에 대해 인터페이스 시 발생할 수 있는 오류를 식별하고 오류 처리 방안에 대한 명세를 작성하는 것이다.

 

• 시스템 및 전송 오류, 연계 프로그램 등에서 정의한 예외 상황 등 대, 내외 시스템 연계 시 발생할 수 있는 다양한 오류 상황을 식별하고 분류한다.
• 연계 매커니즘 구성요소
  • 송신 시스템 : 연계 프로그램으로부터 생성된 데이터를 전송 형식에 맞게 인터페이스 테이블이나 파일(xml, csv, text 등)로 변환한 후 송신하는 시스템
  • 수신 시스템 : 수신한 인터페이스 테이블이나 파일을 연계 프로그램에서 처리할 수 있는 형식으로 변환한 후 연계 프로그램에 반영하는 시스템
  • 연계 서버 : 송, 수신 시스템 사이에 위치하여 데이터의 송, 수신 현황을 모니터링 하는 역할을 수행함
• 오류 상황에 대해 오류 코드, 오류 메시지, 오류 설명, 해결 방법 등을 명세화 한다.

 

🔔 예) 오류 코드 명명 규칙

ES10001 = 앞 2자리는 오류 발생 영역 구분자, 그 다음 3자리는 오류 그룹번호, 나머지는 일련 번호에 해당한다.

오류 코드	오류 메시지	설명	해결 방법
ES10001	연계 서버에 접속할 수 없음	연계 서버의 네트워크 회선 오류 등으로 인해 연계 서버에 접속할 수 없음	연계 서버의 네트워크 회선 오류 여부를 확인한 후 조치
ES50001	연계 서버에서 데이터 변환 에러가 발생함	연계 서버에서 데이터 변환 과정에서 유효하지 않은 코드 값으로 인해 매핑 오류가 발생함	미등록 코드를 코드 테이블과 매핑 정의서에 등록한 후 재실행
SD4001	송신 시스템에서 데이터 조회에 실패함	송신 시스템의 인터페이스 프로그램에서 전송할 데이터를 DB에서 읽어 오지 못함	데이터베이스 접근 권한 문제 작동 여부, 데이터 테이블 삭제 등을 확인 후 재실행

 

• 오류 코드는 표준화된 오류 코드 작성 규칙을 준수해야 하지만 표준 작성 규칙이 없을 경우 이해 관계자들의 합의를 통해 지정한다.