Metaforce.WebEditor.Api.Client.Core 2.0.1

Metaforce.WebEditor.Api clients

This client package 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 (but .NET Core as well) - 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 your appsettings.json with the following configuration structure:

{
  "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()
.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 your appsettings.json with the following configuration structure:

{
  "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()
.ConfigureServices((context, services) =>
{
    _ = services.WebEditorClientCore(context.Configuration);
});

var host = hostBuilder.Build();

Once configuration is done you can use the following clients (interfaces) via dependency injection. Each interface corresponds to the api:s exposed by the Metaforce WebEditor api.

• IWebEditorApiClient - Corresponds to the Interact controller used to generate ondemand documents in PDF- and HTML-format, creating WebEditor instances and working with the Dynamo (postprocess database).
• IWebEditorArchive - Corresponds to the Archive controller used to interact with the Viewpoint archiving system.
• IWebEditorDistribution - Corresponds to Distribution controller used to generate and distribute documents to digital mailboxes, email and SMS notification and more services.
• IWebEditorStatus - Corresponds to Status controller used to controll and manage WebEditor instances.