Box Connector v1.0
1. General Information
Box began as a simple service for storing, sharing, and syncing files among users and devices.
After logging in you will be directed to the below page.
2. Authentication
Client-side OAuth 2.0 is one of the easiest ways to authenticate a user for the Box API. It is an open standard designed to allow users to provide applications access to their data in other applications.
3. Developer App
To authenticate with Box, the user needs to create a developer application.
Go to the developer console
After clicking on Dev Console, it will redirect the user to the developer portal:
Click on Create New App and select app type based on the type of Integration:
Fill the relevant App detail here:
Adding webhooks is done from the created apps page:
Details like Developer Token creation, OAuth 2.0 Client ID / Client Secret, Redirect URIs, and application scopes can be accessed from the App’s Configuration page:
4. Connector Actions and Tests
Action Name / Method | Uploads: Upload file (POST) |
|---|---|
Action Description | Uploads: Upload file (POST)
|
Test Case | This action is used to upload new file
|
Request Body Name | Parameter |
| File |
Name |
|
Content Created At |
|
Content Modified At |
|
Parent |
|
Action Name / Method | Get File Information |
|---|---|
Action Description | Get file details |
Test Case | File information retrieved successfully
|
Request Body Name | Paramenter |
| File ID |
| If-none-match |
| Boxapi |
| X-rep-hints |
Action Name / Method | Download File |
|---|---|
Action Description | Download file |
Test Case | File data downloaded
|
Request Body Name | Paramenter |
| File ID |
| range |
5. Connection Settings and Configuration
Settings Parameters | Value | Description | Required (Y/N) | Default Value |
|---|---|---|---|---|
Connector | Box | Connector Name | Y | Box |
Host Name | https://api.box.com/2.0 | Endpoint required for performing CRUD | Y | https://api.box.com/2.0 |
Authentication | OAuth2 | Type of authentication | Y |
|
Client Id | {client_id} |
| Y |
|
Client Secret | {client_secret} |
| Y |
|
Token URL | https://api.box.com/oauth2/token |
| Y | https://api.box.com/oauth2/token |
Authorization Url | https://account.box.com/api/oauth2/authorize |
| Y | https://account.box.com/api/oauth2/authorize |
Scopes | root_readonly root_readwrite |
|
| root_readonly root_readwrite |
