OpenAPI+ 메뉴얼 – 로그인과 버전처리

개요

  • OpenAPI(Application Programing Interface)

    • 국내주식상품과
    • 코스피200 지수선물/옵션,
    • 주식선물을 거래할 수 있는

    거래/분석프로그램을 개발 할 수 있도록 하는 일종의 프로그램으로, COM형태로 제공합니다.

  • 주요기능은

    • 시세데이터 조회와 실시간 데이터제공,
    • 주문기능,
    • 조건검색기능(주식만 가능)

    을 제공하며 모두 로그인 이후 가능합니다.

[통신동작]

  • OpenAPI함수호출과 이벤트는 모두 비동식 방식으로 서버에 시세조회나 주문등을 함수호출로 요청하면 처리 결과를 전용 이벤트를 호출해서 전달합니다.
  • 여기서 수신데이터를 가져오려면 반드시 이벤트 리턴전에 적절한 데이터 획득함수를 사용해서 얻어와야 합니다.
  • 이벤트가 호출하기 전에 데이터 획득함수를 사용하거나 이벤트 리턴후에 호출하게 되면 혹은 임의로 이벤트를 호출하면 정상적인 데이터를 얻을수 없습니다.
  • 지금까지 설명을 조회요청을 예를들어 정리하면 다음과 같습니다. 이외 OpenAPI기능도 관련 함수와 이벤트 차이가 있을뿐 전체 동작은 동일합니다.
기능요청(조회함수 CommRqData, CommKwRqData 호출)  ---> 이벤트 호출(OnReceiveTRData ) ---> 데이터 획득 (GetCommData함수)

[화면번호]

  • 화면번호는 서버에 조회나 주문등 필요한 기능을 요청할때 이를 구별하기 위한 키값으로 이해하시면 됩니다.
  • 0000(혹은 0)을 제외한 임의의 숫자를 사용하시면 되는데 갯수가 200개로 한정되어 있기 때문에 이 갯수를 넘지 않도록 관리하셔야 합니다.
  • 만약 사용하는 화면번호가 200개를 넘는 경우 조회결과나 주문결과에 다른 데이터가 섞이거나 원하지 않는 결과를 나타날 수 있습니다.

[이벤트]

  • 시세조회나 조건검색요청등 관련함수 호출로 요청하면 서버에서 이를 처리해서 결과를 OpenAPI의 특정함수를 호출해서 알려주는데 이 함수를 이벤트라고 합니다.
  • 조회를 예로 들면 SetInputValue(), CommRqData()함수로 조회를 하면 조회결과를 만들어서 OpenAPI로 전달하고 조회한 사용자의 OnReceiveTRData를 호출하게 됩니다.
  • 이벤트는 일반함수와 구별하기 위해 이름앞에 On~에 있으며 OnEventConnect, OnReceiveTRData, OnReceiveRealData등이 있습니다.
  • 로그인, 조회, 주문, 조건검색등 기능별로 함수와 이벤트가 분류되어 있으니 용도에 맞는 함수와 이벤트를 사용해야 합니다.

로그인과 버전처리

[로그인 개요]

  • 로그인은 CommConnect()함수를 호출하며 OnEventConnect 이벤트 인자값으로 로그인 성공여부를 알수 있습니다.
  • 이 값이 0이면 성공이고 나머지는 실패로 오류코드값을 참고해서 실패원인을 파악할수 있습니다.
  • 실서버와 동일한 시세데이터로 주문테스트를 할 수 있는 모의투자서버를 제공하는데 로그인창에서 "모의투자 서버"을 선택해서 간단히 접속하실수 있습니다.

[수동 로그인]

  • 로그인창에 로그인ID와 비밀번호를 직접입력해서 로그인을 하는것을 말하며 기본적으로 이 로그인방법을 사용하게 됩니다.
  • 수동 로그인중에 버전처리내용이 있는 경우 버전처리도 함께 진행됩니다.

[자동 로그인]

  • 로그인한 다음 계좌비밀번호 입력창을 통해 자동로그인을 설정할 수 있습니다.
  • 트레이 메뉴(모니터 오른쪽 하단)에서 "계좌비밀번호 저장" 메뉴를 선택하면 화면이 표시되는데 여기서 로그인 이후 사용할 계좌와 계좌비밀번호를 입력하고 등록버튼을 눌러서 저장한 다음 계좌번호 아래에 있는 AUTO 체크 박스를 선택하시면 자동 로그인을 위한 설정이 모두 끝납니다.
  • 로그인 설정을 자동으로 하면 종목정보를 제외한 버전처리를 모두 무시하게 되며 버전처리를 다시 받으려면 AUTO 버튼을 체크 해지하고 프로그램을 재 실행 하시면 됩니다.

[계좌비밀번호 설정]

  • 잔고나 주문가능금액, 수량등 계좌관련 조회나 주문전에 미리 계좌비밀번호를 설정해야 오류 알림창과 -301 오류코드없이 사용하실수 있습니다.
  • 계좌비밀번호 설정은 계좌비밀번호 입력창에서만 가능하며 이 입력창은 메뉴나 함수로 출력하실수 있습니다.

    • 메뉴이용 - 로그인후 트레이 메뉴(모니터 오른쪽 하단)에서 "계좌비밀번호 저장"선택
    • 함수이용 - 로그인후 OpenAPI.KOA_Functions(_T("ShowAccountWindow"), _T(""))호출

[버전 처리]

  • 로그인할때 버전처리가 필요한 경우 버전처리 알림창이 출력될수 있습니다.
  • 이 알림창이 표시되면 OpenAPI프로그램을 먼저 모두 종료한다음 알림창에 있는 닫기버튼을 누르셔야 합니다.
  • 그렇지 않으면 버전처리가 정상적으로 끝나지 않아서 로그인할때 또 버전처리 알림창이 표시됩니다.
  • 그리고 알림창이 표시되었을때 KOA Studio도 실행중이면 역시 함께 종료시켜주셔야 합니다.
  • 이렇게 OpenAPI프로그램을 모두 종료하신 다음 알림창을 닫아주시면 버전처리가 자동으로 진행되고 프로그램을 재실행 해주시면 됩니다.

[모의투자]

  • 로그인 창에서 모의투자접속을 선택을 체크하면 모의투자로 접속하며 이 체크를 풀면 실서버(운영서버)로 접속합니다.
  • KOA Studio 프로그램은 항상 모의투자로만 접속가능해서 모의투자접속 체크 해지가 않됩니다.
  • 모의투자로 로그인하시려면 당사 홈페이지에서 미리 모의투자 사용신청을 하셔야 하며 상세한 내용은 당사 홈페이지를 참고하시기 바랍니다.
  • 모의투자 계좌번호, 주문 가능종목, 수수료등 정책은 실서버와 차이가 있으므로 상세한 내용은 홈페이지 내용을 꼭 참고해 주세요.

[중복로그인]

  • 실서버에서는 중복로그인을 허용하지 않기 때문에 동일PC나 다른PC나 관계없이 마지막에 로그인한 경우만 유지되고 이전에 로그인한 프로그램은 자동으로 로그오프됩니다.
  • 그러나 모의투자서버는 중복로그인이 가능해서 얼마든지 로그인 하실수 있습니다.

[LONG CommConnect()]

  • 수동 로그인설정인 경우 로그인창을 출력해서 로그인을 시도하거나 자동로그인 설정인 경우 로그인창 출력없이 로그인을 시도합니다.

[LONG GetLoginInfo()]

  • 로그인 후 사용할 수 있으며 인자값에 대응하는 정보를 얻을 수 있습니다. 인자는 다음값을 사용할 수 있습니다.

    • "ACCOUNT_CNT"
      : 보유계좌 수를 반환합니다.

    • "ACCLIST" 또는 "ACCNO"
      : 구분자 ';'로 연결된 보유계좌 목록을 반환합니다.

    • "USER_ID"
      : 사용자 ID를 반환합니다.

    • "USER_NAME"
      : 사용자 이름을 반환합니다.

    • "KEY_BSECGB"
      : 키보드 보안 해지여부를 반환합니다.(0 : 정상, 1 : 해지)

    • "FIREW_SECGB"
      : 방화벽 설정여부를 반환합니다.(0 : 미설정, 1 : 설정, 2 : 해지)

    • "GetServerGubun"
      : 접속서버 구분을 반환합니다.(1 : 모의투자, 나머지 : 실서버)

    • 리턴값
      : 인자값에 대응하는 정보를 얻을 수 있습니다.

[보유계좌 목록 예시]

CString   strAcctList = GetLoginInfo("ACCLIST");

여기서 strAcctList는 ';'로 분리한 보유계좌 목록임 예) "3040525910;567890;3040526010"

[OnEventConnect()이벤트]

OnEventConnect(
  long nErrCode   // 로그인 상태를 전달하는데 자세한 내용은 아래 상세내용 참고
)

로그인 처리 이벤트입니다. 성공이면 인자값 nErrCode가 0이며 에러는 다음과 같은 값이 전달됩니다.

nErrCode별 상세내용

  • 100 사용자 정보교환 실패
  • 101 서버접속 실패
  • 102 버전처리 실패

[OnReceiveMsg()이벤트]

OnReceiveMsg(
  BSTR sScrNo,   // 화면번호
  BSTR sRQName,  // 사용자 구분명
  BSTR sTrCode,  // TR이름
  BSTR sMsg      // 서버에서 전달하는 메시지
)

서버통신 후 수신한 메시지를 알려줍니다.
메시지에는 6자리 코드번호가 포함되는데 이 코드번호는 통보없이 수시로 변경될 수 있습니다. 따라서 주문이나 오류관련처리를
이 코드번호로 분류하시면 안됩니다.

댓글 남기기

이메일은 공개되지 않습니다. 필수 입력창은 * 로 표시되어 있습니다