Deprecation notice

This version of the Box .NET SDK is under maintenance mode, and will be deprecated soon, only critical security updates and bug fixes will be provided. We recommend using the new version Box .NET SDK, which can be found at box/box-dotnet-sdk-gen

You can find the migration guide here for transitioning from Box .NET SDK v5.x to the new box-sdk-gen package. If you have any questions, please create an issue in the new repository or reach out to Box Developer Support.

Box Windows V2 SDK

The Box .NET SDK can be used to make API calls to the Box APIs in a .NET project.

The SDK is available for both .NET Framework 4.6.2 and .NET Core 2.0 or above. The installation of the SDK depends on the platform used.

Table of contents

• Getting Started
  • Installation
  • Authentication
  • Sample Apps
• Usage
• Other Resources
• Versions
  • Supported Version
  • Version schedule
• Questions, Bugs, and Feature Requests?
• Contributing
• Copyright and License

Getting Started

Installation

You can install SDK library using Nuget

If you want to use .NET Core

PM> Install-Package Box.V2.Core

If you want to use .NET Framework

PM> Install-Package Box.V2

Or you can add it to your project directly in Visual Studio.

You can also download latest version from our Github's release page

Authentication

Our .NET SDK supports the following authentication methods:

• Server Auth with JWT
• Server Auth with CCG
• Traditional 3-Legged OAuth2
• Developer token

Sample apps

You can check one of our sample apps included in this repository to see how to use the SDK

• Create App User
• Upload File
• Proxy example
• JWT Auth
• Token exchange

Usage

You can find detailed usage documentation and code samples under docs directory.

Other resources

• API Reference
• API Guides
• SDK Nuget Package
• .NET Core SDK Nuget Package
• Box Windows SDK Video Tutorial
• Getting Started Docs

Versions

We use a modified version of Semantic Versioning for all changes. See version strategy for details which is effective from 30 July 2022.

Supported Version

Only the current MAJOR version of SDK is supported. New features, functionality, bug fixes, and security updates will only be added to the current MAJOR version.

A current release is on the leading edge of our SDK development, and is intended for customers who are in active development and want the latest and greatest features. Instead of stating a release date for a new feature, we set a fixed minor or patch release cadence of maximum 2-3 months (while we may release more often). At the same time, there is no schedule for major or breaking release. Instead, we will communicate one quarter in advance the upcoming breaking change to allow customers to plan for the upgrade. We always recommend that all users run the latest available minor release for whatever major version is in use. We highly recommend upgrading to the latest SDK major release at the earliest convenient time and before the EOL date.

Version schedule

Migrating from the old version?

If you are migrating from the old major version visit our upgrade documentation.

Questions, Bugs, and Feature Requests?

Browse the issues tickets! Or, if that doesn't work, file a new one and someone will get back to you. If you have general questions about the Box API, you can post to the Box Developer Forum.

Contributing

All contributions to this project are welcome! For more information, please see our Contribution guidelines.

Copyright and License

Copyright 2018 Box, Inc. All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.