Retail Server 拡張 API の作成 (Retail SDK バージョン 10.0.11 以降)

[アーティクル]
11/14/2023

この記事では、新しい Retail Server アプリケーションプログラミングインターフェイス (API) の作成方法、および販売時点管理 (POS) または他のクライアントがそれを使用できるようにするための公開方法について説明します。既存の Retail Server API の変更はサポートされていません。

この記事は、Retail ソフトウェア開発キット (SDK) バージョン 10.0.11 以降に適用されます。

Retail SDK には、Commerce Runtime (CRT) を含む、エンドツーエンドの Retail Server 拡張機能のサンプルがいくつか用意されているのみです。これらのサンプルをテンプレートとして使用して、拡張機能を起動できます。サンプル拡張機能は、RetailSDK\SampleExtensions\RetailServer フォルダーで見つけることができます。

ノート

新しい Retail Server 拡張 API を作成し、その API が大量に使用され、チャネルデータベースから読み取る必要がある場合、マイクロソフトはデータベース読み取り用のキャッシュを有効にすることを推奨します。これをしない場合、拡張機能が Retail Server とチャネルデータベースのリソースを過剰に消費し、ビジネスに影響を及ぼすCommerce Scale Unit (CSU) 全体のパフォーマンスの問題が発生する可能性があります。

Retail SDK のエンドツーエンドサンプルリポジトリ

サンプル拡張機能 (RetailSDK\SampleExtensions\RetailServer)	CRT サンプル (RetailSDK\SampleExtensions\CommerceRuntime)	POS サンプル (RetailSDK\POS\Extensions)
Extensions.StoreHoursSample	Extensions.StoreHoursSample	StoreHoursSample
Extensions.SalesTransactionSignatureSample	Extensions.SalesTransactionSignatureSample	SalesTransactionSignatureSample
Extensions.PrintPackingSlipSample	Extensions.PrintPackingSlipSample
Extensions.CrossLoyaltySample	Extensions.CrossLoyaltySample

拡張機能クラスダイアグラム

次の図は、拡張機能のクラスダイアグラムを示しています。

Commerce Scale Unit の拡張機能クラスダイアグラム。

メモ

Retail サーバーでは、IController と CommerceController の両方の拡張機能の読み込みはサポートされていません。両方のタイプの拡張機能を含めると、Retail サーバーの負荷は失敗します。拡張機能は IController または CommerceController のいずれかである必要があります。 IController 拡張機能に移行する場合は、すべての Retail サーバー拡張機能を IController に移行します。

新しい Retail Server API の作成

CRT 拡張機能を作成します。 Retail Server 拡張機能を作成する前に、CRT 拡張機能を作成します。 Retail Server API には、パラメーターで CRT を呼び出すロジック以外のロジックはありません。
Microsoft .NET フレームワークバージョン NET Standard 2.0 をターゲットフレームワークとして使用する、新しい C# クラスライブラリプロジェクトを作成します。または、Retail ソフトウェア開発キット (SDK) に含まれている Retail Server のサンプルのいずれかをテンプレートとして使用できます。
Retail Server 拡張機能プロジェクトで、CRT 拡張機能ライブラリまたはプロジェクトへの参照を追加します。この参照を使用して、CRT 要求、応答およびエンティティを呼び出すことができます。
Retail Server 拡張機能プロジェクトで、NuGet パッケージマネージャーを使用して、Microsoft.Dynamics.Commerce.Hosting.Contracts パッケージを追加します。 NuGet パッケージは、RetailSDK\pkgs フォルダにあります。
新しい公開コントローラークラスを作成し、IController からクラスを拡張します。このコントローラークラスには、Retail Server API が公開する必要のあるメソッドが含まれているので、コントローラークラスは公開である必要があります。
コントローラークラス内で、CRT 要求を呼び出すメソッドを追加します。新しいコントローラークラスを、CustomerController、SalesOrdersController、または ProductController などの既存のコントローラークラスから拡張しないでください。拡張クラスでは、IController クラスのみを拡張する必要があります。
コントローラークラス (コントローラークラス名) 上で RoutePrefix 属性を追加します。
```
[RoutePrefix("SimpleExtension")]
```
メモ

RoutePrefix 属性の追加はオプションです。 RoutePrefix 属性を追加する場合、カスタムエンティティのみを含む BindEntity 属性を追加する必要があります。すぐに利用できる RoutePrefix (顧客および製品など) の追加、およびすぐに利用できるエンティティ (製品、買い物カゴ、および顧客など) の追加はサポートされていません。 RoutePrefix および顧客カスタムエンティティのみを追加することができます。
コントローラークラスで BindEntity 属性を追加します。この手順はオプションです。 RoutePrefix を追加し、カスタムエンティティを返す場合のみ属性を追加します。
```
[BindEntity(typeof(SimpleEntity))]
```

メモ

拡張クラスがエンティティにバインドされている場合は、手順 7 と 8 が必要です。これらの手順は、エンティティではなく、単純型を返す非制限コントローラクラスには必要ありません。

次のサンプルコードでは、エンティティ、文字列、およびブール値を返す単純な Retail Server API を作成します。サンプルで使用されている CRT 要求および応答は、このサンプルには含まれていません。 CRT 要求および応答の例については、Commerce Runtime (CRT) の拡張機能およびトリガーを参照してください。

カスタムエンティティにバインドされるコントローラクラスのサンプルコード

メモ

拡張コードは、顧客、買い物カゴ、または製品などの既存のエンティティにバインドしてはいけません。 API がコレクションを返す場合、IEnumerable<T> 型のみを返す必要があり、Dictionary <String, String> のような他の型を返すことはサポートされていません。結果として、System.Collections.Generic.Dictionary2[System.String,System.String] is not supported. などのエラーが表示されることがあります。コレクションを返すには、Commerce API で PageResult<T> を使用し、IEnumerable<T> を実装します。このパターンに従い、コレクションを返します。

// New extended controller.
[RoutePrefix("SimpleExtension")]
[BindEntity(typeof(SimpleEntity))]
public class SimpleExtensionController : IController
{
    /// <summary>
    /// The action to get the string value.
    /// </summary>
    /// <param name="context">The context parameters.</param>
    /// <param name="stringValue">The string value parameters.</param>
    /// <returns>The string value.</returns>
    [HttpPost]
    [Authorization(CommerceRoles.Customer, CommerceRoles.Employee)]
    public async Task<string> GetStringValue(IEndpointContext context, string stringValue)
    {
        GetStringValueResponse resp = await context.ExecuteAsync<GetStringValueResponse>
                                    (new GetStringValueRequest(stringValue)).ConfigureAwait(false);
        return resp.StringValue;
    }

    /// <summary>
    /// The action to get the bool value.
    /// </summary>
    /// <param name="context">The context parameters.</param>
    /// <param name="boolValue">The string value parameters.</param>
    /// <returns>The bool value.</returns>
    [HttpPost]
    [Authorization(CommerceRoles.Customer, CommerceRoles.Employee)]
    public async Task<bool> GetBoolValue(IEndpointContext context, string boolValue)
    {
        GetBoolValueResponse resp = await context.ExecuteAsync<GetBoolValueResponse>
                                    (new GetBoolValueRequest(boolValue)).ConfigureAwait(false);
        return resp.BoolValue;
    }

    /// <summary>
    /// The action to get the simple entity.
    /// </summary>
    /// <param name="context">The context parameters.</param>
    /// <param name="name">The name parameters.</param>
    /// <returns>The simple entity.</returns>
    [HttpPost]
    [Authorization(CommerceRoles.Customer, CommerceRoles.Employee)]
    public async Task<SimpleEntity> GetSimpleEntity(IEndpointContext context, string name)
    {
        GetSimpleEntityResponse resp = await context.ExecuteAsync<GetSimpleEntityResponse>
                                        (new GetSimpleEntityRequest(name)).ConfigureAwait(false);
        return resp.SimpleEntityObj;
    }
}

カスタムエンティティにバインドされていないコントローラクラスのサンプルコード

namespace Contoso.UnboundController.Sample
{
    using System.Threading.Tasks;
    using Microsoft.Dynamics.Commerce.Runtime.DataModel;
    using Microsoft.Dynamics.Commerce.Runtime.Hosting.Contracts;

    /// <summary>
    /// An extension unbounded controller sample.
    /// </summary>
    public class UnboundController : IController
    {
        /// <summary>
        /// A simple GET endpoint to demonstrate GET endpoints on an unbound controller.
        /// </summary>
        /// <returns>A simple true value to indicate the endpoint was reached.</returns>
        [HttpGet]
        [Authorization(CommerceRoles.Anonymous, CommerceRoles.Application, CommerceRoles.Customer, CommerceRoles.Device, CommerceRoles.Employee, CommerceRoles.Storefront)]
        public Task<bool> SampleGet()
        {
            return Task.FromResult(true);
        }

        /// <summary>
        /// A simple POST endpoint to demonstrate POST endpoints on an unbound controller.
        /// </summary>
        /// <returns>A simple true value to indicate the endpoint was reached.</returns>
        [HttpPost]
        [Authorization(CommerceRoles.Customer, CommerceRoles.Device, CommerceRoles.Employee)]
        public Task<bool> SamplePost()
        {
            return Task.FromResult(true);
        }
    }
}

Retail Server API では、さまざまな承認ロールがサポートされています。コントローラーメソッドへのアクセスは、コントローラーメソッドの承認属性で指定された承認ロールに基づいて許可されます。次の例は、サポートされている承認ロールを示しています。拡張コードは、承認属性の代わりに CommerceAuthorization 属性を使用することはできません。 CommerceAuthorization 属性は、10.0.11 より前の SDK バージョンでのみサポートされています。

// Represents the type of logon type.
[DataContract]
public static class CommerceRoles
{
    // Anonymous Role.
    [DataMember]
    public const string Anonymous = "Anonymous";

    // SharePoint Role used by Connector.
    [DataMember]
    public const string Storefront = "Storefront";

    // Employee Role.
    [DataMember]
    public const string Employee = "Employee";

    // Customer Role.
    [DataMember]
    public const string Customer = "Customer";

    // Represents the Device level of authentication.
    [DataMember]
    public const string Device = "Device";

    // Represents Application level of authentication.
    [DataMember]
    public const string Application = "Application";

    // The list of all possible Microsoft.Dynamics.Commerce.Runtime.DataModel.CommerceRoles values.
    public static readonly string[] All;
}

Retail Server API のページングのサポート

リリース 10.0.19 から、API にページングが必要な場合、API に QueryResultSettings を追加し、クライアントから値を渡すことができます。 QueryResultSettings には、PagingInfo およびレコードがフェッチまたはスキップするための他のパラメーターが含まれます。

拡張機能は、QueryResultSettings を CRT 要求に渡すことができ、データベースクエリがあるときに CRT 要求で使用することができます。

Retail SDK では、完全なサンプルコードを使用することができます: RetailSDK\SampleExtensions\CommerceRuntime\Extensions.StoreHoursSample\StoreHoursDataService.cs RetailSDK\SampleExtensions\RetailServer\Extensions.StoreHoursSample\StoreHoursController.cs"


    [HttpPost]
        [Authorization(CommerceRoles.Anonymous, CommerceRoles.Customer, CommerceRoles.Device, CommerceRoles.Employee)]
        public async Task<PagedResult<SampleDataModel.StoreDayHours>> GetStoreDaysByStore(IEndpointContext context, string StoreNumber, QueryResultSettings queryResultSettings)
        {
            var request = new GetStoreHoursDataRequest(StoreNumber) { QueryResultSettings = queryResultSettings };
            var hoursResponse = await context.ExecuteAsync<GetStoreHoursDataResponse>(request).ConfigureAwait(false);
            return hoursResponse.DayHours;
        }


private async Task<CommerceEntity> GetStoreDayHoursAsync(GetStoreHoursDataRequest request)
            {
                ThrowIf.Null(request, "request");

                using (DatabaseContext databaseContext = new DatabaseContext(request.RequestContext))
                {
                    var query = new SqlPagedQuery(request.QueryResultSettings)
                    {
                        DatabaseSchema = "ext",
                        Select = new ColumnSet("DAY", "OPENTIME", "CLOSINGTIME", "RECID"),
                        From = "CONTOSORETAILSTOREHOURSVIEW",
                        Where = "STORENUMBER = @storeNumber",
                    };

                    query.Parameters["@storeNumber"] = request.StoreNumber;
                    return new GetStoreHoursDataResponse(await databaseContext.ReadEntityAsync<DataModel.StoreDayHours>(query).ConfigureAwait(false));
                }
            }

拡張機能の登録

拡張機能プロジェクトをビルドし、バイナリを \RetailServer\webroot\bin\Ext フォルダーにコピーします。

extensionComposition セクションで新しい拡張ライブラリ名を追加して、\RetailServer\webroot フォルダーの Commerce Scale Unit web.config ファイルを更新します。

<extensionComposition>
    <!-- Use fully qualified assembly names for ALL if you need to support loading from the Global Assembly Cache.
    If you host in an application with a bin folder, this is not required. -->
    <add source="assembly" value="SimpleExtensionSample" >
</extensionComposition>

インターネットインフォメーションサービス (IIS) で Commerce Scale Unit を再起動して、新しい拡張機能を読み込みます。

拡張機能の検証

拡張機能が正常に読み込まれたことを確認するには、Retail Server のメタデータを参照します。エンティティおよびメソッドが一覧に表示されることを確認します。メタデータを参照するには、Web ブラウザーの次の形式で URL を開きます。

https://RS-URL/Commerce/$metadata
クライアントで Retail Server 拡張機能を呼び出すには、クライアント Typescript プロキシを生成する必要があります。その後、プロキシを使用して、クライアントから新しい Retail Server API を呼び出すことができます。

Retail Server 拡張 API を使用して、EdmModelExtender ファイルを拡張機能に追加する必要はありません。これらのファイルは、Retail SDK バージョン 10.0.10 またはそれ以前を使用している場合にのみ必要です。

RS 拡張機能のデバッグ

Visual Studio で RS 拡張機能プロジェクトをデバッグする方法。 デバッグ > プロセスに添付するに移動します。 w3wp.exe (Retail Server の IIS プロセス) を選択します。複数の w3wp.exe プロセスがある場合は、プロセス ID に基づいて適切なプロセスを使用します。 Retail サーバープロセス IDは、IIS > ワーカープロセスを使用するか、コマンドプロンプトと tasklist コマンドを使用して見つけることができます。

POS Typescript プロキシの生成

POS は Typescript プロキシを使って、Retail サーバー API や CRT エンティティにアクセスします。プロキシクラスは、サービスを実行するためのクラスまたは Wrapper として機能し、プロキシ拡張機能を使用せずに Retail Server API やエンティティメタデータを検索することによって、Retail Server API にアクセスします。

プロキシファイルを生成する手順

Visual Studio 2017 では、サンプルプロキシテンプレートプロジェクトを Visual Studio 2017 の \RetailSDK\Code\SampleExtensions\TypeScriptProxy\TypeScriptProxy.Extensions.StoreHoursSample\Proxies.TypeScriptProxy.Extensions.StoreHoursSample.csproj から開きます。新しい名前が必要な場合は、プロジェクトの名前を変更します。
このプロキシテンプレートプロジェクトに、Retail Server 拡張プロジェクトをプロジェクト参照プロジェクトとして追加します。既存の StoreHoursSample プロジェクト参照を削除します。
Proxies.TypeScriptProxy.Extensions.StoreHoursSample.csproj プロジェクトを右クリックし、Edit Proxies.TypeScriptProxy.Extensions.StoreHoursSample.csproj を選択します。
<RetailServerExtensionAssemblies> ノードの下に、Retail Server 拡張機能のアセンブリ名を指定します。次の例は、アセンブリ名を追加する方法を示しています。
```
<ItemGroup>
    <RetailServerExtensionAssemblies Include="..\..\RetailServer\Extensions.Sample\bin\$(Configuration)\net461\$(AssemblyNamePrefix).RetailServer.Extension.Sample.dll" />
</ItemGroup>
```
<Copy> ノードの下で、POS 拡張フォルダーの DestinationFolder パスを更新して、生成されたプロキシファイルが POS 拡張フォルダーに自動的にコピーされるようにします。生成されたプロキシファイルも \RetailSDK\Code\SampleExtensions\TypeScriptProxy\TypeScriptProxy.Extensions.StoreHoursSample\DataService にコピーされます。次の例は、パスを更新する方法を示しています。
```
<Copy SourceFiles="@(GeneratedDataServiceContracts)" DestinationFolder="$(SdkRootPath)\POS\Extensions\Sample\DataService" SkipUnchangedFiles="true" />
```
変更が完了したら、プロキシプロジェクトをビルドして TypeScript プロキシファイルを生成します。ビルドが完了すると、\RetailSDK\Code\SampleExtensions\TypeScriptProxy\TypeScriptProxy.Extensions.StoreHoursSample\DataService フォルダーでプロキシファイルが使用可能となり、そのフォルダーはコピー コマンドによって指定されます。パスとフォルダーパスは、フォルダ構造によって異なる場合があります。

オフラインの Retail Server 拡張機能

Microsoft.Dynamics.Commerce.Hosting.Contracts API を使用してビルトされた Retail Server 拡張機能は、オフライン実装でも使用できます。個別の C# プロキシライブラリを生成する必要はありません。 \Microsoft Dynamics 365\70\Retail Modern POS\ClientBroker\ext フォルダーにある Retail Server 拡張機能ライブラリをコピーして、 RetailProxy.MPOSOffline.ext 構成ファイルにこのライブラリを含めるように構成します。この拡張機能では、Typescript プロキシのみを生成する必要があります。 SDK サンプルは、\RetailSDK\SampleExtensions\TypeScriptProxy) フォルダーにあります。

次の例は、RetailProxy.MPOSOffline.ext 構成ファイル内の要素の追加を更新する方法を示しています。

<?xml version="1.0" encoding="utf-8"?>
<retailProxyExtensions>
    <composition>
        <add source="assembly" value="Contoso.RetailServer.StoreHoursSample" />
    </composition>
</retailProxyExtensions>

次の方法で共有

Retail Server 拡張 API の作成 (Retail SDK バージョン 10.0.11 以降)

Retail SDK のエンドツーエンドサンプルリポジトリ

拡張機能クラスダイアグラム

新しい Retail Server API の作成

カスタムエンティティにバインドされるコントローラクラスのサンプルコード

カスタムエンティティにバインドされていないコントローラクラスのサンプルコード

Retail Server API のページングのサポート

拡張機能の登録

拡張機能の検証

RS 拡張機能のデバッグ

POS Typescript プロキシの生成

プロキシファイルを生成する手順

オフラインの Retail Server 拡張機能

フィードバック

フィードバック

その他のリソース

次の方法で共有

Retail Server 拡張 API の作成 (Retail SDK バージョン 10.0.11 以降)

Retail SDK のエンドツーエンド サンプル リポジトリ

拡張機能クラス ダイアグラム

新しい Retail Server API の作成

カスタム エンティティにバインドされるコントローラ クラスのサンプルコード

カスタム エンティティにバインドされていないコントローラ クラスのサンプルコード

Retail Server API のページングのサポート

拡張機能の登録

拡張機能の検証

RS 拡張機能のデバッグ

POS Typescript プロキシの生成

プロキシ ファイルを生成する手順

オフラインの Retail Server 拡張機能

フィードバック

フィードバック

その他のリソース

Retail SDK のエンドツーエンドサンプルリポジトリ

拡張機能クラスダイアグラム

カスタムエンティティにバインドされるコントローラクラスのサンプルコード

カスタムエンティティにバインドされていないコントローラクラスのサンプルコード

プロキシファイルを生成する手順