アクセス許可
On occasion, it may be required to grant access to a customer without the need for them to have made a purchase of any kind. The eSuite platform deems this action as ad-hoc. Therefore the ability to add Entitlements has been introduced.
概要
AddEntitlementToUser のAPIは、購入フロー外のユーザーにアクセスを許可するときにコールされます。 APIメソッドを実行しても、サブスクリプションや注文情報は生成されません。
注意
このリクエストはエンタイトルメントの定期循環規則をサポートしていません。定期循環規則を使用してエンタイトルメントを一括追加するには、eSuite HQを使用してください。
リクエスト
C#
[csharp]
using (var client = new eDeveloperClient())
{
var request = new AddEntitlementToUserRequest
{
clientId = 433;
apiPassword = "sN?67oS=cE";
EntitlementIdentifier = "Ent1234";
EntitlementFriendlyName = "Entitlement Friendly Description";
StartDate = DateTime.Now;
EndDate = DateTime.Now.AddMonths(1);
};
{
var request = new AddEntitlementToUserRequest
{
clientId = 433;
apiPassword = "sN?67oS=cE";
EntitlementIdentifier = "Ent1234";
EntitlementFriendlyName = "Entitlement Friendly Description";
StartDate = DateTime.Now;
EndDate = DateTime.Now.AddMonths(1);
};
var result = client.AddEntitlementToUser(request);
}
[/csharp]
リクエスト パラメータ
次の表は、AddEntitlementToUserに渡す必要がある引数、それぞれを設定する目的と効果を示しています。また必須な引数も示しています。
| 名称 | データータイプ | 説明 | 必須か？ | 値の例 |
|---|---|---|---|---|
| clientID | 整数 | MPP Globalによって提供される一意の識別子 | Yes | 433 |
| apipassword | 文字列 | MPP Globalから発行される固有のパスワード | Yes | sN?67oS=cE |
| Guid | 文字列 | エンドユーザーアカウントの有効なセッショントークンのGUID。 | No* | d5e2d8fe677543f4a495e48e3024e3f1 |
| EmailAddress | 文字列 | エンドユーザのEmailアドレス | No* | email@email.com |
| UserPassword | 文字列 | エンドユーザーのパスワード | No* | P4ssw0rd1 |
| ClientUserId | 文字列 | エンドユーザーのアカウントを識別するClientUserId。 | No* | 1234567 |
| EntitlementIdentifier | 文字列 | 追加されたエンタイトルメントの名前。 | Yes | Ent1234 |
| EntitlementFriendlyName | 文字列 | エンタイトルメントの説明。 | No | エンタイトルメントの説明。 |
| StartDate | DateTime | エンタイトルメントの開始日。 | No | 2015-08-27T00:00:00 |
| EndtDate | DateTime | エンタイトルメントの終了日。 | No | 2015-08-28T00:00:00 |
* これらのパラメーターの1つが必須ですが、すべてではありません。