Box Developer Documentation
Log in

ファイルに共有リンクを追加

put
https://api.box.com/2.0
/files/:file_id/

ファイルに共有リンクを追加します。

Request

Bearer [ACCESS_TOKEN]
application/json

Path Parameters

stringin pathrequired
12345

ファイルを表す一意の識別子。

ファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLがhttps://*.app.box.com/files/123の場合、file_idは123です。

Query Parameters

stringin queryrequired
shared_link

この項目に返されるshared_linkフィールドを明示的にリクエストします。

Request Body

objectin body

ファイルに作成する共有リンクの設定。

共有リンクにデフォルト設定を使用するには、空のオブジェクト ({}) を使用します。

stringin bodyoptional
open

共有リンクのアクセスレベル。これは、リンクを知っているすべてのユーザー (open)、会社内のユーザーのみ (company)、ファイルに招待されたユーザーのみ (collaborators) のいずれかに制限できます。

設定しなかった場合、このフィールドは、デフォルトで、企業の管理者が指定したアクセスレベルになります。このデフォルトの設定で共有リンクを作成するには、{ "shared_link": {} }のように、accessフィールドを指定せずにshared_linkオブジェクトを渡します。

companyアクセスレベルは、有料アカウントのみで使用できます。

Value is one of open,company,collaborators

stringin bodyoptional
do-not-use-this-password

共有リンクへのアクセスに必要なパスワード。 パスワードをnullに設定するとパスワードが削除されます。

パスワードはaccessがopenに設定されている場合にのみ設定できます。

objectin body
booleanin bodyoptional
true

共有リンクからのファイルのダウンロードが許可されているかどうか。accessが、openまたはcompanyに設定されている場合にのみ設定できます。

string / date-timein bodyoptional
2012-12-12T10:53:43-08:00

この共有リンクの有効期限が切れる日時のタイムスタンプ。このフィールドを設定できるのは、有料アカウントを持つユーザーのみです。この値には、現在の日時より後の日時を指定する必要があります。

stringin bodyoptional
my-shared-link

共有リンクのURLで使用するカスタムバニティ名を定義します (例: https://app.box.com/v/my-shared-link)。

バニティURLは通常の共有リンクよりもかなり推測しやすいため、機密性の高いコンテンツを共有する場合は、カスタムURLを使用しないでください。

Response

application/jsonFile (Standard)

新しい共有リンクが追加されている、ファイルの基本レプリゼンテーションを返します。

application/jsonクライアントエラー

Authorizationヘッダーで指定されているアクセストークンが認識されないか、指定されていない場合に返されます。

application/jsonクライアントエラー

更新を完了するための権限がユーザーに不足している場合に返されます。

application/jsonクライアントエラー

ファイルが見つからない場合、またはユーザーにファイルへのアクセス権限が与えられていない場合に返されます。

application/jsonクライアントエラー

file_idが認識されていない形式で指定されている場合に返されます。

application/jsonクライアントエラー

If-Matchヘッダーがファイルの現在のetag値と一致しない場合にエラーを返します。これは、ファイルが前回リクエストされたときから変更されていることを示します。

application/jsonクライアントエラー

予期しないクライアントエラー。

put
ファイルに共有リンクを追加
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

cURL
curl -i -X PUT "https://api.box.com/2.0/files/32423234?fields=shared_link" \
     -H "Authorization: Bearer <ACCESS_TOKEN>" \
     -d '{
       "shared_link": {
         "access": "open",
         "password": "mypassword",
         "unshared_at": "2012-12-12T10:53:43-08:00",
         "permissions": {
           "can_download": false
         }
       }
     }'
Java
BoxFile file = new BoxFile(api, "id");
BoxSharedLink.Permissions permissions = new BoxSharedLink.Permissions();
permissions.setCanDownload(true);
permissions.setCanPreview(true);
Date unshareDate = new Date();
BoxSharedLink sharedLink = file.createSharedLink(BoxSharedLink.Access.OPEN, null, permissions);
Python
file_id = '11111'

url = client.file(file_id).get_shared_link(access='open', allow_download=False)
print('The file shared link URL is: {0}'.format(url))
Node
client.folders.update('12345', {
  shared_link: {
    access: client.accessLevels.COMPANY,
    permissions: {
      can_download: true
    }
  }
}).then(folder => {
  // ...
})

Response Example

{
  "id": "12345",
  "type": "file",
  "etag": "1",
  "shared_link": {
    "url": "https://app.box.com/s/kwio6b4ovt1264rnfbyqo1",
    "download_url": "https://app.box.com/shared/static/kwio6b4ovt1264rnfbyqo1.pdf",
    "vanity_url": null,
    "vanity_name": null,
    "effective_access": "open",
    "effective_permission": "can_download",
    "is_password_enabled": false,
    "unshared_at": "2020-09-21T10:34:41-07:00",
    "download_count": 0,
    "preview_count": 0,
    "access": "open",
    "permissions": {
      "can_preview": true,
      "can_download": true
    }
  }
}