受け取り人Webユーザー管理のチュートリアル
このチュートリアルでは、Varicent IncentivesREST APIを使用して、新しいWebユーザーの有効化、Webユーザーのロックとロック解除、Webユーザーのパスワードのリセットを行います。
前提条件
受け取り人データが受け取り人テーブルにインポートされている。テーブルへのデータ追加の詳細は、???を参照してください。
管理する受け取り人のポータル・アクセスグループが作成されている。ポータル・アクセスグループの作成についての詳細は、「ポータル・アクセスモジュール」を参照してください。
???の説明どおり、Varicent APIキーが取得されている。
概要
このチュートリアルでは、次のREST API呼び出しを使用して、ポータル・アクセスグループ内の新しい受け取り人グループを有効にします。
- ポータル・アクセスグループIDの取得
この呼び出しは、変更するデータを含むテーブルの名前を取得します。
- ポータル・アクセスグループの有効化
この呼び出しは、
テーブル名を取得呼び出しによって取得されたテーブル名を使用して、変更するデータを含む入力フォームのIDを取得します。
次に、次のREST API呼び出しを使用して、 受け取り人をロックおよびロック解除し、 受け取り人のパスワードをリセットします。
- Webユーザーの更新
この呼び出しは、パスワードやロックステータスなどのWebユーザーの情報を更新します。
ポータル・アクセスグループIDの取得
まず、Varicent IncentivesREST API呼び出しを使用して、すべてのポータル・アクセスグループのリストを取得します。
次のリクエストを行います。
GET /api/v1/portalaccessgroups例：
curl -X GET -H "Authorization: Bearer API_KEY" -H "Model: YOUR_CLIENT_MODEL” -H "Content-Type: application/json" https://YOUR_ICM10_API_SERVER_ADDRESS/api/v1/portalaccessgroups
次のパラメーターを使用して、返されるレスポンスをフィルタリングできます。
パラメーター
説明
フィルター
サポートされているフィールドは次のとおりです。
groupName：ポータル・アクセスグループ名。groupId：ポータル・アクセスグループID。
次の演算がサポートされています。
等しい`name=admin`。これは厳密で大文字と小文字が区別されます。
`name^admi`で始まる、または`name$min`で終わります。大文字と小文字は区別されません。
`userType=Admin\\,Web`など、リスト内で等しい一致。大文字と小文字は区別されません。
`date=[2015-09-22\\,2015-09-25]`のような間隔一致は、包括的/排他的制約の`[a\\,b]`、`(a\\,b)`、または混合の`(a\\,b]`の数学的表記をサポートします。また、間隔は無制限の制約、`(a\\,]`もサポートします。
等しくない`name<>admin`。これは厳密で大文字と小文字が区別されます。
`name⊇dmi`に含まれます。これは大文字と小文字を区別しません。
null判定、たとえば `name=NULL`または `name<>NULL`。等号演算子と不等号演算子のみがサポートされます。
1つの属性に複数のフィルターを使用できます。また、フィルタークエリは演算子の使用もサポートします。上述のような、完全なフィルター定義が演算子の両側に求められます。フィルターする列は、演算子の両側で同じでなければなりません。次の演算子がサポートされています。AND `&&`、OR `||`。
複数の属性にフィルターを定義するには、各フィルターステートメントを`;`で区切ります。
以下は、フィルターパラメーターを使用した例です。
GET /api/v1/portalaccessgroups?filter=groupId=80
レスポンスボディで、有効にする 受け取り人を含むポータル・アクセスグループを見つけ、IDをメモします。
[ { "comment": "", "group": { "definition": { "groupId": 2, "groupName": "Administrator" }, "isPasswordExpiryEnabled": false }, "name": "Administrator", "passwordExpiryEnabled": false, "type": "Group", "subtreeGroupCount": 1, "id": 2, "parent": 1, "version": { "rowVersion": 1305203 } }, { "comment": "", "group": { "definition": { "groupId": 80, "groupName": "Account Executives" }, "isPasswordExpiryEnabled": false }, "name": "Account Executives", "passwordExpiryEnabled": false, "type": "Group", "subtreeGroupCount": 1, "id": 80, "parent": 1, "version": { "rowVersion": 1305204 } },
ポータル・アクセスグループの有効化
Varicent Incentivesでは、REST APIを使用してポータル・アクセスグループを有効にすることができます。
次のリクエストを行います。
POST /api/v1/portalaccessgroups/{PortalAccessGroupId}/webusers受け取り人グループに付与するパスワードがリクエストボディに含まれる場合：
注記
リクエストボディはJSON形式である必要があります。
{ "password":"<password>" }例：
curl -X POST -H "Authorization: Bearer API_KEY" -H "Model: YOUR_CLIENT_MODEL” -H "Content-Type: application/json" https://YOUR_ICM10_API_SERVER_ADDRESS/api/v1/portalaccessgroups/80/webusers
リクエストボディ：
{ "password":"s3cret!@#$" }
Webユーザーの情報の更新
Varicent Incentivesでは、REST APIを使用して、Webユーザーの次の情報を更新できます。Web有効ステータス、ロックステータス、次回ログイン時のパスワード変更、およびパスワードです。
次のリクエストを行います。
POST /api/v1/webusers更新するデータがリクエストボディに含まれている場合:
注記
リクエストボディはJSON形式である必要があります。
[ {"isWebEnabled":<true/false>, "isLocked":<true/false>, "changePasswordOnNextLogin":<true/false>, "title":"<title>", "email":"<email address>", "phone":"<phone number>", "reportsTo":"<title of user that the payee reports to>", "name":"<name>", "id":"<payeeID>", "password":"<password>"} ]例：
curl -X POST -H "Authorization: Bearer API_KEY" -H "Model: YOUR_CLIENT_MODEL” -H "Content-Type: application/json" https://YOUR_ICM10_API_SERVER_ADDRESS/api/v1/webusers
リクエストボディ：
[ {"isWebEnabled":true, "isLocked":false, "changePasswordOnNextLogin":true, "title":"Vice President Sales", "email":"kdawson@rti.com", "phone":"", "reportsTo":"CEO", "name":"Kim Dawson", "id":"VP001", "password":"S3cret!@#$"} ]