Please visit our developer blog for the latest information about new features and bug fixes.
Box Platform Documentation
Welcome to the Box platform's instructional site, a place to learn how to enable your applications to integrate with Box. By working with the Box platform, Box's 10 million+ users will be able to interact with the content they store on Box through your application or service.
Below you can find the information you need to begin creating file actions and applications that use our external API. When ready, you can begin a project by visiting the Box platform services site.
Please note that we are continually editing and improving this documentation. If you have any questions or comments, please feel free to contact us at developers@box.com.
Get Started
The fastest way to get started with our API is to use one of our pre-built SDKs in the programming language you're most comfortable with. You can find these SDKs on Github. We also provide guides to get started with the API:
Details on individual methods can be found on the sidebar to the right.
File Actions
File actions allow you to connect a web application into the box.com web interface, giving your service direct access and visibility to our user base. Box users can add your service to their Box account and use your service to modify, share, or perform other actions on their files within Box.
See some examples of existing file actions.
The pages below should help get you started with the creation of service that leverage file actions.
- User Experience - A complete overview of the Box platform user experience. Begin here to get a good understanding of the Box platform.
- Request Workflow - A developer-centric view of the Box platform experience.
- Box Platform Services - Create and configure your Box platform service.
- File Actions - Define the things your Box platform service can do.
- Box Parameters - Use parameters in prompts or callbacks to provide Box services with the information they need.
- Client Callback URL - Details on this special case for popup actions.
Mobile
For developers of mobile applications, we have special tools and resources to help you work with Box's platform API.
Please visit our Box Platform Mobile Guide to get started.
Need additional assistance? Please feel free to post a question to our forum or email us.
