Quick Import

Page history last edited by jeremy@... 1 wk ago

Description

 

The OpenBox API provides plenty of flexibility to create a custom application, but for those who want a quick and easy integration, we provide Quick Import.  This method enables you to send content to a user's Box account without the effort of writing authentication code, obtaining and displaying the content of a user's account, and specifying an upload location.  Quick Import performs all of these tasks for you.

 

Quick Import can be used in one of two ways:

 

 

Quick Import URL

 

The first is through our simple GET request, for which you can redirect users to the following location in Box:

 

Input parameters

 

Name Type Description
url string The url of the file to copy into Box
name string The name you want to set for the file when it is imported to Box.  Note that users will have the option to change that name.
description string The description to be set for the file when imported to box.  Note that users will have the option to change this before saving the file.

 

Sample call:

 

https://www.box.net/api/1.0/import?url=www.example.com/sampledocument.doc&name=sampledocument.doc&description=sampleDescription&import_as=file

 

 

This request will not contain return parameters.  Rather, the page should be presented to the user, so that Box can display an import interface.  The importer interface looks like the following:

 

 

 

When the user completes the login and import process, the page will redirect to Box.net.

 

 

Quick Import Buttons

 

If you have a file that you would like to transfer to a user's Box account, but keep the user on your page, Quick Import Buttons will be your best method.  These buttons will popup the import dialogue within your webpage, and close back into your page once the import process is complete.

 

 

Simply add the following code snippet to your webpage:

 

<a href="#" onclick="return boxnet_import('file','<file_url>','<file_name>','<file_description>');"><img src="https://www.box.net/img/import_button.gif" width="124" height="20" alt="Save to Box.net" style="border:0"/></a>

<script type="text/javascript" src="http://www.box.net/api/1.0/import.js"></script>

 

Similar to Quick Import URL, all you need to do is provide the url to access the file, and optionally your preferred file name and file description.  Also, feel free to provide a different image for the link, as long as the image clearly relates to a Box.net integration.