표준코드 연계 적용 가이드
개요
표준코드 DB 연계
표준코드 연계 적용 가이드에선 표준코드 DB를 구축하고 표준코드 전체 데이터 셋으로 데이터를 적재 한 이 후에 매일의 변동 값을 구축한 DB에 입력 할 수 있는 파일 및 활용 방법에 대해 아래와 같이 제공합니다.
목적
표준코드 DB 연계의 주된 목적은 개발자가 각자의 시스템에서 식품 표준코드를 일관되고 체계적으로 관리할 수 있도록 하는 것입니다. API를 통해 제공되는 데이터를 기반으로 Java Workspace, 라이브러리(JAR 파일), JavaDoc을 함께 제공하여 개발자들이 손쉽게 유지관리 할 수 있는 환경을 지원합니다.
제공파일
표준코드 연계 적용에 사용되는 아래의 3개 파일을 제공합니다.
클릭 시 아이콘의 해당 파일이 다운로드 됩니다.
클릭 시 아이콘의 해당 파일이 다운로드 됩니다.
STDCD_LINK.zip | 표준코드 연계적용 클라이언트 전체 소스파일입니다. 이 파일은 소스를 직접 수정하여 활용할 수 있습니다. |
---|
STDCD_LINK-jar.zip | 표준코드 연계적용 클라이언트 라이브러리 jar파일입니다. 이 파일은 어플리케이션의 라이브러리 경로에 위치해야합니다. |
---|
STDCD_LINK-doc.zip | 표준코드 연계적용 클라이언트 소스의 java Document입니다. 라이브러리에 제공되는 함수에 대한 설명을 보실 수 있습니다. |
---|
제공파일 활용 예제
표준코드 변동값 요청 예제 소스
-
/** * StdReceiver 클래스의 receiverCode() 함수를 호출하여 데이터를 요청합니다. * 함수에 사용되는 주요파라메터는 accessKey , servicePath , dateFrom , dateTo 입니다. * 결과데이터는 StdData 객체로 반환됩니다. */ // import 필요한 클래스 정보 import kr.mfds.StdReceiver; import kr.mfds.StdData; public class StdClient { public static void main( String[] args ) { StdClient sc = new StdClient(); try { sc.getStdInfo(); } catch ( Exception e ) { throw new Error( "에러가 발생하였습니다." ); } } public void getStdInfo() throws Exception { // api 호출함수 선언 StdReceiver stdRec = new StdReceiver(); /** * -필수 * accessKey : 발급받은 승인키 * servicePath : 요청 서비스경로( OPEN API 조회/신청 - API 상세정보에서 확인가능합니다. ) * -선택 * dateFrom 요청일자( from ) - 미입력 시 현재일기준 전 날짜의 데이터만 조회 ( ex:YYYYMMDD ) * dateTo 요청일자( to ) ( ex.YYYYMMDD ) */ String accessKey = "발급받은 승인키"; // 여러 건 요청이 필요하실 경우, 아래와 같이 입력해주시기 바랍니다. String[] servicePath = { "서비스경로1","서비스경로2".... }; String dateFrom = "20240801"; String dateTo = "20240802"; // 변동 자료를 저장할 폴더를 설정합니다. ( ex. C:/stdCd/ ) stdRec.setFilePath( "저장경로" ); for( String service : servicePath ) { try { /** * API 연계서비스 요청 및 응답데이터 확인 * accessKey 승인키 * service servicePath 배열에서 가져오는 서비스경로명 * dateFrom 요청일( from ) * dateTo 요청일( to ) */ StdData stdData = stdRec.receiverCode( accessKey , service , dateFrom , dateTo ); System.out.println( "-----------------------응답결과------------------------" ); System.out.println( "파일경로 : " + stdData.getFilePath() ); System.out.println( "파일명 : " + stdData.getFileName() ); System.out.println( "결과코드 : " + stdData.getResultCode() ); System.out.println( "결과메세지 : " + stdData.getResultMsg() ); System.out.println( "--------------------------------------------------------"); } catch ( Exception e ) { throw new Error( "에러가 발생하였습니다." ); } } } }
-
파일 다운로드 경로 설정 및 표준코드 변동 값 요청 API 호출 메소드
파일 다운로드 경로 설정 및 표준코드 변동 값 요청 API 호출 메소드 정보 테이블 - 메소드명, 설명, 매개변수, 반환값, 사용예시로 구성 메소드명 설명 매개변수 반환값 사용예시 stdRec.setFilePath 응답받은 변동 자료를 지정된 경로에 저장하도록 설정합니다. String filePath void stdRec.setFilePath( “C:\\data” ); stdRec.receiverCode API를 호출하고 응답 값인 표준코드 변동 값을 파일로 저장합니다. String accessKey
String service
String dateFrom
String dataToStdData 객체 stdRec.receiverCode( “인증키” , service , dateFrom , dateTo );
메소드 파라미터클라이언트 소스파일에서 메소드 호출 시 필요한 파라미터 정보를 안내합니다.메소드 파라미터 정보 테이블 - 주요파라메터, 필수여부, 요청형식, 설명로 구성 주요파라메터 필수여부 요청형식 설명 accessKey 필수 String 표준코드 DB 변동자료를 연계받기위한 승인키 servicePath 필수 String[] OPEN API로 제공되는 표준코드의 서비스경로 ( OPEN API 조회 상세화면에서 확인가능 ) dateFrom 선택 String 데이터 요청 시작일자( 입력방식 : YYYYMMDD ) dateTo 선택 String 데이터 요청 종료일자( 입력방식 : YYYYMMDD )
결과 데이터 확인 메소드결과 데이터 확인 메소드 정보 테이블 - 메소드명, 반환타입, 설명, 결과예시로 구성 메소드명 반환타입 설명 결과예시 stdData.getFilePath 변동 자료 파일이 저장 된 파일 경로를 반환합니다. String C:\data stdData.getFileName 변동 자료 파일명을 반환합니다. String 20231221_TESTITEM.txt stdData.getResultCode stdRec.receiverCode 메소드의 결과코드를 반환합니다. String 0000 stdData.getResultMsg stdRec.receiverCode 메소드의 결과값을 반환합니다. String 정상 처리되었습니다.