クイックスタート

Boxは、どこからでもコンテンツの保存、アクセス、コラボレーションが行える、クラウドベースのインテリジェントなコンテンツ管理およびファイル共有プラットフォームです。

無料アカウントへのサインアップ

お使いのメールアドレスを確認し、Developerアカウントを有効にしてください。

Boxにファイルをアップロードし、ルートフォルダ内のすべてのファイルのリストを取得する

ファイルをアップロードエンドポイントを使用すると、アップロードドメインhttps://upload.box.com/api/2.0/files/contentを通じて、Boxに1つのファイルをアップロードできます。

ファイルサイズの上限は50 MBです。ファイルがこれより大きい場合は、を使用してください。

すぐに使い始められるよう、クライアント資格情報許可 (CCG) 認証を使用する構築済みのアプリケーションが自動的に作成されます。このアプリは自動的に承認されるため、APIコールの実行前に管理者の承認を別途受ける必要はありません。リクエストを認証するための開発者トークンを作成します。開発者コンソールから構築済みアプリケーションに移動し、[アプリの詳細] セクションを探します。[開発者トークン] フィールドを見つけ、[開発者トークンの生成] を選択して、トークンをコピーします。

開発者トークンは、生成から1時間後に期限切れになります。

アップロード用の請求書サンプルが用意されています。プロジェクトのルートフォルダを作成したら、からサンプルをダウンロードし、フォルダに保存してください。

Python
Node.js
Swift
Java
.NET

Pythonの仮想環境を作成してアクティブ化します。

python3 -m venv .venv
source .venv/bin/activate

を使用して、次のコマンドを実行し、Box Python SDKをインストールします。

pip install "boxsdk>=10"

必ずPython SDKの最新版を使用してください。詳細については、を参照してください。

開発者トークンでclientを取得します。

from box_sdk_gen import BoxClient, BoxDeveloperTokenAuth, UploadFileAttributes, UploadFileAttributesParentField
import json

auth = BoxDeveloperTokenAuth(token="YOUR_DEVELOPER_TOKEN")
client = BoxClient(auth=auth)

本番環境のコードベースの場合には、必ず資格情報を.envファイルに保存したうえで、.gitignoreに.envを追加してください。

次に、以下のようにアップロードAPIを呼び出します。

with open("demo-invoice-20tax-2.pdf", "rb") as file_content_stream:
    uploaded_file = client.uploads.upload_file(
        UploadFileAttributes(
            name="demo-invoice-20tax-2.pdf",
            parent=UploadFileAttributesParentField(id="0"),
        ),
        file_content_stream,
    )

items = client.folders.get_folder_items("0")
print(json.dumps(items.to_dict(), indent=2))

get_folder_itemsコマンドは、ルートフォルダ内にあるすべてのファイルのリストを取得するものです。このスクリプトを実行してファイルをアップロードし、すべてのファイルのリストを取得します。

を使用して、次のコマンドを実行し、Box Node.js SDKをインストールします。boxパッケージはBox Node SDKとBox CLIを直接的な依存関係としてインストールします。Node.js 22以降が必要です。

npm install box

既存のプロジェクトでは引き続きnpm install box-node-sdkを使用できます。このパッケージはまだサポートされています。

SDKをインポートします。

import BoxSDK from 'box/sdk';  // ESM
const BoxSDK = require('box/sdk');  // CommonJS

すぐに使い始められるよう、構築済みのアプリケーションが用意されています。リクエストを認証するための開発者トークンを作成します。開発者コンソールから構築済みアプリケーションに移動し、[アプリの詳細] セクションを探します。[開発者トークン] フィールドを見つけ、[開発者トークンの生成] を選択して、トークンをコピーします。開発者トークンでclientを取得します。

const { BoxClient, BoxDeveloperTokenAuth } = require('box/sdk');
const auth = new BoxDeveloperTokenAuth({ token: 'YOUR_DEVELOPER_TOKEN' });
const client = new BoxClient({ auth });

開発者トークンは、生成から1時間後に期限切れになります。

const fs = require('fs');

const attrs = { name: 'demo-invoice-20tax-2.pdf', parent: { id: '0' } };
const body = {
  attributes: attrs,
  file: fs.createReadStream('demo-invoice-20tax-2.pdf'),
};
const files = await client.uploads.uploadFile(body);
const file = files.entries[0];
console.log(`File uploaded with id ${file.id}, name ${file.name}`);

const items = await client.folders.getFolderItems('0');
console.log(JSON.stringify(items, null, 2));

getFolderItemsコマンドは、ルートフォルダ内にあるすべてのファイルのリストを取得するものです。このスクリプトを実行してファイルをアップロードし、すべてのファイルのリストを取得します。

を使用して、次のコマンドを実行し、Box Swift SDKをインストールします。

swift package update

開発者トークンは、生成から1時間後に期限切れになります。

開発者トークンでclientを取得します。

import BoxSdkGen

let auth = BoxDeveloperTokenAuth(token: "YOUR_DEVELOPER_TOKEN")
let client = BoxClient(auth: auth)

必要なパラメータを含むリクエスト本文を作成します。パラメータとして属性 (nameおよびparent id) とファイルストリームを指定します。

guard let fileStream = InputStream(url: URL(fileURLWithPath: "demo-invoice-20tax-2.pdf")) else {
    fatalError("Could not read a file")
}

let requestBody = UploadFileRequestBody(
    attributes: UploadFileRequestBodyAttributesField(
        name: "demo-invoice-20tax-2.pdf",
        parent: UploadFileRequestBodyAttributesParentField(id: "0")
    ),
    file: fileStream
)

let files = try await client.uploads.uploadFile(requestBody: requestBody)

if let file = files.entries?[0] {
    print("File uploaded with id \(file.id), name \(file.name!)")
}

let items = try await client.folders.getFolderItems(folderId: "0")
if let entries = items.entries {
    for entry in entries {
        switch entry {
        case let .fileMini(file):
            print("file \(file.name!) [\(file.id)]")
        case let .folderMini(folder):
            print("folder \(folder.name!) [\(folder.id)]")
        case let .webLinkMini(webLink):
            print("webLink \(webLink.name!) [\(webLink.id)]")
        }
    }
}

開発者トークンは、生成から1時間後に期限切れになります。

Gradlebuild.gradleファイルに以下の依存関係を追加して、Box Java SDKをインストールします。

implementation 'com.box:box-java-sdk:10.9.0'

必ず最新バージョン番号のJava SDKを使用してください。詳細については、を参照してください。

Maven以下をMaven依存関係に追加します。

<dependency>
    <groupId>com.box</groupId>
    <artifactId>box-java-sdk</artifactId>
    <version>10.9.0</version>
</dependency>

開発者トークンでclientを取得します。

BoxDeveloperTokenAuth auth = new BoxDeveloperTokenAuth("YOUR_DEVELOPER_TOKEN");
BoxClient client = new BoxClient(auth);

new UploadFileRequestBodyをclient.getUploads().uploadFileに渡します。属性 (名前を表すUploadFileRequestBodyAttributesFieldとフォルダIDを表すUploadFileRequestBodyAttributesParentField) と、ファイルのバイトを表すInputStreamを指定します。

FileInputStream fileContentStream = new FileInputStream("demo-invoice-20tax-2.pdf");
client.getUploads().uploadFile(
    new UploadFileRequestBody(
        new UploadFileRequestBodyAttributesField(
            "demo-invoice-20tax-2.pdf",
            new UploadFileRequestBodyAttributesParentField("0")
        ),
        fileContentStream
    )
);

client.getFolders().getFolderItems("0").getEntries().forEach(item -> {
    System.out.println(item);
});

.NET Framework.NET Frameworkに.NET SDKをインストールするには、パッケージマネージャを使用して以下のコマンドを実行します。

PM> Install-Package Box.V2.Core

開発者トークンは、生成から1時間後に期限切れになります。

.NET Core.NET Coreフレームワークに.NET SDKをインストールするには、パッケージマネージャを使用して以下のコマンドを実行します。

PM> Install-Package Box.V2.Core

開発者トークンでclientを取得します。

using Box.Sdk.Gen;

var auth = new BoxDeveloperTokenAuth(token: "YOUR_DEVELOPER_TOKEN");
var client = new BoxClient(auth: auth);

new UploadFileRequestBodyを使用してclient.Uploads.UploadFileAsyncを待機します。UploadFileRequestBodyAttributesField (nameとparent id)、およびStream (例: File.OpenReadから)。

using var fileContentStream = File.OpenRead("demo-invoice-20tax-2.pdf");
var files = await client.Uploads.UploadFileAsync(
    requestBody: new UploadFileRequestBody(
        attributes: new UploadFileRequestBodyAttributesField(
            name: "demo-invoice-20tax-2.pdf",
            parent: new UploadFileRequestBodyAttributesParentField(id: "0")),
        file: fileContentStream));
var file = files.Entries[0];
Console.WriteLine($"File uploaded with id {file.Id}, name {file.Name}");

var items = await client.Folders.GetFolderItemsAsync(folderId: "0");
if (items.Entries != null)
{
    foreach (var item in items.Entries)
    {
        if (item.FileFull != null)
        {
            Console.WriteLine(item.FileFull.Name);
        }
        else if (item.FolderMini != null)
        {
            Console.WriteLine(item.FolderMini.Name);
        }
        else if (item.WebLink != null)
        {
            Console.WriteLine(item.WebLink.Name);
        }
    }
}

これで、Boxに最初のファイルをアップロードし、ルートフォルダ内のすべてのファイルのリストを取得できました。

ユースケース

Boxに適したユースケースかどうかがわからない場合には、以下を参考にしてください。以下のいずれかに該当する場合には、Boxが効果を発揮します。

ユースケースの中核はコンテンツ
プロセスにはコンテンツの移動が伴う
ワークフローがウォーターフォール型の権限に準拠できる
プロセスに自動化できる管理タスクが含まれている

お客様向けの一般的なソリューションには、以下のようなものがあります。

マーケティング資産の管理
ドキュメントの安全な保管庫
資産管理ポータル
ユーザープロビジョニングに基づくフォルダの自動作成
機械学習を使用した関連メタデータの追加
組み込みの承認/拒否フローによるクレームレビュー
セキュリティと監査のためのイベント監視

次のステップ

以下のリソースをご確認ください。

無料の開発者プランで利用できる機能
認証方法: 利用可能なさまざまな認証方法を確認します。
Box CLI: アプリケーションの作成に役立ちます。
Boxの用語集: Box for Developersの主要な概念が解説されています。
変更ログ: 最新の変更内容を確認できます。

はじめに

アプリケーションと統合

IDとアクセス

APIの利用

トラブルシューティング

コンテンツ

コラボレーション

メタデータと検索

イベントとWebhook

ユーザー

インテリジェントなワークフロー

電子サイン

セキュリティとコンプライアンス

クイックスタート

無料アカウントへのサインアップ

Boxにファイルをアップロードし、ルートフォルダ内のすべてのファイルのリストを取得する

ユースケース

次のステップ

​無料アカウントへのサインアップ

​Boxにファイルをアップロードし、ルートフォルダ内のすべてのファイルのリストを取得する

​ユースケース

​次のステップ

無料アカウントへのサインアップ

Boxにファイルをアップロードし、ルートフォルダ内のすべてのファイルのリストを取得する

ユースケース

次のステップ