Corporation Search API 가이드

Search > Corporation Search > Corporation Search API 가이드

Corporation Search API 공통 정보

인증 및 권한

Corporation Search API를 사용하려면 Appkey와 SecretKey가 필요합니다.

Appkey는 NHN Cloud의 각 서비스별로 발급되는 고유 인증 키로 API 요청 시 서비스 식별과 유효성 검증에 사용됩니다. SecretKey는 API에 대한 접근을 제어하는 비밀 키입니다.

Appkey 및 SecretKey 확인 및 사용에 대한 자세한 내용은 Appkey를 참고하세요.

오류코드

응답코드 설명
0 성공
-1002 JSON 규격 에러
-1003 복호화 및 기타 에러
-1006 해당 AppKey의 등록된 사용자가 없습니다.
-1008 지정한 날짜 형식이 잘못되었습니다.
-1201 요청한 거래처가 없습니다.
-1202 인증된 사용자가 아닙니다.
-1203 사업자조회가 처리중입니다.
-1204 요청된 내역이 없습니다.
-1205 잘못된 요청번호입니다.
-1206 잘못된 사업자번호입니다.
-1207 존재하지 않는 요청번호입니다.
-1208 최근 7일간 요청내역이 없습니다.
-1209 해당 일자는 이미 스크래핑이 완료되었습니다.

거래처 휴/폐업 요청

거래처 사업자등록번호 목록에 대한 휴/폐업 정보 조회를 요청합니다.

요청

POST /scraping/v1.0/appkeys/{appkey}/requests?p={param}
Content-Type: application/x-www-form-urlencoded

요청 파라미터

예시 URL 
https://api-corpsearch.nhncloudservice.com/scraping/v1.0/appkeys/1sdaf3rs34d2/requests?p=rteo7fjjhGlVznybl239YSngEb2Y3VHOSJaM12AGasdyI1Y0pclSFnPo8uD8eHLFJ41AigDRpsXW36aBQoJXkTFhVeTQ4CMJFg8qKUXj%2Bl%2BwxjdkDJxVdCkJlh4Nnvxm
이름 구분 타입 필수 설명
appkey URL String Y AppKey
p URL String Y 암호화된 Request body Parameter

요청 본문

예시 코드 
{
    "custNo": 1,
    "crtKey": "qaz!@wsx",
    "bnoList": ["1234567890", "0123456789", "9012345678"]
}

JSON 데이터를 AES256 암호화 처리 후, URLEncoder(UTF-8) 처리된 데이터
rteo7fjjhGlVznybl239YSngEb2Y3VHOSJaM12AGasdyI1Y0pclSFnPo8uD8eHLFJ41AigDRpsXW36aBQoJXkTFhVeTQ4CMJFg8qKUXj%2Bl%2BwxjdkDJxVdCkJlh4Nnvxm
이름 타입 필수 설명
custNo Long Y 고객번호(Console 페이지 내 있음)
crtKey String Y 고객인증키(Console 페이지 내 있음)
bnoList String Y 사업자등록번호(복수 개 가능)

응답

예시 코드 
{
    "header": {
        "resultCode": 0,
        "resultMessage": "정상적으로 요청되었습니다.",
        "successful": true
    },
    "data": {
        "reqNo": 68,
        "reqCnt": 8,
        "reqDate": "2015-12-10 10:10:10"
    }
}
이름 타입 설명
reqNo Long 요청번호
resultCnt Int 요청된 사업자등록번호 개수
reqDate String 요청된 일시

거래처 휴/폐업 요청 상태확인

요청한 휴/폐업 정보 조회 작업의 처리 상태를 확인합니다.

요청

GET /scraping/v1.0/appkeys/{appkey}/verification?p={param}

요청 파라미터

예시 URL 
https://api-corpsearch.nhncloudservice.com/scraping/v1.0/appkeys/1sdaf3rs34d2/verification?p=TSNRsStai0hQUM5m40dyDxIJsW5TON7QqVYjjhCIjBUKbMFqmiM1xZ8ND5%2Buo5xd
이름 구분 타입 필수 설명
appkey URL String Y AppKey
p URL String Y 암호화된 Request body Parameter

요청 본문

예시 코드 
{
    "custNo": 1,
    "crtKey": "qaz!@wsx",
    "reqNo": 58
}

JSON 데이터를 AES256 암호화 처리 후, URLEncoder(UTF-8) 처리된 데이터
TSNRsStai0hQUM5m40dyDxIJsW5TON7QqVYjjhCIjBUKbMFqmiM1xZ8ND5%2Buo5xd
이름 타입 필수 설명
custNo Long Y 고객번호(Console 페이지 내 있음)
crtKey String Y 고객인증키(Console 페이지 내 있음)
reqNo Long Y 요청번호

응답

예시 코드 
{
    "header": {
        "resultCode": 0,
        "resultMessage": "정상적으로 요청되었습니다.",
        "successful": true
    },
    "data": {
        "reqNo": 68,
        "resultDate": "2015-11-11 10:10:10"
    }
}
이름 타입 설명
reqNo Long 요청번호
resultDate String 완료일시

거래처 휴/폐업 요청 결과데이터 받기

요청한 휴/폐업 정보 조회의 결과 데이터를 조회합니다.

요청

GET /scraping/v1.0/appkeys/{appkey}/results?p={param}

요청 파라미터

예시 URL 
https://api-corpsearch.nhncloudservice.com/scraping/v1.0/appkeys/1sdaf3rs34d2/results?p=TSNRsStai0hQUM5m40dyDxIJsW5TON7QqVYjjhCIjBUKbMFqmiM1xZ8ND5%2Buo5xd
이름 구분 타입 필수 설명
appkey URL String Y AppKey
p URL String Y 암호화된 Request body Parameter

요청 본문

예시 코드 
{
    "custNo": 1,
    "crtKey": "qaz!@wsx",
    "reqNo": 58
}

JSON 데이터를 AES256 암호화 처리 후, URLEncoder(UTF-8) 처리된 데이터
TSNRsStai0hQUM5m40dyDxIJsW5TON7QqVYjjhCIjBUKbMFqmiM1xZ8ND5%2Buo5xd
이름 타입 필수 설명
custNo Long Y 고객번호(Console 페이지 내 있음)
crtKey String Y 고객인증키(Console 페이지 내 있음)
reqNo Long Y 요청번호
scn String [Y,N] N 거래처명 조회 플래그

응답

예시 코드 
{
    "header": {
        "resultCode": 0,
        "resultMessage": "조회요청이 완료되었습니다.",
        "successful": true
    },
    "data": {
        "reqNo": 58,
        "resultCnt": 8,
        "resultDate": "2015-11-11 10:10:10",
        "resultEncrytData": "8LAT2G8kMp1rFby+n0gWIDYhpnO/sDSU2zMyp0tLnb9Y901/+sw5agirJsWgpJm6s81R1uwOyC+zzBOG98H+WrC1zAMHX1U5tcpbgF+RSeQdx//8r6Af1NXQ3FZ/IsVJnhvttKEqnpFVzGt11zhNz1Tunj4d+N+MWYEr7BW2izaQXxRlZ0HX8X8lEiJp7JutKO9BKpZbAtR471SsDAtT6gS845CayO2ojA6ujpqtF/v/ZQei+0KEF10eBwutGTmn1i891E7K/NzdsQbu8qeau7Ksx+QrLSm0SaPHrK71XFjincB/xxXp12xc1zsZK3drQQ/U2xbiAY3CPqTXdNjWpj/iBRZaagQcC6VVvlIrMJ4t4O+cr7xsW5iMgmcpg75dPpsa4pkG8V0S9YKGg24TH+qfM7RZ9Xh7m+OSZMQRtbFT4fLLawB4E7mMKRPCBjmR3elQ0vVrNhWZ8kFt+a8C4D+EdWTIplvkS13tKkFFCF4="
    }
}
이름 타입 설명
reqNo Long 요청번호
resultCnt Int 완료데이터 개수
resultDate String 완료일자
resultEncrytData String 암호화된 휴폐업정보데이터

resultEncrytData 해당 데이터의 URLDecoder 처리 후, AES256 복호화 처리

[
    {
        "bno": "1234567890",
        "bnoCd": "01",
        "bnoCont": "부가가치세 일반과세자 입니다.",
        "bnoDate": "2015-11-11 10:10:10"
    },
    {
        "bno": "1234567890",
        "bnoCd": "01",
        "bnoCont": "부가가치세 일반과세자 입니다.",
        "bnoDate": "2015-11-11 10:10:10"
    },
    {
        "bno": "1234567890",
        "bnoCd": "01",
        "bnoCont": "부가가치세 일반과세자 입니다.",
        "bnoDate": "2015-11-10 10:10:10"
    }
]
이름 타입 설명
bno String 사업자등록번호
bnoCd String 결과코드
bnoCont String 조회결과
bnoDate String 조회날짜
custNm String 거래처명(scn이 Y인 경우만 포함됨)

거래처 휴/폐업 최근 요청중인 요청번호 확인

가장 최근에 요청한 휴/폐업 정보 조회의 요청번호를 확인합니다.

요청

GET /scraping/v1.0/appkeys/{appkey}/recent?p={param}

요청 파라미터

예시 URL 
https://api-corpsearch.nhncloudservice.com/scraping/v1.0/appkeys/1sdaf3rs34d2/recent?p=3Tm2TS3ynvXw3jcgh1SzQcMIBA2EIRp%2FheQSAsWSXHTP0TODL%2FYEL1Iml3Qn1CWn
이름 구분 타입 필수 설명
appkey URL String Y AppKey
p URL String Y 암호화된 Request body Parameter

요청 본문

예시 코드 
{
    "custNo": 1,
    "crtKey": "qaz!@wsx"
}

JSON 데이터를 AES256 암호화 처리 후, URLEncoder(UTF-8) 처리된 데이터
3Tm2TS3ynvXw3jcgh1SzQcMIBA2EIRp%2FheQSAsWSXHTP0TODL%2FYEL1Iml3Qn1CWn
이름 타입 필수 설명
custNo Long Y 고객번호(Console 페이지 내 있음)
crtKey String Y 고객인증키(Console 페이지 내 있음)

응답

예시 코드 
{
    "header": {
        "resultCode": 0,
        "resultMessage": "정상적으로 요청되었습니다.",
        "successful": true
    },
    "data": {
        "recentReqNo": 68,
        "recentReqDate": "2015-11-11 10:10:10"
    }
}
이름 타입 설명
recentReqNo Long 최근요청번호
recentReqDate String 최근요청일시

거래처 휴/폐업 최근 일주일내 요청내역 확인

최근 일주일 내 휴/폐업 정보 조회 요청 내역 목록을 조회합니다.

요청

GET /scraping/v1.0/appkeys/{appkey}/reqlists?p={param}

요청 파라미터

예시 URL 
https://api-corpsearch.nhncloudservice.com/scraping/v1.0/appkeys/1sdaf3rs34d2/reqlists?p=3Tm2TS3ynvXw3jcgh1SzQcMIBA2EIRp%2FheQSAsWSXHTP0TODL%2FYEL1Iml3Qn1CWn
이름 구분 타입 필수 설명
appkey URL String Y AppKey
p URL String Y 암호화된 Request body Parameter

요청 본문

예시 코드 
{
    "custNo": 1,
    "crtKey": "qaz!@wsx"
}

JSON 데이터를 AES256 암호화 처리 후, URLEncoder(UTF-8) 처리된 데이터
3Tm2TS3ynvXw3jcgh1SzQcMIBA2EIRp%2FheQSAsWSXHTP0TODL%2FYEL1Iml3Qn1CWn
이름 타입 필수 설명
custNo Long Y 고객번호(Console 페이지 내 있음)
crtKey String Y 고객인증키(Console 페이지 내 있음)

응답

예시 코드 
{
    "header": {
        "resultCode": 0,
        "resultMessage": "정상적으로 요청되었습니다.",
        "successful": true
    },
    "data": {
        "reqList": [
            {
                "reqNo": 68,
                "reqStatCd": "REQUEST",
                "reqYmdt": "2015-10-10 10:10:10",
                "trtYmdt": "",
                "reqCnt": 20
            },
            {
                "reqNo": 69,
                "reqStatCd": "COMPLETE",
                "reqYmdt": "2015-10-10 10:10:10",
                "trtYmdt": "2015-10-12 10:10:10",
                "reqCnt": 20
            }
        ]
    }
}
이름 타입 설명
reqNo Long 요청번호
reqStatCd String 요청상태
reqYmdt String 요청일시
trtYmdt String 결과일시
reqCnt Int 요청개수

참고사항

결과조회코드표

코드값 결과값
00 사업을 하고 있지 않는 사업자
01 부가가치세 일반과세자
02 부가가치세 간이과세자
03 부가가치세 면세사업자
04 수익사업을 영위하지 않는 비영리법인이거나 고유번호가 부여된 단체·국가기관
05 휴업자
06 폐업자
09 기타

AES 256 암호화

암호화모듈 개발시 CBC, 패딩은 PKCS5Padding 사용 [Example] Cipher cipher = Cipher.getInstance("AES/CBC/PKCS5Padding")

문자셋 Encoding은 UTF8을 사용

목차
TOP