Login
      내용 x
      구성원
        • 인쇄
        • PDF
        내용

        구성원

          • 인쇄
          • PDF
          Article Summary

          설명

          고객사의 구성원 정보를 WORKBOX로 설정하기 위한 API입니다.

          추가 API

          구성원 정보를 추가한다.

          요청 URL

          POST https://workbox.apigw.ntruss.com/workbox/workbox/openapi/v1/organization/company/{companyId}/user/{externalKey}

          요청 헤더

          헤더명설명
          x-ncp-apigw-timestamp1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타내며
          API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주
          x-ncp-apigw-timestamp:{Timestamp}
          x-ncp-apigw-api-keyAPIGW에서 발급받은 키 값
          x-ncp-apigw-api-key:{API Gateway API Key}
          x-ncp-iam-access-key네이버 클라우드 플랫폼 포털에서 발급받은 Access Key ID 값
          x-ncp-iam-access-key:{Account Access Key}
          x-ncp-apigw-signature-v1Access Key ID 값과 Secret Key로 암호화한 서명
          x-ncp-apigw-signature-v1:{API Gateway Signature}
          Content-TypeRequest body content type을 application/json으로 지정
          Content-Type: application/json

          요청 Path 파라미터

          파라미터타입크기필수 여부설명
          companyIdString36Y연동키(CompanyId)
          Developers > 기본 설정 > 연동키
          externalKeyString36Y구성원 외부키

          요청 Body 파라미터

          파라미터타입크기필수 여부설명
          nameString100Y기본이름
          i18nNamesMapN이름 다국어 Map<Locale, String> i18nNames
          deptExternalKeyString36N부서 외부키
          gradeExternalKeyString100N직급 외부키
          positionExternalKeyString100N직책 외부키
          emailAddrString100Y업무메일(로그인 ID)
          telNoString30N전화번호
          cphNoString100N휴대폰번호
          localeTypeCdStringN로캘 정보
          tmznTypeCdStringN타임존 정보

          요청 예시

          POST https://workbox.apigw.ntruss.com/workbox/workbox/openapi/v1/organization/company/578c7009-bdad-4493-9835-72302cf988c6/emp/EX00001

POST /openapi/v1/organization/company/578c7009-bdad-4493-9835-72302cf988c6/emp/EX00001
HOST: workbox.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-v1: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=

{
    "deptExternalKey": "00002",
    "emailAddr": "gildong@sample.co.kr",
    "name": "홍길동",
    "i18nNames": {
            "ko_KR": "홍길동",
            "en_US": "gildong"
        },
    "gradeExternalKey" : "grade001",
    "telNo" :"0317841111",
    "cphNo" : "01012341234",
    "localeTypeCd":"ko_KR",
    "tmznTypeCd" : "Asia/Seoul",
    "positionExternalKey" : "pos001"
}

          응답 예시

          HTTP/1.1 201 OK
Server: nginx
Date: Wed, 12 Sep 2018 10:18:11 GMT
Content-Type: application/json;charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
Access-Control-Allow-Origin: *
x-ncp-trace-id: 68d1o68pm4cr63gc3169gm4p34

{
    "deptExternalKey": "00002",
    "emailAddr": "gildong@sample.co.kr",
    "name": "홍길동",
    "i18nNames": {
            "ko_KR": "홍길동",
            "en_US": "gildong"
        },
    "gradeExternalKey" : "grade001",
    "telNo" :"0317841111",
    "cphNo" : "01012341234",
    "localeTypeCd":"ko_KR",
    "tmznTypeCd" : "Asia/Seoul",
    "positionExternalKey" : "pos001"
}

          수정 API

          구성원 정보를 수정한다.

          변경없는 정보도 함께 넘겨줘야 한다.(부분편집 안 됨)

          요청 URL

          PUT https://workbox.apigw.ntruss.com/workbox/workbox/openapi/v1/organization/company/{companyId}/user/{externalKey}

          요청 헤더

          헤더명설명
          x-ncp-apigw-timestamp1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타내며
          API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주
          x-ncp-apigw-timestamp:{Timestamp}
          x-ncp-apigw-api-keyAPIGW에서 발급받은 키 값
          x-ncp-apigw-api-key:{API Gateway API Key}
          x-ncp-iam-access-key네이버 클라우드 플랫폼 포털에서 발급받은 Access Key ID 값
          x-ncp-iam-access-key:{Account Access Key}
          x-ncp-apigw-signature-v1Access Key ID 값과 Secret Key로 암호화한 서명
          x-ncp-apigw-signature-v1:{API Gateway Signature}
          Content-TypeRequest body content type을 application/json으로 지정
          Content-Type: application/json

          요청 Path 파라미터

          파라미터타입크기필수 여부설명
          companyIdString36Y연동키(CompanyId)
          Developers > 기본 설정 > 연동키
          externalKeyString36Y구성원 외부키

          요청 Body 파라미터

          파라미터타입크기필수 여부설명
          nameString100Y기본이름
          i18nNamesMapN이름 다국어 Map<Locale, String> i18nNames
          deptExternalKeyString36N부서 외부키
          gradeExternalKeyString100N직급 외부키
          positionExternalKeyString100N직책 외부키
          telNoString30N전화번호
          cphNoString100N휴대폰번호
          localeTypeCdStringN로캘 정보
          tmznTypeCdStringN타임존 정보

          요청 예시

          POST https://workbox.apigw.ntruss.com/workbox/workbox/openapi/v1/organization/company/578c7009-bdad-4493-9835-72302cf988c6/emp/EX00001

POST /openapi/v1/organization/company/578c7009-bdad-4493-9835-72302cf988c6/emp/EX00001
HOST: workbox.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-v1: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=

{
    "deptExternalKey": "00002",
    "name": "홍길동",
    "i18nNames": {
            "ko_KR": "홍길동",
            "en_US": "gildong"
        },
    "gradeExternalKey" : "grade001",
    "telNo" :"0317841111",
    "cphNo" : "01012341234",
    "positionExternalKey" : "pos001"
}

          응답 예시

          HTTP/1.1 200 OK
Server: nginx
Date: Wed, 12 Sep 2018 10:18:11 GMT
Content-Type: application/json;charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
Access-Control-Allow-Origin: *
x-ncp-trace-id: 68d1o68pm4cr63gc3169gm4p34

{
    "deptExternalKey": "00002",
    "name": "홍길동",
    "i18nNames": {
            "ko_KR": "홍길동",
            "en_US": "gildong"
        },
    "gradeExternalKey" : "grade001",
    "telNo" :"0317841111",
    "cphNo" : "01012341234",
    "positionExternalKey" : "pos001"
}

          삭제 API

          구성원 정보를 삭제한다.

          요청 URL

          DELETE https://workbox.apigw.ntruss.com/workbox/workbox/openapi/v1/organization/company/{companyId}/user/{externalKey}

          요청 헤더

          헤더명설명
          x-ncp-apigw-timestamp1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타내며
          API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주
          x-ncp-apigw-timestamp:{Timestamp}
          x-ncp-apigw-api-keyAPIGW에서 발급받은 키 값
          x-ncp-apigw-api-key:{API Gateway API Key}
          x-ncp-iam-access-key네이버 클라우드 플랫폼 포털에서 발급받은 Access Key ID 값
          x-ncp-iam-access-key:{Account Access Key}
          x-ncp-apigw-signature-v1Access Key ID 값과 Secret Key로 암호화한 서명
          x-ncp-apigw-signature-v1:{API Gateway Signature}
          Content-TypeRequest body content type을 application/json으로 지정
          Content-Type: application/json

          요청 Path 파라미터

          파라미터타입크기필수 여부설명
          companyIdString36Y연동키(CompanyId)
          Developers > 기본 설정 > 연동키
          externalKeyString36Y구성원 외부키

          응답

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

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

          지원하는 언어 코드

          로캘 코드설명
          ko_KR한국어
          ja_JP일본어
          zh_CN중국어(간체)
          zh_TW중국어(번체)
          en_US영어

          타임존 코드

          timeZone 코드설명
          Pacific/MidwayGMT-11:00(MidwayIsland, Samoa)
          Pacific/HonoluluGMT-10:00(Hawaii)
          Pacific/MarquesasGMT-09:30(Marquesas)
          America/AnchorageGMT-09:00(Alaska)
          America/Los_AngelesGMT-08:00(PacificTime)
          America/DenverGMT-07:00(MountainTime_US/Canada)
          America/ChicagoGMT-06:00(CentralTime_US/Canada)
          America/New_YorkGMT-05:00(EasternTime_US/Canada)
          America/CaracasGMT-04:30(Caracas)
          America/SantiagoGMT-04:00(Santiago)
          America/St_JohnsGMT-03:30(Newfoundland)
          America/Sao_PauloGMT-03:00(SaoPaulo)
          America/NoronhaGMT-02:00(Mid-Atlantic)
          Atlantic/AzoresGMT-01:00(Azores)
          Europe/LondonGMT+00:00(GreenwichMeanTime_London)
          Europe/BerlinGMT+01:00(Amsterdam,Berlin, Vienna)
          Europe/AthensGMT+02:00(Athens, Cairo)
          Asia/BaghdadGMT+03:00(Moscow, Baghdad)
          Asia/TehranGMT+03:30(Tehran)
          Asia/BakuGMT+04:00(Baku, Muscat)
          Asia/KarachiGMT+05:00(Karachi)
          Asia/ColomboGMT+05:30(NewDelhi,Mumbai, Colombo)
          Asia/KatmanduGMT+05:45(Katmandu)
          Asia/DhakaGMT+06:00(Astana, Dhaka)
          Asia/RangoonGMT+06:30(Rangoon)
          Asia/BangkokGMT+07:00(Bangkok, Hanoi,Jakarta)
          Asia/ShanghaiGMT+08:00(Beijing,Dalian, Singapore, Taiwan)
          Asia/SeoulGMT+09:00(Seoul)
          Asia/TokyoGMT+09:00(Tokyo, Fukuoka)
          Australia/DarwinGMT+09:30(Darwin,Adelaide)
          Australia/SydneyGMT+10:00(Guam,Canberra, Sydney)
          Australia/Lord_HoweGMT+10:30(LordHoweIsland)
          Pacific/NoumeaGMT+11:00(NewCaledonia)
          Pacific/NorfolkGMT+11:30(NorfolkIsland)
          Pacific/AucklandGMT+12:00(Auckland,Fiji)
          이 문서가 도움이 되었습니까?
          What's Next
          Change password!
          Changing your password will log you out immediately. Use the new password to log back in.
          Change profile
          Success!
          First name must have atleast 2 characters. Numbers and special characters are not allowed.
          Last name must have atleast 1 characters. Numbers and special characters are not allowed.
          Enter a valid email
          Enter a valid password
          Your profile has been successfully updated.
          Logout