Trimble.Xchange.Connector.SDK 1.3.1-beta.1

.NET 7.0 This package targets .NET 7.0. The package is compatible with this framework or higher.
This is a prerelease version of Trimble.Xchange.Connector.SDK.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package Trimble.Xchange.Connector.SDK --version 1.3.1-beta.1                

                    
                

            
NuGet\Install-Package Trimble.Xchange.Connector.SDK -Version 1.3.1-beta.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Trimble.Xchange.Connector.SDK" Version="1.3.1-beta.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Trimble.Xchange.Connector.SDK --version 1.3.1-beta.1                

                    
                

            
#r "nuget: Trimble.Xchange.Connector.SDK, 1.3.1-beta.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install Trimble.Xchange.Connector.SDK as a Cake Addin
#addin nuget:?package=Trimble.Xchange.Connector.SDK&version=1.3.1-beta.1&prerelease

// Install Trimble.Xchange.Connector.SDK as a Cake Tool
#tool nuget:?package=Trimble.Xchange.Connector.SDK&version=1.3.1-beta.1&prerelease

The SDK documentation on this page is meant for developers building connectors on App Xchange. For a broader introduction to the App Xchange integration platform, view our help docs and connectivity FAQ.

Getting Started

Connectors are built using .NET and the creation is driven by our CLI tooling Trimble.Xchange.Connector.CLI. These tools are needed to start building a connector. This guide will help you through that process!

Prerequisites for using the Connector SDK

  • Have an HTTP API. It is possible to create a Connector that interacts with your software outside of an HTTP API, however the SDK is currently optimized for use with HTTP endpoints.

  • Able to request test data from your software. You won’t want to build your Connector using live/actual data that matters to your customers. Verify you have a way to access test data from your system during your Connector build that won’t impact your customers in a negative way.

  • At minimum, intermediate C# development skills. The SDK currently supports C#.

  • Installation of .NET SDK. The Connector SDK currently targets .NET 7 and .NET 8. You can install .NET here

  • A solid understanding of your HTTP API resources. Before you can efficiently create a Connector, you will need to know your product’s API pretty well and how to make requests against its endpoints.

  • An initial use case or target integration for which to build. It can be helpful to begin with an initial use case, or an example of the type of integration that would be developed using the connector. The connector may provide for initial use cases to begin with and can be extended upon later as needed.

Main parts of the App Xchange Connector Building

The App Xchange Connector SDK consists of two main parts:

  • The SDK library NuGet package, which provides a framework to build and run connectors.
  • The CLI, an interactive tool for working with the Xchange platform and local code.

Install Trimble.Xchange.Connector.CLI as a .NET tool

The recommended way to install the CLI is to install it as a global .NET Tool. This will automatically download the appropriate package for your system and make the Xchange command available in your environment PATH, as well as enable easy updates when new versions are released. Ensure that the .NET Core SDK v7.0 or higher is installed on your system.

Install Trimble.Xchange.Connector.CLI as a .NET global tool:

dotnet tool install Trimble.Xchange.Connector.CLI --global

To Update:

dotnet tool update Trimble.Xchange.Connector.CLI --global

If you have already started building your connector and are updating, make sure to also update PackageReference Include in your connector.csproj file.

List .NET global tools on your system:

When running:

dotnet tool list --global

You should see Trimble.Xchange.Connector.CLI in the list.

!!! success "Congratulations!" You should now be able to invoke xchange directly from any directory.

Product Compatible and additional computed target framework versions.
.NET net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Trimble.Xchange.Connector.SDK:

Package Downloads
Trimble.Xchange.Connector.SDK.Test.Local

Package Description

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.3.4 720 11/1/2024
1.3.3 1,879 10/10/2024
1.3.2 221 10/9/2024
1.3.2-beta.6 160 10/3/2024
1.3.2-beta.5 46 10/3/2024
1.3.2-beta.3 153 9/30/2024
1.3.2-beta.2 46 9/30/2024
1.3.1 804 9/26/2024
1.3.1-beta.1 152 9/18/2024
1.3.0 679 9/11/2024
1.2.3 322 9/4/2024
1.2.3-beta.1 200 8/20/2024
1.2.2 566 8/19/2024
1.2.1 523 8/14/2024
1.2.0 441 8/8/2024
1.2.0-beta.1 58 8/7/2024
1.1.2-beta.1 86 8/5/2024
1.1.1 753 7/31/2024
1.1.0 749 7/25/2024