Box

Introduction

Box is a cloud content management and file sharing platform designed for businesses and individuals to securely store, manage, and collaborate on files.

It offers features like document sharing, version control, and advanced security measures, including data encryption and compliance certifications. The platform integrates with popular applications enhancing workflow efficiency.

Box also supports automation, enabling users to create workflows for content management and approval processes.

You can find more details and the supported operations on Box | qibb Catalog.

How to get started with Box integration

Before you get started using Box integration please make sure that you have the needed permission for the operations. Here you can find Box API documentation.

1. You will need an Client ID, Client Secret and Enterprise ID (Subject ID) for authentication. Here you can find the documentation about the Client Credentials Grant authentication: https://developer.box.com/guides/authentication/client-credentials/

2. Once you have these credentials, you can use the /oauth2/token endpoint to obtain an Access Token, which can be used as a Bearer Token for authentication.

3. You can follow the steps below to get your credentials and configure Box environment:

   1. Create a new custom app and fetch the credentials:

      1. Log in to the Developer Console. Here you can find a documentation about how to setup an app: https://developer.box.com/guides/authentication/client-credentials/client-credentials-setup/

         

      2. Click on Create New App and select Custom App.

         

      3. Provide a name for your app and select a purpose. Then, click Next.

         

      4. In the Authentication Method section, choose Server Authentication (Client Credentials Grant) for server-to-server communication and click on Create App.

         

      5. After creating the app, navigate to the General Settings tab.

      6. Here, you will find your Enterprise ID under the App Info section. This ID will be used to authenticate your app.

         

      7. Redirect to Configuration to fetch your Client ID and Secret.

         

      8. Scroll down, select Generate user access token and click on Save. You can also configure the application scope on this page.

         

   2. Authorize your app in the Admin Console

      1. Redirect to Admin Console to authorize your app and click on Apps.

         

      2. Click on Custom Apps Manager, Add App and provide the Client ID generated in the previous steps.

         

      3. Click Authorize to grant your app the required permissions.

         

   3. Add service account as a collaborator to Box Folders
      Box uses a Service Account to perform actions via the API. To allow your app to interact with files and folders, you must add this service account as a collaborator on the necessary folders.

      1. Navigate back to your app settings in the Developer Console and locate your Service Account email address.

         

      2. Redirect to your Box storage, select a folder, click on Share and enter the service account's email address to invite it as a collaborator.

         

4. Go to qibb Workflow Editor, open Node Catalog in the right sidebar, and install Box node by clicking on the + button.

5. Drag Box Platform API and Box Auth nodes from the left sidebar to your workflow and connect them to build the workflow you need.

6. Enter your credentials in the Client ID, Client Password, Box Subject Type, Box Subject ID and Grant Type fields in the Box Auth node, select an operation in Box node and you can start using the integration!

   

Fetching Folder ID and File ID:
Some endpoints require the Folder ID or File ID. You can retrieve these IDs from the UI. After logging into your dashboard, navigate to the desired folder or file.

The ID will be visible in the address bar of your browser when you click on the folder or file.

Importing flow examples of a node

Once you've successfully installed a node from the qibb catalog, you can easily import example flows that showcase how the nodes can be used. These example flows are directly accessible within the Flow Editor and are designed to guide users with helpful hints, including how to configure mandatory parameters and credentials.

Here's how to import examples:

1. In the top right corner of the Flow Editor, click on the menu icon.

2. Select Import to open the Import Dialog.

3. Click on the Examples tab.

4. Choose an example from the list.

5. Confirm your selection by clicking on the Import button.

By following these steps, you are now ready to make basic API calls using the provided examples. For further exploration of what’s possible, you can find more complex examples in the Flow Catalog.