Worldline Connect .NET SDK

Introduction

The .NET SDK helps you to communicate with the Worldline Connect Server API. Its primary features are:

• convenient C# wrapper around the API calls and responses
  • marshalls C# request objects to HTTP requests
  • unmarshalls HTTP responses to C# response objects or C# exceptions
• handling of all the details concerning authentication
• handling of required metadata

Its use is demonstrated by an example for each possible call. The examples execute a call using the provided API keys.

See the Worldline Connect Developer Hub for more information on how to use the SDK.

Structure of this repository

This repository consists out of four main components:

1. The source code of the SDK itself: /Worldline.Connect.Sdk
2. The source code of the SDK unit tests: /Worldline.Connect.Sdk.Tests
3. The source code of the example integration tests: /Worldline.Connect.Sdk.IntegrationTests
4. The source code of the example calls: /Worldline.Connect.Sdk.Examples

Requirements

The .NET SDK supports .NET Framework 4.5 and .NET Standard 2.0 and 2.1.

.NET Framework 4.5

When using .NET Framework 4.5, the following packages are required:

• Json.NET 13.0.1 or higher
• NLog 4.3.7 or higher
• System.Collections.Immutable 1.2.0 or higher

In addition, the following references are required, which are part of the .NET Framework:

• System.Configuration
• System.Net.Http

.NET Standard 2.0 and 2.1

When using .NET Standard 2.0 or 2.1, the following packages are required:

• Json.NET 13.0.1 or higher
• NLog 4.6.8 or higher
• System.Collections.Immutable 1.6.0 or higher
• System.Configuration.ConfigurationManager 4.6.0 or higher

Installation

Release

Package Manager

To install the latest .NET SDK release, run the following command in the Package Manager Console (Tools -> NuGet Package Manager -> Package Manager Console) in Visual Studio:

PM> Install-Package Worldline.Connect.Sdk

.NET CLI

To install the latest .NET SDK release, run the following command:

dotnet add package Worldline.Connect.Sdk

Release (Strong-Named)

To install the latest .NET SDK release as a Strong-Named assembly, follow the instructions above but use Worldline.Connect.Sdk.StrongName instead of Worldline.Connect.Sdk.

Building the repository

This repository uses Visual Studio 2022 to build. Open Worldline.Connect.Sdk.sln in Visual Studio, and click build.