WORKBOX概要

概要

WORKBOXの組織/構成員/職級/役職/基本情報などを設定できるAPIを提供します。
HTTP方式のPOST/PUT/DELETEメソッド呼び出しを通じて行われます。

共通設定

WORKBOX URL

POST/PUT/DELETE
https://workbox.apigw.ntruss.com/workbox/workbox/openapi/v1

リクエストヘッダ

認証ヘッダ

WORKBOX APIはNaverクラウドプラットフォームAPI Gatewayを通じて提供されるし、API Gatewayに登録されているAPIを使うためには3つの認証キー(Access Key ID, Secret Key, API Key)の発行が必要です。

詳しい内容についてはNAVER Cloud Platform APIをご参考ください。

• 認証キーの作成
  • Naverクラウドプラットフォームポータルのマイページ > アカウント管理 > 認証キー管理メニューで新規API認証キー作成をクリックしてAccess Key ID、Secret Keyを作成します。
  • もし、Access Key ID、Secret Keyがある場合は該当キーを使います。

リクエスト例示

curl -i -X GET \
   -H "x-ncp-apigw-timestamp:1505290625682" \
   -H "x-ncp-apigw-api-key:cstWXuw4wqp1EfuqDwZeMz5fh0epaTykRRRuy5Ra" \
   -H "x-ncp-iam-access-key:D78BB444D6D3C84CA38A" \
   -H "x-ncp-apigw-signature-v1:WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=" \
 'https://workplageg.apigw.ntruss.com//calendar/v1/holiday?year=2018&locale=ko_KR&companyId=e721e2da-29ee-4782-9672-3d2b150ac1a6'

• Signature作成(改行文字は\nを使用)

  • リクエストにあわせてStringToSignを作成してからSecretKeyを用いてHmacSHA256アルゴリズムで暗号化した後、Base64でエンコードします。
  • この値を x-ncp-apigw-signature-v1で使います。

• サンプルコード

public String makeSignature() {
    String space = " ";  // 空白
    String newLine = "\n";  // 改行
    String method = "GET";  // HTTPメソッド
    String url = "/calendar/v1/holiday?year=2018&locale=ko_KR&companyId=e721e2da-29ee-4782-9672-3d2b150ac1a6";  // ドメインを除外した"/"以下の全体url (クエリストリングを含む)
    String timestamp = "{timestamp}";  // 現在のタイムスタンプ (epoch, millisecond)
    String apiKey = "{apiKey}";  // api key (from api gateway)
    String accessKey = "{accessKey}";  // access key id (from portal or Sub Account)
    String secretKey = "{secretKey}";  // secret key (from portal or Sub Account)

    String message = new StringBuilder()
        .append(method)
        .append(space)
        .append(url)
        .append(newLine)
        .append(timestamp)
        .append(newLine)
        .append(apiKey)
        .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;

}

共通エラー

HTTPステータスコードでリターンされ、Body情報で伝達する。

{
    "resultCode": "E901",
    "resultMessage": "Please check if API is used in the developer console."
}