Metaforce.WebEditor.Api.Client 5.0.0

Metaforce.WebEditor.Api clients

This client package aims to facilitate the integration with the Metaforce WebEditor/Pages api. There use to be two versions of this package, now there's only one. The one written in netstandard2.0 has been removed and now the nuget package is written for net8.0 + net9.0... It offers auntentication with either ClientId/ClientSecret or ClientId/CertificateThumbprint (mTLS).

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"
  }
}

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"
  }
}

Configuration properties

• AuthorityEndpoint - The URL of the Identity server. Should always be https://identity-v2.metaforce.net.
• ApiBaseAddress - The base URL of the service. Should always be https://api.webeditor.metaforce.net.
• ClientId - The ClientId of the api client. Get it from Centerpoint.
• ClientSecret - The ClientSecret of the api client. Get it from Centerpoint.
• CertificateThumbprint - The thumbprint of your client authentication certificate. Use it when you create your client in Centerpoint. The client certificate should be installed in the CurrentUser certificate store.
• Scopes - The api client should always be scoped to "api.external". If one wants to further limit the scope of the api client one can also configure the api client to be scoped for webeditor.dev, webeditor.test, webeditor.stage, webeditor.demo and webeditor.prod. This scope should then be configured for a Pages environment to limit what clients can access the specific environment. This Scopes value will limit the client to access TEST environments: "api.external webeditor.test".
• CustomerEnvironment - This value should point to the specific Pages environment the client should Pages with. Possible values are Development, Test, Test1, Test2, Test3, Test4, Test5, IntegrationTest, AcceptanceTest and Production.

Configure services

var hostBuilder = new HostBuilder()
.ConfigureServices((context, services) =>
{
    _ = services.WebEditorClient(context.Configuration);
});

var host = hostBuilder.Build();

Client services

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-, PDF with metadata and HTML-format, creating WebEditor instances and working with the Dynamo (postprocess database).
• IWebEditorArchive - Corresponds to the Archive controller that views documents in 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.