ウェブリンクの共有リンクを取得

get

https://api.box.com/2.0

/web_links/:web_link_id

ウェブリンクの共有リンクの情報を取得します。

リクエスト

authorizationbearer [ACCESS_TOKEN]

content-typeapplication/json

パスパラメータ

web_link_id stringパス内必須

例12345

ウェブリンクのID。

クエリパラメータ

fields stringクエリ内必須

例shared_link

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

レスポンス

200application/jsonウェブリンク

追加の共有リンク情報を含むウェブリンクのBase版の表示を返します。

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

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

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

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

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

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

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

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

get

ウェブリンクの共有リンクを取得

このドキュメント内で一部のAPIを試せるようになりました。

ログイン

リクエストの例

cURL

curl -i -X GET "https://api.box.com/2.0/web_links/32423234?fields=shared_link" \
     -H "authorization: Bearer <ACCESS_TOKEN>"

Python

shared_link = client.web_link('12345').get().shared_link
url = shared_link['url']

レスポンスの例

{
  "id": "12345",
  "type": "web_link",
  "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,
      "can_edit": false
    }
  }
}