.boxnoteファイルがBoxアカウント内に作成されます。
前提条件
始める前に、以下のものが準備されていることを確認してください。- ファイルのアップロード権限を持つBoxアカウント。
- Box開発者コンソールで構成された。
- 認証用の有効なアクセストークン (OAuth 2.0またはJWT)。
- メモが作成されるBox内のターゲットフォルダのID。
Box Notes APIでは、APIバージョン
2026.0が必要です。すべてのリクエストには、box-version: 2026.0ヘッダーを含める必要があります。手順1: アクセストークンを生成する
APIコールを認証するには、アクセストークンが必要です。 テスト用に開発者トークンを作成するには:- [開発者コンソール] > [Platformアプリ] に移動します。
- アプリの横のオプションメニューボタン ([…]) をクリックします。
- [開発者トークンを生成] を選択します。トークンが自動的にクリップボードにコピーされます。
手順2: ターゲットフォルダを特定する
新しいメモが作成されるフォルダのIDが必要です。フォルダIDを確認するには、以下の操作を行います。- Boxウェブアプリでそのフォルダを開きます。URL (
https://app.box.com/folder/123456789) の末尾の数値がフォルダIDです。 - あるいは、APIエンドポイントを使用します。
手順3: 最初のBox Noteを作成する
マークダウンコンテンツを指定したPOSTリクエストを/2.0/notes/convertエンドポイントに送信します。APIはマークダウンをBox Noteに変換し、指定されたフォルダにアップロードします。
201 Createdが返されます。
手順4: メモが作成されたことを確認する
返されたidを使用して、BoxファイルAPIからファイルのメタデータをすべて取得します。
.boxnoteファイルがあることを確認できます。
