28 시작하기
hanmj edited this page 9 months ago

xit-lvis-interface란?

차세대 자동차관리 정보시스템에 연계하여

  • 자동차 기본정보 조회
  • 압류내역 조회
  • 대체 압류차량 조회
  • 압류 연계등록 을 REST API로 지원한다.

스프링부트 애플리케이션으로 java 17이상에서 설치 후 즉시 실행할 수 있다.

사전요건

  • 행정정보 공동이용 시스템의
    • 접속승인이 있어야 한다.
    • 사용 api에 대한 api_key를 발급받아야 한다.
  • 차세대 자동차관리 정보시스템의
    • 접속승인이 있어야 한다.
    • 사용 api에 대한 cvmis_apikey를 발급받아야 한다.

암복호화를 위한 gpki 모듈이 설치되어 있어야 한다.

설치

배포파일(xit-lvis-interface.zip)을 원하는 디렉토리에 압축을 풀면 다음과 같은 레이아웃으로 설치된다.

  • 17 - 자바17 운영환경
  • intf-conf - 연계 모듈 설정 파일 디렉토리
  • logs - 로그파일 디렉토리
  • message - 로그파일 디렉토리
  • sql - 데이터베이스 스크립트 디렉토리
  • application.yml - 애플리케이션 기본설정 파일
  • ojdbc6.jar - 오라클 jdbc 라이브러리
  • gpki.conf - 암호화 설정 파일
  • xit-lvis-interface.bat - 시작 배치파일
  • xit-lvis-interface.sh - 시작 셸스크립트
  • xit-lvis-interface.jar - 자동차관리 정보시스템 연계 모듈

xit-lvis 설치 참고

설정

application.yml

application.yml 파일을 열어

  • 포트 설정: server.port
  • 데이터베이스 접속 설정
    • spring.datasource.hikari.jdbc-url: jdbc url
    • spring.datasource.hikari.username: 사용자 아이디
    • spring.datasource.hikari.password: 사용자 비밀번호
등을 설정한다. ### 나머지 설정 [xit-lvis 설정](http://xit.xit-git.com:3000/xit-interfaces/xit-lvis/wiki/xit-lvis-24.06.01#user-content-%ec%84%a4%ec%a0%95) 참고

시작 / 종료

윈도우 운영체제에서 xit-lvis-interface를

  • 시작하려면 xit-lvis-interface.bat를 실행한다.
  • 별도의 jvm으로 실행하려면 xit-lvis-interface.bat 파일을 열어 JAVA_HOME 변수에 경로를 지정한다.
  • 종료하려면 실행창을 닫는다.

리눅스 운영체제에서 xit-lvis-interface를 제어하려면 xit-lvis-interface.sh를 실행한다.

  • 실행 전에 xit-lvis-interface.sh를 열어
    • APP_HOME 변수를 설치 디렉토리 경로로 수정한다.
    • JAVA_HOME 변수에 자바 경로를 지정한다.
  • 시작하려면 `xit-lvis-interface.sh start`를 실행한다.
  • 종료하려면 `xit-lvis-interface.sh stop`을 실행한다.
## 지원 API URL xit-lvis-interface가 지원하는 api의 url은 다음과 같다. * `/intf/lvis/a01`: 자동차 기본정보 조회 * `/intf/lvis/a02`: 자동차 등록원부(갑), 현재 지원하지 않음 * `/intf/lvis/a03`: 자동차 등록원부(을), 현재 지원하지 않음 * `/intf/lvis/b01`: 압류내역 조회 * `/intf/lvis/b02`: 압류내역 연계등록 * `/intf/lvis/b03`: 대체압류차량 정보 조회 * `/intf/lvis/d01`: 번호판 영치대상 조회, 현재 지원하지 않음

위 api는 json 객체를 응답으로 반환한다.

xml로 응답 객체를 반환하는 api의 url은 다음과 같다.

  • /intf/lvis/xml/a01: 자동차 기본정보 조회
  • /intf/lvis/xml/a02: 자동차 등록원부(갑), 현재 지원하지 않음
  • /intf/lvis/xml/a03: 자동차 등록원부(을), 현재 지원하지 않음
  • /intf/lvis/xml/b01: 압류내역 조회
  • /intf/lvis/xml/b02: 압류내역 연계등록
  • /intf/lvis/xml/b03: 대체압류차량 정보 조회
  • /intf/lvis/xml/d01: 번호판 영치대상 조회, 현재 지원하지 않음

위 api 호출 시 포함되는 공통 파라미터api별 파라미터에 대해서는 xit-lvis를 참고한다.

연계 테스트

시스템은 swagger로 테스트를 실행할 수 있다.

시스템을 테스트하려면

  • 시스템을 시작한다.
  • 웹브라우저를 시작하고, http://호스트:포트/swagger-ui/index.html 페이지를 연다.
  • 예) http://localhost:18080/swagger-ui/index.html 또는
  • SSL이 적용되었으면 https://호스트:포트/swagger-ui/index.html
  • 예) https://localhost:18080/swagger-ui/index.html
  • 테스트 하려는 업무를 클릭한다.
  • “Try it out” 버튼을 클릭하고 “Request body”에 요청정보를 입력한 후 “Execute” 버튼을 클릭한다.