> ## Documentation Index
> Fetch the complete documentation index at: https://developer.box.com/llms.txt
> Use this file to discover all available pages before exploring further.
> Boxの無料Developerアカウントにサインアップし、開発者トークンを生成して、最初のAPIコールを行います。
# クイックスタート
export const SignupCTA = ({children}) => {
return ;
};
export const Link = ({href, children, className, ...props}) => {
const localizedHref = localizeLink(href);
return
{children}
;
};
[Box](https://www.box.com)は、どこからでもコンテンツの保存、アクセス、コラボレーションが行える、クラウドベースのインテリジェントなコンテンツ管理およびファイル共有プラットフォームです。
## 無料アカウントへのサインアップ
無料のDeveloperアカウントを作成すると、開発者コンソール、API、AIユニットにアクセスできるようになり、各開発者向けガイドに沿って作業を進めるために必要なものがすべて揃います。
お使いのメールアドレスを確認し、Developerアカウントを有効にしてください。
## Boxにファイルをアップロードし、ルートフォルダ内のすべてのファイルのリストを取得する
[ファイルをアップロード](/reference/post-files-content)エンドポイントを使用すると、アップロードドメイン`https://upload.box.com/api/2.0/files/content`を通じて、Boxに1つのファイルをアップロードできます。
ファイルサイズの上限は50 MBです。ファイルがこれより大きい場合は、
すぐに使い始められるよう、構築済みのアプリケーションが用意されています。リクエストを認証するための開発者トークンを作成します。[開発者コンソール](https://cloud.app.box.com/developers/console)から構築済みアプリケーションに移動し、\[**アプリの詳細**] セクションを探します。\[**開発者トークン**] フィールドを見つけ、\[**開発者トークンの生成**] を選択して、トークンをコピーします。
開発者トークンは、生成から1時間後に期限切れになります。
アップロード用の請求書サンプルが用意されています。プロジェクトのルートフォルダを作成したら、
Pythonの仮想環境を作成してアクティブ化します。
```shell theme={null}
python3 -m venv .venv
source .venv/bin/activate
```
必ずPython SDKの最新版を使用してください。詳細については、
開発者トークンで`client`を取得します。
```python theme={null}
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を呼び出します。
```python theme={null}
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`コマンドは、ルートフォルダ内にあるすべてのファイルのリストを取得するものです。このスクリプトを実行してファイルをアップロードし、すべてのファイルのリストを取得します。
既存のプロジェクトでは引き続き`npm install box-node-sdk`を使用できます。このパッケージはまだサポートされています。
SDKをインポートします。
```javascript theme={null}
import BoxSDK from 'box/sdk'; // ESM
const BoxSDK = require('box/sdk'); // CommonJS
```
すぐに使い始められるよう、構築済みのアプリケーションが用意されています。リクエストを認証するための開発者トークンを作成します。[開発者コンソール](https://cloud.app.box.com/developers/console)から構築済みアプリケーションに移動し、\[**アプリの詳細**] セクションを探します。\[**開発者トークン**] フィールドを見つけ、\[**開発者トークンの生成**] を選択して、トークンをコピーします。
開発者トークンで`client`を取得します。
```javascript theme={null}
const { BoxClient, BoxDeveloperTokenAuth } = require('box/sdk');
const auth = new BoxDeveloperTokenAuth({ token: 'YOUR_DEVELOPER_TOKEN' });
const client = new BoxClient({ auth });
```
開発者トークンは、生成から1時間後に期限切れになります。
```javascript theme={null}
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`コマンドは、ルートフォルダ内にあるすべてのファイルのリストを取得するものです。このスクリプトを実行してファイルをアップロードし、すべてのファイルのリストを取得します。
開発者トークンは、生成から1時間後に期限切れになります。
開発者トークンで`client`を取得します。
```swift theme={null}
import BoxSdkGen
let auth = BoxDeveloperTokenAuth(token: "YOUR_DEVELOPER_TOKEN")
let client = BoxClient(auth: auth)
```
必要なパラメータを含むリクエスト本文を作成します。パラメータとして属性 (`name`および`parent id`) とファイルストリームを指定します。
```swift theme={null}
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)]")
}
}
}
```
`getFolderItems`コマンドは、ルートフォルダ内にあるすべてのファイルのリストを取得するものです。このスクリプトを実行してファイルをアップロードし、すべてのファイルのリストを取得します。
すぐに使い始められるよう、構築済みのアプリケーションが用意されています。リクエストを認証するための開発者トークンを作成します。[開発者コンソール](https://cloud.app.box.com/developers/console)から構築済みアプリケーションに移動し、\[**アプリの詳細**] セクションを探します。\[**開発者トークン**] フィールドを見つけ、\[**開発者トークンの生成**] を選択して、トークンをコピーします。
開発者トークンは、生成から1時間後に期限切れになります。
**Gradle**
`build.gradle`ファイルに以下の依存関係を追加して、Box Java SDKをインストールします。
```shell theme={null}
implementation 'com.box:box-java-sdk:10.9.0'
```
必ず最新バージョン番号のJava SDKを使用してください。詳細については、
**Maven**
以下をMaven依存関係に追加します。
```xml theme={null}
com.box
box-java-sdk
10.9.0
```
開発者トークンで`client`を取得します。
```java theme={null}
BoxDeveloperTokenAuth auth = new BoxDeveloperTokenAuth("YOUR_DEVELOPER_TOKEN");
BoxClient client = new BoxClient(auth);
```
**`new UploadFileRequestBody`**を**`client.getUploads().uploadFile`**に渡します。属性 (名前を表す**`UploadFileRequestBodyAttributesField`**とフォルダIDを表す**`UploadFileRequestBodyAttributesParentField`**) と、ファイルのバイトを表す**`InputStream`**を指定します。
```java theme={null}
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);
});
```
`getFolderItems`コマンドは、ルートフォルダ内にあるすべてのファイルのリストを取得するものです。このスクリプトを実行してファイルをアップロードし、すべてのファイルのリストを取得します。
**.NET Framework**
.NET Frameworkに.NET SDKをインストールするには、
開発者トークンは、生成から1時間後に期限切れになります。
**.NET Core**
.NET Coreフレームワークに.NET SDKをインストールするには、
これで、Boxに最初のファイルをアップロードし、ルートフォルダ内のすべてのファイルのリストを取得できました。
## ユースケース
Box Platformに適したユースケースかどうかがわからない場合には、以下を参考にしてください。以下のいずれかに該当する場合には、Box Platformが効果を発揮します。
* ユースケースの中核はコンテンツ
* プロセスにはコンテンツの移動が伴う
* ワークフローが[ウォーターフォール型の権限](https://docs.box.com/en/box-apps/box-apps-for-box-admins/box-apps-permissions#permissions)に準拠できる
* プロセスに自動化できる管理タスクが含まれている
お客様向けの一般的なソリューションには、以下のようなものがあります。
* マーケティング資産の管理
* ドキュメントの安全な保管庫
* 資産管理ポータル
* ユーザープロビジョニングに基づくフォルダの自動作成
* 機械学習を使用した関連メタデータの追加
* 組み込みの承認/拒否フローによるクレームレビュー
* セキュリティと監査のためのイベント監視
## 次のステップ
以下のリソースをご確認ください。
* [無料の開発者プランで利用できる機能](/platform/free-developer-plan)
* [認証方法](/guides/authentication/select): 利用可能なさまざまな認証方法を確認します。
* [Box CLI](/guides/cli): アプリケーションの作成に役立ちます。
* [Boxの用語集](/platform/box-glossary): Box Platformの主要な概念が解説されています。
* [変更ログ](/changelog/): 最新の変更内容を確認できます。
