インスピレーションと洞察から生成されました 5 ソースから

img6

img7

img8

img9

img10

img11

はじめに

  • Box APIを利用してあるフォルダ内のファイル一覧を取得するには、GETリクエストを以下に送信します: https://api.box.com/2.0/folders/:folder_id/items。

  • このAPIエンドポイントでは、ファイル、フォルダ、ウェブリンクなどのアイテムをリスト化できます。

  • フォルダIDをパスパラメータとして指定する必要があり、例としてルートフォルダはIDが0になります。

  • 認可ヘッダーには、Bearerに続けて有効なアクセストークンを渡す必要があります。

  • クエリパラメータとして、取得するアイテムのソート方法やフィルタリングを指定できます（例: 'sort=name'）。

APIエンドポイント [1]

  • エンドポイントURL: https://api.box.com/2.0/folders/:folder_id/items。

  • HTTPメソッド: GET。

  • フォルダーIDはパスパラメータとして含まれ、特定フォルダーの内容を取得します。

  • このエンドポイントへのアクセスには、Box APIの開発者登録と認証が必要です。

  • エンドポイントは上記URLを利用してフォルダのアイテムをリスト化するために利用されます。

認証方法 [2]

  • 認証にはBearerトークンが使用されます。

  • アクセストークンをHeaderに設定することで、APIに対する認証を行います。

  • APIにアクセスするには、事前にBoxの開発者コンソールでアプリを設定し、クライアントIDとシークレットを取得する必要があります。

  • トークンはOAuth2.0を利用して取得され、60分間有効です。

  • 認証設定を間違えると403 Forbiddenエラーになることがあります。

img6

フィルタリングとソート [1]

  • クエリパラメータで結果のソートを設定できます。可能な値は[id, name, date, size]です。

  • directionパラメータで並び替えの方向を指定できます。値はASC（昇順）もしくはDESC（降順）です。

  • 利用可能なfieldsパラメータには、Miniおよびmetadataが含まれます。

  • ソートとフィルタはAPIレスポンスのパフォーマンス最適化に役立ちます。

  • マーカー方式でのページネーションもサポートされ、次ページに進むためのmarkerパラメータが使用できます。

サンプルコード例 [1]

  • Python: items = client.folder(folder_id='22222').get_items(); for item in items: print(f'{item.type.capitalize()} {item.id} is named "{item.name}"')

  • Java: BoxFolder folder = new BoxFolder(api, "id"); for (BoxItem.Info itemInfo : folder) { if (itemInfo instanceof BoxFile.Info) { BoxFile.Info fileInfo = (BoxFile.Info) itemInfo; // Do something with the file. } }

  • cURL: curl -i -X GET "https://api.box.com/2.0/folders/0/items" -H "authorization: Bearer <ACCESS_TOKEN>"

  • .NET: BoxCollection<BoxItem> folderItems = await client.FoldersManager.GetFolderItemsMarkerBasedAsync("11111", 100);

  • Node.js: client.folders.getItems('12345', { fields: 'name', offset: 0, limit: 25 })

img6

img7

img8

エラーハンドリング [1]

  • 403 Forbidden: 認証が不十分の場合発生するエラー。

  • 404 Not Found: 存在しないフォルダIDを指定した場合に発生。

  • 401 Unauthorized: トークンの不正または期限切れに関連するエラー。

  • 429 Too Many Requests: APIリクエストの制限を超えた場合、このエラーが表示されます。

  • エラーメッセージは、問題を特定し修正するための手がかりを提供します。

関連動画

<br><br>

<div class="-md-ext-youtube-widget"> { "title": "BOX API \u30d5\u30a1\u30a4\u30eb\u30c0\u30a6\u30f3\u30ed\u30fc\u30c9\u30fb\u30a2\u30c3\u30d7\u30ed\u30fc\u30c9\u3010Uipath ...", "link": "https://www.youtube.com/watch?v=Qq7zL8QTmGw", "channel": { "name": ""}, "published_date": "", "length": "14:05" }</div>

<div class="-md-ext-youtube-widget"> { "title": "\u3055\u308f\u3063\u3066\u307f\u3088\u3046\uff01\u521d\u3081\u3066\u306eBox API", "link": "https://www.youtube.com/watch?v=6uug8sod9Eo", "channel": { "name": ""}, "published_date": "", "length": "47:34" }</div>