연동코드 v2

인쇄
공유
PDF

연동코드 v2

인쇄
공유
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

설명

고객사에서 사용하는 연동 코드 정보를 WORKPLACE에서 사용하기 위한 API 입니다.

요청 헤더 공통

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 사용

리스트 API

연동 코드 리스트를 가져옵니다.

요청 URL

GET https://workplace.apigw.ntruss.com/workflow/apigw/v2/company/{companyId}/interlocking-code/codes

요청 헤더 공통

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/workflow/apigw/v2/company/c1798784-9a47-4751-ab9f-b9629825ab93/interlocking-code/codes

GET /workflow/apigw/v2/company/c1798784-9a47-4751-ab9f-b9629825ab93/interlocking-code/codes
HOST: workplace.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp: 1505290625682
x-ncp-iam-access-key: D78BB444D6D3C84CA38A
x-ncp-apigw-signature-v2: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=

응답 예시

HTTP/1.1 200 OK
Server: nginx
Date: Wed, 12 Sep 2020 01: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

[
  {
    "codeIndex": 1,
    "codeKey": "vegetables",
    "codeName": {
      "defaultMessage": "채소",
      "messages": {
        "zh_CN": "蔬菜",
        "ja_JP": "野菜",
        "ko_KR": "채소",
        "zh_TW": "蔬菜",
        "en_US": "vegetables"
      }
    },
    "used": "N",
    "items": []
  },
  {
    "codeIndex": 2,
    "codeKey": "fruits",
    "codeName": {
      "defaultMessage": "과일",
      "messages": {
        "zh_CN": "水果",
        "ja_JP": "果物",
        "ko_KR": "과일",
        "zh_TW": "水果",
        "en_US": "fruits"
      }
    },
    "used": "Y",
    "items": []
  }
]

연동 코드 정보와 아이템 리스트

연동 코드 정보와 관련 아이템 리스트를 가져옵니다.

요청 URL

GET https://workplace.apigw.ntruss.com/workflow/apigw/v2/company/{companyId}/interlocking-code/codes/{codeKey}

요청 헤더

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 > 기본 설정 > 연동키
codeKey	String	30	Y	연동 코드 키

요청 예시

GET https://workplace.apigw.ntruss.com/workflow/apigw/v2/company/c1798784-9a47-4751-ab9f-b9629825ab93/interlocking-code/codes/vegetables

GET /workflow/apigw/v2/company/c1798784-9a47-4751-ab9f-b9629825ab93/interlocking-code/codes/vegetables
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=

응답 예시

HTTP/1.1 200 OK
Server: nginx
Date: Wed, 12 Sep 2020 01: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

{
    "codeIndex": 1,
    "codeKey": "vegetables",
    "codeName": {
      "defaultMessage": "채소",
      "messages": {
        "zh_CN": "蔬菜",
        "ja_JP": "野菜",
        "ko_KR": "채소",
        "zh_TW": "蔬菜",
        "en_US": "vegetables"
      }
    },
  "used": "N",
  "items": [
    {
      "itemId": "1",
      "itemValue": {
        "defaultMessage": "당근",
        "messages": {
           "zh_CN": "胡萝卜",
           "ja_JP": "ニンジン",
           "ko_KR": "채소",
           "zh_TW": "胡蘿蔔",
           "en_US": "carrot"
        }
      },
      "used": "N"
    },
    {
      "itemId": "2",
      "itemValue": {
        "defaultMessage": "양파",
        "messages": {
           "zh_CN": "洋葱",
           "ja_JP": "タマネギ",
           "ko_KR": "양파",
           "zh_TW": "洋蔥",
           "en_US": "onion"
        }
      },
      "used": "Y"
    },
    {
      "itemId": "3",
      "itemValue": {
        "defaultMessage": "마늘",
        "messages": {
           "zh_CN": "大蒜",
           "ja_JP": "ニンニク",
           "ko_KR": "마늘",
           "zh_TW": "大蒜",
           "en_US": "garlic"
        }
      },
      "used": "Y"
    },
    {
      "itemId": "4",
      "itemValue": {
        "defaultMessage": "상추",
        "messages": {
           "zh_CN": "生菜",
           "ja_JP": "レタス",
           "ko_KR": "상추",
           "zh_TW": "生菜",
           "en_US": "lettuce"
        }
      },
      "used": "Y"
    },
  ]
}

연동 코드 저장

연동 코드 저장합니다.

요청 URL

POST https://workplace.apigw.ntruss.com/workflow/apigw/v2/company/{companyId}/interlocking-code/codes

요청 헤더

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 > 기본 설정 > 연동키

요청 Body 파라미터

파라미터	타입	크기	필수 여부	설명
codeKey	String	30	Y	연동코드 키
codeName	i18nName		Y	코드명 다국어 값
used	String		Y	사용여부( Y: 사용, N: 사용하지 않음)

i18nName Type

파라미터	타입	크기	필수 여부	설명
defaultMessage	String	30	Y	연동코드명 기본 값
messages	Map		N	연동코드명 다국어 `Map<Locale, String> i18nName`

요청 예시

POST https://workplace.apigw.ntruss.com/workflow/apigw/v2/company/c1798784-9a47-4751-ab9f-b9629825ab93/interlocking-code/codes

POST /workflow/apigw/v2/company/c1798784-9a47-4751-ab9f-b9629825ab93/interlocking-code/codes
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=
{
  "codeKey": "fishes",
  "codeName": {
    "defaultMessage": "물고기",
    "messages": {
      "ko_KR": "물고기",
      "ja_JP": "魚",
      "zh_CN": "鱼儿",
      "zh_TW": "魚兒",
      "en_US": "fishes"
    }
  },
  "used": "Y"
}

응답 예시

HTTP/1.1 200 OK
Server: nginx
Date: Wed, 12 Sep 2020 01: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

{
  "codeIndex": 3,
  "codeKey": "fishes",
  "codeName": {
    "defaultMessage": "물고기",
    "messages": {
      "ko_KR": "물고기",
      "ja_JP": "魚",
      "zh_CN": "鱼儿",
      "zh_TW": "魚兒",
      "en_US": "fishes"
    }
  },
  "used": "Y",
  "items": []
}

응답

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

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

응답 예시

{
    "status": 400,
    "code": -4001,
    "errors": [],
    "message": "This is a duplicate login ID"
}

지원하는 언어 코드

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

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

What's Next

연동코드아이템 v2

설명
요청 헤더 공통
리스트 API
연동 코드 정보와 아이템 리스트
연동 코드 저장
응답
지원하는 언어 코드

태그

WORKPLACE