Create or Update Shared Link

ガイド 共有リンク Create or Update Shared Link

Create or Update Shared Link

Shared links may be created or directly for file, folder, or web link resources to generate a read-only URL to permit users with the appropriate access level to view the content.

You may only have one active shared link for a file, folder, or web link at any time.

共有リンクの作成には少なくとも以下の情報が必要です。

  • The type of resource, either a file, folder, or web link.
  • リソースのID。

共有リンクの作成時には、以下の情報もオプションとして指定できます。

  • 以下のいずれかのアクセスレベル。

    • open: パブリックな共有リンク。リンクを知っている全員がアクセスできます。
    • company: 会社内のすべてのユーザーがアクセスできます。
    • collaborators: コンテンツのコラボレーションに参加しているすべてのユーザーがアクセスできます。
  • 有効期限。その日時から、共有リンクが自動的に無効になります。
  • リソースへのアクセスに必要なパスワード。

共有リンクの作成時にアクセスレベルを指定しなかった場合、会社の管理者が指定したデフォルトのアクセスレベルが使用されます。

ファイルの共有リンクを作成するには、ファイルのIDとオプションの共有リンクパラメータを指定します。

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
         }
       }
     }'
Python
file_id = '11111'

url = client.file(file_id).get_shared_link(access='open', allow_download=False)
print(f'The file shared link URL is: {url}')
Node
client.files.update('12345', {
  shared_link: {
    access: "open",
    password: "do-not-use-this-password", 
    unshared_at: "2022-12-12T10:53:43-08:00",
    vanity_name: "my-shared-link",
    permissions: {
	  can_view: true,
	  can_download: true,
	  can_edit: true
    }
  }
}).then(file => {
  // ...
})

フォルダの共有リンクを作成するには、フォルダのIDとオプションの共有リンクパラメータを指定します。

cURL
curl -i -X PUT "https://api.box.com/2.0/folders/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
         }
       }
     }'
Python
folder_id = '11111'

url = client.folder(folder_id).get_shared_link(access='open', allow_download=False)
print(f'The folder shared link URL is: {url}')
Node
client.folders.update('12345', {
  shared_link: {
    access: "open",
    password: "do-not-use-this-password",
    unshared_at: "2022-12-12T10:53:43-08:00",
    vanity_name: "my-shared-link",
    permissions: {
      can_view: true,
      can_download: true
    }
  }
}).then(folder => {
  // ...
})

To create a shared link on a web link, specify the ID of the web link with any optional shared link parameters.

cURL
curl -i -X PUT "https://api.box.com/2.0/web_links/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
         }
       }
     }'
Python
url = client.web_link('12345').get_shared_link(access='open')
print(f'The web link shared link URL is: {url}')