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": [],
}