ファイルのダウンロード

ファイルをダウンロードするには、取得するコンテンツが含まれるファイルのIDをGET /files/:id/contentに渡します。

curl -i -L -X GET "https://api.box.com/2.0/files/12345/content" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \

TypeScript Gen

const fs = require('fs');

const fileContent = await client.downloads.downloadFile('123456789');
const fileWriteStream = fs.createWriteStream('file.pdf');
fileContent.pipe(fileWriteStream);

Python Gen

client.downloads.download_file(uploaded_file.id)

.NET Gen

await client.Downloads.DownloadFileAsync(fileId: uploadedFile.Id);

Java

BoxFile file = new BoxFile(api, "id");
BoxFile.Info info = file.getInfo();

FileOutputStream stream = new FileOutputStream(info.getName());
file.download(stream);
stream.close();

Python

file_id = '11111'
file_content = client.file(file_id).content()

.NET

Stream fileContents = await client.FilesManager.DownloadStreamAsync(id: "11111");

Node

var fs = require('fs');
client.files.getReadStream('12345', null, function(error, stream) {

	if (error) {
		// handle error
	}

	// write the file to disk
	var output = fs.createWriteStream('/path/to/file');
	stream.pipe(output);
});

iOS

let url = FileManager.default.homeDirectoryForCurrentUser

let task: BoxDownloadTask = client.files.download(fileId: "11111", destinationURL: url) { (result: Result<Void, BoxSDKError>) in
    guard case .success = result else {
        print("Error downloading file")
        return
    }

    print("File downloaded successfully")
}

// To cancel download
if someConditionIsSatisfied {
    task.cancel()
}

SDKを使用しない場合、このAPIコールでは、HTTP 302 Foundステータスコードとともに、次のようなダウンロードURLへのリンクを含むlocationヘッダーが返されます。

https://dl.boxcloud.com/d/1/[long-random-string]/download

cURLで-Lフラグを使用することで、自動的にこのリダイレクトに従うことができます。

SDKでは、結果として、バイナリデータがダウンロードされます。APIでは、ダウンロードURLがlocationヘッダーを介して返されます。

また、SDKを介してダウンロードURLを取得することも可能です。

このダウンロードURLは、ファイルのダウンロードを許可するためにユーザーのブラウザに渡すことができますが、このURLが期限切れになると、その後でダウンロードするには再度リクエストする必要があります。

ファイルをダウンロードする準備がまだできていない場合は、クライアントがファイルをダウンロードできるようになるまでの秒数を示すretry-afterヘッダーが返されます。

このレスポンスは、ダウンロードリクエストの直前にファイルがアップロードされた場合に発生することがあります。

ファイルのダウンロード

ファイルのダウンロード

ダウンロードURL

ダウンロードURLの有効期限

ファイルの準備ができていない

関連するAPI

関連するガイド