EConnect.Psb.AspNetCore.Mvc 0.9.31

EConnect PSB .NET Client

A reference implementation meant as an example of how to use the PSB api using C#.

The Procurement Service Bus (PSB) provides a cloud managed connection to eDelivery networks like the Peppol network.

Requirements

• .NET Core 2.0 or higher / .NET Framework 4.6.1 or higher

Install

• Go through the Getting started documentation.

• Install the package in your project, through NuGet or another tool of choice.

Install-Package EConnect.Psb

API references

For an explanation of the API please refer to the following documentation.

Setup

Make sure to initialise the service and setup the proper authentication.

Hostbuilder

The recommended way to setup the PSB APIs is to use a hostbuilder, enabling dependency injection.

builder.Services.AddPsbService(_ =>
{
    _.Username = "{username}";
    _.Password = "{password}";
    _.PsbUrl = "{psbUrl}";
    _.IdentityUrl = "{identityUrl}";
    _.ClientId = "{clientId}";
    _.ClientSecret = "{clientSecret}";
    _.SubscriptionKey = "{SubscriptionKey}";
});

After the PsbService is initialised the following APIs can be used:

• IPsbMeApi
• IPsbHookApi
• IPsbPeppolApi
• IPsbPurchaseInvoiceApi
• IPsbPurchaseOrderApi
• IPsbSalesInvoiceApi
• IPsbSalesOrderApi
• IPsbGenericApi

For example, it's now possible to inject the sales invoice API into your controller:

public YourController(IPsbSalesInvoiceApi salesInvoice)
{
    _salesInvoice = salesInvoice;
}

All API interfaces are public which makes it possible to mock them.

Example (web) hostbuilder

An example of the hostbuilder can be found in the project EConnect.Psb.Web.Example. In this project the .net client can be used to send an invoice via Peppol.
Additionally, the supplied webhook receiver shows a simple implementation to receive invoices from Peppol.

PsbServiceHost

Use the PsbServiceHost when it is not possible to use a dependency framework.

using (var psb = PsbServiceHost.Create(_ =>
    {
    _.Username = "{username}";
    _.Password = "{password}";
    _.PsbUrl = "{psbUrl}";
    _.IdentityUrl = "{identityUrl}";
    _.ClientId = "{clientId}";
    _.ClientSecret = "{clientSecret}";
    _.SubscriptionKey = "{SubscriptionKey}";
    }
))
{
    // Example for QueryRecipientParty
    var res = await psb.SalesInvoice.QueryRecipientParty("{senderPartyId}", new[] { "{receiverPartyId}"  }).ConfigureAwait(false);
    Console.WriteLine(res);
}

Example console application

An example of the PsbServiceHost can be found in the project EConnect.Psb.ConsoleNet.Example.

AspNetCore Mvc

The EConnect.Psb.AspNetCore.Mvc package makes it easy to validate a Psb webhook by simply adding an attribute on top of your method in your MVC controller. The Psb webhooks are secured by the X-EConnect-Signature. This package will validate that signature for you.

Hardcoded secret

[PsbWebhook("mySecret")]
public IActionResult Webhook([PsbWebhookValidSentOn] PsbWebHookEvent @event) 
{
  //...
}

Secret from config

[PsbWebhookOptions("webhook")]
public IActionResult Webhook([PsbWebhookValidSentOn] PsbWebHookEvent @event) 
{
  //...
}

Read more

If you want to know more about Peppol e-procurement or other procurement networks, please refer to the Procurement Service Bus introduction page.