Metaforce.WebEditor.Api.Client.Core
2.0.0
See the version list below for details.
dotnet add package Metaforce.WebEditor.Api.Client.Core --version 2.0.0
NuGet\Install-Package Metaforce.WebEditor.Api.Client.Core -Version 2.0.0
<PackageReference Include="Metaforce.WebEditor.Api.Client.Core" Version="2.0.0" />
paket add Metaforce.WebEditor.Api.Client.Core --version 2.0.0
#r "nuget: Metaforce.WebEditor.Api.Client.Core, 2.0.0"
// Install Metaforce.WebEditor.Api.Client.Core as a Cake Addin #addin nuget:?package=Metaforce.WebEditor.Api.Client.Core&version=2.0.0 // Install Metaforce.WebEditor.Api.Client.Core as a Cake Tool #tool nuget:?package=Metaforce.WebEditor.Api.Client.Core&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:
- One written in netstandard2.0 aimed at .NET Framework implementations - Metaforce.WebEditor.Api.Client.
- One written in net6.0 aimed at .NET Core implementations - Metaforce.WebEditor.Api.Client.Core.
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 | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net6.0 is compatible. 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. |
-
net6.0
- IdentityModel (>= 6.0.0)
- System.IdentityModel.Tokens.Jwt (>= 6.28.1)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.