DNV.Veracity.Services.Api.My 1.5.2

Veracity - My Services API v3 - My Client

Provides an async .NET client for the My view point in Veracity My Services API v3. Allows fetching information and making requests for the authenticated user.

Resources

• Companies
• Messages
• Policies
• Profile
• Services

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 My view point only supports User Credential Flow.

{
	"OAuthHttpClients": [
		...
		{
			"Name": "my-profile",
			"Flow": "UserCredentials",
			"BaseUri": <BaseUri>,
			"SubscriptionKey": <SubscriptionKey>,
			"OAuthClientOptions": {
				"Authority": <Authority>,
				"Scopes": [ <Scope> ]
			}
		}
		...
	]
}

2. Registration

Register the service or services using extensions methods available from the DNV.Veracity.Services.Api.My.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.AddMyProfile("my-profile")
	...
}

3. Request service

Request the service from the constructor by its interface:

ExampleController.cs

public class ExampleController : Controller
{
	...
	private readonly IMyProfile _myPofile;
	...
	public ExampleController(IMyProfile myProfile)
	{
		...
		_myPofile = myProfile ?? throw new ArgumentNullException(nameof(myProfile));
		...
	}
	...
	public async Task<IActionResult> FetchProfile()
	{
		return Json(await _myPofile.Get());
	}
	...
}