WEB 에이전트 API 연동

트래픽 제어가 필요한 메서드에 적용 등 임의로 대기실 기능을 직접 사용하고 싶을 때 소스 코드에 API 형태로 대기실 기능을 활성화할 수 있습니다.

API 활용을 통한 트래픽 제어를 위해서는 WEB 에이전트 설치가 선행되어야 합니다.

API 함수 설명

Surffy_Action

Surffy_Action(request URL, callback)

진입 요청 API 호출을 위한 함수로, 대기실 활성화를 위해 사용합니다.

위 함수 실행 시 Surffy NetFUNNEL 서버에 티켓 발급을 요청합니다.

트래픽 제어가 필요한 메서드에 해당 API를 적용합니다.

• Code Template

Surffy_Action({세그먼트에 등록된 URL}, function() {
// to do
});

Parameter

• url(string) *필수
  • 트래픽 제어 대상이 되는 URL입니다. 넷퍼넬 콘솔에서 등록한 URL과 일치하는 경우 Surffy NetFUNNEL 서버에 진입을 요청하고, 그렇지 않으면 바로 이어서 두 번째 인자로 전달한 콜백 함수를 실행합니다.
• callback(function) *선택
  • NetFUNNEL Web Agent에서 진입 응답 코드를 받았을 경우 실행하는 콜백 함수입니다. 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입니다. 넷퍼넬 콘솔에서 등록한 구간 제어 종료 URL과 일치하는 경우 NetFUNNEL 서버에 진입 완료를 요청하고, 두 번째 인자로 전달한 콜백 함수를 실행합니다.
• callback(function) *선택
  • 완료 요청 후 실행하는 콜백 함수입니다. URL이 콘솔에 등록한 구간 제어 세그먼트 시작 URL에 해당되지 않는 경우에도 바로 콜백 함수가 실행됩니다.
•  Sample

import React, { useEffect } from "react"; const Promotion = () => { useEffect(() => { window.Surffy_Complete(); }, []); return <div>프로모션 페이지</div>; }; export default Promotion;

에이전트 테스트

NetFUNNEL Web Agent가 잘 적용되었는지 확인하고 싶다면, 아래의 순서를 따라 진행해 주세요.

1. 기본 제어 세그먼트의 진입 허용량을 '0'으로 설정
2. 적용한 방식(기본 동적 트래픽 제어/API 직접 호출/메인 페이지)에 따라서 웹 페이지 내 진입 요청
3. 대기실이 화면에 뜨는지 확인 (VWR 확인)
4. NetFUNNEL 콘솔 기본 제어 내 해당 세그먼트의 수치 변동이 있는지 확인 (EUM 확인)