# Restful API \[개요]\ \- bizplay에서 제공하는 API를 통해 ERP사에서 개발을 진행 합니다. ![\[그림1\] API방식](/files/-LpWWoQj3dx6RcGgpYkv) ① Message API 호출을 bizplay로 전송 합니다.\ ② 데이터 조회/전송을 수행 합니다.\ ③ 요청된 결과 값을 다시 전송 합니다.\ ※ 고객을 식별할 수 있는 고유 키를 발급해 드립니다.\ ※ 운영 환경은 Https 인증방식 암호화 합니다. \[방화벽 설정]\ \- bizplay는 OPEN API 로 연결 되어 아래와 같은 Out-Bound 방화벽 설정이 필요 합니다.\ (In-bound 없음) ![\[그림2\] 방화벽 설정](/files/-LpWX9MbuM6iYffC5hXH) ① bizplay는 목동 KT IDC센터에 금융 클라우드 센터로 운영 합니다.\ ② 도착지 호출은 URL 방식으로 내부 서버에서 DNS를 찾을 수 없으면 HOSTS파일에 등록해야 합니다.\ ③ 개발 API 전문테스트는 개발 작업 시 에만 필요 합니다.\ ④ 이미지 링크는 ERP나 GW에서 첨부 이미지 링크가 필요할 경우 사용 합니다. \[API 실습] \ \- GET방식으로 외부 사이트를 이용하여 실습을 합니다. ![\[그림3\] API URL](/files/-LpWXN0xrGrqZEgMIW2y) ▶ 개발 전문을 테스트 페이지에서 확인 합니다.\ 1\. 열고 ![](/files/-LpWXYD__NwrIiSqVwoE) 2\. ①"서비스 코드 목록"에 "카드 영수증 처리 내역 조회(0411)" 선택하여 ②"쿼리전송"을 클릭 합니다.\ ③ JSON\_OUT 결과물이 나옵니다.\ 3\. 결과 확인 에 접속하여 ![\[그림5\] JSON Viewer 화면](/files/-LpWXhyUXpFugyPSMxWJ) 4\. ③번 결과물을 ④"Text" 항목 선택 후 붙여넣기를 합니다.\ ⑤"Format" 탭을 클릭하면 결과물이 정렬됩니다. ![\[그림6\] JSON Viewer 화면](/files/-LpWXwe_JhWj09XMaG74) 5\. ⑥"viewer" 탭을 클릭하면 정렬된 결과물을 확인 할 수 있습니다. ▶ get 방식 API테스트\ \- URL 인코딩된 API 입력값 구하기\ URL인코딩(base64) : Protocol로 사용하는 http URL에는 의미를 가진 문자가 있음 해당문자를 URL에\ 명령어로 인식하지 못하도록 암호화 하는 방법 ![](/files/-LpWYAh5o-GL5y9ffFGi) ① "서비스코드 목록" 에서 "카드 영수증 처리 내역 조회 (0411) 선택합니다.\ ② JSON\_IN 입력된 내역을 복사합니다. ![\[그림8\] URL 인코딩](/files/-LpWYHTgYIXy9-XmB4P6) ③ [http://www.convertstring.com/ko/EncodeDecode/UrlEncode ]() 접속하여 \ 복사한 내역을 "여기에 URL 인코딩하고자하는..." 붙여 넣습니다.\ ④ "URL 인코딩!"을 클릭합니다.\ ⑤ "여기에 URL 인코딩 된 텍스트를 복사 : " 출력물 값을 복사합니다. ![\[그림9\] 메모장](/files/-LpWYTSfgCCcJXgY7-Hp) ⑥ 메모장안에 "" 입력합니다.\ ⑦에 ⑤결과물을 붙여 넣습니다. ![\[그림10\] Chrome 주소란](/files/-LpWYfOvWSoVxLTnOyf1) ⑧ "Chrome" 실행하여 주소란에 "{그림9} 메모장" 안에 있는 내용을 복사하여 붙여넣습니다. ![\[그림11\] URL인코딩 실행 화면](/files/-LpWYvZdhXTvOhSMDd_D) ⑨ URL 실행 후 결과물을 복사합니다.\ 위에 "▶ 개발 전문을 테스트 페이지에서 확인 합니다." 에서 3\~5 설명되어 있는데로\ 실습을 합니다. ▶ 리바운드 전문\ \- 전문 통신 특성상 응답을 무한정 길게 전송이 불가능하기 때문에 일정 건별로 페이징을 반복하여 \ 전문을 호출합니다. ![\[그림12\] NEXT\_KEY](/files/-LpWZ62niDb9AWXhz3cr) ① 쿼리전송을 하여 JSON\_OUT 결과창에 "NEXT\_KEY" 값이 있는지 확인합니다.\ "NEXT\_KEY" 값이 있으면 다음 페이지가 존재하기 때문에 다시 요청을 하여야 합니다.\ ② JSON\_IN 창에 "NEXT\_KEY" :" 뒤에 ①JSON\_OUT 창에 나온 "NEXT\_KEY"을 입력 후 쿼리전송을 합니다. ▶JOSN\_IN 쿼리 설명\ \- JSON\_IN 쿼리는 "공통부", "입력부"로 나누어 집니다. ![\[그림13\] API 0910 조회](/files/-LpWZH2ZyFOr1Pr1AqWa) \- 접속하여\ \- "서비스코드 목록"에서 "거래종류 코드 조회(0910)" 선택 후 "쿼리전송"을 클릭합니다.\ \ \- 쿼리문\ {① "API\_ID" : "0910",\ ② "API\_KEY" : "5a0d6070-1853-4e37-a4b0-fd11e5699296", "ORG\_CD" : "2148635102", \ ③ "REQ\_DATA" : {\ ④ "BIZ\_NO" : "2148635102",\ ⑤ "REQ\_CNT" : "",\ ⑥ "NEXT\_KEY" : "" } } \- 공통부 설명 \ ① 서비스코드 "거래종류 코드(0910)" 조회ID 입니다.\ ② 발급받은 "인증키"를 입력합니다.\ \ \- 입력부 설명\ ③ 입력부 시작 구분값입니다.\ ④ 조회하고자 하는 고객사 "사업자번호"를 입력합니다.\ ⑤ 조회할 "요청건수"를 입력합니다.\ ⑥ "다음결과키" 한화면에 일정 건수만 표시되어 다음건수 조회시 "JSON\_OUT" 응답내용에 \ "NEXT\_KEY" 입력합니다. --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.bizplay.co.kr/system_if/link-method-guide/api.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.