WORKPLACE Summary

Summary

It provides an API that enables you to set departments, employees, job grades, job titles, and basic information in WORKPLACE.
It is done through the HTTP method POST/PUT/DELETE method call.

Common Attributes

Workplace URL

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

Request Header

• AUTHPARAMS request example

  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'
  

• Create signature

  • Use \n as new line character.
  • Create StringToSign matching the request, encrypt using SecretKey with HmacSHA256 algorithm, and encode using Base64.
  • This value is used for x-ncp-apigw-signature-v2.
  Caution

  The x-ncp-apigw-timestamp value of the request header and timestamp of StringToSign must be an identical value.

• Request examples

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;
}

Common Errors

Response status code example

Scope of error codes returned from status codes in the 400 range

In case of errors, the HTTP status code is returned to the 400 range, and the Body information is forwarded in the following format.

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