We are excited to introduce the stable release of the latest generation of Box Dotnet SDK Gen, designed to elevate the developer experience and streamline your integration with the Box Content Cloud.
With this SDK, you’ll have access to:
Embrace the new generation of Box SDKs and unlock the full potential of the Box Content Cloud.
You can install SDK using Nuget
Install-Package Box.Sdk.Gen
Alternatively, you can find this package and it's latest version on nuget and manually add it to the .csproj
file as a reference:
<ItemGroup> <PackageReference Include="Box.Sdk.Gen" Version="X.Y.Z" /> </ItemGroup>BouncyCastle runtime integrity check
The version of BouncyCastle included in the SDK performs a checksum validation at runtime. As a result, any modifications to the .dll file, such as those introduced by optimizations like ReadyToRun (R2R) compilation, can alter the checksum, causing the validation to fail. This can lead to issues with SDK functionalities that rely on BouncyCastle, such as JWT authentication unusable.
You can exclude BouncyCastle from ReadyToRun compilation by adding the following to your .csproj
file:
<ItemGroup> <PublishReadyToRunExclude Include="bc-fips-1.0.2.dll" /> <PublishReadyToRunExclude Include="bcpkix-fips-1.0.2.dll" /> </ItemGroup>
To get started with the SDK, get a Developer Token from the Configuration page of your app in the Box Developer Console. You can use this token to make test calls for your own Box account.
The SDK provides a BoxDeveloperTokenAuth
class, which allows you to authenticate using your Developer Token. Use instance of BoxDeveloperTokenAuth
to initialize BoxClient
object. Using BoxClient
object you can access managers, which allow you to perform some operations on your Box account.
The example below demonstrates how to authenticate with Developer Token and print names of all items inside a root folder.
using Box.Sdk.Gen; var auth = new BoxDeveloperTokenAuth(token: "DEVELOPER_TOKEN_GOES_HERE"); var client = new BoxClient(auth: auth); var items = await client.Folders.GetFolderItemsAsync(folderId: "0"); if (items.Entries != null) { foreach (var item in items.Entries) { if (item.FileFull != null) { Console.WriteLine(item.FileFull.Name); } else if (item.FolderMini != null) { Console.WriteLine(item.FolderMini.Name); } else if (item.WebLink != null) { Console.WriteLine(item.WebLink.Name); } } }
The usage docs that show how to make calls to the Box API with the SDK can be found here.
We recommend, familiarizing yourself with the remaining authentication methods, uploading files and downloading files.
Browse the docs or see API Reference for more information.
Upgrading from our legacy SDKs to the new generation SDKs is a straightforward process. See our migration guide and changelog for more information.
Running integration tests locally Create Platform ApplicationTo run integration tests locally you will need a Custom App
created in the Box Developer Console with Server Authentication (with JWT)
selected as authentication method. Once created you can edit properties of the application:
App Access Level
select App + Enterprise Access
. You can enable all Application Scopes
.Advanced Features
enable Make API calls using the as-user header
and Generate user access tokens
.Now select Authorization
and submit application to be reviewed by account admin.
Configuration
tab and in the bottom in the section App Settings
download your app configuration settings as JSON.base64 -i path_to_json_file
JWT_CONFIG_BASE_64
with base64 encoded jwt configuration fileBOX_FILE_REQUEST_ID
with ID of file request already created in the user account, BOX_EXTERNAL_USER_EMAIL
with email of free external user which not belongs to any enterprise.WORKFLOW_FOLDER_ID
with the ID of the Relay workflow that deletes the file that triggered the workflow. The workflow should have a manual start to be able to start it from the API.APP_ITEM_ASSOCIATION_FILE_ID
to the ID of the file with associated app item and APP_ITEM_ASSOCIATION_FOLDER_ID
to the ID of the folder with associated app item.APP_ITEM_SHARED_LINK
to the shared link associated with app item.SLACK_AUTOMATION_USER_ID
to the ID of the user responsible for the Slack automation, SLACK_ORG_ID
to the ID of the Slack organization and SLACK_PARTNER_ITEM_ID
to the ID of the Slack partner item.To run integration tests locally:
dotnet test
Need to contact us directly? Browse the issues tickets! Or, if that doesn't work, file a new one and we will get back to you. If you have general questions about the Box API, you can post to the Box Developer Forum.
Copyright 2023 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.
For third party notices visit THIRD-PARTY-NOTICES
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4