For further questions about the new Box View or to start using the new Box View, please email us at firstname.lastname@example.org.
If you have any product issues that require support, please submit a question to our Developer Forum, submit a support ticket with Box (as "API/Developer Question/Issue"), or submit a Crocodoc support ticket.
API Documentation is available here: https://docs.box.com/docs/getting-started-with-new-box-view
API Documentation for using the Get Embed Link endpoint is available here: https://docs.box.com/reference#get-embed-link
You can also explore a demo application for our file preview and annotations capabilities here: https://previewexperience.herokuapp.com
What is Box View?
Box View is an API service that allows customers and developers to display high-fidelity, interactive viewers for documents, images, videos, 360 images and videos, 3D files and more in custom web and mobile applications. Using Box View, customers and developers can display nearly any file type in their app without having to build their own viewers.
Why is Box EOL’ing the legacy Box View?
Box is EOL’ing the legacy Box View product in an effort to consolidate disparate technologies and improve the underlying infrastructure of Box View to support continued innovation and performance enhancements.
What is the EOL date for the legacy Box View?
The EOL date for the legacy Box View and Crocodoc products is January 15th, 2018.
When will the new Box View be available?
The New Box View is currently available.
How long does a customer have to migrate to the new Box View from the time of purchase?
The official EOL Date or the end date of your current contract, whichever is later.
What are the principle differences between the legacy Box View and Crocodoc and the new Box View?
The principle differences between the legacy Box View and Crocodoc product and the new Box View are:
- Improved fidelity, font handling, language support, and load times for file renderings.
- Expanded on the file type support to include viewers for more than 120 different file types.
- Support for annotations. Annotations were available in the Crocodoc product, but not the legacy Box View.
- The ability to store all the content in Box. Previously, files were stored in a commodity cloud storage service. This allows customers and developers to take advantage of Box’s security capabilities.
How does the new Box View work?
To use the new Box View, you will need to enable the new Box Developer Console. Please follow the steps below to do so:
- Turn on our cookie switch for the new Box (which turns on our new Admin Console UI): https://box.com/on/allnewbox
- Enable the cookie switch for the new Box Developer Console by pasting this into your browser and hitting enter "cloud.app.box.com/cookieswitch/devcon/enable"
- Go to cloud.app.box.com/developers/console and log in through your Box Account.
To use new Box View, follow these steps:
- Create a new App Token Auth application through the new Developer Console
- Generate an App Token through the Developer Console
- Upload a file using the App Token and Upload API
- Retrieve a File Token using Token Exchange (optional)*
- Generate a Preview of the file using the App/File Token and Get Embed Link API
For more details, refer to the documentation page here: https://docs.box.com/docs/getting-started-with-new-box-view
Is there a tool for migrating from the legacy Box View to the new Box View? When is it available?
There are two types of migrations that take place for you to move onto the new Box View product: an application migration and a content migration.
An application migration requires changes to an application’s code in order to call the new Box View APIs instead of the Crocodoc/legacy Box View APIs. The structure of API calls is fairly similar and we will be providing step-by-step instructions for calling the new APIs. You will need to make the changes to the application’s code. For step-by-step instructions on how to integrate the new Box View into your application, please see our Getting Started Guide.
A content migration is a process of moving content from the cloud storage infrastructure (Amazon S3) into Box so that it can be used with the new Box View APIs. Only content that needs to be previewed using the new Box View needs to be migrated. You have two options for a content migration to the new Box View.
Self-Serve Migration: You can migrate files from Crocodoc/legacy Box View yourself by using Box’s public APIs in a two-step process. First, content can be downloaded from Crocodoc/legacy Box View using the Download API and then uploaded to the new Box View using the Upload API. Please note that you will need to map the file IDs in Crocodoc/legacy Box View to the new file IDs in the new Box View since the file IDs will not be valid in the new Box View APIs.
For Crocodoc Customers
Annotations migration is not supported from Crocodoc to new Box View, due to limitations of how annotations are built in Crocodoc, and the complexity of extracting the annotation geo-positions.
What file types are supported in the new Box View?
'as', 'as3', 'asm', 'bat', 'c', 'cc', 'cmake', 'cpp', 'cs', 'css', 'csv', 'cxx', 'diff', 'doc', 'docx', 'erb', 'gdoc', 'groovy', 'gsheet', 'h', 'haml', 'hh', 'htm', 'html', 'java', 'js', 'less', 'm', 'make', 'ml', 'mm', 'msg', 'ods', 'odt', 'odp', 'pdf', 'php', 'pl', 'ppt', 'pptx', 'properties', 'py', 'rb', 'rtf', 'sass', 'scala', 'scm', 'script', 'sh', 'sml', 'sql', 'txt', 'vi', 'vim', 'wpd', 'xls', 'xlsm', 'xlsx', 'xml', 'xsd', 'xsl', 'yaml'
'ai', 'bmp', 'gif', 'eps', 'jpeg', 'jpg', 'png', 'ps', 'psd', 'svg', 'tif', 'tiff', 'dcm', 'dicm', 'dicom', 'svs', 'tga'
'aac', 'aifc', 'aiff', 'amr', 'au', 'flac', 'm4a', 'mp3', 'ogg', 'ra', 'wav', 'wma'
'3g2', '3gp', 'avi', 'm2v', 'm2ts', 'm4v', 'mkv', 'mov', 'mp4', 'mpeg', 'mpg', 'ogg', 'mts', 'qt', 'wmv'
Which file types are not supported on mobile in the new Box View?
- All documents supported on web preview are supported on mobile browsers (iOS safari and Chrome).
- Write annotations is not supported on mobile browsers (read is).
- Mobile SDKs (for iOS and Android) do not support 360 Videos/Images, and 3D.
- Mobile SDKs (for iOS and Android) do not support annotations (both read and write)
What are annotations?
Annotations are mark up on a file rendering generated from the new Box View. Annotations allow end users to collaborate on a file rendering.
What types of annotations does the new Box View offer?
The new Box View offers two types of annotations: point comments and highlights. Point comments allow a user to click on a particular area in a file rendering and add a text comment, visible to other users. Highlights allow a user to place a transparent yellow overlay on text in a file rendering.
After uploading a file, how can my application get file representations, such as a PDF version or thumbnails?
The Box API Representations endpoint lets you get the digital assets created for files stored in Box. You can use this endpoint to get PDF, text, image, and thumbnail representations for a file.
Can I use the new Box View with storage providers other than Box?
Currently, the new Box View is only compatible with files that are stored in Box. You can delete the files from Box once you no longer need to display them. However, you would need to upload it again in order to generate the preview. For this reason, we recommend keeping the files stored in Box for at least as long as you want to be able to display them.
How do I fix the CORS error Box gives me when I try to embed a Box UI element?
To fix the CORS error, you have to whitelist each domain you want to show the UI element on. You can whitelist the domain on your application's configuration page within the Box developer console. If you have many subdomains that you want to use the UI element on, you can use a wildcard for the subdomain (https://*.domain.com).
How can I replace the Box logo that shows up on the UI element or the file preview generated using the Get Embed Link endpoint?
Custom branding can be enabled for customers on a paid plan. If you want custom branding enabled for your application, please file a support ticket.
How do I get annotations to show up on a file preview?
If you want to show annotations on a file preview, you have to set the showAnnotations parameter to true. You also have to make the request to the Get Embed Link endpoint using a token generated with JWT authorization instead of with an App Token.
How is the new Box View priced?
The new Box View is priced based on the number of API calls, total storage, and bandwidth that an application will require to upload, convert, and display files within an application. A conversion occurs when a file is uploaded via the API to Box and is prepared to be displayed in an app. A conversion happens only one time per file.
Customers will license appropriate levels of API calls, storage, and bandwidth to meet their use case. We estimate the resource allocation based on the number of files a customer estimates will be uploaded and converted each month. We offer volume discounts as customers purchase more API calls, storage, or bandwidth. Additional resources can be purchased a-la-carte depending on the customer's use case.
For example, if a customer estimates that they will be converting 250,000 documents per month, it will require 1,250,000 API calls, 110 GB of total storage, and 1.637 TB of bandwidth per month. These calculations are based on common patterns in our API usage. Once we have an estimate of the number of files they will be converting, we can generate a quote.
INPUT - Estimated Monthly Conversions: 250,000
Monthly API Calls: 1,250,000
Total Storage (TB): 0.110
Monthly Bandwidth (TB): 1.637
List Price Total: $3,297 per month
How is this different from the legacy Box View pricing?
The legacy Box View was priced based on the number of uploads, not API calls. When a file was uploaded, it was converted and HTML5 was returned to the developer via the API. The new Box View is priced on API calls, not based on the number of uploads. Each API call that the application makes will count towards the quota.
If I have an active legacy View contract and wish to migrate to new Box View, how will it work?
All customers who wish to migrate to new Box View can do so without additional charges until the end of their existing contract under the assumption that they are using the new service to transition over and that they would renew on the new Box View pricing once their existing contract ends. We will provide you with pricing for the new SKU before you start migrating.
All customers renewing on New Box View get automatically grandfathered into legacy Box View/Crocodoc until EOL.