Box 開発者プラットフォーム

API 変更ログ

2017-02-22 Breaking Changes to the Preview SDK

If you are using a version of the Preview SDK prior to v0.101.0, please upgrade to v0.101.0 or higher. We will be making breaking changes to the underlying API the Preview SDK uses to support more functionality. We will release this change on March 22, 2017.

2017-02-08 Updates to the Box Java SDK

We have released a major update to the Box Java SDK to support all endpoints of the Box Content API. The latest version of the Box Java SDK supports several new endpoints, adds new features, and fixes several bugs that were identified by developers. The SDK is available on Github here.

The Box Java SDK now supports all endpoints, including:

  • Legal Hold Policies
  • Legal Hold Policy Assignment
  • 保持ポリシー
  • メタデータ
  • メタデータテンプレート
  • グループ
  • 電子すかしの適用
  • Webhooks for File and Folder objects
  • Web リンク
  • コレクション
  • BoxGroupMembership for Paging
  • Device Pinning

The Box Java SDK also now supports features, including:

  • Token-based Authentication (also known as Transactional Authentication) to support Box View
  • The ability to pass a file's SHA1 when uploading new versions
  • Effective access for shared links
  • New Event Types in the BoxEvent class

You can access the SDK on Github here and read the release notes for the Box Java SDK v2.3.0 here.

2017-02-08 Updates to the Box Node.js SDK

We have released an update to the Box Node.js SDK to support all endpoints of the Box Content API. The SDK is available on Github here.

The Box Node.js SDK now supports all endpoints, including:

  • Legal Hold Policies
  • 保持ポリシー
  • Webhooks on File and Folder objects
  • 電子すかしの適用
  • タスク
  • ユーザー
  • Groups
    The latest release of the Box Node.js SDK is available on Github here.

2017-02-08 Updates to the Box .NET SDK and Support for .NET Core

we have released a major update to our .NET/C# SDK (also known as the Box Windows v2 SDK) to support all endpoints of the Box Content API. The latest version of the Box .NET/C# SDK supports several new endpoints, adds new features, and fixes several bugs that were identified by developers. Moreover, many developers in our community have requested support for .NET Core, which has also been added in this release. The SDK is available on Github here.

The new SDK supports new endpoints of the Box Content API, including:

  • File Versions
  • コレクション
  • Webhooks for File and Folder Objects
  • メタデータ
  • 電子すかしの適用
  • グループ
  • ユーザー
  • コメント
  • Task Assignment
  • イベント
  • Device Pinning
  • Weblinks
  • Shared Links
  • コラボレーション
  • 保持ポリシー
  • Legal Hold Policies
  • Legal Hold Policy Assignment

The .NET/C# SDK also supports new features, including:
Token-based Authentication (also known as Transactional Authentication) to support Box View
Auto-pagination

You can access the SDK on Github here.

2017-02-07 Shared Link in Endpoint Responses

We modified the response of our endpoints to return the Shared Link URL when the caller is authorized to view the Shared Link. This affected endpoints such as Get File's Info , Get Folder's Info, and Shared Items. Only users with the following permission levels will be able to access a Shared Link URL:

  • Co-owner
  • Editor
  • Viewer Uploader
  • Viewer

You can read more about Box permission levels on our Community Site here.

2017-02-02 File Preview Client Events Available Through Box Preview SDK

We added support for file preview client events to our Preview SDK. This feature lets you listen for events associated with a file preview, such as when a user zooms into an image, navigates to the next page of a presentation, or pauses a video. The full list of client events supported for each file type is available here.

2017-02-02 New CONTENT_ACCESS Event Type

We have added a new event type to the user events API and the enterprise events API called CONTENT_ACCESS.

A CONTENT_ACCESS event fires every time a representation of a file is accessed. This may refer to a representation being accessed for preview, prefetching or offline access.

2017-01-10 Change to 'Move User's Folder' Name Structure

We have made a change to the naming structure of the folder that is automatically created when performing a Delete & Transfer on a user in the Box Admin Console or when performing a Move User's Folder API call using the Box Content API.

Previously, this auto-created folder would have the following name structure: "[Deleted User's Name]'s Files & Folders". To aid customers using this folder as part of automated deprovisioning processes, we've added the deleted user's email address to this folder's name. The folder now has the following name structure: "[Deleted User's Email Address] - [Deleted User's Name]'s Files and Folders".

2017-01-03 Markdown File Viewer

We introduced a new file viewer for Markdown files for file previews generated via the Get Embed Link endpoint of the Box Content API.

2016-12-12 File Collaborations API

We have expanded the Collaboration object in the Box Content API to support file-level collaborations, allowing you to set and apply permissions for users or groups to individual files. Previously, collaborations could only be applied to folder objects.

You can learn more about using collaborations for files and folders in our API documentation.

2016-12-05 Improved File Viewers for Text, Code, and CSV File Types

We have introduced new file viewers for text, code, and CSV file types for web browsers for file previews generated via the Get Embed Link endpoint of the Box Content API. These new viewers dramatically improve the readability and overall appearance of these file types in an embedded viewing experience.

Text Files

Text file preview

Text file preview

Code Files

CSV Files

2016-11-14 User Events API の変更

We've added six new event types for the user events API under the "changes" stream type:

  • COLLAB_ADD_COLLABORATOR
  • COLLAB_ROLE_CHANGE
  • COLLAB_INVITE_COLLABORATOR
  • COLLAB_REMOVE_COLLABORATOR
  • GROUP_ADD_USER
  • GROUP_REMOVE_USER

これらのイベントには、「all」ストリームタイプからアクセスできますが、ユーザーイベント API の場合は、「changes」ストリームタイプでもアクセスできます。

2016-11-10 Watermarking API

Box Watermarking API が一般に利用できるようになりました。 Box Watermarking API を使用すると、半透過的なオーバーレイをアプリケーションのユーザーエクスペリエンスに表示されるレンダリングに適用し、ファイルに機密情報または権限情報が含まれていることを示すことができます。

電子すかしは、現在のビューアーのメールアドレスまたはユーザーID(ユーザーアカウントのタイプおよびビューアーがログインしているかどうかによって決まります)、およびファイルのコンテンツにアクセスした時間を表示します。 電子すかしは、テキストベースのドキュメント、プレゼンテーション、画像などのファイルに適用することも、フォルダに適用して、そのフォルダに含まれるすべてのファイルに電子すかしオーバーレイを適用することもできます。

Box Watermarking API は、すべての Developer、Enterprise、Elite の Box プランで使用できます。 Box Watermarking API は、Box管理対象のユーザーまたは App User が使用できます。

詳細については、当社のブログ投稿および API のドキュメントを参照してください。

2016-10-27 Webhooks v2 用の新しいイベントトリガー

webhooks v2 の 6 個の新しいイベントトリガーを追加しました。

  • FOLDER.TRASHED
  • COLLABORATION.CREATED
  • COLLABORATION.ACCEPTED
  • COLLABORATION.REJECTED
  • COLLABORATION.REMOVED
  • COLLABORATION.UPDATED

2016-10-14 Enterprise Events API の変更内容

11 月初旬、METADATA_INSTANCE_CREATE、METADATA_INSTANCE_UPDATE、および METADATA_INSTANCE_DELETE イベントタイプの「additional_details」JSON 応答オブジェクトに監査情報が戻されました。 監査情報には、操作タイプ、対象フィールド、対象フィールドの結果の値が含まれます。 JSON 応答の operationParams フィールドは、JSON パッチ構造(RFC6209)に従っています。

{
    "chunk_size": 5,
    "next_stream_position": "1152922979616062927",
    "entries": [
        {
            "source": {
                "item_type": "file",
                "item_id": "5009686173",
                "item_name": "platform.jpg",
                "parent": {
                    "type": "folder",
                    "name": "Imagine",
                    "id": "998943173"
                }
            },
            "created_by": {
                "type": "user",
                "id": "20276369",
                "name": "Marge",
                "login": "Marge@some.email.com"
            },
            "created_at": "2016-09-27T13:45:22-07:00",
            "event_id": "f8d6ddcf-e88b-4501-ad3d-5391aefa06d9",
            "event_type": "METADATA_INSTANCE_CREATE",
            "ip_address": "Unknown IP",
            "type": "event",
            "session_id": null,
            "additional_details": {
                "metadata": {
                    "type": "coolStuff-ff11f2c2-d54b-454d-b0c4-a31854500806",
                    "operationParams": "[]"
                },
                "version_id": "122070245"
            }
        },
        {
            "source": {
                "item_type": "file",
                "item_id": "5009686173",
                "item_name": "platform.jpg",
                "parent": {
                    "type": "folder",
                    "name": "Imagine",
                    "id": "998943173"
                }
            },
            "created_by": {
                "type": "user",
                "id": "20276369",
                "name": "Marge",
                "login": "Marge@some.email.com"
            },
            "created_at": "2016-09-27T13:45:47-07:00",
            "event_id": "a6c6109c-a7e5-41c0-9ffa-93c55c6a7532",
            "event_type": "METADATA_INSTANCE_UPDATE",
            "ip_address": "Unknown IP",
            "type": "event",
            "session_id": null,
            "additional_details": {
                "metadata": {
                    "type": "coolStuff-ff11f2c2-d54b-454d-b0c4-a31854500806",
                    "operationParams": "[{\"op\":\"add\",\"path\":\"\\/name\",\"value\":\"Platform Shoe\"}]"
                },
                "version_id": "122070245"
            }
        },
        {
            "source": {
                "item_type": "file",
                "item_id": "5009686173",
                "item_name": "platform.jpg",
                "parent": {
                    "type": "folder",
                    "name": "Imagine",
                    "id": "998943173"
                }
            },
            "created_by": {
                "type": "user",
                "id": "20276369",
                "name": "Marge",
                "login": "Marge@some.email.com"
            },
            "created_at": "2016-09-27T13:46:28-07:00",
            "event_id": "89c94b9d-b397-4e39-98e2-51fde1fc335c",
            "event_type": "METADATA_INSTANCE_UPDATE",
            "ip_address": "Unknown IP",
            "type": "event",
            "session_id": null,
            "additional_details": {
                "metadata": {
                    "type": "coolStuff-ff11f2c2-d54b-454d-b0c4-a31854500806",
                    "operationParams": "[{\"op\":\"add\",\"path\":\"\\/coolDescription\",\"value\":\"Lace-ups\"}]"
                },
                "version_id": "122070245"
            }
        },
        {
            "source": {
                "item_type": "file",
                "item_id": "5009686173",
                "item_name": "platform.jpg",
                "parent": {
                    "type": "folder",
                    "name": "Imagine",
                    "id": "998943173"
                }
            },
            "created_by": {
                "type": "user",
                "id": "20276369",
                "name": "Marge",
                "login": "Marge@some.email.com"
            },
            "created_at": "2016-09-27T13:46:46-07:00",
            "event_id": "a4fd1514-db29-4754-861b-9f932bad6dcc",
            "event_type": "METADATA_INSTANCE_UPDATE",
            "ip_address": "Unknown IP",
            "type": "event",
            "session_id": null,
            "additional_details": {
                "metadata": {
                    "type": "coolStuff-ff11f2c2-d54b-454d-b0c4-a31854500806",
                    "operationParams": "[{\"op\":\"test\",\"path\":\"\\/name\",\"value\":\"Platform Shoe\"},{\"op\":\"replace\",\"path\":\"\\/name\",\"value\":\"Fashion Shoe\"}]"
                },
                "version_id": "122070245"
            }
        },
        {
            "source": {
                "item_type": "file",
                "item_id": "5009686173",
                "item_name": "platform.jpg",
                "parent": {
                    "type": "folder",
                    "name": "Imagine",
                    "id": "998943173"
                }
            },
            "created_by": {
                "type": "user",
                "id": "20276369",
                "name": "Marge",
                "login": "Marge@some.email.com"
            },
            "created_at": "2016-09-27T13:46:55-07:00",
            "event_id": "fa26b848-05a6-4e47-b0a4-f2a2d2603a05",
            "event_type": "METADATA_INSTANCE_DELETE",
            "ip_address": "Unknown IP",
            "type": "event",
            "session_id": null,
            "additional_details": {
                "metadata": {
                    "type": "coolStuff-ff11f2c2-d54b-454d-b0c4-a31854500806"
                },
                "version_id": "122070245"
            }
        }
    ]
}

2016-09-21 Enterprise Events API の変更内容

項目関連イベント(UPLOAD、DOWNLOAD イベントなど)のサイズ属性が Enterprise Events API に追加されました。 新しい属性は additional_details 内で使用でき、項目のサイズをバイトで表します。

 {
      "source": {
        "item_type": "file",
        "item_id": "75012612274",
        "item_name": "sample.jpg",
        "parent": {
          "type": "folder",
          "name": "All Files",
          "id": "0"
        }
      },
      "created_by": {
        "type": "user",
        "id": "222853849",
        "name": "Joe Smith",
        "login": "jsmith@example.com"
      },
      "created_at": "2016-09-19T20:19:05-07:00",
      "event_id": "dbb79480-9c09-4c27-a0c7-5e530403129b",
      "event_type": "DOWNLOAD",
      "ip_address": "Unknown IP",
      "type": "event",
      "session_id": null,
      "additional_details": {
  "size": 629644,
        "shared_link_id": "r9cjcjnoqlds4d8lqj28hj8axivah72y",
        "ekm_id": "56847758-20e2-4538-aefb-9181313a0dcf",
        "version_id": "79419605034"
      }
    }

2016-09-16 User Events API の変更

11 月、User Events API の「changes」ストリームタイプに 6 つの新しいイベントが追加されます。

  • COLLAB_ADD_COLLABORATOR
  • COLLAB_ROLE_CHANGE
  • COLLAB_INVITE_COLLABORATOR
  • COLLAB_REMOVE_COLLABORATOR
  • GROUP_ADD_USER
  • GROUP_REMOVE_USER

これらのイベントには、現時点では User Events API の「all」ストリームタイプからアクセスできますが、今回の新リリースでは、「changes」ストリームタイプでもアクセスできるようになります。

2016-09-12 注釈をパブリックベータ版で使用可能に

注釈は、ユーザーがファイルプレビュー上で直接ファイルをマークアップできるようにする、新しいベータ機能です。 Box では 2 種類の注釈 (ハイライト注釈とポイント注釈)が提供されています。 注釈は、Get Embed Link エンドポイントから使用できます。 アプリの特定のプレビューで注釈を有効にするには、Get Embed Link エンドポイントで生成された URL の末尾に「?showAnnotations=true」パラメータを追加するだけです。

2016-09-08 Webhooks v2 GA

Webhooks v2 が一般に利用できるなりました。 Box API の Webhook v2 エンドポイントでは、Webhook の作成に使用できる GET、POST、PUT、DELETE メソッドの定義、通知をトリガーするイベントの定義、通信に使用する URL の設定、これらが不要になった場合の削除などを行います。 詳細については、こちらをご覧ください。

2016-09-08 サービスアカウント

Service Accounts are a secure and powerful way to connect your apps to Box Platform. This is a type of Box account that represents a custom application within an enterprise instance of Box and allows that application to make server-side calls to the Box APIs. You can define the capabilities of each individual Service Account dynamically, setting permissions such as uploading and managing content, managing users and groups, accessing events, or using premium features like Box Governance to set retention policies or apply legal holds. Find out more details here.

2016-09-08 新しい開発者コンソール

Box 開発者コンソールのユーザーエクスペリエンスと機能のオーバーホールを開始しました。 新しい機能には、新しい UI、アプリケーションの構成手順のガイド、サポートへのアクセスの簡素化、ドキュメントと通知が含まれます。 新しいエクスペリエンスを試すには、こちらをクリックしてください

2016-09-08 JavaScript Preview SDK

Javascript Preview SDK を使用すると、開発者は Box ファイルのプレビューを簡単にウェブアプリケーションに埋め込むことができます。 この SDK は、Box Content API を使用してファイルおよび変換済みファイル表現に関する情報を取得し、ファイルタイプに適したビューアーを選択して、必要な静的アセットとファイル表現を動的にロードし、最終的にプレビューをクライアント側にレンダリングします。 またこの SDK を使用すると、複数のファイルのプレビューを同一コンテナ内にロードして、これらのファイル間を移動するための矢印を表示することができます。

2016-08-19 ダウンロード用ドメインの分割を開始

「boxcloud.com」ダウンロードリンクで個別のサブドメインを使用するように変更されました。 この変更により、匿名ユーザーまたは無料の Box ユーザーによるダウンロードは「public.boxcloud.com」で処理され、有料のエンタープライズカスタマは「dl.boxcloud.com」で処理されるようになります。

2016-07-28 リーガルホールドエンドポイントが Box Governance の一環として利用可能に

リーガルホールドを Box Governance の一環として利用できるようになりました。 リーガルホールドにより、Governance のカスタマはコンテンツを所定の場所に保持して、訴訟に直面したときに電子情報開示(eDiscovery)プロセスを開始できるようになりました。 容易な管理、法的責任を制限するための支援、保持スケジュールとシームレスに連携し、最適な電子情報開示テクノロジとの統合を実現して、企業の資産保護を強化します。 詳細については、こちらを参照してください。

2016-07-28 オープンベータ版の Webhook v2 を公開

Webhook v2 がオープンベータ版として公開されました。 Webhook v2 では、開発者はすべて API を使用して、プログラムによって Box 内のアクティビティを監視し、アクティビティに基づいてアクションをトリガーできます。詳細については、こちらをご覧ください。

2016-07-22 現在、ベータで注釈が使用可能

現在、ベータで注釈が使用可能です。 注釈を使用すると、Box API の Get Embed Link で取得したファイルのプレビューに、ユーザーはポイントアンドクリックでコメントまたはテキストの強調表示を追加できます。注釈は、API で生成されたファイルプレビューのみで使用可能であり、現在、Box アプリではサポートされていません。 ベータの詳細については、ここをクリックしてください。

2016-07-14 現在、Box Node.js SDK が使用可能

現在、Box Node.js SDK は Github および npm で使用できます。 Box Node.js SDK は、Box の正式にサポートされている SDK です。これは、当社は新しい機能としてこの SDK の更新を継続し、機能が Box API で使用可能になることを意味します。

2016-07-14 Get Embed Link エンドポイントを使用したファイルプレビューでの電子すかし

現在、電子すかしは、API の Get Embed Link エンドポイントで生成されたファイルプレビューに表示されます。電子すかしは、Box ウェブアプリを使用して構成できます。電子すかしは、App Users ではなく、Box ユーザーアカウントに対してのみ表示されます。

詳細については、Watermarking サポートページを参照してください。

2016/07/05 - 標準的なユーザーイベントの新しいイベントタイプ

グループでユーザーが追加または削除されたことを示す標準的なユーザーイベントとして GROUP_ADD_USERGROUP_REMOVE_USER を追加

2016-06-28 現在、開発者コンソールで使用できる CORS 設定

開発者は現在、API へ CORS 要求を出せる送信元のカンマ区切りリストを、開発者コンソールから入力できます。 これまで開発者は、これらの送信元を追加するためにサポートに連絡する必要がありました。 CORS(Cross-origin resource sharing)は、リソースが本来存在しているドメインとは別のドメインから、ウェブページ上のリソースを要求できるようにするメカニズムです。

2016-06-08 Enterprise Events API の変更内容

当社は先日、Enterprise Events API を通じてレポートされるイベントに新しい属性を追加しました。イベントに、3 つの追加属性が表示されるようになりました。

  • service_id - Box API 上に構築されたアプリケーションを表す一意の永続的な識別子。 単一のアプリケーションにわたるイベントの集計に使用できます。
  • service_name - 開発者が Box 開発者コンソールで更新できる、アプリケーションを表す一意の非永続的な名前。
  • ekm_id - Box Keysafe を使用しているお客様がイベントを HSM ログに関連付けるための一意の永続的な ID。

次に、イベントの例を示します。

    {
      "source": {
        "item_type": "file",
        "item_id": "40811830645",
        "item_name": "tigers.jpeg",
        "parent": {
          "type": "folder",
          "name": "All Files",
          "id": "0"
        }
      },
      "created_by": {
        "type": "user",
        "id": "233213282",
        "name": "Joe Smith",
        "login": "joe@email.com"
      },
      "created_at": "2016-05-31T14:03:01-07:00",
      "event_id": "0cb8893d-e314-4f82-b257-f462b4c477f4",
      "event_type": "DOWNLOAD",
      "ip_address": "Unknown IP",
      "type": "event",
      "session_id": null,
      "additional_details": {
        "ekm_id": "8b4364bb-997c-4448-a8bd-5cb6d219ef27",
        "version_id": "40922128381",
        "service_id": "13176",
        "service_name": "My Application"
      }
    }

2016-06-08 Get Embed Link API への変更通知

当社は 7 月 1 日(フリープランのユーザーの場合)および 8 月 1 日(有料プランのユーザーの場合)に、Get Embed Link API から生成されるプレビュー環境に対して、次の変更内容をリリースします。

  • プレビューヘッダーバーに Box ブランディングを追加します。 エンタープライズプランのお客様は、カスタムブランディングのオプションを利用できます。 詳細については、Box カスタマーサクセスマネージャーまでお問い合わせください。
  • プレビューヘッダーバーにダウンロードボタンと印刷ボタンを追加。 これらのボタンは権限ベースであるため、ドキュメントをダウンロードする権限を持つユーザーにのみ表示されます。 印刷ボタンは、ドキュメントファイルタイプでのみ表示されます。

これらの変更についてご質問がある場合は、カスタマーサクセスマネージャーまでお問い合わせいただくか、content-experience-feedback@box.com までメールをお送りください。

2016-05-18 - Enterprise イベントの新しいイベントタイプ

Box 内のファイルでウィルスが検出されたことを示す FILE_MARKED_MALICIOUS をエンタープライズイベントとして追加

2016-03-26 - Enterprise イベント用の新しいイベントタイプと属性

Box での 1 つのファイルのコラボレーションをサポートするために、2 つのイベントタイプを導入しました: GROUP_ADD_FILEGROUP_REMOVE_FILE 。既存のイベントタイプも、属性名が更新されています。 Enterprise Events API を使用した開発者は、これにより、COLLABORATION_ACCEPTCOLLABORATION_ROLE_CHANGEUPDATE_COLLABORATION_EXPIRATIONCOLLABORATION_REMOVECOLLABORATION_INVITECOLLABORATION_EXPIRATION など、コラボレーションイベントタイプに影響があります。 現在のフォルダレベルのコラボレーションイベントは変わりませんが、ファイルに対するコラボレーションは、folder_idfolder_name ではなく file_idfile_name をソース属性として持ちます。

2016-02-19 - Box Content API を使用した HD ビデオとパノラマ写真の埋め込み

当社は、開発者が Box Content API を使用して HD ビデオやパノラマ写真をアプリに埋め込むことができるパブリックベータを公開しています。

API 変更ログ