FastComments JavaScript/TypeScript SDK

이것은 FastComments용 공식 JavaScript/TypeScript SDK입니다.

FastComments API용 공식 JavaScript/TypeScript SDK

저장소

설치

npm install fastcomments-sdk

API 문서

전체 API 참조: docs/api/README.md

브라우저 대 서버 호환성

이 SDK는 최적의 호환성을 보장하고 런타임 오류를 방지하기 위해 이중 진입점을 사용합니다:

fastcomments-sdk/browser - 네이티브 fetch를 사용하는 브라우저 안전 버전
fastcomments-sdk/server - SSO를 지원하는 전체 Node.js 버전
fastcomments-sdk (기본) - 타입 전용, 어디서나 안전하게 임포트 가능

사용법

이 SDK는 브라우저 및 서버 환경에 대해 최적의 호환성과 보안을 보장하기 위해 별도의 진입점을 제공합니다:

Browser Usage (Client-Side)

브라우저/프런트엔드 애플리케이션의 경우 Node.js 종속성을 제외한 브라우저 안전 익스포트를 사용하세요:

// Browser-safe import (no Node.js dependencies)
import { createFastCommentsBrowserSDK } from 'fastcomments-sdk/browser';

// Create browser SDK instance
const sdk = createFastCommentsBrowserSDK({
  basePath: 'https://fastcomments.com' // optional, defaults to https://fastcomments.com
});

// Use public APIs (no API key needed - safe for browsers)
const comments = await sdk.publicApi.getCommentsPublic({ 
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Server Usage (Node.js)

서버/백엔드 애플리케이션의 경우 SSO 및 인증 기능을 포함한 전체 SDK를 사용하세요:

// Server-side import (includes SSO and designed to work with NodeJS)
import { createFastCommentsSDK } from 'fastcomments-sdk/server';

// Create server SDK instance
const sdk = createFastCommentsSDK({
  apiKey: 'your-api-key', // Keep this secret on the server!
  basePath: 'https://fastcomments.com' // optional, defaults to https://fastcomments.com
});

// Use secured APIs with your API key
const comments = await sdk.defaultApi.getComments({ 
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Types Only Import

TypeScript 타입만 필요하고 런타임 코드는 필요하지 않다면(default import)을 사용하세요:

// Types only (no runtime dependencies - safe everywhere)
import type { 
  PublicComment, 
  CreateCommentParams, 
  GetCommentsPublic200Response 
} from 'fastcomments-sdk';

Using Individual API Classes

Browser Environment

import { PublicApi, Configuration } from 'fastcomments-sdk/browser';

const config = new Configuration({
  basePath: 'https://fastcomments.com'
});

const publicApi = new PublicApi(config);

Server Environment

import { DefaultApi, PublicApi, Configuration } from 'fastcomments-sdk/server';

const config = new Configuration({
  apiKey: 'your-api-key',
  basePath: 'https://fastcomments.com'
});

const defaultApi = new DefaultApi(config);
const publicApi = new PublicApi(config);

공개 vs 보호된 API

The SDK는 세 가지 주요 API 클래스를 제공합니다:

DefaultApi - 인증을 위해 API 키가 필요한 보안 엔드포인트입니다. 서버 측 작업에 사용하세요.
PublicApi - API 키 없이 접근 가능한 공개 엔드포인트입니다. 브라우저/모바일 기기 등에서 직접 호출할 수 있습니다.
HiddenApi - 고급 사용 사례를 위한 내부/관리자용 엔드포인트입니다.

예시: Public API 사용 (브라우저에서 안전하게 사용)

import { PublicApi } from 'fastcomments-sdk/browser';

const publicApi = new PublicApi();

// 페이지의 댓글을 가져옵니다 (API 키 필요 없음)
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

예시: Default API 사용 (서버 측 전용)

import { DefaultApi, Configuration } from 'fastcomments-sdk/server';

const config = new Configuration({
  apiKey: 'your-api-key' // 비밀로 유지하세요!
});
const defaultApi = new DefaultApi(config);

// 전체 관리자 권한으로 댓글을 가져옵니다
const response = await defaultApi.getComments({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

SSO(싱글 사인온) 통합

FastComments는 기존 사용자 인증 시스템과 통합하기 위해 SSO를 지원합니다. SSO 기능은 Node.js의 crypto 기능을 필요로 하기 때문에 서버 내보내기에서만 사용할 수 있습니다.

간단한 SSO (서버 전용)

간단한 SSO는 서버 측에서 생성되어 클라이언트로 전송되어야 합니다:

// 서버 측 코드 (Node.js/백엔드)
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

// Create simple SSO using the built-in helper  
const userData = {
  username: 'john_doe',
  email: 'john@example.com',
  displayName: 'John Doe',
  avatar: 'https://example.com/avatar.jpg'
};

const sso = FastCommentsSSO.createSimple(userData, {
  loginURL: '/login',
  logoutURL: '/logout'
});

const ssoToken = sso.createToken();

// ssoToken을 클라이언트 측 코드로 전송
// 클라이언트 측 코드는 이 토큰을 브라우저 SDK와 함께 사용할 수 있음

보안 SSO (서버 측, 권장)

보안 SSO는 서버 측에 구현되어야 하며 더 나은 보안을 제공합니다:

// 서버 측 코드 (Node.js/백엔드)
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

// Create secure SSO using the built-in helper
const userData = {
  id: 'user-123',
  email: 'john@example.com',
  username: 'john_doe',
  displayName: 'John Doe',
  avatar: 'https://example.com/avatar.jpg',
  isAdmin: false,
  isModerator: false
};

const sso = FastCommentsSSO.createSecure('your-api-key', userData, {
  loginURL: '/login',
  logoutURL: '/logout'
});

const ssoConfig = sso.prepareToSend();

// 서버에서 API 호출과 함께 사용
const publicApi = new PublicApi();
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id',
  sso: JSON.stringify(ssoConfig)
});

// 또는 브라우저 사용을 위해 ssoConfig를 클라이언트로 전송

브라우저에서 SSO 사용 (서버 생성 토큰 포함)

// 클라이언트 측 코드 (브라우저)
import { PublicApi } from 'fastcomments-sdk/browser';

// 서버 엔드포인트에서 SSO 토큰 가져오기
const ssoToken = await fetch('/api/sso-token').then(r => r.json());

const publicApi = new PublicApi();
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id',
  sso: ssoToken // 서버에서 생성된 SSO 토큰 사용
});

댓글 생성과 함께하는 SSO

// 서버 측: SSO 및 댓글 생성
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

const sso = FastCommentsSSO.createSecure('your-api-key', userData);
const ssoConfig = sso.prepareToSend();

const response = await publicApi.createCommentPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id',
  broadcastId: 'unique-broadcast-id',
  commentData: {
    comment: 'This is my comment',
    date: Date.now(),
    commenterName: 'John Doe',
    url: 'https://example.com/page',
    urlId: 'page-url-id'
  },
  sso: JSON.stringify(ssoConfig)
});

일반적인 사용 사례

페이지의 댓글 가져오기

const comments = await sdk.publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'article-123'
});

댓글 생성

const newComment = await sdk.publicApi.createCommentPublic({
  createCommentParams: {
    tenantId: 'your-tenant-id',
    urlId: 'article-123',
    comment: 'Great article!',
    commenterName: 'John Doe',
    commenterEmail: 'john@example.com'
  }
});

댓글에 투표하기

const voteResponse = await sdk.publicApi.voteComment({
  voteBodyParams: {
    commentId: 'comment-id',
    direction: 1 // 1은 찬성(업보트), -1은 반대(다운보트)
  }
});

사용자 관리 (API 키 필요)

// 사용자 검색 (DefaultApi 필요)
const users = await sdk.defaultApi.searchUsers({
  tenantId: 'your-tenant-id',
  urlId: 'page-id',
  usernameStartsWith: 'john'
});

라이브 이벤트(실시간 업데이트)

댓글, 투표 및 기타 활동에 대한 실시간 업데이트를 받기 위해 라이브 이벤트를 구독하세요.

페이지 수준 이벤트

특정 페이지의 라이브 이벤트(댓글, 투표 등)를 수신합니다:

import { subscribeToChanges, LiveEvent, LiveEventType } from 'fastcomments-sdk/browser';

const config = {
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id',
};

// 특정 페이지의 라이브 이벤트를 구독합니다
const subscription = subscribeToChanges(
  config,
  'your-tenant-id', // tenantIdWS
  'page-url-id',    // urlIdWS  
  'user-session-id', // userIdWS (getComments 응답에서 가져옵니다)
  (event: LiveEvent) => {
    console.log('Live event received:', event);

    switch (event.type) {
      case LiveEventType.new_comment:
        console.log('New comment:', event.comment);
        // 새 댓글로 UI를 업데이트합니다
        break;
      case LiveEventType.new_vote:
        console.log('New vote:', event.vote);
        // UI의 투표 수를 업데이트합니다
        break;
      case LiveEventType.updated_comment:
        console.log('Comment updated:', event.comment);
        break;
      default:
        console.log('Other event type:', event.type);
    }

    return true; // 이벤트가 처리되었으면 true를 반환합니다
  },
  (isConnected: boolean) => {
    console.log('Connection status:', isConnected ? 'Connected' : 'Disconnected');
  }
);

// 완료되면 구독을 닫습니다
subscription.close();

사용자 이벤트 구독

사용자별 이벤트(알림, 멘션 등)를 수신합니다:

import { subscribeToUserFeed, LiveEvent, LiveEventType } from 'fastcomments-sdk/browser';

const userConfig = {
  userIdWS: 'user-session-id', // getComments 응답에서 가져옵니다
};

// 사용자의 개인 피드를 구독합니다
const userSubscription = subscribeToUserFeed(
  userConfig,
  (event: LiveEvent) => {
    console.log('User event received:', event);

    switch (event.type) {
      case LiveEventType.notification:
        console.log('New notification:', event.notification);
        // UI에 알림을 표시합니다
        break;
      case LiveEventType.notification_update:
        console.log('Notification updated:', event.notification);
        break;
      default:
        console.log('Other user event:', event.type);
    }

    return true;
  },
  (isConnected: boolean) => {
    console.log('User feed connection:', isConnected ? 'Connected' : 'Disconnected');
  }
);

// 완료되면 닫습니다
userSubscription.close();

userIdWS 가져오기

The userIdWS parameter is required for live events and can be obtained from API responses:

const response = await sdk.publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-id'
});

// 응답에서 userIdWS를 추출합니다
const userIdWS = response.data?.userSessionInfo?.userIdWS;

if (userIdWS) {
  // 이제 라이브 이벤트를 구독할 수 있습니다
  const subscription = subscribeToChanges(config, tenantIdWS, urlIdWS, userIdWS, handleEvent);
}

브로드캐스트 ID

일부 API 호출에서는 broadcastId를 전달해야 한다는 것을 보게 될 것입니다. 이벤트를 수신하면 이 ID가 반환되므로, 클라이언트에서 낙관적으로 변경을 적용하려는 경우(가장 좋은 경험을 제공하므로 아마도 그렇게 하게 될 것입니다) 해당 이벤트를 무시해야 할지 알 수 있습니다. 여기에는 UUID를 전달하세요. 이 ID는 브라우저 세션에서 두 번 발생하지 않을 정도로 충분히 고유해야 합니다.

import { v4 as uuidv4 } from 'uuid';

const response = await sdk.publicApi.createCommentPublic({
  createCommentParams: {
    tenantId: 'your-tenant-id',
    urlId: 'page-id',
    comment: 'My comment',
    broadcastId: uuidv4() // 이 작업을 위한 고유 ID
  }
});

오류 처리

try {
  const comments = await sdk.publicApi.getCommentsPublic({
    tenantId: 'your-tenant-id',
    urlId: 'page-id'
  });
} catch (error) {
  if (error.response?.status === 404) {
    console.log('Page not found');
  } else {
    console.error('API Error:', error.message);
  }
}

집계

문서를 그룹화하여 (groupBy가 제공된 경우) 여러 연산을 적용해 집계합니다. 다양한 연산(예: sum, countDistinct, avg 등)이 지원됩니다.

매개변수

이름	형식	필수
tenantId	string	예
aggregationRequest	AggregationRequest	예
parentTenantId	string	아니요
includeStats	boolean	아니요

응답

반환: AggregationResponse

감사 로그 가져오기

매개변수

이름	형식	필수
tenantId	string	예
limit	number	아니오
skip	number	아니오
order	SORTDIR	아니오
after	number	아니오
before	number	아니오

응답

반환: GetAuditLogs200Response

공개 댓글 차단

매개변수

이름	유형	필수
tenantId	string	예
commentId	string	예
publicBlockFromCommentParams	PublicBlockFromCommentParams	예
sso	string	아니오

응답

반환: BlockFromCommentPublic200Response

공개 댓글 차단 해제

매개변수

이름	형식	필수
tenantId	string	예
commentId	string	예
publicBlockFromCommentParams	PublicBlockFromCommentParams	예
sso	string	아니오

응답

반환: UnBlockCommentPublic200Response

차단된 댓글 확인

매개변수

이름	형식	필수
tenantId	string	예
commentIds	string	예
sso	string	아니오

응답

반환: CheckedCommentsForBlocked200Response

댓글에서 사용자 차단

매개변수

이름	타입	필수
tenantId	string	예
id	string	예
blockFromCommentParams	BlockFromCommentParams	예
userId	string	아니요
anonUserId	string	아니요

응답

반환: BlockFromCommentPublic200Response

공개 댓글 생성

매개변수

이름	타입	필수
tenantId	string	예
urlId	string	예
broadcastId	string	예
commentData	CommentData	예
sessionId	string	아니오
sso	string	아니오

응답

반환: CreateCommentPublic200Response

댓글 삭제

매개변수

이름	형식	필수
tenantId	string	예
id	string	예
contextUserId	string	아니요
isLive	boolean	아니요

응답

반환: DeleteComment200Response

공개 댓글 삭제

매개변수

이름	형식	필수
tenantId	string	예
commentId	string	예
broadcastId	string	예
editKey	string	아니오
sso	string	아니오

응답

반환: DeleteCommentPublic200Response

댓글 투표 삭제

매개변수

이름	형식	필수
tenantId	string	예
commentId	string	예
voteId	string	예
urlId	string	예
broadcastId	string	예
editKey	string	아니요
sso	string	아니요

응답

반환: DeleteCommentVote200Response

댓글 신고

매개변수

이름	유형	필수
tenantId	string	예
id	string	예
userId	string	아니오
anonUserId	string	아니오

응답

반환: FlagComment200Response

댓글 가져오기

매개변수

이름	타입	필수	설명
tenantId	string	예
id	string	예

응답

반환: GetComment200Response

댓글 목록 가져오기

매개변수

이름	유형	필수
tenantId	string	예
page	number	아니오
limit	number	아니오
skip	number	아니오
asTree	boolean	아니오
skipChildren	number	아니오
limitChildren	number	아니오
maxTreeDepth	number	아니오
urlId	string	아니오
userId	string	아니오
anonUserId	string	아니오
contextUserId	string	아니오
hashTag	string	아니오
parentId	string	아니오
direction	SortDirections	아니오

응답

반환: GetComments200Response

공개 댓글 가져오기

req tenantId urlId

매개변수

이름	형식	필수
tenantId	string	예
urlId	string	예
page	number	아니오
direction	SortDirections	아니오
sso	string	아니오
skip	number	아니오
skipChildren	number	아니오
limit	number	아니오
limitChildren	number	아니오
countChildren	boolean	아니오
fetchPageForCommentId	string	아니오
includeConfig	boolean	아니오
countAll	boolean	아니오
includei10n	boolean	아니오
locale	string	아니오
modules	string	아니오
isCrawler	boolean	아니오
includeNotificationCount	boolean	아니오
asTree	boolean	아니오
maxTreeDepth	number	아니오
useFullTranslationIds	boolean	아니오
parentId	string	아니오
searchText	string	아니오
hashTags	Array	아니오
userId	string	아니오
customConfigStr	string	아니오
afterCommentId	string	아니오
beforeCommentId	string	아니오

응답

반환: GetCommentsPublic200Response

댓글 텍스트 가져오기

매개변수

이름	유형	필수
tenantId	string	예
commentId	string	예
editKey	string	아니요
sso	string	아니요

응답

반환: GetCommentText200Response

댓글 투표 사용자 이름 가져오기

매개변수

이름	유형	필수
tenantId	string	예
commentId	string	예
dir	number	예
sso	string	아니오

응답

반환: GetCommentVoteUserNames200Response

댓글 잠금

매개변수

이름	형식	필수
tenantId	string	예
commentId	string	예
broadcastId	string	예
sso	string	아니요

응답

반환: LockComment200Response

댓글 고정

매개변수

이름	형식	필수
tenantId	string	예
commentId	string	예
broadcastId	string	예
sso	string	아니요

응답

반환: PinComment200Response

댓글 저장

매개변수

이름	형식	필수
tenantId	string	예
createCommentParams	CreateCommentParams	예
isLive	boolean	아니오
doSpamCheck	boolean	아니오
sendEmails	boolean	아니오
populateNotifications	boolean	아니오

응답

반환: SaveComment200Response

댓글 일괄 저장

매개변수

이름	타입	필수
tenantId	string	예
createCommentParams	Array	예
isLive	boolean	아니요
doSpamCheck	boolean	아니요
sendEmails	boolean	아니요
populateNotifications	boolean	아니요

응답

반환: Array<SaveComment200Response

댓글 텍스트 설정

매개변수

이름	유형	필수
tenantId	string	예
commentId	string	예
broadcastId	string	예
commentTextUpdateRequest	CommentTextUpdateRequest	예
editKey	string	아니요
sso	string	아니요

응답

반환: SetCommentText200Response

댓글에서 사용자 차단 해제

매개변수

이름	형식	필수
tenantId	string	예
id	string	예
unBlockFromCommentParams	UnBlockFromCommentParams	예
userId	string	아니오
anonUserId	string	아니오

응답

반환: UnBlockCommentPublic200Response

댓글 신고 해제

매개변수

이름	형식	필수
tenantId	string	예
id	string	예
userId	string	아니오
anonUserId	string	아니오

응답

반환: FlagComment200Response

댓글 잠금 해제

매개변수

이름	형식	필수
tenantId	string	예
commentId	string	예
broadcastId	string	예
sso	string	아니오

응답

반환: LockComment200Response

댓글 고정 해제

매개변수

이름	형식	필수
tenantId	string	예
commentId	string	예
broadcastId	string	예
sso	string	아니요

응답

반환: PinComment200Response

댓글 업데이트

매개변수

이름	타입	필수
tenantId	string	예
id	string	예
body	PickAPICommentUpdatableCommentFields	예
contextUserId	string	아니오
doSpamCheck	boolean	아니오
isLive	boolean	아니오

응답

반환: FlagCommentPublic200Response

댓글에 투표

매개변수

이름	형식	필수
tenantId	string	예
commentId	string	예
urlId	string	예
broadcastId	string	예
voteBodyParams	VoteBodyParams	예
sessionId	string	아니오
sso	string	아니오

응답

반환: VoteComment200Response

도메인 구성 추가

매개변수

이름	유형	필수	설명
tenantId	string	예
addDomainConfigParams	AddDomainConfigParams	예

응답

반환: AddDomainConfig200Response

도메인 구성 삭제

매개변수

이름	형식	필수	설명
tenantId	string	예
domain	string	예

응답

반환: DeleteDomainConfig200Response

도메인 구성 가져오기

매개변수

이름	유형	필수	설명
tenantId	string	예
domain	string	예

응답

반환: GetDomainConfig200Response

도메인 구성 목록 가져오기

매개변수

이름	형식	필수	설명
tenantId	string	예

응답

반환: GetDomainConfigs200Response

도메인 구성 부분 업데이트

매개변수

이름	형식	필수
tenantId	string	예
domainToUpdate	string	예
patchDomainConfigParams	PatchDomainConfigParams	예

응답

반환: GetDomainConfig200Response

도메인 구성 전체 교체

매개변수

이름	유형	필수
tenantId	string	예
domainToUpdate	string	예
updateDomainConfigParams	UpdateDomainConfigParams	예

응답

반환: GetDomainConfig200Response

이메일 템플릿 생성

매개변수

이름	타입	필수	설명
tenantId	string	예
createEmailTemplateBody	CreateEmailTemplateBody	예

응답

반환: CreateEmailTemplate200Response

예제

createEmailTemplate 예제

Copy

const tenantId: string = "tenant_7a9f2b3d";
const createEmailTemplateBody: CreateEmailTemplateBody = {
  name: "Comment Notification",
  subject: "New comment on your article: ",
  htmlBody: "<p> left a comment:</p><blockquote></blockquote>",
  enabled: true,
  defaultLocale: "en-US",
  metadata: { createdBy: "admin@example.com", purpose: "notify_comment" } // 선택적 추가 데이터
};
const result: CreateEmailTemplate200Response = await createEmailTemplate(tenantId, createEmailTemplateBody);

이메일 템플릿 삭제

매개변수

이름	유형	필수	설명
tenantId	string	예
id	string	예

응답

반환: FlagCommentPublic200Response

예제

deleteEmailTemplate 예제

Copy

const tenantId: string = "tenant_4b2f6a-4b2f6a2d";
const templateId: string = "email_template_9f8b7c3e";
const result: FlagCommentPublic200Response = await deleteEmailTemplate(tenantId, templateId);
const status: APIStatus | undefined = result?.status

이메일 템플릿 렌더링 오류 삭제

매개변수

이름	유형	필수
tenantId	string	예
id	string	예
errorId	string	예

응답

반환: FlagCommentPublic200Response

예제

deleteEmailTemplateRenderError 예제

Copy

const tenantId: string = "tenant_8f3b2a9c";
const id: string = "template_4a1c9f7e";
const errorId: string = "err_20260112_abc123";
const result: FlagCommentPublic200Response = await deleteEmailTemplateRenderError(tenantId, id, errorId);

이메일 템플릿 가져오기

매개변수

이름	타입	필수	설명
tenantId	string	예
id	string	예

응답

반환: GetEmailTemplate200Response

예제

getEmailTemplate 예제

Copy

(async () => {
  const tenantId: string = 'acme-enterprises-123';
  const id: string = 'welcome-email-template-v2';
  const locale: string | undefined = 'en-US'; // 선택적 매개변수 예제
  const template: GetEmailTemplate200Response = await getEmailTemplate(tenantId, id);
  console.log(template, locale);
})();

이메일 템플릿 정의 가져오기

매개변수

이름	형식	필수	설명
tenantId	string	예

응답

반환: GetEmailTemplateDefinitions200Response

예제

getEmailTemplateDefinitions 예제

Copy

const tenantId: string = 'acme-enterprises-78f2';
const emailTemplates: GetEmailTemplateDefinitions200Response = await getEmailTemplateDefinitions(tenantId);

이메일 템플릿 렌더링 오류 가져오기

매개변수

이름	타입	필수
tenantId	string	예
id	string	예
skip	number	아니요

응답

반환: GetEmailTemplateRenderErrors200Response

예제

getEmailTemplateRenderErrors 예제

Copy

const tenantId: string = "tenant_7b3f2a9c";
const id: string = "tmpl_4f1b2c9e";
const skip: number = 25;
const result: GetEmailTemplateRenderErrors200Response = await getEmailTemplateRenderErrors(tenantId, id, skip);

이메일 템플릿 목록 가져오기

매개변수

이름	타입	필수	설명
tenantId	string	예
skip	number	아니오

응답

반환: GetEmailTemplates200Response

예제

getEmailTemplates 예제

Copy

const tenantId: string = 'tenant_8f4d2b7c';
const responseWithoutSkip: GetEmailTemplates200Response = await getEmailTemplates(tenantId);
const skip: number = 20;
const responseWithSkip: GetEmailTemplates200Response = await getEmailTemplates(tenantId, skip);

이메일 템플릿 렌더링

매개변수

Name	Type	Required
tenantId	string	예
renderEmailTemplateBody	RenderEmailTemplateBody	예
locale	string	아니오

응답

반환: RenderEmailTemplate200Response

예제

renderEmailTemplate 예제

Copy

const tenantId: string = 'acme-corp-7f3';
const renderEmailTemplateBody: RenderEmailTemplateBody = {
  templateId: 'new-comment-notification',
  recipientEmail: 'jane.doe@acme.com',
  variables: {
    commenterName: 'Samir Patel',
    commentText: 'I found this article really helpful — thanks for sharing!',
    threadUrl: 'https://acme.com/blog/123#comments'
  },
  includeUnsubscribeLink: true
};
const locale: string = 'en-US';
const response: RenderEmailTemplate200Response = await renderEmailTemplate(tenantId, renderEmailTemplateBody, locale);

이메일 템플릿 업데이트

매개변수

이름	유형	필수
tenantId	string	예
id	string	예
updateEmailTemplateBody	UpdateEmailTemplateBody	예

응답

반환: FlagCommentPublic200Response

예제

updateEmailTemplate 예제

Copy

const tenantId: string = 'acme-corp-tenant-01';
const id: string = 'email_tpl_42b7a9';
const updateEmailTemplateBody: UpdateEmailTemplateBody = {
  name: 'Comment Flag Notification',
  subject: 'A comment was flagged on acme.com',
  html: '<p>A comment by  was flagged. Review at </p>',
  replyTo: 'noreply@acme.com', // 선택적 필드 예시
  enabled: true,
  customConfig: { priority: 'high' } // 선택적 사용자 정의 매개변수
};
const response: FlagCommentPublic200Response = await updateEmailTemplate(tenantId, id, updateEmailTemplateBody);

이벤트 로그 가져오기

req tenantId urlId userIdWS

매개변수

이름	형식	필수
tenantId	string	예
urlId	string	예
userIdWS	string	예
startTime	number	예
endTime	number	예

응답

반환: GetEventLog200Response

글로벌 이벤트 로그 가져오기

req tenantId urlId userIdWS

매개변수

이름	유형	필수
tenantId	string	예
urlId	string	예
userIdWS	string	예
startTime	number	예
endTime	number	예

응답

반환: GetEventLog200Response

피드 게시물 생성

매개변수

이름	유형	필수
tenantId	string	예
createFeedPostParams	CreateFeedPostParams	예
broadcastId	string	아니요
isLive	boolean	아니요
doSpamCheck	boolean	아니요
skipDupCheck	boolean	아니요

응답

반환: CreateFeedPost200Response

공개 피드 게시물 생성

매개변수

이름	타입	필수
tenantId	string	예
createFeedPostParams	CreateFeedPostParams	예
broadcastId	string	아니요
sso	string	아니요

응답

반환: CreateFeedPostPublic200Response

공개 피드 게시물 삭제

매개변수

이름	타입	필수
tenantId	string	예
postId	string	예
broadcastId	string	아니요
sso	string	아니요

응답

반환: DeleteFeedPostPublic200Response

피드 게시물 목록 가져오기

req tenantId afterId

매개변수

이름	유형	필수
tenantId	string	예
afterId	string	아니요
limit	number	아니요
tags	Array	아니요

응답

반환: GetFeedPosts200Response

공개 피드 게시물 가져오기

req tenantId afterId

매개변수

이름	타입	필수
tenantId	string	예
afterId	string	아니오
limit	number	아니오
tags	Array	아니오
sso	string	아니오
isCrawler	boolean	아니오
includeUserInfo	boolean	아니오

응답

반환: GetFeedPostsPublic200Response

피드 게시물 통계 가져오기

매개변수

이름	타입	필수
tenantId	string	예
postIds	Array	예
sso	string	아니요

응답

반환: GetFeedPostsStats200Response

공개 사용자 반응 가져오기

매개변수

이름	형식	필수
tenantId	string	예
postIds	Array	아니오
sso	string	아니오

응답

반환: GetUserReactsPublic200Response

공개 피드 게시물에 반응

매개변수

이름	타입	필수
tenantId	string	예
postId	string	예
reactBodyParams	ReactBodyParams	예
isUndo	boolean	아니요
broadcastId	string	아니요
sso	string	아니요

응답

반환: ReactFeedPostPublic200Response

피드 게시물 업데이트

매개변수

이름	유형	필수
tenantId	string	예
id	string	예
feedPost	FeedPost	예

응답

반환: FlagCommentPublic200Response

공개 피드 게시물 업데이트

매개변수

이름	유형	필수
tenantId	string	예
postId	string	예
updateFeedPostParams	UpdateFeedPostParams	예
broadcastId	string	아니오
sso	string	아니오

응답

반환: CreateFeedPostPublic200Response

공개 댓글 신고

매개변수

이름	타입	필수
tenantId	string	예
commentId	string	예
isFlagged	boolean	예
sso	string	아니요

응답

반환: FlagCommentPublic200Response

해시태그 추가

매개변수

이름	형식	필수	설명
tenantId	string	아니요
createHashTagBody	CreateHashTagBody	아니요

응답

반환: AddHashTag200Response

예제

addHashTag 예제

Copy

const tenantId: string = 'tenant_7b2f6c2b';
const createBody: CreateHashTagBody = {
  tag: 'feature-request',
  label: 'Feature Request',
  description: 'Requests for new functionality in the web client',
  isActive: true,
  visibility: 'public',
  allowedDomains: ['example.com', 'internal.example.com']
};
const result: AddHashTag200Response = await addHashTag(tenantId, createBody);
const resultWithoutTenant: AddHashTag200Response = await addHashTag(undefined, {
  tag: 'bug',
  label: 'Bug',
  description: 'Use for reproducible bugs reported by users',
  isActive: true,
  visibility: 'public'
});

해시태그 일괄 추가

매개변수

이름	형식	필수	설명
tenantId	string	아니오
bulkCreateHashTagsBody	BulkCreateHashTagsBody	아니오

응답

반환: AddHashTagsBulk200Response

예제

addHashTagsBulk 예제

Copy

(async () => {
  const tenantId: string = 'tenant_3f2b9a';
  const bulkCreateHashTagsBody: BulkCreateHashTagsBody = {
    tags: [
      { name: 'performance', description: 'Comments about site performance', visibleToModeratorsOnly: false },
      { name: 'feature-request', description: 'Requests for new features', visibleToModeratorsOnly: true }
    ]
  };
  const result: AddHashTagsBulk200Response = await addHashTagsBulk(tenantId, bulkCreateHashTagsBody);
  const resultWithNoTenant: AddHashTagsBulk200Response = await addHashTagsBulk(undefined, bulkCreateHashTagsBody);
  console.log(result, resultWithNoTenant);
})();

해시태그 삭제

매개변수

이름	유형	필수
tag	string	예
tenantId	string	아니요
deleteHashTagRequest	DeleteHashTagRequest	아니요

응답

반환: FlagCommentPublic200Response

예제

deleteHashTag 예제

Copy

const tag: string = 'breaking-news';
const tenantId: string = 'tenant_42';
const deleteReq: DeleteHashTagRequest = { removedBy: 'moderator_jane', reason: 'off-topic for this community', deleteAssociatedComments: true } as DeleteHashTagRequest;
const result: FlagCommentPublic200Response = await deleteHashTag(tag, tenantId, deleteReq);

해시태그 가져오기

매개변수

이름	유형	필수	설명
tenantId	string	예
page	number	아니요

응답

반환: GetHashTags200Response

예제

getHashTags 예제

Copy

(async () => {
  const tenantId: string = "acme-corp-7a9f";
  const tagsPage1: GetHashTags200Response = await getHashTags(tenantId);
  const tagsPage2: GetHashTags200Response = await getHashTags(tenantId, 2);
  console.log(tagsPage1, tagsPage2);
})();

해시태그 부분 업데이트

매개변수

Name	Type	Required
tag	string	예
tenantId	string	아니오
updateHashTagBody	UpdateHashTagBody	아니오

응답

반환: PatchHashTag200Response

예제

patchHashTag 예제

Copy

const tag: string = 'release-2026';
const tenantId: string = 'tenant_42';
const updateHashTagBody: UpdateHashTagBody = {
  displayName: 'Release 2026',
  description: 'Discussions and notes for the 2026 product release',
  isActive: true
};
const result: PatchHashTag200Response = await patchHashTag(tag, tenantId, updateHashTagBody);

모더레이터 생성

매개변수

이름	유형	필수	설명
tenantId	string	예
createModeratorBody	CreateModeratorBody	예

응답

반환: CreateModerator200Response

예제

createModerator 예제

Copy

const tenantId: string = "tenant_prod_us-east_01";
const createModeratorBody: CreateModeratorBody = {
  email: "maria.lopez+mod@fastcompany.com",
  username: "mlopez_mod",
  displayName: "Maria Lopez",
  roles: ["content_moderator"],
  notifyOnReports: true,
  metadata: { region: "us-east", team: "community" }
};
const result: CreateModerator200Response = await createModerator(tenantId, createModeratorBody);

모더레이터 삭제

매개변수

이름	형식	필수
tenantId	string	예
id	string	예
sendEmail	string	아니요

응답

반환: FlagCommentPublic200Response

예제

deleteModerator 예제

Copy

const tenantId: string = 'acme-tenant-987';
const moderatorId: string = 'mod-78b2c9a4-3f1e-4d6a';
const sendEmail: string = 'true';
const result: FlagCommentPublic200Response = await deleteModerator(tenantId, moderatorId, sendEmail);

모더레이터 가져오기

매개변수

이름	유형	필수	설명
tenantId	string	예
id	string	예

응답

반환: GetModerator200Response

예제

getModerator 예제

Copy

const tenantId: string = "tenant_eu_4f8d2b9e";
const maybeModeratorId: string | undefined = "mod_91c3b7a2"; // 선택적 소스(정의되지 않을 수 있음)
const moderator: GetModerator200Response = await getModerator(tenantId, maybeModeratorId!);

모더레이터 목록 가져오기

매개변수

이름	유형	필수	설명
tenantId	string	예
skip	number	아니요

응답

반환: GetModerators200Response

예제

getModerators 예제

Copy

const tenantId: string = "tenant_corp_7f9b2a";
const moderatorsPage1: GetModerators200Response = await getModerators(tenantId);
const skip: number = 50;
const moderatorsPage2: GetModerators200Response = await getModerators(tenantId, skip);

초대장 전송

매개변수

Name	Type	Required
tenantId	string	예
id	string	예
fromName	string	예

응답

반환: FlagCommentPublic200Response

예제

sendInvite 예제

Copy

const tenantId: string = 'acme-tenant-004';
const id: string = 'comment_9b7f3a2c';
const fromName: string = 'María Hernández';
const response: FlagCommentPublic200Response = await sendInvite(tenantId, id, fromName);

모더레이터 업데이트

매개변수

이름	유형	필수
tenantId	string	예
id	string	예
updateModeratorBody	UpdateModeratorBody	예

응답

반환: FlagCommentPublic200Response

예제

updateModerator 예제

Copy

const tenantId: string = '4f8a9c2e-3b6d-4d9e-8c2f-1a2b3c4d5e6f';
const id: string = 'mod_92a7c4';
const updateModeratorBodyMinimal: UpdateModeratorBody = { displayName: 'Sophia Patel' };
const updateModeratorBodyWithOptional: UpdateModeratorBody = {
  displayName: 'Sophia Patel',
  email: 'sophia.patel@newsroom.example',
  permissions: ['remove_comments', 'ban_user'],
  notifyOnFlag: true // 선택적 매개변수 예시
};
const result: FlagCommentPublic200Response = await updateModerator(tenantId, id, updateModeratorBodyWithOptional);

알림 수 삭제

매개변수

Name	Type	Required	Description
tenantId	string	예
id	string	예

응답

반환: FlagCommentPublic200Response

예제

deleteNotificationCount 예제

Copy

const tenantId: string = 'tenant_7f3a1b2c4d9e';
const notificationId: string = 'notif_8c9d0a1b2f3e4b7';
const result: FlagCommentPublic200Response = await deleteNotificationCount(tenantId, notificationId);

캐시된 알림 수 가져오기

매개변수

이름	형식	필수	설명
tenantId	string	예
id	string	예

응답

반환: GetCachedNotificationCount200Response

예제

getCachedNotificationCount 예제

Copy

const tenantId: string = 'acme-tenant-01';
const baseNotificationId: string = 'notif-000123';
const idSuffix: string | undefined = undefined; // 선택적 매개변수 예시
const notificationId: string = idSuffix ? `${baseNotificationId}-${idSuffix}` : baseNotificationId;
const result: GetCachedNotificationCount200Response = await getCachedNotificationCount(tenantId, notificationId);
console.log(result);

알림 수 가져오기

Parameters

Name	Type	Required
tenantId	string	예
userId	string	아니요
urlId	string	아니요
fromCommentId	string	아니요
viewed	boolean	아니요
type	string	아니요

Response

반환: GetNotificationCount200Response

Example

getNotificationCount 예제

Copy

const tenantId: string = 'tenant_8a9b7c';
const userId: string = 'user_42b3c';
const urlId: string = 'https://blog.example.com/posts/introducing-new-editor';
const fromCommentId: string | undefined = undefined;
const viewed: boolean = false;
const type: string = 'mention';
const result: GetNotificationCount200Response = await getNotificationCount(tenantId, userId, urlId, fromCommentId, viewed, type);

알림 목록 가져오기

매개변수

이름	유형	필수
tenantId	string	예
userId	string	아니오
urlId	string	아니오
fromCommentId	string	아니오
viewed	boolean	아니오
type	string	아니오
skip	number	아니오

응답

반환: GetNotifications200Response

예제

getNotifications 예제

Copy

(async () => {
  const tenantId: string = 'tenant_8f3b1a2c';
  const userId: string = 'user_42';
  const urlId: string = 'https://news.example.com/articles/2026/01/11/comment-thread';
  const fromCommentId: string = 'cmt_9a7b';
  const viewed: boolean = false;
  const type: string = 'mention';
  const skip: number = 0;
  const response: GetNotifications200Response = await getNotifications(tenantId, userId, urlId, fromCommentId, viewed, type, skip);
  console.log(response);
})();

알림 업데이트

매개변수

이름	형식	필수
tenantId	string	예
id	string	예
updateNotificationBody	UpdateNotificationBody	예
userId	string	아니오

응답

반환: FlagCommentPublic200Response

예제

updateNotification 예제

Copy

const tenantId: string = "tenant_86a7b3";
const id: string = "notif_20260112_01";
const userId: string = "moderator_42";
const updateNotificationBody: UpdateNotificationBody = {
  name: "Flagged comment alert",
  enabled: true,
  channels: ["email"],
  recipients: ["mod-team@news-site.com"],
  threshold: 1
};
(async () => {
  const result: FlagCommentPublic200Response = await updateNotification(tenantId, id, updateNotificationBody, userId);
  console.log(result);
})();

페이지 추가

매개변수

이름	유형	필수	설명
tenantId	string	예
createAPIPageData	CreateAPIPageData	예

응답

반환: AddPageAPIResponse

페이지 삭제

매개변수

이름	형식	필수	설명
tenantId	string	예
id	string	예

응답

반환: DeletePageAPIResponse

URL ID로 페이지 가져오기

매개변수

이름	유형	필수	설명
tenantId	string	예
urlId	string	예

응답

반환: GetPageByURLIdAPIResponse

페이지 목록 가져오기

매개변수

이름	유형	필수	설명
tenantId	string	예

응답

반환: GetPagesAPIResponse

페이지 부분 업데이트

매개변수

이름	유형	필수
tenantId	string	예
id	string	예
updateAPIPageData	UpdateAPIPageData	예

응답

반환: PatchPageAPIResponse

대기 중인 웹훅 이벤트 삭제

Parameters

Name	Type	Required	Description
tenantId	string	예
id	string	예

Response

반환: FlagCommentPublic200Response

Example

deletePendingWebhookEvent 예제

Copy

const tenantId: string = 'tenant_7f4e2b';
const pendingEventId: string = '9f7b6a8c-3b2a-4c0d-a8e5-1234567890ab';
const result: FlagCommentPublic200Response = await deletePendingWebhookEvent(tenantId, pendingEventId);
console.log(result);

대기 중인 웹훅 이벤트 수 가져오기

매개변수

이름	타입	필수
tenantId	string	예
commentId	string	아니오
externalId	string	아니오
eventType	string	아니오
type	string	아니오
domain	string	아니오
attemptCountGT	number	아니오

응답

반환: GetPendingWebhookEventCount200Response

예제

getPendingWebhookEventCount 예제

Copy

(async () => {
  const tenantId: string = 'tenant_9c3b2b';
  const commentId: string = 'cmt_f4a1b2';
  const externalId: string = 'ext-789';
  const eventType: string = 'comment.created';
  const type: string = 'delivery';
  const domain: string = 'app.example.com';
  const attemptCountGT: number = 2;
  const result: GetPendingWebhookEventCount200Response = await getPendingWebhookEventCount(
    tenantId,
    commentId,
    externalId,
    eventType,
    type,
    domain,
    attemptCountGT
  );
  console.log(result);
})();

대기 중인 웹훅 이벤트 가져오기

매개변수

이름	유형	필수
tenantId	string	예
commentId	string	아니요
externalId	string	아니요
eventType	string	아니요
type	string	아니요
domain	string	아니요
attemptCountGT	number	아니요
skip	number	아니요

응답

반환: GetPendingWebhookEvents200Response

예제

getPendingWebhookEvents 예제

Copy

const tenantId: string = "tenant_78b2f1";
const commentId: string = "cmt_0042";
const eventType: string = "comment.created";
const domain: string = "blog.example.com";
const attemptCountGT: number = 1;
const skip: number = 0;
const pending: GetPendingWebhookEvents200Response = await getPendingWebhookEvents(
  tenantId,
  commentId,
  undefined, // externalId (외부 ID)
  eventType,
  undefined, // type (유형)
  domain,
  attemptCountGT,
  skip
);

질문 구성 생성

매개변수

이름	형식	필수	설명
tenantId	string	예
createQuestionConfigBody	CreateQuestionConfigBody	예

응답

반환: CreateQuestionConfig200Response

예제

createQuestionConfig 예제

Copy

const tenantId: string = "tenant_live_7f8b3c2a";
const customOptions: QuestionConfigCustomOptionsInner[] = [
  { value: "under18", label: "Under 18" },
  { value: "18-24", label: "18-24" },
  { value: "25-34", label: "25-34", defaultSelected: true }
];
const createQuestionConfigBody: CreateQuestionConfigBody = {
  key: "age_range",
  label: "What is your age range?",
  required: false, // 선택적: 선택적 필드를 생략한 경우와 포함한 경우를 보여줍니다
  renderingType: QuestionRenderingType.Dropdown,
  options: customOptions,
  whenSave: QuestionWhenSave.Always
};
const result: CreateQuestionConfig200Response = await createQuestionConfig(tenantId, createQuestionConfigBody);

질문 구성 삭제

매개변수

이름	형식	필수	설명
tenantId	string	예
id	string	예

응답

반환: FlagCommentPublic200Response

예제

deleteQuestionConfig 예제

Copy

async function deleteIfPresent(tenantId: string, id?: string): Promise<FlagCommentPublic200Response | null> {
  if (!id) return null;
  const result: FlagCommentPublic200Response = await deleteQuestionConfig(tenantId, id);
  return result;
}
const tenantId: string = 'tenant_acme_001';
const optionalConfigId: string | undefined = 'qcfg_20260112_01';
(async (): Promise<void> => {
  const deleted: FlagCommentPublic200Response | null = await deleteIfPresent(tenantId, optionalConfigId);
  void deleted;
})();

질문 구성 가져오기

매개변수

이름	유형	필수	설명
tenantId	string	예
id	string	예

응답

반환: GetQuestionConfig200Response

예제

getQuestionConfig 예제

Copy

const tenantId: string = 'acme-corp-47';
const questionId: string = 'q-2026-01-12-01';
const result: GetQuestionConfig200Response = await getQuestionConfig(tenantId, questionId);
function summarizeConfig(cfg: GetQuestionConfig200Response, includeMetadata?: boolean): QuestionConfig | undefined {
  // includeMetadata는 선택 사항입니다; 간결성을 위해 구현은 생략되었습니다
  return undefined;
}
const summarizedWithMeta: QuestionConfig | undefined = summarizeConfig(result, true);
const summarizedDefault: QuestionConfig | undefined = summarizeConfig(result);

질문 구성 목록 가져오기

매개변수

이름	유형	필수	설명
tenantId	string	예
skip	number	아니오

응답

반환: GetQuestionConfigs200Response

예제

getQuestionConfigs 예제

Copy

const tenantId: string = 'tenant-42a7b9';
const firstPage: GetQuestionConfigs200Response = await getQuestionConfigs(tenantId);
const secondPage: GetQuestionConfigs200Response = await getQuestionConfigs(tenantId, 50);

질문 구성 업데이트

매개변수

이름	타입	필수
tenantId	string	예
id	string	예
updateQuestionConfigBody	UpdateQuestionConfigBody	예

응답

반환: FlagCommentPublic200Response

예제

updateQuestionConfig 예제

Copy

const tenantId: string = 'tenant-82b3a';
const id: string = 'qst-20260112';
const updateQuestionConfigBody: UpdateQuestionConfigBody = { label: 'Age verification', required: true, renderingType: 'singleChoice', customOptions: [{ value: '18-24', label: '18–24' }] } as UpdateQuestionConfigBody;
const result: FlagCommentPublic200Response = await updateQuestionConfig(tenantId, id, updateQuestionConfigBody);

질문 결과 생성

매개변수

이름	유형	필수	설명
tenantId	string	예
createQuestionResultBody	CreateQuestionResultBody	예

응답

반환: CreateQuestionResult200Response

예제

createQuestionResult 예제

Copy

const tenantId: string = "fc_tenant_7a3c_us-east-1";
const metaItem: MetaItem = { key: "referrer", value: "/blog/how-to-comment" };
const createQuestionResultBody: CreateQuestionResultBody = {
  questionId: "q_42",
  commenterId: "user_1984",
  answer: "yes",
  score: 4,
  meta: [metaItem] // 선택적 메타데이터 예시
} as CreateQuestionResultBody;
const result: CreateQuestionResult200Response = await createQuestionResult(tenantId, createQuestionResultBody);

질문 결과 삭제

매개변수

이름	유형	필수	설명
tenantId	string	예
id	string	예

응답

반환: FlagCommentPublic200Response

예제

deleteQuestionResult 예제

Copy

const tenantId: string = 'acme-tenant-01';
const questionResultId: string = '6f1a2b3c-4d5e-6789-abcd-ef0123456789';
const deletedResult: FlagCommentPublic200Response = await deleteQuestionResult(tenantId, questionResultId);
console.log(deletedResult);

질문 결과 가져오기

매개변수

이름	형식	필수	설명
tenantId	string	Yes
id	string	Yes

응답

반환: GetQuestionResult200Response

예제

getQuestionResult 예제

Copy

const tenantId: string = "3fa85f64-5717-4562-b3fc-2c963f66afa6";
const questionId: string = "question_72f1b9c3a4";
const result: GetQuestionResult200Response = await getQuestionResult(tenantId, questionId);
console.log(result);

질문 결과 목록 가져오기

매개변수

Name	Type	Required
tenantId	string	예
urlId	string	아니요
userId	string	아니요
startDate	string	아니요
questionId	string	아니요
questionIds	string	아니요
skip	number	아니요

응답

반환: GetQuestionResults200Response

예제

getQuestionResults 예제

Copy

const tenantId: string = 'tenant_42';
const urlId: string = 'news/2025/fastcomments-release';
const userId: string = 'user_8b7f3c';
const startDate: string = '2025-01-01T00:00:00Z';
const questionIds: string = 'q123,q124';
const skip: number = 20;
const result: GetQuestionResults200Response = await getQuestionResults(tenantId, urlId, userId, startDate, undefined, questionIds, skip);

질문 결과 업데이트

매개변수

이름	타입	필수
tenantId	string	예
id	string	예
updateQuestionResultBody	UpdateQuestionResultBody	예

응답

반환: FlagCommentPublic200Response

예제

updateQuestionResult 예제

Copy

const tenantId: string = 'tenant_84f2b9';
const id: string = 'question_3a7c1d';
const updateQuestionResultBody: UpdateQuestionResultBody = {
  result: { verdict: 'helpful', confidence: 0.92 },
  reviewer: { id: 'mod_102', name: 'Aisha Rahman' },
  notifyUser: true // 선택적 매개변수 포함
};
const response: FlagCommentPublic200Response = await updateQuestionResult(tenantId, id, updateQuestionResultBody);

질문 결과 집계

매개변수

이름	형식	필수
tenantId	string	예
questionId	string	아니오
questionIds	Array	아니오
urlId	string	아니오
timeBucket	AggregateTimeBucket	아니오
startDate	Date	아니오
forceRecalculate	boolean	아니오

응답

반환: AggregateQuestionResults200Response

질문 결과 일괄 집계

매개변수

이름	형식	필수
tenantId	string	예
bulkAggregateQuestionResultsRequest	BulkAggregateQuestionResultsRequest	예
forceRecalculate	boolean	아니요

응답

반환: BulkAggregateQuestionResults200Response

댓글을 질문 결과와 결합

매개변수

이름	유형	필수
tenantId	string	예
questionId	string	아니요
questionIds	Array	아니요
urlId	string	아니요
startDate	Date	아니요
forceRecalculate	boolean	아니요
minValue	number	아니요
maxValue	number	아니요
limit	number	아니요

응답

반환: CombineCommentsWithQuestionResults200Response

SSO 사용자 추가

매개변수

이름	형식	필수	설명
tenantId	string	예
createAPISSOUserData	CreateAPISSOUserData	예

응답

반환: AddSSOUserAPIResponse

SSO 사용자 삭제

매개변수

이름	유형	필수
tenantId	string	예
id	string	예
deleteComments	boolean	아니오
commentDeleteMode	string	아니오

응답

반환: DeleteSSOUserAPIResponse

이메일로 SSO 사용자 가져오기

매개변수

이름	형식	필수	설명
tenantId	string	예
email	string	예

응답

반환: GetSSOUserByEmailAPIResponse

ID로 SSO 사용자 가져오기

매개변수

이름	유형	필수	설명
tenantId	string	예
id	string	예

응답

반환: GetSSOUserByIdAPIResponse

SSO 사용자 목록 가져오기

매개변수

이름	유형	필수	설명
tenantId	string	예
skip	number	아니오

응답

반환: GetSSOUsers200Response

SSO 사용자 부분 업데이트

매개변수

이름	유형	필수
tenantId	string	예
id	string	예
updateAPISSOUserData	UpdateAPISSOUserData	예
updateComments	boolean	아니요

응답

반환: PatchSSOUserAPIResponse

SSO 사용자 전체 교체

매개변수

이름	형식	필수
tenantId	string	예
id	string	예
updateAPISSOUserData	UpdateAPISSOUserData	예
updateComments	boolean	아니오

응답

반환: PutSSOUserAPIResponse

구독 생성

매개변수

Name	Type	Required	Description
tenantId	string	예
createAPIUserSubscriptionData	CreateAPIUserSubscriptionData	예

응답

반환: CreateSubscriptionAPIResponse

구독 삭제

매개변수

이름	형식	필수
tenantId	string	예
id	string	예
userId	string	아니요

응답

반환: DeleteSubscriptionAPIResponse

구독 목록 가져오기

매개변수

이름	형식	필수	설명
tenantId	string	예
userId	string	아니요

응답

반환: GetSubscriptionsAPIResponse

테넌트 일별 사용량 가져오기

매개변수

이름	유형	필수
tenantId	string	예
yearNumber	number	아니오
monthNumber	number	아니오
dayNumber	number	아니오
skip	number	아니오

응답

반환: GetTenantDailyUsages200Response

예제

getTenantDailyUsages 예제

Copy

const tenantId: string = "tenant_89f3c2-prod";
const yearNumber: number = 2026;
const monthNumber: number = 1;
const skip: number = 0;
const usages: GetTenantDailyUsages200Response = await getTenantDailyUsages(tenantId, yearNumber, monthNumber, undefined, skip);

테넌트 패키지 생성

매개변수

이름	형식	필수	설명
tenantId	string	예
createTenantPackageBody	CreateTenantPackageBody	예

응답

반환: CreateTenantPackage200Response

예제

createTenantPackage 예제

Copy

const tenantId: string = "tenant_7f3b1a9c";
const tenantPackage: TenantPackage = { id: "pkg_001", name: "Premium Plan", seats: 100 };
const customConfig: CustomConfigParameters = { enableImages: true, maxImageSizeMb: 10 };
const createTenantPackageBody: CreateTenantPackageBody = {
  packageName: "Premium Plus",
  tenantPackage,
  customConfig,
  notes: "Enable advanced moderation and image uploads" // 선택적 매개변수 예시
};
const result: CreateTenantPackage200Response = await createTenantPackage(tenantId, createTenantPackageBody);

테넌트 패키지 삭제

매개변수

이름	형식	필수	설명
tenantId	string	예
id	string	예

응답

반환: FlagCommentPublic200Response

예제

deleteTenantPackage 예제

Copy

const tenantId: string = 'fc-tenant-8a9c2b';
const packageId: string = 'pkg-47f3c9';
const result: FlagCommentPublic200Response = await deleteTenantPackage(tenantId, packageId);

테넌트 패키지 가져오기

Parameters

이름	형식	필수	설명
tenantId	string	예
id	string	예

응답

반환: GetTenantPackage200Response

예제

getTenantPackage 예제

Copy

const tenantId: string = 'tenant_westus_01';
const packageId: string = 'pkg_premium_annual_2026';
interface FetchOptions { includeArchived?: boolean }
const options: FetchOptions = { includeArchived: false };
const result: GetTenantPackage200Response = await getTenantPackage(tenantId, packageId);

테넌트 패키지 목록 가져오기

매개변수

이름	형식	필수	설명
tenantId	string	예
skip	number	아니오

응답

반환: GetTenantPackages200Response

예제

getTenantPackages 예제

Copy

const tenantId: string = 'tenant_4f3a9c2d';
const skip: number = 25;
const packagesResponse: GetTenantPackages200Response = await getTenantPackages(tenantId);
const pagedPackagesResponse: GetTenantPackages200Response = await getTenantPackages(tenantId, skip);

테넌트 패키지 교체

매개변수

이름	형식	필수
tenantId	string	예
id	string	예
replaceTenantPackageBody	ReplaceTenantPackageBody	예

응답

반환: FlagCommentPublic200Response

예제

replaceTenantPackage 예제

Copy

const tenantId: string = 'tenant-9b72f2';
const packageId: string = 'pkg-prod-v2';
const replaceTenantPackageBody: ReplaceTenantPackageBody = {
  name: 'Premium Moderation Bundle',
  enabled: true,
  maxModerators: 4,
  // "notes" 또는 "trialExpiry" 같은 선택적 필드는 여기에서 의도적으로 생략되었습니다
} as ReplaceTenantPackageBody;
const result: FlagCommentPublic200Response = await replaceTenantPackage(
  tenantId,
  packageId,
  replaceTenantPackageBody
);

테넌트 패키지 업데이트

매개변수

이름	유형	필수
tenantId	string	예
id	string	예
updateTenantPackageBody	UpdateTenantPackageBody	예

응답

반환: FlagCommentPublic200Response

예제

updateTenantPackage 예제

Copy

const tenantId: string = 'tenant_8a4f1c9b';
const packageId: string = 'pkg_premium_v2';
const customConfig: CustomConfigParameters = { enableRichText: true, maxImagesPerComment: 5 };
const updateTenantPackageBody: UpdateTenantPackageBody = {
  name: 'Premium Moderation Package',
  enabled: true,
  description: 'Adds advanced spam rules, image moderation and priority support',
  customConfigParameters: customConfig
};
const result: FlagCommentPublic200Response = await updateTenantPackage(tenantId, packageId, updateTenantPackageBody);

테넌트 사용자 생성

매개변수

이름	유형	필수	설명
tenantId	string	예
createTenantUserBody	CreateTenantUserBody	예

응답

반환: CreateTenantUser200Response

예제

createTenantUser 예제

Copy

const tenantId: string = "tenant_9a8c7e4b";
const createTenantUserBody: CreateTenantUserBody = {
  email: "julia.smith@acme-corp.com",
  displayName: "Julia Smith",
  role: "moderator",
  password: "Str0ngP@ssword!23",
  sendInviteEmail: true, // 선택적 매개변수 예시
  locale: "en-US",
  metadata: { department: "Customer Success" }
};
const result: CreateTenantUser200Response = await createTenantUser(tenantId, createTenantUserBody);

테넌트 사용자 삭제

매개변수

이름	유형	필수
tenantId	string	예
id	string	예
deleteComments	string	아니요
commentDeleteMode	string	아니요

응답

반환: FlagCommentPublic200Response

예제

deleteTenantUser 예제

Copy

const tenantId: string = 'tenant_8f3b2a9c';
const id: string = 'user_4e5f6a7b';
const deleteComments: string = 'true';
const commentDeleteMode: string = 'hard';
const result: FlagCommentPublic200Response = await deleteTenantUser(tenantId, id, deleteComments, commentDeleteMode);

테넌트 사용자 가져오기

매개변수

이름	형식	필수	설명
tenantId	string	예
id	string	예

응답

반환: GetTenantUser200Response

예제

getTenantUser 예제

Copy

const tenantId: string = "tenant_9f7d4b2a-1c3e";
const id: string = "user_6a12b3c4d5";
const includeProfile: boolean | undefined = true; // 선택적 매개변수 예시
const response: GetTenantUser200Response = await getTenantUser(tenantId, id);
console.log("Tenant user fetched", response);

테넌트 사용자 목록 가져오기

매개변수

이름	형식	필수	설명
tenantId	string	예
skip	number	아니오

응답

반환: GetTenantUsers200Response

예제

getTenantUsers Example

Copy

const tenantId: string = 'tenant_8f3b2c1a';
const skip: number = 50;
const firstPage: GetTenantUsers200Response = await getTenantUsers(tenantId);
const nextPage: GetTenantUsers200Response = await getTenantUsers(tenantId, skip);

테넌트 사용자 교체

매개변수

이름	형식	필수
tenantId	string	예
id	string	예
replaceTenantUserBody	ReplaceTenantUserBody	예
updateComments	string	아니요

응답

반환: FlagCommentPublic200Response

예제

replaceTenantUser 예제

Copy

const tenantId: string = "tenant_5f8b9a";
const id: string = "user_92bf21";
const replaceTenantUserBody: ReplaceTenantUserBody = {
  email: "jane.doe@acme-corp.com",
  displayName: "Jane Doe",
  externalId: "acme|12345",
  roles: ["commenter", "moderator"],
  isActive: true,
  metadata: { team: "product", location: "NYC" }
};
const updateComments: string = "Update historical comments to reflect new display name";
const result: FlagCommentPublic200Response = await replaceTenantUser(tenantId, id, replaceTenantUserBody, updateComments);

로그인 링크 전송

매개변수

이름	형식	필수
tenantId	string	예
id	string	예
redirectURL	string	아니오

응답

반환: FlagCommentPublic200Response

예제

sendLoginLink 예제

Copy

const tenantId: string = 'tenant_acme_01';
const id: string = 'user_9f3b2a';
const redirectURL: string = 'https://app.example.com/onboard?source=login-email';
const result: FlagCommentPublic200Response = await sendLoginLink(tenantId, id, redirectURL);

테넌트 사용자 업데이트

매개변수

이름	유형	필수
tenantId	string	예
id	string	예
updateTenantUserBody	UpdateTenantUserBody	예
updateComments	string	아니요

응답

반환: FlagCommentPublic200Response

예제

updateTenantUser 예제

Copy

const tenantId: string = 'tenant_84f3b2';
const id: string = 'user_7a9d1c';
const updateComments: string = 'Promoted to moderator and updated contact email';
const updateTenantUserBody: UpdateTenantUserBody = {
  email: 'jane.doe+mod@example.com',
  displayName: 'Jane D.',
  roles: ['moderator'],
  isBanned: false,
  metadata: { department: 'community' }
};
const result: FlagCommentPublic200Response = await updateTenantUser(tenantId, id, updateTenantUserBody, updateComments);

테넌트 생성

매개변수

이름	형식	필수	설명
tenantId	string	예
createTenantBody	CreateTenantBody	예

응답

반환: CreateTenant200Response

예제

createTenant 예제

Copy

const tenantId: string = "acme-corporation";
const billing: BillingInfo = { planId: "pro", billingContactEmail: "finance@acme-corp.com", currency: "USD" };
const domainConfig: APIDomainConfiguration = { primaryDomain: "comments.acme-corp.com", allowedDomains: ["acme-corp.com", "www.acme-corp.com"], enforceHttps: true };
const importedSites: ImportedSiteType[] = [{ siteId: "site-001", url: "https://blog.acme-corp.com", name: "Acme Blog" }]; // 선택적
const createBody: CreateTenantBody = { tenantName: "Acme Corporation", adminEmail: "admin@acme-corp.com", billingInfo: billing, domainConfiguration: domainConfig, importedSites, enableModeration: true };
const response: CreateTenant200Response = await createTenant(tenantId, createBody);

테넌트 삭제

매개변수

Name	Type	Required
tenantId	string	예
id	string	예
sure	string	아니오

응답

반환: FlagCommentPublic200Response

예제

deleteTenant 예제

Copy

const tenantId: string = "tenant_7b3f1a9e";
const id: string = "flag_9c4d2b1a";
const sure: string = "yes_confirm_delete";
const result: FlagCommentPublic200Response = await deleteTenant(tenantId, id, sure);
console.log(result);

테넌트 가져오기

매개변수

이름	유형	필수	설명
tenantId	string	예
id	string	예

응답

반환: GetTenant200Response

예제

getTenant 예제

Copy

const tenantId: string = "tenant_acme_corp";
const id: string = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
interface GetOptions { includeDeleted?: boolean; locale?: string; }
const options: GetOptions = { locale: "en-US" };
const result: GetTenant200Response = await getTenant(tenantId, id);

테넌트 목록 가져오기

매개변수

이름	유형	필수
tenantId	string	예
meta	string	아니오
skip	number	아니오

응답

반환: GetTenants200Response

예제

getTenants 예제

Copy

(async () => {
  const tenantId: string = 'tenant_9f2d1b7c';
  const meta: string = 'include=domains,billing,customConfig';
  const skip: number = 20;
  const response: GetTenants200Response = await getTenants(tenantId, meta, skip);
  console.log(response);
})();

테넌트 업데이트

매개변수

Name	Type	Required
tenantId	string	예
id	string	예
updateTenantBody	UpdateTenantBody	예

응답

반환: FlagCommentPublic200Response

예제

updateTenant 예제

Copy

const tenantId: string = "tenant_01H4ZQ7KABCD";
const id: string = "site_9f8e7d6c";
const apiDomainConfiguration: APIDomainConfiguration = {
  primaryDomain: "comments.acme.com",
  allowSubdomains: true
};
const billingInfo: BillingInfo = {
  planName: "Business",
  billingContactEmail: "billing@acme.com",
  seats: 25
};
const updateTenantBody: UpdateTenantBody = {
  displayName: "Acme Corporation Comments",
  apiDomainConfiguration,
  billingInfo, // 선택적 매개변수 예시
  enableModeration: true
};
const result: FlagCommentPublic200Response = await updateTenant(tenantId, id, updateTenantBody);

이미지 업로드

이미지 업로드 및 크기 조정

매개변수

이름	유형	필수
tenantId	string	예
file	Blob	예
sizePreset	SizePreset	아니요
urlId	string	아니요

응답

반환: UploadImageResponse

ID로 사용자 배지 진행 상황 가져오기

매개변수

이름	타입	필수	설명
tenantId	string	예
id	string	예

응답

반환: GetUserBadgeProgressById200Response

사용자 ID로 사용자 배지 진행 상황 가져오기

매개변수

이름	형식	필수	설명
tenantId	string	예
userId	string	예

응답

반환: GetUserBadgeProgressById200Response

사용자 배지 진행 목록 가져오기

매개변수

이름	형식	필수
tenantId	string	예
userId	string	아니오
limit	number	아니오
skip	number	아니오

응답

반환: GetUserBadgeProgressList200Response

사용자 배지 생성

매개변수

이름	유형	필수	설명
tenantId	string	예
createUserBadgeParams	CreateUserBadgeParams	예

응답

반환: CreateUserBadge200Response

사용자 배지 삭제

매개변수

이름	형식	필수	설명
tenantId	string	예
id	string	예

응답

반환: UpdateUserBadge200Response

사용자 배지 가져오기

매개변수

이름	형식	필수	설명
tenantId	string	예
id	string	예

응답

반환: GetUserBadge200Response

사용자 배지 목록 가져오기

매개변수

이름	유형	필수
tenantId	string	예
userId	string	아니요
badgeId	string	아니요
type	number	아니요
displayedOnComments	boolean	아니요
limit	number	아니요
skip	number	아니요

응답

반환: GetUserBadges200Response

사용자 배지 업데이트

매개변수

이름	유형	필수
tenantId	string	예
id	string	예
updateUserBadgeParams	UpdateUserBadgeParams	예

응답

반환: UpdateUserBadge200Response

사용자 알림 수 가져오기

매개변수

이름	형식	필수	설명
tenantId	string	예
sso	string	아니요

응답

반환: GetUserNotificationCount200Response

사용자 알림 목록 가져오기

매개변수

이름	형식	필수
tenantId	string	예
pageSize	number	아니오
afterId	string	아니오
includeContext	boolean	아니오
afterCreatedAt	number	아니오
unreadOnly	boolean	아니오
dmOnly	boolean	아니오
noDm	boolean	아니오
includeTranslations	boolean	아니오
sso	string	아니오

응답

반환: GetUserNotifications200Response

사용자 알림 수 재설정

매개변수

이름	형식	필수	설명
tenantId	string	예
sso	string	아니오

응답

반환: ResetUserNotifications200Response

사용자 알림 재설정

매개변수

이름	형식	필수
tenantId	string	예
afterId	string	아니오
afterCreatedAt	number	아니오
unreadOnly	boolean	아니오
dmOnly	boolean	아니오
noDm	boolean	아니오
sso	string	아니오

응답

반환: ResetUserNotifications200Response

사용자 댓글 알림 구독 상태 업데이트

특정 댓글에 대한 알림을 활성화하거나 비활성화합니다.

매개변수

Name	Type	Required
tenantId	string	예
notificationId	string	예
optedInOrOut	UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum	예
commentId	string	예
sso	string	아니오

응답

반환: UpdateUserNotificationStatus200Response

사용자 페이지 알림 구독 상태 업데이트

페이지에 대한 알림을 활성화하거나 비활성화합니다. 사용자가 페이지를 구독하면 새 최상위 댓글에 대한 알림이 생성되며, 또한

매개변수

이름	유형	필수
tenantId	string	예
urlId	string	예
url	string	예
pageTitle	string	예
subscribedOrUnsubscribed	UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum	예
sso	string	아니요

응답

반환: UpdateUserNotificationStatus200Response

사용자 알림 상태 업데이트

매개변수

이름	유형	필수
tenantId	string	예
notificationId	string	예
newStatus	UpdateUserNotificationStatusNewStatusEnum	예
sso	string	아니요

응답

반환: UpdateUserNotificationStatus200Response

사용자 접속 상태 가져오기

매개변수

이름	유형	필수
tenantId	string	예
urlIdWS	string	예
userIds	string	예

응답

반환: GetUserPresenceStatuses200Response

사용자 검색

매개변수

이름	타입	필수
tenantId	string	예
urlId	string	예
usernameStartsWith	string	예
mentionGroupIds	Array	아니요
sso	string	아니요

응답

반환: SearchUsers200Response

사용자 가져오기

매개변수

이름	타입	필수	설명
tenantId	string	예
id	string	예

응답

반환: GetUser200Response

예제

getUser 예제

Copy

const tenantId: string = "acme-publishing-42";
const userIdOptional: string | undefined = "user_9d7b4c"; // 일부 흐름에서는 undefined일 수 있음(선택 사항)
const id: string = userIdOptional ?? "user_default_0001";
const result: GetUser200Response = await getUser(tenantId, id);
console.log(result);

투표 생성

매개변수

이름	형식	필수
tenantId	string	예
commentId	string	예
direction	CreateVoteDirectionEnum	예
userId	string	아니오
anonUserId	string	아니오

응답

반환: VoteComment200Response

예제

createVote 예제

Copy

(async () => {
  const tenantId: string = 'acme-tenant-812';
  const commentId: string = '5e8f8b7a-3d4b-4f1b-9a2e-1c9f2d6a7b8c';
  const direction: CreateVoteDirectionEnum = CreateVoteDirectionEnum.UP;
  const anonUserId: string = 'anon-84b9c2d';
  const voteResult: VoteComment200Response = await createVote(tenantId, commentId, direction, undefined, anonUserId);
  console.log(voteResult);
})();

투표 삭제

매개변수

이름	유형	필수
tenantId	string	예
id	string	예
editKey	string	아니오

응답

반환: DeleteCommentVote200Response

예제

deleteVote 예제

Copy

const tenantId: string = 'tenant_7f3b21c9';
const id: string = 'vote_4a2d9f1b';
const editKey: string = 'edit_92b7c6a1';
const resultWithoutEditKey: DeleteCommentVote200Response = await deleteVote(tenantId, id);
const resultWithEditKey: DeleteCommentVote200Response = await deleteVote(tenantId, id, editKey);

투표 목록 가져오기

매개변수

이름	유형	필수	설명
tenantId	string	예
urlId	string	예

응답

반환: GetVotes200Response

예제

getVotes 예제

Copy

const tenantId: string = 'tenant_9f8b3c_prod';
const urlId: string = '/news/2026/typescript-ecosystem-update';
const votes: GetVotes200Response = await getVotes(tenantId, urlId);
// 선택적 매개변수가 존재한다면, 예: includeHidden, 다음과 같이 사용할 수 있습니다:
// const votesWithHidden: GetVotes200Response = await getVotes(tenantId, urlId, { includeHidden: true });

사용자 투표 가져오기

매개변수

이름	타입	필수
tenantId	string	예
urlId	string	예
userId	string	아니오
anonUserId	string	아니오

응답

반환: GetVotesForUser200Response

예제

getVotesForUser 예제

Copy

const tenantId: string = 'tenant_acme_01';
const urlId: string = 'news/2026/01/12/product-launch';
const userId: string = 'user_9c3f2b';
const anonUserId: string = 'anon_d4e7a1';
const votesForUser: GetVotesForUser200Response = await getVotesForUser(tenantId, urlId, userId);
const votesForAnon: GetVotesForUser200Response = await getVotesForUser(tenantId, urlId, undefined, anonUserId);

도움을 원하십니까?

JavaScript/TypeScript SDK에 문제가 있거나 질문이 있는 경우, 다음을 이용해 주세요:

기여

기여는 언제나 환영합니다! 기여 지침은 GitHub 저장소를 방문하세요.

언어 🇰🇷 한국어

시작하기

API 참조

문서

사용법

집계

감사 로그

댓글 차단

차단된 댓글 확인

댓글

도메인 구성

이메일 템플릿

이벤트 로그

피드 게시물

댓글 신고

해시태그

모더레이터

알림 수

알림

페이지

대기 중인 웹훅 이벤트

질문 구성

질문 결과

질문 결과 집계

SSO 사용자

구독

테넌트 일별 사용량

테넌트 패키지

테넌트 사용자

테넌트

이미지 업로드

사용자 배지 진행 상황

사용자 배지

사용자 알림

사용자 접속 상태

사용자 검색

사용자

투표

FastComments JavaScript/TypeScript SDK

저장소

설치

API 문서

전체 API 참조: docs/api/README.md

브라우저 대 서버 호환성

사용법

Browser Usage (Client-Side)

Server Usage (Node.js)

Types Only Import

Using Individual API Classes

Browser Environment

Server Environment

공개 vs 보호된 API

예시: Public API 사용 (브라우저에서 안전하게 사용)

예시: Default API 사용 (서버 측 전용)

SSO(싱글 사인온) 통합

간단한 SSO (서버 전용)

보안 SSO (서버 측, 권장)

브라우저에서 SSO 사용 (서버 생성 토큰 포함)

댓글 생성과 함께하는 SSO

일반적인 사용 사례

페이지의 댓글 가져오기

댓글 생성

댓글에 투표하기

사용자 관리 (API 키 필요)

라이브 이벤트(실시간 업데이트)

페이지 수준 이벤트

사용자 이벤트 구독

userIdWS 가져오기

브로드캐스트 ID

오류 처리

집계

매개변수

응답

감사 로그 가져오기

매개변수

응답

공개 댓글 차단

매개변수

응답

공개 댓글 차단 해제