ホワイトリストへの API の追加
Marketing Platform フィックスパック 10.0.0.1 を適用した場合に限り、API 呼び出しをスケジュールする外部タスクを作成する前に、この手順を実行してください。
手順
- テキスト・エディターで API のホワイトリスト・ファイルを開いて編集します。
API のホワイトリスト・ファイルは Platform_Admin_Scheduler_API.properties です。このファイルは、Marketing Platform インストール済み環境の conf ディレクトリーにあります。
- スケジュールする API の URI を入力し、照会パラメーターを使用する場合は、値は含めずにそれらのパラメーター名を含めます。
例えば、以下の API 呼び出しを、ここに示しているすべての照会パラメーターを使用してスケジュールするとします。
http://www.example.com/tickets?fields=id&state=open&sort=updated_at
すべてのパラメーターをリストして、ホワイトリスト・ファイルに以下のエントリーを作成します。
http://www.example.com/tickets?fields&state&sort
このホワイトリストのエントリーによって、リストしたパラメーターの一部またはすべてを使用する API 呼び出しをスケジュールすることができます。以下に例を示します。
- http://www.example.com/tickets
- http://www.example.com/tickets?fields=id
- http://www.example.com/tickets?fields=id&state=open
- http://www.example.com/tickets?fields=id&state=open&sort=updated_at
- http://www.example.com/tickets?fields=id&sort=updated_at
- http://www.example.com/tickets?fields=id&state=open
リストされていない照会パラメーターを使用する API 呼び出しをスケジュールすることはできません。ホワイトリストに存在しないパラメーターが使用されると、スケジューラーの検証は失敗します。
- ホワイトリスト・ファイルを保存して閉じます。
これで、「設定」>「スケジュール管理」ページの「スケジュール」タブで、この API 呼び出しをスケジュールすることができます。