초기화 설정
이 문서는 Netfunnel.initialize()에서 사용할 수 있는 모든 초기화 설정을 설명합니다.
필수 매개변수
초기화 설정에는 clientId와 secretKey 매개변수가 필요합니다.
Client ID 및 Secret Key 가져오기
Client ID와 Secret Key를 가져오는 방법과 초기화 예제는 빠른 시작 문서를 참조하세요.
기본 초기화
필수 매개변수만 사용
import { Netfunnel } from 'netfunnel-node-agent';
Netfunnel.initialize({
clientId: '{{CLIENT_ID}}',
secretKey: '{{SECRET_KEY}}'
});
초기화 설정 매개변수
| 필드 | 타입 | 기본값 | 설명 | 에이전트 버전 |
|---|---|---|---|---|
clientId | string | N/A | 콘솔에서 발급받은 클라이언트 아이디를 입력합니다. | 4.0.1 이상 |
secretKey | string | N/A | 콘솔에서 발급받은 암호화 키를 입력합니다. | 4.0.1 이상 |
serverUrl | string | N/A | NetFUNNEL 서버의 URL입니다. CNAME을 사용하지 않고, clientId 기반의 URL 조합이 아닌 별도의 URL로 서버에 접근할 때 사용합니다. (기존 방식과의 호환성을 위해 지원됩니다.) | 4.0.1 이상 |
settingUrl | string | N/A | NetFUNNEL 환경설정 파일의 URL입니다. CNAME을 사용하지 않고, clientId 기반의 URL 조합이 아닌 별도의 URL로 설정 파일을 불러올 때 사용합니다. (기존 방식과의 호환성을 위해 지원됩니다.) | 4.0.1 이상 |
vwrPageUrl | string | N/A | NetFUNNEL VWR Page의 URL입니다. CNAME을 사용하지 않고, clientId 기반의 URL 조합이 아닌 별도의 URL로 대기실 페이지에 진입해야 할 때 지정합니다. | 4.0.1 이상 |
returnKey | boolean | true | 사용자가 대기열을 통과해 페이지에 진입하면 즉시 다음 사용자가 입장할 수 있습니다. 옵션을 비활성화하면, 사용자가 페이지에 진입한 뒤에도 일정 시간동안 다음 사용자가 대기하게 됩니다. (타임아웃 설정은 콘솔의 세그먼트 설정 > 고급설정에서 가능합니다.) | 4.0.1 이상 |
printLog | boolean | false | 디버그 로그 출력 여부를 설정합니다. | 4.0.1 이상 |
goodBots | string[] | N/A | 선의의 봇(검색엔진 등)이 NetFUNNEL 진입 요청에서 제외되도록 설정합니다. 문자열의 배열로 값을 받습니다. 예시: ["Googlebot", "Bingbot"] | 4.0.1 이상 |
userId | string | N/A | 이 값을 입력하면 화이트리스트 및 영구 차단 사용자 구분에 ID가 사용됩니다. 콘솔의 반복 요청 차단 > 사용자 설정 > 접속자 관리에서 설정한 ID가 적용됩니다. | 4.0.1 이상 |
vwrPageDomain | string | N/A | CNAME 도메인만으로 VWR Page URL을 구성할 때 사용합니다. 예시: https://vwr.example.com | 4.0.1 이상 |
cookieDomain | string | N/A | 발급되는 NetFUNNEL 쿠키의 도메인(Domain) 값을 직접 지정할 수 있습니다. | 4.0.2 이상 |
설정 예제
기본 설정
import { Netfunnel } from 'netfunnel-node-agent';
Netfunnel.initialize({
clientId: '{{CLIENT_ID}}',
secretKey: '{{SECRET_KEY}}'
});
디버그 로그 활성화
import { Netfunnel } from 'netfunnel-node-agent';
Netfunnel.initialize({
clientId: '{{CLIENT_ID}}',
secretKey: '{{SECRET_KEY}}',
printLog: true
});
Good Bot 예외 처리
import { Netfunnel } from 'netfunnel-node-agent';
Netfunnel.initialize({
clientId: '{{CLIENT_ID}}',
secretKey: '{{SECRET_KEY}}',
goodBots: ['Googlebot', 'Bingbot', 'Slurp', 'Applebot', 'facebookexternalhit']
});
사용자 식별 설정
import { Netfunnel } from 'netfunnel-node-agent';
Netfunnel.initialize({
clientId: '{{CLIENT_ID}}',
secretKey: '{{SECRET_KEY}}',
userId: '{{USER_ID}}'
});
진입 키 자동 반납 비활성화
import { Netfunnel } from 'netfunnel-node-agent';
Netfunnel.initialize({
clientId: '{{CLIENT_ID}}',
secretKey: '{{SECRET_KEY}}',
returnKey: false
});
대기실 도메인 변경
import { Netfunnel } from 'netfunnel-node-agent';
Netfunnel.initialize({
clientId: '{{CLIENT_ID}}',
secretKey: '{{SECRET_KEY}}',
vwrPageDomain: 'https://wait.example.com'
});
쿠키 도메인 설정
import { Netfunnel } from 'netfunnel-node-agent';
Netfunnel.initialize({
clientId: '{{CLIENT_ID}}',
secretKey: '{{SECRET_KEY}}',
cookieDomain: '.example.com'
});
완전한 구성 예제
import { Netfunnel } from 'netfunnel-node-agent';
Netfunnel.initialize({
// 필수
clientId: '{{CLIENT_ID}}',
secretKey: '{{SECRET_KEY}}',
// 서버 구성 (선택사항)
serverUrl: 'https://custom-server.example.com',
settingUrl: 'https://custom-setting.example.com',
vwrPageUrl: 'https://custom-vwr.example.com',
// 대기실 설정
vwrPageDomain: 'https://wait.example.com',
cookieDomain: '.example.com',
// 키 관리
returnKey: true,
// 로깅
printLog: false,
// 봇 예외 처리
goodBots: ['Googlebot', 'Bingbot'],
// 사용자 식별
userId: '{{USER_ID}}'
});
매개변수 유효성 검사
clientId
- 필수
- 유형: string
- 유효성 검사: 빈 문자열일 수 없음
- 소스: NetFUNNEL 콘솔 → 프로필 아이콘 →
통합 자격 증명(Integration Credentials)
secretKey
- 필수
- 유형: string
- 유효성 검사: 빈 문자열일 수 없음
- 소스: NetFUNNEL 콘솔 → 프로필 아이콘 →
통합 자격 증명(Integration Credentials)
printLog
- 선택
- 유형: boolean
- 기본값: false
- 동작:
true인 경우 디버그 로그를 콘솔에 출력
goodBots
- 선택
- 유형:
string[] - 기본값: undefined
- 예시:
['Googlebot', 'Bingbot']
returnKey
- 선택
- 유형: boolean
- 기본값: true
- 동작:
true인 경우 즉시 키 반납,false인 경우 타임아웃 설정에 따라 반납