メインコンテンツへスキップ
サインイン
English (US) 한국어
Menu

WEBエージェントAPI連動

The Surffy Team
  • 更新

トラフィックコントロールが必要なメソッドに適用するなど、任意に待合室機能を直接使用したい場合、ソースコードにAPIの形で待合室機能を有効にすることができます。

APIを活用したトラフィックコントロールのためには、WEBエージェントをインストールする必要があります。


API関数の説明

Surffy_Action

Surffy_Action(request URL, callback)

アクセスリクエストAPIを呼び出すための関数で、待合室を有効にするために使用します。

上記の関数を実行すると、 NetFUNNELサーバーにチケット発行を要求します。

トラフィックコントロールが必要なメソッドに該当するAPIを適用します。

  • Code Template
Surffy_Action({セグメントに登録されたURL}, function() {
// to do
});

Parameter

  • url(string) *必須
    • トラフィックコントロール対象となるURLです。NetFUNNELコンソールで登録したURLと一致する場合、NetFUNNELサーバーにアクセスをリクエストし、そうでない場合は2番目の引数で渡したコールバック関数を実行します。
  • callback(function) *選択
    • NetFUNNEL Webエージェントからアクセス応答コードを受け取った場合に実行するコールバック関数です。URLがコンソールに登録したセグメントURLに該当しない場合でも、すぐにコールバック関数が実行されます。
  • Sample
<script> const handleSubmitForm = (e) => { e.preventDefault(); console.log("submit"); // 検証などのロジック if (document.test.userid.value == "") { ... return false; } // メソッドの使用 Surffy_Action(document.test.action, () => { document.test.submit(); }); }; </script> <form name="test" action="/test" onsubmit="return handleSubmitForm(event)"> <input type="text" name="userid" /> <input type="submit" value="ログイン" /> </form>
... <script> const handleClickButton = () => { // メソッド実行前のロジック if (!validation()) { return false; } // メソッドの使用Surffy_Action('https://surffy.io/button', function() { console.log('callback'); }); } </script> <div onclick="handleClickButton"> <span>ここをクリックしてください。</span> </div>


Surffy_Complete

Surffy_Complete(request URL, callback)

アクセス完了リクエストAPIで、待機を終了してチケットを返却するために使用します。

正常に待機後にアクセスに成功した場合には、ページが更新されると自動的にチケット返却を行います。 したがって、特定の例外的な状況がなければ使用しませんが、そうでない場合(ページ遷移時にも更新されないSPAフレームワークの使用など)、その関数を呼び出して別途に完了処理をする必要があります。

チケットを返却しない場合、NetFUNNELサーバーに設定されたTimeout時間が過ぎると自動的にチケットが返却されます。

Timeout時間中にユーザーの新規アクセスが遅れる問題を防ぐためには、アクセス応答コードを受け取った場合、チケットの返却処理が必要です。

基本コントロール完了要求時にパラメータなしで呼び出します。

  • Code Template
Surffy_Complete();

区間コントロール完了要求時にパラメータを入れて呼び出します。

  • Code Template
Surffy_Complete({セグメント内に入力されたURL}, function() { //TO Do });

Parameter

  • url(string) *必須
    • アクセス完了処理の対象となるURLです。NetFUNNELコンソールで登録した区間コントロール終了URLと一致する場合、NetFUNNELサーバーにアクセス完了を要求し、第2引数で渡したコールバック関数を実行します。
  • callback(function) *選択
    • 完了リクエスト後に実行するコールバック関数です。URLがコンソールに登録した区間コントロールセグメントの開始URLに該当しない場合でも、すぐにコールバック関数が実行されます。
  •  Sample
import React, { useEffect } from "react"; const Promotion = () => { useEffect(() => { window.Surffy_Complete(); }, []); return <div>プロモーションページ</div>; }; export default Promotion;

 

エージェントテスト

NetFUNNEL Webエージェントが正しく適用されたかどうかを確認したい場合は、以下の手順に従ってください。

  1. 基本コントロールセグメントのアクセス許可量を「0」に設定します
  2. 適用した方式(基本動的トラフィックコントロール/API直接呼び出し/メインページ)に応じて、Webページ内のアクセス要求
  3. 待合室が画面に表示されるか確認(VWR確認)
  4. NetFUNNELコンソール基本コントロール内の該当するセグメントの数値変動があるか確認(EUM確認)

関連記事

コメント

0件のコメント

サインインしてコメントを残してください。