Box Developer Documentation
 

    SDKs & Tools

    SDKs & Tools

    The following SDKs and tools are developed and supported by Box.

    SDKs

    Here you will find a list of SDKs you can use to build your application. Separately, we have listed the next generation Python, TypeScript, and .NET SDKs, which are the newest addition. .NET is still a beta feature, but we encourage you to give it a try and explore all the features they bring along.

    The tables below list SDKs along with additional information telling you if the project is maintained and has API parity.

    Maintained: Fully maintained projects are actively developed by Box. They receive the latest security updates and new features. For support with these projects please visit GitHub or our Platform support forum.

    API Parity: Projects with full API parity are actively updated with all platform functionality as this becomes available on the Box Platform. Projects with partial API parity lack some functionality while we work on bringing these projects to full parity.

    Next generation SDKs

    The latest generation Box Python SDK, Box TypeScript SDK, .NET SDK, and Swift SDK are designed to elevate the developer experience and streamline your integration with the Box Content Cloud.

    Swift SDK is in a Public Beta phase.

    Here's what you can expect from the new SDKs:

    • Full API Support: New Box SDKs empower developers with complete coverage of the Box API ecosystem. You can access all the latest features and functionalities offered by Box and build feature-rich applications.
    • Rapid API Updates: The new auto-generation development approach allows for adding Box APIs to SDKs at a much faster pace (in a matter of days). This means you can leverage the most up-to-date features in your applications without delay.
    • Embedded Documentation: All objects and parameters are documented directly in the source code of the SDK so all the necessary information is stored in one place.
    • Enhanced Convenience Methods: The newly introduced convenience methods cover various aspects such as authentication, chunk uploads, exponential back-offs, automatic retries, type checkers which help to ensure that you’re using variables correctly, and much more.
    PlatformMaintained?API Parity
    Python Gen SDKYesFull
    Typescript Gen SDKYesFull
    .NET SDKYesFull
    Swift SDK (Beta)YesFull

    SDKs

    The table lists Box SDKs that you can use when building your applications.

    PlatformMaintained?API Parity
    Java SDKYesFull
    iOS Content SDKYesFull
    Android Content SDKNoPartial
    .NET SDKDeprecated. Only critical security updates and bug fixes are implemented.Full
    Python SDKDeprecated. Only critical security updates and bug fixes are implemented.Full
    Node SDKDeprecated. Only critical security updates and bug fixes are implemented.Full

    As of May 31, 2023 Android SDK is no longer supported. You can still use your existing Android SDK applications with no impact, but you won't receive new features, updates, or bug fixes.

    If you would like to continue getting the latest and greatest Android features, we recommend using Java SDK to build apps on Android. Refer to this documentation for more details.

    Box CLI

    Box CLI is a user-friendly command line tool which allows both technical and non-technical users to leverage Box API to perform routine or bulk actions.

    PlatformMaintained?API Parity
    CLIYesFull

    Postman Collection

    Postman is a tool that lets you build and test HTTP requests in an easy-to-use interface without configuring a full development environment. The Box Postman Collection is a set of preconfigured requests that make it possible to get started with the Box API without having to manually configure the requests.

    The simplest way to get started with Postman is with our Postman Quick Start guide.

    Get Started with the Box Postman Collection

    Salesforce Developer Toolkit

    The Box for Salesforce Developer Toolkit allows customers to programmatically customize the behavior of the Box for Salesforce integration. The Toolkit consists of several global APEX methods that can be used to trigger and extend the default behavior. The global methods can update the internal Salesforce record to Box folder mapping and handle permission management.

    This functionality is part of the latest Box for Salesforce package.

    What the Toolkit does NOT provide

    The Toolkit is not a full-featured APEX wrapper for the BOX Content API. If this is what you are looking for, have a look at the Box SDK for Salesforce.

    Official UI Libraries

    Extend your application with pre-built UI components to browse, share, and preview files on Box.

    BrowseSharePreview
    Browse Share Preview
    Navigate and manipulate your files on Box using our pre-built UI.Share files with our pre-built UI elements for file & folder collaboration.Review over 120 files types, from PDFs to HD videos, with a rich preview experience.

    Unofficial & Community Tools

    The following tools are developed by Box and maintained by Box and its community members. These tools do not receive regular product updates or security updates.

    PlatformMaintained?API Parity
    Salesforce SDKLimited, by Box and community membersPartial
    Ruby SDKLimited, by Box and community membersPartial
    Client-side JS SDKLimited, by Box and community membersPartial

    Maintained: Projects with limited maintenance are updated by Box in collaboration with the community. They receive irregular security updates. If you are a Box customer on a premium support plan, please contact customer services for any urgent feature requests for these tools. For other support queries with these projects please visit GitHub or our Platform support forum.

    API Parity:  Projects with limited API parity can lack some functionality as new features are not automatically rolled out to these projects as they become available for the Box Platform. If you are a Box customer on a premium support plan, please contact customer services for any urgent feature requests for these tools.