DNV.Veracity.Services.Api.This 1.5.2

Veracity - My Services API v3 - This Client

Provides an async .NET client for the This view point in Veracity My Services API v3. Allows manipulation and retrival of information related to a service.

Resources

• Administrators
• Services
• Subscribers
• Users

Example

With the nuget package installed, services for each resource may be individually configured, injected and requested inside your solution.

1. Configuration

To configure a resource service, introduce configuration in the form of OAuthHttpClientOptions:

appsettings.json

The This view point only supports Client Credential Flow.

{
	"OAuthHttpClients": [
		...
		{
			"Name": "this-subscribers",
			"Flow": "ClientCredentials",
			"BaseUri": <BaseUri>,
			"SubscriptionKey": <SubscriptionKey>,
			"OAuthClientOptions": {
				"Authority": <Authority>,
				"ClientId": <ClientId>,
				"ClientSecret": <ClientSecret>,
				"Scopes": [ <Scope> ],
			}
		}
		...
	]
}

2. Registration

Register the service or services using extensions methods available from the DNV.Veracity.Services.Api.This.Extensions namespace.

startup.cs

Packages from DNV.Veracity.Service.Api are dependent on the DNV.OAuth.Api.HttpClient package, therefore the HttpClientFactory should also be injected.

public void ConfigureServices(IServiceCollection services)
{
	...
	services.AddOAuthHttpClientFactory(Congiuration.GetSection("OAuthHttpClients").Get<IEnumerable<OAuthHttpClientOptions>>());
	...
	services.AddThisSubscribers("this-subscribers")
	...
}

3. Request service

Request the service from the constructor by its interface:

ExampleController.cs

public class ExampleController : Controller
{
	...
	private readonly IThisSubscribers _thisSubscribers;
	...
	public ExampleController(IThisSubscribers thisSubscribers)
	{
		...
		_thisSubscribers = thisSubscribers ?? throw new ArgumentNullException(nameof(thisSubscribers));
		...
	}
	...
	public async Task<IActionResult> FetchSubscribers(int page, int pageSize)
	{
		return Json(await _thisSubscribers.List(page, pageSize));
	}
	...
}