WORKPLACE 개요

개요

WORKPLACE의 조직/사원/직급/직책/기본정보 등을 설정할 수 있는 API를 제공합니다.
HTTP 방식의 POST/PUT/DELETE 메서드 호출을 통해서 이루어집니다.

공통 설정

Workplace URL

POST/PUT/DELETE
https://workplace.apigw.ntruss.com/organization/apigw/v1

요청 헤더

• AUTHPARAMS 요청 예시

  curl -i -X GET \
  -H "x-ncp-apigw-timestamp:1505290625682" \
  -H "x-ncp-iam-access-key:D78BB444D6D3C84CA38D" \
  -H "x-ncp-apigw-signature-v2:WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEa=" \  'https://workplace.apigw.ntruss.com/organization/apigw/v2/company/c1798784-9a47-4751-ab9f-b9629825ab93/department?offset=0&limit=10'
  

• Signature 생성하기

  • 개행문자는 \n을 사용합니다.
  • 요청에 맞게 StringToSign을 생성하고 SecretKey로 HmacSHA256 알고리즘으로 암호화한 후 Base64로 인코딩합니다.
  • 이 값을 x-ncp-apigw-signature-v2로 사용합니다.
  주의

  요청 헤더의 x-ncp-apigw-timestamp 값과 StringToSign의 timestamp는 반드시 같은 값이여야 합니다.

• 요청 예시

public String makeSignature() {
	String space = " ";					// one space
	String newLine = "\n";					// new line
	String method = "GET";					// method
	String url = "/organization/apigw/v2/company/c1798784-9a47-4751-ab9f-b9629825ab93/department?offset=0&limit=10";	// url (include query string)
	String timestamp = "{timestamp}";			// current timestamp (epoch)
	String accessKey = "{accessKey}";			// access key id (from portal or Sub Account)
	String secretKey = "{secretKey}";

	String message = new StringBuilder()
		.append(method)
		.append(space)
		.append(url)
		.append(newLine)
		.append(timestamp)
		.append(newLine)
		.append(accessKey)
		.toString();

	SecretKeySpec signingKey = new SecretKeySpec(secretKey.getBytes("UTF-8"), "HmacSHA256");
	Mac mac = Mac.getInstance("HmacSHA256");
	mac.init(signingKey);

	byte[] rawHmac = mac.doFinal(message.getBytes("UTF-8"));
	String encodeBase64String = Base64.encodeBase64String(rawHmac);

  return encodeBase64String;
}

공통 오류

응답 상태코드 예시

400번대 상태코드에서 리턴되는 오류코드 범위

오류 발생시 HTTP 상태 코드가 400번대로 리턴되고, 다음과 같은 형식의 Body 정보가 전달됩니다.

{
	"status": 400,
	"code": -1015,
	"message": "emp not found",
	"errors": [],
}