Skip to main content

.NET SDK

The .NET SDK provides a comprehensive library for easily integrating with the Mambo API. This client library simplifies development by handling authentication, request formatting, and response parsing, allowing you to focus on your application logic. The NUPKG bundle also contains inline documentation to facilitate development with Visual Studio.

To connect to the Mambo API, use one of the service classes provided in the services package. See the code samples below for implementation examples.

Installation

Requirements

  • .NET Framework Version 4.0 or greater

Dependencies

Manual installation

  1. How to configure a local NuGet repository using Visual Studio:

    • How to install nuget package locally
    • Tools -> Options -> NuGet Package Manager -> Package Sources
    • Add a new source using the path to the folder which contains the Mambo NuGet package
  2. Installing the NuGet package for the SDK:

    • Tools -> NuGet Package Manager -> Manage NuGet Packages for Solution
    • In "Package Source:" select the repository created above
    • Click on "Browse" and select the Mambo package
    • Select your project and click "Install"

Downloads

The .NET SDK can be downloaded as a Nupkg or as a DLL. The DLL contains all of the SDK's dependencies embedded such that they will not clash with your project's dependencies (if the same libraries with different version numbers are used). The recommended approach is to use the Nupkg option, but sometimes it's not possible to remove or upgrade your project's dependencies.

Documentation

Client initialisation

To initialise the SDK, you'll need to set your credentials and, if using an on-premise installation, the API endpoint URL:

.NET

Path and query parameters

Use parameter objects to provide path and query parameters to endpoint methods:

.NET

Request options

Use the request options object to provide configuration on a per-request basis. This object can be used to provide idempotency keys or request specific timeouts:

.NET

Getting started

Here's a complete example showing how to initialise the client and make a basic API call:

.NET

Troubleshooting

Common issues

Connection timeouts

If you experience connection timeouts, you can increase the timeout settings when initialising the client:

.NET

Logging

Enable debug logging to troubleshoot issues:

.NET