OpenAPI

HOME > OpenAPI > 홈택스

홈택스

홈택스 정보를 제공합니다


1 요청URL
GET
POST
    URL
  • http://api.goodapi.co.kr:8888/Rest/api/Hometax?sessionID=공개키
    • 샘플
  • http://api.goodapi.co.kr:8888/Rest/api/Hometax?sessionID=test
  • [application/x-www-form-urlencoded]
  • path01=1178121379
  • [application/xml]
  • <R><path01>1178121379</path01></R>
  • [application/json]
  • {"path01":"1178121379"}

    • 주의사항
  • filename, type, eCode, serviceKey, subFileName, wcfName 요청변수명은 사용이 불가하며,
  • path01 ~ path20은 Path에서 사용하지 않을 경우 사용가능.
  • 요청변수명 중복사용시 Query보다 Body가 우선함.

2 요청변수
구분 요청변수 변수명 유형 필수 샘플값 설명
Path fileName 요청 업무 string true Hometax
 Hometax
추가/변경 가능
path01 사업자번호 string true 1178121379
Query returnType응답형식stringfalsexmlxml or json
HTTP Header의 Accept 사용 권장
eCode 법인코드 string false Dataservice 요청 처리하고자 하는 법인코드
sessionID 공개키 string true test 접근하려는 연계시스템 또는 사용자에 부여하는 Key값
subFileName 요청 업무(구분) string false 088 요청 업무 세부 구분 코드(예-은행코드)

3 출력결과필드
출력변수 유형 샘플값 설명
R_CODE responseindex
R_MSG responseindex
조회결과 responseindex

4 추가응답코드
  • 개발가이드 페이지의 기본응답코드외 해당 업무특성상 추가되는 응답코드
    • 응답코드 응답메세지 조치 방안

    5 Test API
    Header
    Key Value 비고
    Content-Type application/x-www-form-urlencoded application/xml
    application/json
    Accept application/xml
    application/json
    Authorization 토큰 인증용 헤더(Bearer + ' ' + 발급토큰)
    client_id 접속회원ID
    client_secret 접속비밀번호
    serviec_key 서비스Key
    user-tr-no 요청자 거래고유번호(요청자 생성)


  • [GET] http://api.goodapi.co.kr:8888/Rest/api/Hometax


    • Response


  • [POST] http://api.goodapi.co.kr:8888/Rest/api/Hometax?sessionID=test

    • Body
    Key Value 비고
    path01 사업자번호


    Response