Metaforce.WebEditor.Api.Client 2.0.0

.NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package Metaforce.WebEditor.Api.Client --version 2.0.0                

                    
                

            
NuGet\Install-Package Metaforce.WebEditor.Api.Client -Version 2.0.0
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="Metaforce.WebEditor.Api.Client" Version="2.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Metaforce.WebEditor.Api.Client --version 2.0.0                

                    
                

            
#r "nuget: Metaforce.WebEditor.Api.Client, 2.0.0"
#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 Metaforce.WebEditor.Api.Client as a Cake Addin
#addin nuget:?package=Metaforce.WebEditor.Api.Client&version=2.0.0

// Install Metaforce.WebEditor.Api.Client as a Cake Tool
#tool nuget:?package=Metaforce.WebEditor.Api.Client&version=2.0.0

Metaforce.WebEditor.Api clients

This client aims to facilitate the integration with the Metaforce WebEditor api. There are two versions of this package:

The main difference is that the .NET Core package offers the ability to authenticate using mTLS, otherwise both packages offers the exact same funtionality.

Getting started

Download the package to include it in your project and enjoy 😃

Usage Metaforce.WebEditor.Api.Client

ClientId/ClientSecret authentication

Setup you appsettings.json with the following properties:

{
  "WebEditorClientOptions": {
    "AuthorityEndpoint": "https://identity-v2.metaforce.net",
    "ApiBaseAddress": "https://api.webeditor.metaforce.net",
    "ClientId": "YOUR_CLIENT_ID",
    "ClientSecret": "YOUR_CLIENT_SECRET",
    "Scopes": "api.external",
    "CustomerEnvironment": "Test"
  }
}

Configure services

var hostBuilder = new HostBuilder()
.ConfigureAppConfiguration((context, config) =>
{
    config.SetBasePath(Directory.GetCurrentDirectory())
    .AddJsonFile("appsettings.json");
})
.ConfigureServices((context, services) =>
{
    _ = services.WebEditorClient(context.Configuration);
});

var host = hostBuilder.Build();

Usage Metaforce.WebEditor.Api.Client.Core

ClientId/ClientSecret authentication (Core)

See ClientId/ClientSecret authentication configuration above...

mTLS authentication

Setup you appsettings.json with the following properties:

{
  "WebEditorClientOptions": {
    "AuthorityEndpoint": "https://identity-v2.metaforce.net",
    "ApiBaseAddress": "https://api.webeditor.metaforce.net",
    "ClientId": "YOUR_CLIENT_ID",
    "CertificateThumbprint": "YOUR_THUMBPRINT",
    "Scopes": "api.external",
    "CustomerEnvironment": "Test"
  }
}

Configure services (Core)

var hostBuilder = new HostBuilder()
.ConfigureAppConfiguration((context, config) =>
{
    config.SetBasePath(Directory.GetCurrentDirectory())
    .AddJsonFile("appsettings.json");
})
.ConfigureServices((context, services) =>
{
    _ = services.WebEditorClientCore(context.Configuration);
});

var host = hostBuilder.Build();

Once configuration is done you can use the following clients (interfaces):

  • IWebEditorApiClient
  • IWebEditorArchive
  • IWebEditorDistribution
  • IWebEditorStatus

Each interface corresponds to the api:s exposed by the Metaforce WebEditor api.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  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 was computed.  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. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
5.0.0 26 11/28/2024
5.0.0-beta3 27 11/28/2024
5.0.0-beta2 28 11/28/2024
5.0.0-beta 27 11/28/2024
4.0.0 71 11/17/2024
3.0.1 171 1/12/2024
3.0.0 157 12/31/2023
2.0.3 627 7/14/2023
2.0.2 167 7/14/2023
2.0.1 159 7/13/2023
2.0.0 164 7/13/2023
1.0.17 174 7/13/2023
1.0.16 633 10/24/2022
1.0.15 675 9/30/2022
1.0.14 420 9/30/2022
1.0.13 396 9/29/2022
1.0.12 404 9/29/2022
1.0.11 408 9/16/2022
1.0.10 709 4/27/2022
1.0.9 502 4/14/2022
1.0.8 448 4/14/2022
1.0.7 443 4/11/2022
1.0.6 437 4/11/2022
1.0.5 504 4/4/2022
1.0.4 438 4/1/2022
1.0.3 595 3/10/2022
1.0.2 609 1/24/2022
1.0.1 531 1/19/2022
1.0.0 455 1/19/2022
0.0.15 498 1/14/2022
0.0.14 460 1/13/2022
0.0.13 446 1/13/2022
0.0.12 482 1/11/2022
0.0.11 465 1/11/2022
0.0.10 301 1/5/2022
0.0.9 285 1/4/2022
0.0.8 291 1/4/2022
0.0.7 279 1/3/2022
0.0.6 296 1/2/2022
0.0.5 313 12/25/2021
0.0.4 397 12/14/2021
0.0.3 291 12/14/2021
0.0.2 295 12/14/2021
0.0.1 310 12/14/2021