사업장

인쇄
공유
PDF

사업장

인쇄
공유
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

설명

고객사의 사업장 정보를 WOKPLACE로 설정하기 위한 API입니다.

추가 API

사업장 정보를 추가한다.

요청 URL

POST https://workplace.apigw.ntruss.com/organization/apigw/v1/company/{companyId}/placebiz/{externalKey}

요청 헤더

Header	Description
x-ncp-apigw-timestamp	- 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타낸 것 - API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주
x-ncp-iam-access-key	- 네이버 클라우드 플랫폼 포털 또는 Sub Account에서 발급받은 Access Key ID
x-ncp-apigw-signature-v2	- 위 예제의 Body를 Access Key ID와 맵핑되는 Secret Key로 암호화한 서명 - HMAC 암호화 알고리즘은 HmacSHA256 사용

요청 Path 파라미터

파라미터	타입	크기	필수 여부	설명
companyId	String	36	Y	연동키(CompanyId) Developers > 기본 설정 > 연동키
externalKey	String	36	Y	추가정보 외부키

요청 Body 파라미터

파라미터	타입	크기	필수 여부	설명
placeNm	String	100	Y	사업장명
placeNmI18nNames	Map		Y	사업장 다국어명 Map<Locale, String> i18nNames
corporateNum	String	30	Y	법인번호 또는 대표자주민번호
corporateNm	String	100	Y	법인명 또는 상호
category	String	1	N	사업장구분(1:대리인, 2:법인사업자, 3:개인사업자)
phoneNum	String	30	N	전화번호
corpRegistNum	String	30	Y	사업자등록번호
corpRegistSubNum	Int		N	종사업장번호(4자리)
bossNm	String	100	Y	사업장명
bossNmI18nNames	Map		N	사업장 다국어명 Map<Locale, String> i18nNames
useYn	String	1	Y	사용여부(Y/N)
zipcode	String	10	N	우편번호
addr	String	100	N	주소
addrDtl	String	100	N	상세주소
bizType	String	100	N	업종
bizCond	String	100	N	업태
texOfficeCode	Int		N	세무서코드
addTexDeclareYn	String	1	N	부가세신고여부
endYmd	String	10	N	사업장종료일

요청 예시

POST https://workplace.apigw.ntruss.com/organization/apigw/v1/company/adc835a8-244c-46b4-8410-7421816d4808/placebiz/gw02attrext0001

POST /organization/apigw/v1/company/adc835a8-244c-46b4-8410-7421816d4808/placebiz/gw02attrext0001
HOST: workplace.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp: 1505290625682
x-ncp-apigw-api-key: DUxjP4HYTP8V7khBkgywdDHQjKuaYWGrppHKpvdv
x-ncp-iam-access-key: D78BB444D6D3C84CA38A
x-ncp-apigw-signature-v2: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=
{
    "placeNm" : "서초사업장",
    "placeNmI18nNames" : {
    "en_US" : "SEOCHO PLACE",
    "ko_KR" : "서초사업장",
    "ja_JP" : "서초사업장(JP)",
    "zh_CN" : "서초사업장(CN)",
    "zh_TW" : "서초사업장(TW)"
    },
    "category" : "1",
    "corporateNum" : "111-22-34567",
    "corporateNm" : "테스트사업장(법인)",
    "phoneNum" : "010-3456-3456",
    "corpRegistNum" : "345-22-34567",
    "corpRegistSubNum" : "666",
    "bossNm" : "홍길동",
    "bossNmI18nNames" : {
    "en_US" : "Gil-Dong Hong",
    "ko_KR" : "홍길동",
    "ja_JP" : "홍길동(JP)",
    "zh_CN" : "홍길동(CN)",
    "zh_TW" : "홍길동(TW)"
    },
    "useYn" : "Y",
    "zipcode" : "123-456",
    "addr" : "경기도 성남시 분당구 동판교로 65번길 34-13",
    "addrDtl" : "상세주소",
    "bizType" : "업태",
    "bizCond" : "업종",
    "texOfficeCode" : "123",
    "addTexDeclareYn" : "Y",
    "endYmd" : "2999-12-31"
}

응답 예시

{
    "companyId": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
    "category": 1,
    "corporateNum": "111-22-34567",
    "placeNm": "테스트사업장",
    "placeNmI18nNames": {
        "en_US": "SEOCHO PLACE",
        "ko_KR": "서초사업장",
        "ja_JP": "서초사업장(JP)",
        "zh_CN": "서초사업장(CN)",
        "zh_TW": "서초사업장(TW)"
    },
    "corporateNm": "테스트사업장(법인)",
    "phoneNum": "010-3456-3456",
    "corpRegistNum": "345-22-34567",
    "corpRegistSubNum": 666,
    "bossNm": "홍길동",
    "bossNmI18nNames": {
        "en_US": "Gil-Dong Hong",
        "ko_KR": "홍길동",
        "ja_JP": "홍길동(JP)",
        "zh_CN": "홍길동(CN)",
        "zh_TW": "홍길동(TW)"
    },
    "useYn": "Y",
    "zipcode": "123-456",
    "addr": "경기도 성남시 분당구 동판교로 65번길",
    "addrDtl": " 34-13 801호",
    "bizType": "인터넷",
    "bizCond": "서비스",
    "texOfficeCode": 123,
    "addTexDeclareYn": "Y",
    "endYmd": "2999-12-31",
    "externalKey": "gw02attrext0001"
}

수정 API

사업장 정보를 수정한다.

요청 URL

PUT https://workplace.apigw.ntruss.com/organization/apigw/v1/company/{companyId}/placebiz/{externalKey}

요청 헤더

Header	Description
x-ncp-apigw-timestamp	* 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타낸 것 * API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주
x-ncp-iam-access-key	* 네이버 클라우드 플랫폼 포털 또는 Sub Account에서 발급받은 Access Key ID
x-ncp-apigw-signature-v2	* 위 예제의 Body를 Access Key ID와 맵핑되는 Secret Key로 암호화한 서명 * HMAC 암호화 알고리즘은 HmacSHA256 사용

요청 Path 파라미터

파라미터	타입	크기	필수 여부	설명
companyId	String	36	Y	연동키(CompanyId) Developers > 기본 설정 > 연동키
externalKey	String	36	Y	추가정보 외부키

요청 Body 파라미터

파라미터	타입	크기	필수 여부	설명
placeNm	String	100	Y	사업장명
placeNmI18nNames	Map		Y	사업장 다국어명 Map<Locale, String> i18nNames
corporateNum	String	30	Y	법인번호 또는 대표자주민번호
corporateNm	String	100	Y	법인명 또는 상호
category	String	1	N	사업장구분(1:대리인, 2:법인사업자, 3:개인사업자)
phoneNum	String	30	N	전화번호
corpRegistNum	String	30	Y	사업자등록번호
corpRegistSubNum	Int		N	종사업장번호(4자리)
bossNm	String	100	Y	사업장명
bossNmI18nNames	Map		N	사업장 다국어명 Map<Locale, String> i18nNames
useYn	String	1	Y	사용여부(Y/N)
zipcode	String	10	N	우편번호
addr	String	100	N	주소
addrDtl	String	100	N	상세주소
bizType	String	100	N	업종
bizCond	String	100	N	업태
texOfficeCode	Int		N	세무서코드
addTexDeclareYn	String	1	N	부가세신고여부
endYmd	String	10	N	사업장종료일

요청 예시

PUT https://workplace.apigw.ntruss.com/organization/apigw/v1/company/adc835a8-244c-46b4-8410-7421816d4808/placebiz/gw02attrext0002

PUT /organization/apigw/v1/company/adc835a8-244c-46b4-8410-7421816d4808/placebiz/gw02attrext0002
HOST: workplaceg.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp:1505290625682
x-ncp-apigw-api-key:DUxjP4HYTP8V7khBkgywdDHQjKuaYWGrppHKpvdv
x-ncp-iam-access-key:D78BB444D6D3C84CA38A
x-ncp-apigw-signature-v2:WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=
{   "placeNm" : "수정-서초사업장",
    "placeNmI18nNames" : {
    "en_US" : "SEOCHO PLACE",
    "ko_KR" : "수정-서초사업장",
    "ja_JP" : "수정-서초사업장(JP)",
    "zh_CN" : "수정-서초사업장(CN)",
    "zh_TW" : "수정-서초사업장(TW)"
    },
    "category" : "1",
    "corporateNum" : "111-22-34567",
    "corporateNm" : "테스트사업장(법인)",
    "phoneNum" : "010-3456-3456",
    "corpRegistNum" : "345-22-34567",
    "corpRegistSubNum" : "666",
    "bossNm" : "홍길동",
    "bossNmI18nNames" : {
    "en_US" : "Gil-Dong Hong",
    "ko_KR" : "홍길동",
    "ja_JP" : "홍길동(JP)",
    "zh_CN" : "홍길동(CN)",
    "zh_TW" : "홍길동(TW)"
    },
     "useYn": "Y",
     "zipcode": "123-456",
     "addr": "경기도 성남시 분당구 동판교로 65번길",
     "addrDtl": " 34-13 801호",
     "bizType": "인터넷",
     "bizCond": "서비스",
     "texOfficeCode": 123,
     "addTexDeclareYn": "Y",
     "endYmd": "2999-12-31"
}

응답 예시

{
    "timestamp": "2019-12-13 14:33:31",
    "status": 200,
    "error": null,
    "message": null,
    "path": "/organization/apigw/v1/company/187d83ad-4038-45b6-8e7c-59eca16fdc46/placebiz/195c1526-d8f4-40b3-9269-1c55b7336551111111",
    "body": {
        "companyId": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
        "category": 1,
        "corporateNum": "111-22-34567",
        "placeNm": "수정-서초사업장",
        "placeNmI18nNames" : {
        "en_US" : "SEOCHO PLACE",
        "ko_KR" : "수정-서초사업장",
        "ja_JP" : "수정-서초사업장(JP)",
        "zh_CN" : "수정-서초사업장(CN)",
        "zh_TW" : "수정-서초사업장(TW)"
        },
        "corporateNm": "테스트사업장(법인)",
        "phoneNum": "010-3456-3456",
        "corpRegistNum": "3452234567",
        "corpRegistSubNum": 666,
        "bossNm": "홍길동",
        "bossNmI18nNames": {
            "zh_CN": "홍길동(CN)",
            "ja_JP": "홍길동(JP)",
            "ko_KR": "홍길동",
            "zh_TW": "홍길동(TW)",
            "en_US": "Gil-Dong Hong"
        },
        "useYn": "Y",
        "zipcode": "123-456",
        "addr": "경기도 성남시 분당구 동판교로 65번길",
        "addrDtl": "34-13 801호",
        "bizType": "업태",
        "bizCond": "업종",
        "texOfficeCode": 123,
        "addTexDeclareYn": "Y",
        "endYmd": "2999-12-31",
        "externalKey": "195c1526-d8f4-40b3-9269-1c55b7336551111111"
    }
}

삭제 API

사업장 정보를 삭제한다.

요청 URL

DELETE https://workplace.apigw.ntruss.com/organization/apigw/v1/company/{companyId}/placebiz/{externalKey}

요청 헤더

Header	Description
x-ncp-apigw-timestamp	* 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타낸 것 * API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주
x-ncp-iam-access-key	* 네이버 클라우드 플랫폼 포털 또는 Sub Account에서 발급받은 Access Key ID
x-ncp-apigw-signature-v2	* 위 예제의 Body를 Access Key ID와 맵핑되는 Secret Key로 암호화한 서명 * HMAC 암호화 알고리즘은 HmacSHA256 사용

요청 Path 파라미터

파라미터	타입	크기	필수 여부	설명
companyId	String	36	Y	연동키(CompanyId) Developers > 기본 설정 > 연동키
externalKey	String	36	Y	추가정보 외부키

응답 예시

{
    "timestamp": "2019-12-17 13:54:08",
    "status": 200,
    "error": null,
    "message": null,
    "path": "/admin/ns/apigw/v1/company/fe5f8382-aae3-4746-8d6e-f9d0545c5a9b/placebiz/KEY_004",
    "body": null
}

전체 리스트 API

설정한 추가정보 전체 리스트를 가져온다.

요청 URL

GET https://workplace.apigw.ntruss.com/organization/apigw/v1/company/{companyId}/placebiz

요청 헤더

Header	Description
x-ncp-apigw-timestamp	- 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타낸 것 - API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주
x-ncp-iam-access-key	- 네이버 클라우드 플랫폼 포털 또는 Sub Account에서 발급받은 Access Key ID
x-ncp-apigw-signature-v2	- 위 예제의 Body를 Access Key ID와 맵핑되는 Secret Key로 암호화한 서명 - HMAC 암호화 알고리즘은 HmacSHA256 사용

요청 Path 파라미터

파라미터	타입	크기	필수 여부	설명
companyId	String	36	Y	연동키(CompanyId) Developers > 기본 설정 > 연동키

요청 예시

GET https://workplace.apigw.ntruss.com/organization/apigw/v1/company/fe5f8382-aae3-4746-8d6e-f9d0545c5a9b/placebiz

응답 예시

{
    "timestamp": "2019-12-17 13:36:21",
    "status": 200,
    "error": null,
    "message": null,
    "path": "/admin/ns/apigw/v1/company/fe5f8382-aae3-4746-8d6e-f9d0545c5a9b/placebiz",
    "body": [
        {
            "companyId": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
            "category": 1,
            "corporateNum": "111-22-34567",
            "placeNm": "서초사업장",
            "placeNmI18nNames": {
                "zh_CN": "서초사업장(CN)",
                "ja_JP": "서초사업장(JP)",
                "ko_KR": "서초사업장",
                "zh_TW": "서초사업장(TW)",
                "en_US": "SEOCHO PLACE"
            },
            "corporateNm": "서초사업장(법인)",
            "phoneNum": "010-3456-3456",
            "corpRegistNum": "3452234567",
            "corpRegistSubNum": 666,
            "bossNm": "홍길동",
            "bossNmI18nNames": {
                "zh_CN": "홍길동(CN)",
                "ja_JP": "홍길동(JP)",
                "ko_KR": "홍길동",
                "zh_TW": "홍길동(TW)",
                "en_US": "Gil-Dong Hong"
            },
            "useYn": "Y",
            "zipcode": "123-456",
            "addr": "경기도 성남시 분당구 동판교로 65번길",
            "addrDtl": " 34-13",
            "bizType": "업태",
            "bizCond": "업종",
            "texOfficeCode": 123,
            "addTexDeclareYn": "Y",
            "endYmd": "2999-12-31",
            "externalKey": "195c1526-d8f4-40b3-9269-1c55b7336551111111"
        },
        {
            "companyId": "fe5f8382-aae3-4746-8d6e-f9d0545c5a9b",
            "category": 2,
            "corporateNum": "111-22-34561",
            "placeNm": "강남사업장",
            "placeNmI18nNames": {
               "zh_CN": "강남사업장(CN)",
               "ja_JP": "강남사업장(JP)",
               "ko_KR": "강남사업장",
               "zh_TW": "강남사업장(TW)",
               "en_US": "GANG-NAM PLACE"
            },
            "corporateNm":  "강남사업장(법인)",
            "phoneNum": "111-3456-7890",
            "corpRegistNum": "3452234567",
            "corpRegistSubNum": 777,
            "bossNm": "홍길석",
            "bossNmI18nNames": {
                "zh_CN": "홍길석(CN)",
                "ja_JP": "홍길석(JP)",
                "ko_KR": "홍길석",
                "zh_TW": "홍길석(TW)",
                "en_US": "Gil-SEOK Hong"
            },
            "useYn": "Y",
            "zipcode": "123-456",
            "addr": "서울시 강남구 교대로 65번길",
            "addrDtl": " 34-13",
            "bizType": "업태",
            "bizCond": "업종",
            "texOfficeCode": 123,
            "addTexDeclareYn": "Y",
            "endYmd": "2017-12-29",
            "externalKey": "195c1526-d8f4-40b3-9269-1c55b7336551111112"
        }
    ]
}

단건 조회 API

사업장중 1건을 조회한다.

요청 URL

GET https://workplace.apigw.ntruss.com/organization/apigw/v1/company/{companyId}/placebiz

요청 헤더

요청 헤더 공통

Header	Description
x-ncp-apigw-timestamp	- 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타낸 것 - API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주
x-ncp-iam-access-key	- 네이버 클라우드 플랫폼 포털 또는 Sub Account에서 발급받은 Access Key ID
x-ncp-apigw-signature-v2	- 위 예제의 Body를 Access Key ID와 맵핑되는 Secret Key로 암호화한 서명 - HMAC 암호화 알고리즘은 HmacSHA256 사용

요청 Path 파라미터

파라미터	타입	크기	필수 여부	설명
companyId	String	36	Y	연동키(CompanyId) Developers > 기본 설정 > 연동키
externalKey	String	36	Y	추가 정보 외부키

요청 예시

GET https://workplace.apigw.ntruss.com/organization/apigw/v1/company/adc835a8-244c-46b4-8410-7421816d4808/placebiz

응답 예시

{
    "timestamp": "2019-12-13 14:33:31",
    "status": 200,
    "error": null,
    "message": null,
    "path": "/organization/apigw/v1/company/187d83ad-4038-45b6-8e7c-59eca16fdc46/placebiz",
    "body": {
        "companyId": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
        "category": 1,
        "corporateNum": "111-22-34567",
        "placeNm": "서초사업장",
        "placeNmI18nNames": {
            "zh_CN": "서초사업장(CN)",
            "ja_JP": "서초사업장(JP)",
            "ko_KR": "서초사업장",
            "zh_TW": "서초사업장(TW)",
            "en_US": "SEOCHO PLACE"
        },
        "corporateNm": "서초사업장(법인)",
        "phoneNum": "010-3456-3456",
        "corpRegistNum": "3452234567",
        "corpRegistSubNum": 666,
        "bossNm": "홍길동",
        "bossNmI18nNames": {
            "zh_CN": "홍길동(CN)",
            "ja_JP": "홍길동(JP)",
            "ko_KR": "홍길동",
            "zh_TW": "홍길동(TW)",
            "en_US": "Gil-Dong Hong"
        },
        "useYn": "Y",
        "zipcode": "123-456",
        "addr": "경기도 성남시 분당구 동판교로 65번길",
        "addrDtl": " 34-13",
        "bizType": "업태",
        "bizCond": "업종",
        "texOfficeCode": 123,
        "addTexDeclareYn": "Y",
        "endYmd": "2999-12-31",
        "externalKey": "195c1526-d8f4-40b3-9269-1c55b7336551111111"
    }
}

응답

HTTP 상태 코드로 리턴되고, Body 정보로 전달한다.

HTTP 상태 코드	응답 메시지	설명
200	OK	일반적인 요청 성공
201	Created	리소스 생성 성공에 대한 응답 코드
400	Bad Request	일반적인 요청 실패에 사용(대체로 서버가 이해할 수 없는 형식의 요청이 왔을 때 응답하기 위해 사용)
500	Internal Server Error	- 일반적인 서버 오류에 대한 응답 코드 4XX대의 오류 코드가 클라이언트 측 오류를 나타내기 위해 사용 - 5XX대의 오류 코드는 서버 측 오류를 나타내기 위해 사용

이 문서가 도움이 되었습니까?

What's Next

대표관리자조회

설명
추가 API
수정 API
삭제 API
전체 리스트 API
단건 조회 API
요청 헤더 공통
응답

태그

WORKPLACE