Content Open With - Box Dev Docs

We no longer support the OpenWith UI element for any new customers as of December 21, 2021.

The Box Content Open With UI Element allows developers to embed a dropdown to open content stored in box with a partner application, or locally on the desktop. The Element fetches information about enabled integrations using the Box API, and calls out to partner services. Users can then take action in these services, and the edited content will be automatically saved back to Box. The integrations included in the Open With Element are Google Suite, and Box Edit. Additional information on the Google Suite integration can be found on the Box Community site. Currently, the element only supports for authentication.

Installation

Box UI elements either through NPM or the Box CDN.

Box Edit

Box Edit requires additional setup in order to be integrated into a platform application. Box Edit uses the desktop application Box Tools in order to open content locally.

Requests must use a secure connection (from an https domain)
The application’s domain must be allowed by Box Tools. Instructions can be found . The ideal workflow is to bundle these steps within an installer that also installs Box Tools.
Safari requires a browser extension to connect to box tools. More details can be found here.

G Suite

A valid G Suite account is required in order to use the Box for G Suite integration. To connect a user’s G Suite and Box account, the external_app_user_id of the app user must be updated to be the email address associated with the user’s G Suite account. The external_app_user_id of an app user can be updated via the endpoint.

Setup

The Open With UI Element is intended to be used after allowing your application and enabling integrations for app users using Box API endpoints.

Activate application

The ‘Open With’ UI Element is available to any developer building with the Box Platform. To activate it for your instance, add the “Enable integrations” scope to your application in the developer console.

Once your application has been activated for API calls it will need to be reauthorized in your enterprise. The steps for performing these actions are available .

List available integrations

The first step to assigning an app integration to a user is to get the list of integrations that are available. This GET request can be made with the following cURL request.

curl -X GET https://api.box.com/2.0/app_integrations \
    -H 'Authorization: Bearer [ACCESS_TOKEN]'

{
  "next_marker": null,
  "entries": [
    { "type": "app_integration", "id": "10897" },
    { "type": "app_integration", "id": "1338" },
    { "type": "app_integration", "id": "13418" },
    { "type": "app_integration", "id": "3282" }
  ],
  "limit": 100
}

The app integration IDs are used to assign an integration to a given user.

Get a specific integration

To obtain additional information about a specific integration, based on ID, the following GET request may be made.

curl -X GET \
    https://api.box.com/2.0/app_integrations/[APP_INTEGRATION_ID] \
    -H 'Authorization: Bearer [ACCESS_TOKEN]'

{
  "type": "app_integration",
  "id": "10897",
  "app": {
    "type": "app",
    "id": "336417"
  },
  "name": "Edit with G Suite",
  "description": "Securely manage your Google Docs, Sheets and Slides in Box",
  "executable_item_types": [
    "file"
  ],
  "restricted_extensions": [
    "docx",
    "gdoc",
    "xlsx",
    "gsheet",
    "pptx",
    "gslides",
    "gslide"
  ],
  "scoped_to": "parent"
}

Add integration to user

To add an app integration to a valid app user, three pieces of information are required:

A valid Access Token.
The ID of the app user to be assigned the integration
The ID of the app integration to assign to the user

While the two previous requests to get app integration information can be done with any valid token including a valid developer token, adding and removing app integrations requires a valid service account’s access token. Using a developer token will produce a 404 Not Found error.

The following POST request can be made to assign an app integration to an app user:

curl -X POST https://api.box.com/2.0/app_integration_assignments \
    -H 'Authorization: Bearer [SERVICE_ACCOUNT_TOKEN]' \
    -d '{
      "assignee": {
        "type": "user",
        "id": "[APP_USER_ID]"
      },
      "app_integration": {
        "type": "app_integration",
        "id": "[APP_INTEGRATION_ID]"
      }
    }'

{
  "type": "app_integration_assignment",
  "id": "72048301",
  "assignee": {
    "type": "user",
    "id": "6084519920"
  },
  "app_integration": {
    "type": "app_integration",
    "id": "3282"
  }
}

The ID in the JSON response can be used to manage app integrations after assignment, and should be stored by the application.

Remove integration from user

To remove an app integration from an app user, the following request may be made with a valid service access token and the app integration assignment ID from the previous step.

curl -X DELETE https://api.box.com/2.0/app_integration_assignments/[APP_INTEGRATION_ASSIGNMENT_ID] \
    -H 'Authorization: Bearer [SERVICE_ACCOUNT_TOKEN]'

204 No Content

Sample HTML

<!DOCTYPE html>
<html lang="en-US">
  <head>
    <meta charset="utf-8" />
    <title>Box Content Open With Demo</title>

    <!-- Latest version of the open with css for your locale -->
    <link
      rel="stylesheet"
      href="https://cdn01.boxcdn.net/platform/elements/{VERSION}/en-US/openwith.css"
    />
  </head>
  <body>
    <div class="container" style="height:600px"></div>
    <!-- Latest version of the open with js for your locale -->
    <script src="https://cdn01.boxcdn.net/platform/elements/{VERSION}/en-US/openwith.js"></script>
    <script>
      var fileId = "123";
      var accessToken = "abc";
      var contentOpenWith = new Box.ContentOpenWith();
      contentOpenWith.show(fileId, accessToken, {
        container: ".container"
      });
    </script>
  </body>
</html>

Demo

Open With Example

Content Explorer + Open With Example

Access TokenThese demos may not fully function until you provide a valid access token under the JS tab of the demo. For the Open With element, you must provide a valid Access Token.

Authentication

The UI Elements are designed in an authentication agnostic way so whether you are using UI Elements for users who have Box accounts (Managed Users) or non-Box accounts (App Users), UI Elements should work out of the box. The reason for this is that UI Elements only expect a “token” to be passed in for authentication, and Box provides two different ways to generate tokens - OAuth and JWT.

Learn about selecting an authentication method

Scopes

To run integrations with downscoped tokens, you must include the item_execute_integration scope as well as the scope required by the specific integration you would like to use.

Google: item_readwrite on the parent folder
Adobe: root_readwrite
Box Edit: item_readwrite on the parent folder.
Box Edit Single File Collaboration: item_readwrite on the file.

More information on scopes can be found .

API

const { ContentOpenWith } = Box;
const contentOpenWith = new ContentOpenWith();

/**
 * Shows the content open with element.
 *
 * @param {string} fileId - The root file id
 * @param {string} accessToken - Box API access token
 * @param {Object} [options] - Options
 * @return {void}
 */
contentOpenWith.show(fileId, accessToken, options);

/**
 * Hides the content open with element, removes all event listeners,
 * and clears out the
 * HTML.
 *
 * @return {void}
 */
openWith.hide();

/**
 * Adds an event listener to the content open with element. Listeners should be added
 * before calling show() so no events are missed.
 *
 * @param {string} eventName - Name of the event
 * @param {Function} listener - Callback function
 * @return {void}
 */
contentOpenWith.addListener(eventName, listener);

/**
 * Removes an event listener from the content open with element.
 *
 * @param {string} eventName - Name of the event
 * @param {Function} listener - Callback function
 * @return {void}
 */
contentOpenWith.removeListener(eventName, listener);

/**
 * Removes all event listeners from the content open with element.
 *
 * @return {void}
 */
contentOpenWith.removeAllListeners();

Parameters

Parameter	Type	Description
`fileId`	String	Box File ID. This will be the ID of the file for which you would like to execute integrations.
`accessToken`	String	Box API access token to use. This should have read/write access to the folder above. The value passed in for the token is assumed to never expire while the explorer is visible.
`options`	Object	Optional options. See below for details. For example: `contentExplorer.show(FOLDER_ID, TOKEN, {canDelete: false})` would be used to hide the delete option.

Options

Parameter	Type	Description
`dropdownAlignment`	`left	right`	Determines the dropdown’s alignment to the open with button. The default is `right`.
`boxToolsName`	`String`	This string will replace the name of Box Tools in the “Install Box Tools to open this file on your desktop” message.
`boxToolsInstallUrl`	`String`	This URL will be used instead of the default Box installation instructions which are linked in the “Install Box Tools to open this file on your desktop” message.
`onExecute`	`Function`	A callback that executes when an integration invocation is attempted.
`onError`	`Function`	A callback that executes when an error occurs.
`requestInterceptor`	`Function`	Function to intercept requests. For an example see . Our underlying XHR library is `axios.js` and we follow a .
`responseInterceptor`	`Function`	Function to intercept responses. For an example see . Our underlying XHR library is `axios.js` and we follow a .

Currently the onError and onExecute events are subject to a known bug. We recommend using openWith.addListener('execute', callback) and openWith.addListener('error', callback) as a temporary workaround.

Events

Event Name	Event Data	Description
`execute`	Integration ID	Will be fired when an integration invocation is executed.
`error`	Error	Will be fired when an error occurs.

Documentation Index

​Installation

​Box Edit

​G Suite

​Setup

​Activate application

​List available integrations

​Get a specific integration

​Add integration to user

​Remove integration from user

​Sample HTML

​Demo

​Open With Example

​Content Explorer + Open With Example

​Authentication

Learn about selecting an authentication method

​Scopes

​API

​Parameters

​Options

​Events

Installation

Box Edit

G Suite

Setup

Activate application

List available integrations

Get a specific integration

Add integration to user

Remove integration from user

Sample HTML

Demo

Open With Example

Content Explorer + Open With Example

Authentication

Scopes

API

Parameters

Options

Events