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 は、最適な互換性とセキュリティを確保するために、ブラウザとサーバー環境それぞれに対して別々のエントリーポイントを提供します:

ブラウザでの使用（クライアント側）

ブラウザ／フロントエンドのアプリケーションでは、Node.js の依存関係を含まないブラウザ用の安全なエクスポートを使用してください:

// ブラウザ安全なインポート（Node.js の依存関係なし）
import { createFastCommentsBrowserSDK } from 'fastcomments-sdk/browser';

// ブラウザ用 SDK インスタンスを作成
const sdk = createFastCommentsBrowserSDK({
  basePath: 'https://fastcomments.com' // オプション、デフォルトは 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'
});

公開 API を使用します（API キーは不要 - ブラウザで安全です）

サーバーでの使用（Node.js）

サーバー／バックエンドのアプリケーションでは、SSO や認証機能を含むフル SDK を使用してください:

// サーバー側インポート（SSO を含み、NodeJS で動作するよう設計されています）
import { createFastCommentsSDK } from 'fastcomments-sdk/server';

// サーバー用 SDK インスタンスを作成
const sdk = createFastCommentsSDK({
  apiKey: 'your-api-key', // これはサーバー側で秘密にしてください！
  basePath: 'https://fastcomments.com' // オプション、デフォルトは https://fastcomments.com
});

// API キーを使って保護された API を使用します
const comments = await sdk.defaultApi.getComments({ 
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

型のみのインポート

TypeScript の型のみが必要で（ランタイムコードは不要な場合）は、デフォルトのインポートを使用してください:

// 型のみ（ランタイム依存なし - どこでも安全）
import type { 
  PublicComment, 
  CreateCommentParams, 
  GetCommentsPublic200Response 
} from 'fastcomments-sdk';

個別の API クラスの使用

ブラウザ環境

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

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

const publicApi = new PublicApi(config);

サーバー環境

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);

公開API とセキュアAPI

The SDK は3つの主要な 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 機能を必要とするため、サーバーエクスポートでのみ利用可能です。

Simple SSO（サーバーサイドのみ）

Simple SSO はサーバーサイドで生成してクライアントに送信する必要があります：

// サーバー側のコード (Node.js/backend)
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

// 組み込みのヘルパーを使って simple SSO を作成  
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 で使用できます

Secure SSO（サーバーサイド、推奨）

Secure SSO はサーバーサイドで実装するべきで、より高いセキュリティを提供します：

// サーバー側のコード (Node.js/backend)
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

// 組み込みのヘルパーを使って secure SSO を作成
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',
};

// Subscribe to live events for a page
const subscription = subscribeToChanges(
  config,
  'your-tenant-id', // tenantIdWS
  'page-url-id',    // urlIdWS  
  'user-session-id', // userIdWS (get this from getComments response)
  (event: LiveEvent) => {
    console.log('Live event received:', event);

    switch (event.type) {
      case LiveEventType.new_comment:
        console.log('New comment:', event.comment);
        // Update your UI with the new comment
        break;
      case LiveEventType.new_vote:
        console.log('New vote:', event.vote);
        // Update vote counts in your UI
        break;
      case LiveEventType.updated_comment:
        console.log('Comment updated:', event.comment);
        break;
      default:
        console.log('Other event type:', event.type);
    }

    return true; // Return true if event was handled
  },
  (isConnected: boolean) => {
    console.log('Connection status:', isConnected ? 'Connected' : 'Disconnected');
  }
);

// Close the subscription when done
subscription.close();

ユーザーイベントを購読

ユーザー固有のイベント（通知、メンションなど）を監視します:

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

const userConfig = {
  userIdWS: 'user-session-id', // Get this from getComments response
};

// Subscribe to user's personal feed
const userSubscription = subscribeToUserFeed(
  userConfig,
  (event: LiveEvent) => {
    console.log('User event received:', event);

    switch (event.type) {
      case LiveEventType.notification:
        console.log('New notification:', event.notification);
        // Show notification in your 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');
  }
);

// Close when done
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'
});

// Extract userIdWS from the response
const userIdWS = response.data?.userSessionInfo?.userIdWS;

if (userIdWS) {
  // Now you can subscribe to live events
  const subscription = subscribeToChanges(config, tenantIdWS, urlIdWS, userIdWS, handleEvent);
}

ブロードキャストID

You'll see you're supposed to pass a broadcastId in some API calls. When you receive events, you'll get this ID back, so you know to ignore the event if you plan to optimistically apply changes on the client (which you'll probably want to do since it offers the best experience). Pass a UUID here. The ID should be unique enough to not occur twice in a browser session.

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

監査ログを取得

パラメータ

Name	Type	Required
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

コメントをピン留め

パラメータ

Name	Type	Required
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

メールテンプレートを作成

パラメータ

Name	Type	Required	Description
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);

メールテンプレートを取得

パラメータ

Name	Type	Required	Description
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);

メールテンプレートをレンダリング

パラメータ

名前	型	必須
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);
})();

ハッシュタグを削除

パラメータ

Name	Type	必須
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);
})();

ハッシュタグを部分更新

パラメータ

名前	型	必須
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"; // オプションのソース（undefined の可能性あり）
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);

招待を送信

パラメータ

名前	型	必須
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);

モデレーターを更新

パラメータ

Name	Type	Required
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);

通知件数を削除

パラメータ

名前	型	必須	説明
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);

通知件数を取得

パラメータ

名前	型	必須
tenantId	string	はい
userId	string	いいえ
urlId	string	いいえ
fromCommentId	string	いいえ
viewed	boolean	いいえ
type	string	いいえ

レスポンス

戻り値: GetNotificationCount200Response

例

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);
})();

通知を更新

パラメータ

Name	Type	必須
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);
})();

ページを追加

Parameters

名前	型	必須	説明
tenantId	string	はい
createAPIPageData	CreateAPIPageData	はい

Response

戻り値: AddPageAPIResponse

ページを削除

パラメータ

名前	型	必須	説明
tenantId	string	はい
id	string	はい

レスポンス

戻り値: DeletePageAPIResponse

URL IDでページを取得

パラメータ

名前	型	必須	説明
tenantId	string	はい
urlId	string	はい

レスポンス

戻り値: GetPageByURLIdAPIResponse

ページ一覧を取得

パラメータ

名前	型	必須	説明
tenantId	string	はい

レスポンス

戻り値: GetPagesAPIResponse

ページを部分更新

パラメータ

名前	型	必須
tenantId	string	はい
id	string	はい
updateAPIPageData	UpdateAPIPageData	はい

レスポンス

戻り値: PatchPageAPIResponse

保留中のWebhookイベントを削除

パラメータ

名前	型	必須	説明
tenantId	string	Yes
id	string	Yes

レスポンス

返却値: FlagCommentPublic200Response

例

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);

保留中のWebhookイベント数を取得

パラメータ

Name	Type	必須
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);
})();

保留中のWebhookイベント一覧を取得

パラメータ

名前	型	必須
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
  eventType,
  undefined, // type
  domain,
  attemptCountGT,
  skip
);

質問設定を作成

パラメータ

Name	Type	Required	Description
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);

質問設定を削除

パラメータ

名前	Type	必須	説明
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);

質問設定を更新

パラメータ

Name	Type	Required
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);

質問結果を作成

パラメータ

Name	Type	Required	Description
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);

質問結果一覧を取得

パラメータ

名前	型	必須
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

コメントと質問結果を結合

パラメータ

Name	Type	必須
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

サブスクリプションを作成

パラメータ

名前	型	必須	説明
tenantId	string	はい
createAPIUserSubscriptionData	CreateAPIUserSubscriptionData	はい

レスポンス

戻り値: CreateSubscriptionAPIResponse

サブスクリプションを削除

パラメータ

名前	型	必須
tenantId	string	はい
id	string	はい
userId	string	いいえ

レスポンス

戻り値: DeleteSubscriptionAPIResponse

サブスクリプション一覧を取得

パラメータ

名前	型	必須	説明
tenantId	string	はい
userId	string	いいえ

レスポンス

戻り値: GetSubscriptionsAPIResponse

テナントの日次使用量を取得

パラメータ

Name	Type	Required
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);

テナントパッケージを取得

パラメータ

名前	型	必須	説明
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);

テナントユーザーを作成

パラメータ

Name	Type	Required	Description
tenantId	string	Yes
createTenantUserBody	CreateTenantUserBody	Yes

レスポンス

戻り値: 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);

テナントユーザーを削除

パラメータ

Name	Type	Required
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 の例

Copy

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

テナントユーザーを置換

パラメータ

Name	Type	Required
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);

テナントユーザーを更新

パラメータ

Name	Type	必須
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);

テナントを削除

パラメータ

名前	型	必須
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);
})();

テナントを更新

パラメータ

名前	型	必須
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

ユーザーのコメント購読ステータスを更新

特定のコメントに対する通知を有効または無効にします。

パラメータ

名前	型	必須
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

ユーザーの在席ステータスを取得

パラメーター

Name	型	必須
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 リファレンス

ドキュメント

使い方

集計

監査ログ

コメントからのブロック

ブロック済みコメントの確認

コメント

ドメイン設定

メールテンプレート

イベントログ

フィード投稿

コメントの通報

ハッシュタグ

モデレーター

通知件数

通知

ページ

保留中のWebhookイベント

質問設定

質問結果

質問結果の集計

SSOユーザー

サブスクリプション

テナント日次使用量

テナントプラン

テナントユーザー

テナント

画像アップロード

ユーザーバッジ進捗

ユーザーバッジ

ユーザー通知

ユーザー在席ステータス

ユーザー検索

ユーザー

投票

FastComments JavaScript/TypeScript SDK

リポジトリ

インストール

API ドキュメント

完全な API リファレンス: docs/api/README.md

ブラウザとサーバーの互換性

使い方

ブラウザでの使用（クライアント側）

サーバーでの使用（Node.js）

型のみのインポート

個別の API クラスの使用

ブラウザ環境

サーバー環境

公開API と セキュアAPI

例: Public API の使用（ブラウザ対応）

例: Default API の使用（サーバー側のみ）

SSO（シングルサインオン）統合

Simple SSO（サーバーサイドのみ）

Secure SSO（サーバーサイド、推奨）

ブラウザからの SSO の使用（サーバー生成トークンあり）

コメント作成時の SSO

一般的なユースケース

ページのコメントを取得する

コメントを作成する

コメントに投票する

ユーザー管理 (APIキーが必要)

ライブイベント（リアルタイム更新）

ページレベルのイベント

ユーザーイベントを購読

userIdWS の取得

ブロードキャストID

エラーハンドリング

集計

パラメータ

レスポンス

監査ログを取得

パラメータ

レスポンス

コメントからブロック（公開）

パラメータ

レスポンス

コメントのブロック解除（公開）

公開API とセキュアAPI