設定

外部サービスとのAPI連携

2024年08月23日 18:03 更新

外部サービスとのAPI連携について

ecforce profileでは、パーソナライズの回答データをAPIを用いて外部のサービスに送信することができます。
送信するタイミングは以下の3つから選択できます。

本記事では、APIを用いてデータを送信するための設定方法についてご案内します。

ページが表示される前（ページ表示前）、又は次のページに遷移した際（ページ完了後）にAPIを送信したい場合、【ページ設定】画面にて任意のページを表示し、項目「API連携」の「追加」をクリックします。

【API連携編集】画面にて、情報を入力し「設定する」をクリックします。

項目名	説明
タイミング	APIを送信するタイミングを設定できます。・ページ表示前・ページ完了後
URL	API接続先URLを設定できます。
メソッド	HTTPメソッドを設定できます。・GET ・PUT ・POST ・DELETE
文字コード	文字コードを設定できます。・UTF-8 ・SHIFT-JIS ・EUC-JP
ヘッダ	リクエストヘッダを設定できます。
コンテンツタイプ	コンテンツタイプを設定できます。・form-urlencoded ・application/json ・text/plain
クエリ	クエリを設定できます。
クエリ用テンプレート	クエリに埋め込めるテンプレートを設定できます。テンプレートを設定する場合は「追加」をクリックしてください。 ※クエリにキーを埋め込む際は、以下の形式で埋め込んでください。 {{キー}}

アクションが実行される際にAPIを送信したい場合、【アクション管理】画面にて任意のアクションを選択し、【アクション編集】画面の項目「API連携」の「追加」をクリックします。

【API連携編集】画面にて、情報を入力し「設定する」をクリックします。

項目名	説明
URL	API接続先URLを設定できます。
メソッド	HTTPメソッドを設定できます。・GET ・PUT ・POST ・DELETE
文字コード	文字コードを設定できます。・UTF-8 ・SHIFT-JIS ・EUC-JP
ヘッダ	リクエストヘッダを設定できます。
コンテンツタイプ	コンテンツタイプを設定できます。・form-urlencoded ・application/json ・text/plain
クエリ	クエリを設定できます。
クエリ用テンプレート	クエリに埋め込めるテンプレートを設定できます。テンプレートを設定する場合は「追加」をクリックしてください。 ※クエリにキーを埋め込む際は、以下の形式（二重中括弧内にキーを記載する形）で埋め込んでください。 {{キー}}

APIのURL、クエリ、クエリ用テンプレートにはThymeleaf変数を埋め込むことができます。
Thymeleaf変数を埋め込む際は以下の形式で埋め込んでください。
※Thymeleaf変数については、Thymeleaf変数リファレンスをご参照ください。

[(Thymeleaf変数)]

例：Google検索クエリにパーソナライズコードを埋め込む場合

https://google.com?q=[(${personalize.code})]

この記事の目次

このセクションの記事

設定