Box: フォルダ共有リンク作成 (Box: Create Shared Link to Folder)
Box 上のフォルダにアクセスできる URL を作成します。有効期限の指定が無い場合は無期限で、パスワードの指定が無い場合はパスワード要求無しで作成します。
Configs:共通設定
  • 工程名
  • メモ
Configs
  • C1: OAuth2 設定 *
  • C2: 共有するフォルダ ID *#{EL}
  • C3: リンクの有効期限が格納されているデータ項目
  • C4: リンクのパスワードが格納されているデータ項目
  • C5: 共有リンクを保存するデータ項目 *
Script (click to open)

main();
function main(){
const folderId = configs.get("FolderId");

if (folderId === "" || folderId === null) {
throw "Folder ID is blank";
}
const dateItem = configs.get("unsharedAt");
const passwordItem = configs.get("DownloadPass");

let unsharedDate = null;
if (dateItem !== "" && dateItem !== null){
unsharedDate = engine.findDataByNumber(dateItem);
}

let password = "";
if (passwordItem !== "" && passwordItem !== null){
password = engine.findDataByNumber(passwordItem);
}

// get OAuth2 Setting
const oauth2 = configs.get("OAuth2");

// フォルダが既に共有リンク作成されているか調べる
const existingUrl = getFolderInformation(oauth2, folderId);

//フォルダに既に共有リンクがある場合はエラーにする 共有リンクが無い場合は作成する
if (existingUrl !== null){
throw `Shared link(${existingUrl.url}) was already created.`;
}
const sharedlinkUrl = createSharedLink(oauth2, folderId, unsharedDate, password);

const UrlData = configs.getObject( "DownloadUrlItem" );
if (UrlData !== null) {
engine.setData(UrlData,sharedlinkUrl);
}
}

/**
* Get Folder Information on Box フォルダが既に共有リンク作成されているか調べる
* @return {String} フォルダの共有リンクオブジェクト
*/
function getFolderInformation(oauth2, folderId) {
const url = `https://api.box.com/2.0/folders/${folderId}?fields=shared_link`;
const response = httpClient.begin()
.authSetting(oauth2)
.get(url);

const status = response.getStatusCode();
const responseTxt = response.getResponseAsString();
engine.log(`status: ${status}`)

if (status !== 200) {
engine.log(responseTxt);
throw "Failed to get folder information";
}
const jsonRes = JSON.parse(responseTxt);
return jsonRes.shared_link;
}

/**
* Create Shared Link to Folder on Box 共有リンク作成
* @return {String} フォルダの共有リンクURL
*/
function createSharedLink(oauth2, folderId, unsharedDate, password) {
let timezone = engine.getTimeZoneId();
if (timezone === "GMT"){
timezone += "+00:00";
}

let jsonBody = {};

jsonBody["shared_link"] = {"access": "open"};
if(unsharedDate !== null){
jsonBody["shared_link"]["unshared_at"] = unsharedDate.toString() + timezone.slice(3);
}
if(password !== "" && password !== null){
jsonBody["shared_link"]["password"] = password;
}

jsonBody["shared_link"]["permissions"] = {"can_download": true };

const url = `https://api.box.com/2.0/folders/${folderId}?fields=shared_link`;
const response = httpClient.begin()
.authSetting(oauth2)
.body(JSON.stringify(jsonBody), "application/json; charset=UTF-8")
.put(url);

const status = response.getStatusCode();
const responseTxt = response.getResponseAsString();
engine.log(`status: ${status}`)

if (status !== 200) {
engine.log(responseTxt);
throw "Failed to create Shared Link";
}
const jsonRes = JSON.parse(responseTxt);
return jsonRes.shared_link.url;
}

Notes

  • フォルダ ID は、URL に含まれています。 https:// {sub-domain}.app.box.com/folder/(Folder ID)
  • Box のリフレッシュトークンには、期限があります。期限を超えないよう、定期的に利用する必要があります。(Box: トークンおよびURLの有効期限)
  • 既に共有リンクが作成されているフォルダは、共有リンクの再設定はできません。

Capture

See also

Appendix

  • box-folder-link-create.xml (C) Questetra, Inc. (MIT License)
    • Professional をご利用であればファイルの内容を改変することでオリジナルのアドオンとして活用できます
%d人のブロガーが「いいね」をつけました。