OpenAPI

HOME > OpenAPI > 개발가이드

개발가이드

본 가이드는 DataService e-Transfer 시스템 OpenAPI(Application Program Interface) 개발 가이드 입니다.



1 요청방식
  • 지원 업무명에 특별한 방식에 대한 지정이 없으면, GET/POST 모두 지원합니다
    • GET방식 POST방식
  • URL에 변수를 포함시켜 요청
  • 브라우저에서 URL을 입력하여 접근하는 방식
  • 데이터가 헤더에 포함되어 전달됨
  • URL에 데이터가 노출됨
  • 길이 제한이 있음
    		•
  • 데이터가 본문(BODY)에 포함되어 전달됨
  • URL에 데이터가 노출되지 않음
  • 길이 제한이 없음
  • 캐시되지 않음
    		•

    2 요청형식
  • FORM,XML,JSON 지원합니다
  • HTTP Header의 Content-Type값으로 요청형식을 구분하여 처리합니다. (application/x-www-form-urlencoded, application/xml, application/json 등등)

    • 3 응답형식
  • XML 또는 JSON 지원합니다
  • HTTP Header의 Accept값으로 응답형식을 설정합니다. (application/xml, application/json 등등)
  • 또는 요청시 QueryString의 returnType or type값을 xml 또는 json으로 설정하여 결과 구분가능합니다.(returnType=json, type=json)

    • 4 인증방식
  • OpenAPI의 인증 방식 및 우선순위입니다.
    • 우선순위 방식 위치 설명
    1 OAuth2.0 Header OAuth2.0 프로토콜 사용
    Authorization=토큰 인증용 헤더(Bearer + ' ' + 발급토큰)
    2 ID/PW Header client_id와 client_secret을 header에 전송
    client_id=test
    client_secret=aslkf345ne3jf3slkjsfslfk3
    3 ServiceKey Header serviceKey를 header에 전송
    service_key=wlkfjdlkjsl3423lj2l2lkdfjskl
    4 ServiceKey query serviceKey를 url query에 전송
    sessionID=wlkfjdlkjsl3423lj2l2lkdfjskl

    5 기본응답코드
  • 모든 요청에 공통적으로 사용되는 기본응답코드입니다
    • 응답코드 응답메세지 조치 방안
    0000 정상처리 요청에 대한 정상처리
    @??? 인증 오류 접근 권한 관련 실패
    SYS1 요청 법인eCode에 대한 환경설정 없음 법인eCode 수정 후 재요청 또는 법인eCode 환경설정 추가
    SYS2 시스템 장애 시스템 담당자에게 확인 요청
    SYS3 요청 정보 포맷 오류 포맷 확인후 재요청
    SYS4 허용되지 않은 요청 업무 시스템 담당자에게 해당 업무 등록 요청
    SYS5 허용되지 않은 IP에서 접속 시스템 담당자에게 해당 IP 등록 요청
    SYS6 허용되지 않은 Request Method 시스템 담당자에게 해당 방식 등록 요청
    SYS8 연계시스템 장애 시스템 담당자에게 확인 요청
    SYS9 예외 발생 시스템 담당자에게 확인 요청
    TIME 타임아웃
    일정 시간동안 응답받지 못함    		 조회업무외 이체 및 B2B발행등의 거래업무는
    반드시 실제 처리 여부 확인후 재요청하여야 함
    이체의 경우 이체확인요청을 통하여 처리여부 확인가능
    UU00~99 사용자정의 코드 시스템 담당자에게 확인 요청
    DB00~99 DB처리관련 오류코드 시스템 담당자에게 확인 요청
    TF00~99 프로세스처리 오류코드 시스템 담당자에게 확인 요청
    그외 은행에서 반환하는 오류 내역 은행별 오류코드집 또는 응답 메세지 확인