FastComments SDK ל-JavaScript/TypeScript

זהו ה-SDK הרשמי של JavaScript/TypeScript עבור FastComments.

נהל תגובות, משתמשים, SSO ומודרציה מתוך Node.js או מהדפדפן.

מאגר

התקנה

npm install fastcomments-sdk

תיעוד ה-API

מדריך API מלא: docs/api/README.md

תאימות דפדפן מול שרת

ה-SDK הזה משתמש ב-שתי נקודות כניסה כדי להבטיח תאימות מיטבית ולמנוע שגיאות בזמן ריצה:

fastcomments-sdk/browser - גרסה בטוחה לדפדפן עם fetch מובנה
fastcomments-sdk/server - גרסה מלאה ל-Node.js עם תמיכה ב-SSO
fastcomments-sdk (ברירת מחדל) - טיפוסים בלבד, בטוח לייבא בכל מקום

שימוש

חבילת SDK זו מספקת נקודות כניסה נפרדות לסביבת הדפדפן ולסביבת השרת על מנת להבטיח תאימות ואבטחה מיטבית:

שימוש בדפדפן (צד-לקוח)

For browser/frontend applications, use the browser-safe export that excludes Node.js dependencies:

// ייבוא בטוח לדפדפן (ללא תלות ב-Node.js)
import { createFastCommentsBrowserSDK } from 'fastcomments-sdk/browser';

// יצירת מופע SDK לדפדפן
const sdk = createFastCommentsBrowserSDK({
  basePath: 'https://fastcomments.com' // optional, defaults to https://fastcomments.com
});

// השתמש ב-APIs ציבוריים (אין צורך במפתח API - בטוח לדפדפנים)
const comments = await sdk.publicApi.getCommentsPublic({ 
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

שימוש בצד השרת (Node.js)

For server/backend applications, use the full SDK with SSO and authentication features:

// ייבוא בצד השרת (כולל SSO ומתוכנן לעבוד עם NodeJS)
import { createFastCommentsSDK } from 'fastcomments-sdk/server';

// יצירת מופע SDK לשרת
const sdk = createFastCommentsSDK({
  apiKey: 'your-api-key', // שמרו על זה בסוד בשרת!
  basePath: 'https://fastcomments.com' // optional, defaults to https://fastcomments.com
});

// השתמשו ב-APIs מאובטחות עם מפתח ה-API שלכם
const comments = await sdk.defaultApi.getComments({ 
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

ייבוא טיפוסים בלבד

If you only need TypeScript types (no runtime code), use the default import:

// רק טיפוסים (ללא תלות בזמן ריצה - בטוח בכל מקום)
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 ציבוריים מול מאובטחים

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 זמינה רק בגרסת השרת מכיוון שהיא דורשת יכולות crypto של Node.js.

SSO פשוט (צד שרת בלבד)

יש ליצור SSO פשוט בצד השרת ולשלוח אותו אל הלקוח:

// קוד צד שרת (Node.js/backend)
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

// יצירת 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 לדפדפן

SSO מאובטח (צד שרת, מומלץ)

יש ליישם SSO מאובטח בצד השרת והוא מספק אבטחה טובה יותר:

// קוד צד שרת (Node.js/backend)
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

// יצירת 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();

// Use with API calls on the server
const publicApi = new PublicApi();
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id',
  sso: JSON.stringify(ssoConfig)
});

// Or send ssoConfig to client for browser usage

שימוש ב-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);
        // עדכן את ממשק המשתמש שלך עם התגובה החדשה
        break;
      case LiveEventType.new_vote:
        console.log('New vote:', event.vote);
        // עדכן את ספירות ההצבעות בממשק המשתמש שלך
        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', // Get this from getComments response
};

// הירשם לפיד האישי של המשתמש
const userSubscription = subscribeToUserFeed(
  userConfig,
  (event: LiveEvent) => {
    console.log('User event received:', event);
    
    switch (event.type) {
      case LiveEventType.notification:
        console.log('New notification:', event.notification);
        // הצג הודעה בממשק המשתמש שלך
        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

פרמטר userIdWS נדרש עבור אירועים חיים וניתן להשיגו מתשובות API:

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

מזהי שידור

תראה שעליך להעביר broadcastId בחלק מקריאות ה-API. כשאתה מקבל אירועים, תקבל חזרה את ה‑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() // מזהה ייחודי לפעולה זו
  }
});

טיפול בשגיאות

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 וכו').

פרמטרים

Name	Type	Required
tenantId	string	כן
aggregationRequest	AggregationRequest	כן
parentTenantId	string	לא
includeStats	boolean	לא

תגובה

מחזיר: AggregationResponse

קבלת יומני ביקורת

פרמטרים

שם	סוג	חובה
tenantId	string	Yes
limit	number	No
skip	number	No
order	SORTDIR	No
after	number	No
before	number	No

תגובה

מחזיר: GetAuditLogs200Response

דוגמה

דוגמה של getAuditLogs

Copy

const tenantId: string = 'tenant_9a8b7c';
const limit: number = 100;
const skip: number = 0;
const after: number = Date.now() - 30 * 24 * 60 * 60 * 1000; // לפני 30 יום
const before: number = Date.now();
const auditLogs: GetAuditLogs200Response = await getAuditLogs(tenantId, limit, skip, undefined, after, before);

חסימה מתוך תגובה (ציבורי)

פרמטרים

שם	סוג	חובה
tenantId	string	כן
commentId	string	כן
publicBlockFromCommentParams	PublicBlockFromCommentParams	כן
sso	string	לא

תגובה

מחזיר: BlockFromCommentPublic200Response

דוגמה

דוגמה ל-blockFromCommentPublic

Copy

const tenantId: string = "site_7f9b2e";
const commentId: string = "comment_2026-03-25_001";
const publicBlockFromCommentParams: PublicBlockFromCommentParams = {
  reason: "Repeated harassment and targeted abuse",
  blockDurationDays: 90,
  includeHistory: true,
  notifyModeratorTeam: true
};
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.fakePayload.signature";
const result: BlockFromCommentPublic200Response = await blockFromCommentPublic(tenantId, commentId, publicBlockFromCommentParams, sso);

הסרת חסימה מתגובה (ציבורי)

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
commentId	string	כן
publicBlockFromCommentParams	PublicBlockFromCommentParams	כן
sso	string	לא

תגובה

מחזיר: UnBlockCommentPublic200Response

דוגמה

דוגמה ל-unBlockCommentPublic

Copy

const tenantId: string = 'tenant_42e8a1';
const commentId: string = 'cmt_9b3f2d';
const publicBlockFromCommentParams: PublicBlockFromCommentParams = {
  reason: 'abusive_language',
  blockedByModeratorId: 'mod_17',
  note: 'Targeted harassment; review complete',
  unblockRequestedAt: new Date().toISOString()
};
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.signature';
const result: UnBlockCommentPublic200Response = await unBlockCommentPublic(tenantId, commentId, publicBlockFromCommentParams, sso);

בדיקת תגובות חסומות

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
commentIds	string	כן
sso	string	לא

תגובה

מחזיר: CheckedCommentsForBlocked200Response

דוגמה

דוגמה ל-checkedCommentsForBlocked

Copy

const tenantId: string = 'tenant_4f3b2a1e';
const commentIds: string = 'c_1001,c_1002,c_1003';
const ssoToken: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyMTIzIn0.Sf4ke7nQP3mZx9v2';
const resultWithoutSSO: CheckedCommentsForBlocked200Response = await checkedCommentsForBlocked(tenantId, commentIds);
const resultWithSSO: CheckedCommentsForBlocked200Response = await checkedCommentsForBlocked(tenantId, commentIds, ssoToken);

חסימת משתמש מהתגובה

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
id	string	כן
blockFromCommentParams	BlockFromCommentParams	כן
userId	string	לא
anonUserId	string	לא

תגובה

מחזיר: BlockFromCommentPublic200Response

דוגמה

דוגמה ל-blockUserFromComment

Copy

const tenantId: string = 'acme-corp';
const id: string = 'comment_7f3b2a9c';
const blockFromCommentParams: BlockFromCommentParams = {
  reason: 'Repeated abusive language and targeted harassment',
  durationDays: 90,
  preventReposting: true
};
const userId: string = 'user_12345';
const anonUserId: string = 'anon_98765';
const result: BlockFromCommentPublic200Response = await blockUserFromComment(
  tenantId,
  id,
  blockFromCommentParams,
  userId,
  anonUserId
);

יצירת תגובה (ציבורי)

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
urlId	string	כן
broadcastId	string	כן
commentData	CommentData	כן
sessionId	string	לא
sso	string	לא

תגובה

מחזיר: CreateCommentPublic200Response

דוגמה

דוגמת createCommentPublic

Copy

const tenantId: string = 'tenant_prod_42';
const urlId: string = 'article-2026-03-25-tech-deep-dive';
const broadcastId: string = 'live-broadcast-001';
const sessionId: string = 'sess_9f8e7d6a3b';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.signature';
const commentData: CommentData = {
  content: 'Great reporting — appreciated the depth on performance tradeoffs.',
  authorName: 'Jordan M.',
  language: 'en-US',
  metadata: { client: 'web' }
};
const result: CreateCommentPublic200Response = await createCommentPublic(tenantId, urlId, broadcastId, commentData, sessionId, sso);

מחיקת תגובה

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
id	string	כן
contextUserId	string	לא
isLive	boolean	לא

תשובה

מחזיר: DeleteComment200Response

דוגמה

דוגמה ל-deleteComment

Copy

const tenantId: string = "tenant_acme_01";
const id: string = "comment_5f3a2b7c";
const contextUserId: string = "user_1229";
const isLive: boolean = true;
const response: DeleteComment200Response = await deleteComment(tenantId, id, contextUserId, isLive);

מחיקת תגובה (ציבורי)

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
commentId	string	כן
broadcastId	string	כן
editKey	string	לא
sso	string	לא

תגובה

מחזיר: DeleteCommentPublic200Response

דוגמה

דוגמה ל-deleteCommentPublic

Copy

const tenantId: string = 'tenant_4f2c9b';
const commentId: string = 'comment-7c3a9f2d';
const broadcastId: string = 'article-2026-03-20';
const editKey: string | undefined = 'ek_pub_abc12345';
const sso: string | undefined = 'sso_eyJhbGciOiJIUzI1Ni';
const result: DeleteCommentPublic200Response = await deleteCommentPublic(
  tenantId,
  commentId,
  broadcastId,
  editKey,
  sso
);

מחיקת הצבעת תגובה

פרמטרים

Name	Type	Required
tenantId	string	כן
commentId	string	כן
voteId	string	כן
urlId	string	כן
broadcastId	string	כן
editKey	string	לא
sso	string	לא

תגובה

מחזיר: DeleteCommentVote200Response

דוגמה

דוגמה ל-deleteCommentVote

Copy

const tenantId: string = 'acme-tenant-87e4fd';
const commentId: string = 'cmt-9a12b3f4';
const voteId: string = 'vote-4f6d21b9';
const urlId: string = 'https://www.acme.com/articles/2026/03/25/how-to-test';
const broadcastId: string = 'broadcast-20260325-01';
const editKey: string = 'editkey-6b7c8d9e';
const sso: string = 'sso-jwt-eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';
const response: DeleteCommentVote200Response = await deleteCommentVote(
  tenantId,
  commentId,
  voteId,
  urlId,
  broadcastId,
  editKey,
  sso
);

דיווח על תגובה

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
id	string	כן
userId	string	לא
anonUserId	string	לא

תגובה

מחזיר: FlagComment200Response

דוגמה

דוגמה ל-flagComment

Copy

const tenantId: string = 'tenant_7f3b21';
const commentId: string = 'cmt_9a2b4';
const userId: string = 'user_1024';
const result: FlagComment200Response = await flagComment(tenantId, commentId, userId);

קבלת תגובה

פרמטרים

Name	Type	Required	Description
tenantId	string	כן
id	string	כן

תגובה

מחזיר: GetComment200Response

דוגמה

דוגמת getComment

Copy

const tenantId: string = "acme-publishing-001";
const commentId: string = "f3b2c1d0-9a8e-4b7c-8123-6d5f0a1e2b3c";
const result: GetComment200Response = await getComment(tenantId, commentId);
const wrapper: GetComment200Response & { comment?: APIComment } = result;
const comment: APIComment | undefined = wrapper.comment;
const authorBadge: CommentUserBadgeInfo | undefined = comment?.user?.badge;
const userHashTags: CommentUserHashTagInfo[] | undefined = comment?.user?.hashTags

קבלת תגובות

פרמטרים

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

דוגמה

דוגמת getComments

Copy

const tenantId: string = 'tenant_acme_42';
const response: GetComments200Response = await getComments(
  tenantId,
  1, // page (עמוד)
  20, // limit (הגבלה)
  0, // skip (דילוג)
  true, // asTree (כעץ)
  1, // skipChildren (דילוג על ילדים)
  3, // limitChildren (הגבלת ילדים)
  4, // maxTreeDepth (עומק מרבי של העץ)
  'articles/2026/new-product-launch', // urlId (מזהה URL)
  'user_7890', // userId (מזהה משתמש)
  'anon_4f3b2', // anonUserId (מזהה משתמש אנונימי)
  undefined, // contextUserId (מזהה משתמש בהקשר)
  '#launch', // hashTag (האשטאג)
  undefined // parentId (מזהה הורה)
);

קבלת תגובות (ציבורי)

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

דוגמה

דוגמה ל-getCommentsPublic

Copy

const tenantId: string = 'tenant_eu-west_01';
const urlId: string = 'https://www.financialtimes.com/articles/2026/market-update-q1';
const response: GetCommentsPublic200Response = await getCommentsPublic(
  tenantId,
  urlId,
  2,
  undefined,
  'eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.tokenPayload.signature',
  undefined,
  0,
  50,
  5,
  true,
  undefined,
  true,
  false,
  true,
  'en-US',
  'reactions,moderation',
  false,
  true,
  true,
  3,
  false,
  undefined,
  'performance',
  ['feature','fastcomments'],
  'user_9876',
  undefined,
  undefined,
  undefined
);

קבלת טקסט תגובה

פרמטרים

שם	סוג	חובה
tenantId	string	כן
commentId	string	כן
editKey	string	לא
sso	string	לא

תגובה

מחזיר: GetCommentText200Response

דוגמה

דוגמה ל-getCommentText

Copy

const tenantId: string = 'tenant_acme_001';
const commentId: string = 'cmt_7890b';
const editKey: string = 'edit_4f2d9b7c';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';
const result: GetCommentText200Response = await getCommentText(tenantId, commentId, editKey, sso);

קבלת שמות מצביעי תגובה

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
commentId	string	כן
dir	number	כן
sso	string	לא

תשובה

מחזיר: GetCommentVoteUserNames200Response

דוגמה

דוגמה של getCommentVoteUserNames

Copy

(async () => {
  const tenantId: string = 'tenant_4f2c1e';
  const commentId: string = 'cmt_9a7b3d';
  const dir: number = 1;
  const resultUpvotes: GetCommentVoteUserNames200Response = await getCommentVoteUserNames(tenantId, commentId, dir);
  const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.fakepayload.signature';
  const dirDown: number = -1;
  const resultDownvotes: GetCommentVoteUserNames200Response = await getCommentVoteUserNames(tenantId, commentId, dirDown, sso);
  console.log(resultUpvotes, resultDownvotes);
})();

נעילת תגובה

פרמטרים

שם	סוג	חובה
tenantId	string	כן
commentId	string	כן
broadcastId	string	כן
sso	string	לא

תגובה

מחזיר: LockComment200Response

דוגמה

דוגמה ל-lockComment

Copy

const tenantId: string = "tenant_prod_8f3a2b";
const commentId: string = "cmt_5d7e9a92";
const broadcastId: string = "broadcast_2026_03_25_1400";
const ssoToken: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.signature";
const resultWithSso: LockComment200Response = await lockComment(tenantId, commentId, broadcastId, ssoToken);
const resultWithoutSso: LockComment200Response = await lockComment(tenantId, commentId, broadcastId);

הצמדת תגובה

פרמטרים

Name	Type	נדרש
tenantId	string	כן
commentId	string	כן
broadcastId	string	כן
sso	string	לא

תגובה

מחזיר: PinComment200Response

דוגמה

דוגמת pinComment

Copy

const tenantId: string = "tenant_4f2b9a";
const commentId: string = "cmt_9f8e7d6c";
const broadcastId: string = "brd_live_concert_2026-03-25";
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.sso_payload_signature";
const result: PinComment200Response = await pinComment(tenantId, commentId, broadcastId, sso);

שמירת תגובה

פרמטרים

Name	Type	Required
tenantId	string	כן
createCommentParams	CreateCommentParams	כן
isLive	boolean	לא
doSpamCheck	boolean	לא
sendEmails	boolean	לא
populateNotifications	boolean	לא

תשובה

מחזיר: SaveComment200Response

דוגמה

דוגמה ל-saveComment

Copy

const tenantId: string = 'tenant_acme_001';
const createCommentParams: CreateCommentParams = {
  content: 'Great article — helped me fix a production issue in minutes.',
  url: 'https://app.acme.com/blog/performance-tips',
  author: { name: 'Maya Chen', email: 'maya.chen@acme.com' },
  metadata: { locale: 'en-US', appVersion: '4.2.1' }
} as CreateCommentParams;
const isLive: boolean = true;
const doSpamCheck: boolean = true;
const sendEmails: boolean = false;
const populateNotifications: boolean = true;
const result: SaveComment200Response = await saveComment(tenantId, createCommentParams, isLive, doSpamCheck, sendEmails, populateNotifications);

שמירת תגובות באצווה

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
createCommentParams	Array	כן
isLive	boolean	לא
doSpamCheck	boolean	לא
sendEmails	boolean	לא
populateNotifications	boolean	לא

תגובה

מחזיר: Array<SaveComment200Response

דוגמה

דוגמה ל-saveCommentsBulk

Copy

const tenantId: string = 'acme-corp-01';
const mentions1: CommentUserMentionInfo[] = [{ userId: 'user-123', displayName: 'Jane Doe' }];
const hashtags1: CommentUserHashTagInfo[] = [{ tag: 'typescript' }];
const createCommentParams: CreateCommentParams[] = [
  {
    content: 'Great insights on async/await patterns.',
    authorName: 'John Smith',
    authorEmail: 'john.smith@acme.com',
    externalId: 'comment-001',
    createdAt: '2026-03-25T10:15:00Z',
    userMentions: mentions1,
    userHashTags: hashtags1
  },
  {
    content: 'I prefer using Promise.all for bulk ops.',
    authorName: 'Emily Turner',
    authorEmail: 'emily.turner@acme.com',
    externalId: 'comment-002',
    createdAt: '2026-03-25T10:20:00Z'
  }
];
const result: SaveComment200Response[] = await saveCommentsBulk(tenantId, createCommentParams, true, true, false, true);

הגדרת טקסט תגובה

פרמטרים

Name	Type	Required
tenantId	string	כן
commentId	string	כן
broadcastId	string	כן
commentTextUpdateRequest	CommentTextUpdateRequest	כן
editKey	string	לא
sso	string	לא

תגובה

מחזיר: SetCommentText200Response

דוגמה

דוגמה ל-setCommentText

Copy

const tenantId: string = 'tenant-42';
const commentId: string = 'cmt-8932';
const broadcastId: string = 'brd-2023-07';
const updateRequest: CommentTextUpdateRequest = {
  text: 'Updated comment text for the product launch — congrats team!',
  mentions: [{ userId: 'user-17', displayName: 'Ava Nguyen' }] as CommentUserMentionInfo[],
  hashtags: [{ tag: 'ProductLaunch' }] as CommentUserHashTagInfo[]
};
const editKey: string = 'edtk-9f7b';
const sso: string = 'sso-token-abc123';
const result: SetCommentText200Response = await setCommentText(tenantId, commentId, broadcastId, updateRequest, editKey, sso);

ביטול חסימת משתמש מהתגובה

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
id	string	כן
unBlockFromCommentParams	UnBlockFromCommentParams	כן
userId	string	לא
anonUserId	string	לא

תגובה

מחזיר: UnBlockCommentPublic200Response

דוגמה

דוגמה של unBlockUserFromComment

Copy

const tenantId: string = 'tenant_87f3e1';
const id: string = 'comment_9b2a4f';
const unBlockFromCommentParams: UnBlockFromCommentParams = {
  reason: 'Reviewed by moderation team — reinstated',
  moderatorId: 'mod_21',
  unblockedAt: new Date().toISOString()
};
const userId: string = 'user_42';
const anonUserId: string = 'anon_e7f9';
const result: UnBlockCommentPublic200Response = await unBlockUserFromComment(tenantId, id, unBlockFromCommentParams, userId, anonUserId);

הסרת דיווח מתגובה

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
id	string	כן
userId	string	לא
anonUserId	string	לא

תגובה

מחזיר: FlagComment200Response

דוגמה

דוגמה ל-unFlagComment

Copy

const tenantId: string = 'acme-tenant-001';
const commentId: string = 'cmt_9f8e7d6c';
const userId: string = 'user_72b4a1c9';
const anonUserId: string = 'anon_3d2c1b0a';
const response: FlagComment200Response = await unFlagComment(tenantId, commentId, userId, anonUserId);

פתיחת נעילת תגובה

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
commentId	string	כן
broadcastId	string	כן
sso	string	לא

תגובה

מחזיר: LockComment200Response

דוגמה

דוגמה ל-unLockComment

Copy

const tenantId: string = 'tenant_9d4f2b';
const commentId: string = 'cmt_8a3e1f';
const broadcastId: string = 'broadcast_2026_03_25';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.signature';
const result: LockComment200Response = await unLockComment(tenantId, commentId, broadcastId, sso);

הסרת הצמדה מתגובה

פרמטרים

Name	Type	Required
tenantId	string	כן
commentId	string	כן
broadcastId	string	כן
sso	string	לא

תגובה

מחזיר: PinComment200Response

דוגמה

דוגמה ל-unPinComment

Copy

const tenantId: string = 'tenant_7f9d2a3b';
const commentId: string = 'comment_842b9c1f';
const broadcastId: string = 'bcast_frontpage_202603';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.exampleSignature';
const result: PinComment200Response = await unPinComment(tenantId, commentId, broadcastId, sso);

עדכון תגובה

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
id	string	כן
updatableCommentParams	UpdatableCommentParams	כן
contextUserId	string	לא
doSpamCheck	boolean	לא
isLive	boolean	לא

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-updateComment

Copy

const tenantId: string = "tenant_3f47b2a1";
const id: string = "comment_9a12b3c4";
const updatableCommentParams: UpdatableCommentParams = {
  body: "Thanks for the update — I've adjusted my view accordingly."
};
const contextUserId: string = "user_8721";
const doSpamCheck: boolean = true;
const isLive: boolean = false;
const result: FlagCommentPublic200Response = await updateComment(tenantId, id, updatableCommentParams, contextUserId, doSpamCheck, isLive);

הצבעה על תגובה

פרמטרים

Name	Type	Required
tenantId	string	כן
commentId	string	כן
urlId	string	כן
broadcastId	string	כן
voteBodyParams	VoteBodyParams	כן
sessionId	string	לא
sso	string	לא

תגובה

מחזיר: VoteComment200Response

דוגמה

דוגמה ל-voteComment

Copy

const tenantId: string = 'tenant_9f8b7c';
const commentId: string = 'cmt_42f3a1';
const urlId: string = 'articles/ai-trends-2026';
const broadcastId: string = 'web';
const voteBodyParams: VoteBodyParams = { vote: 1, reason: 'Insightful and on-topic' };
const sessionId: string = 'sess_6d2b4c9e';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';
const result: VoteComment200Response = await voteComment(tenantId, commentId, urlId, broadcastId, voteBodyParams, sessionId, sso);

קבלת תגובות למשתמש

פרמטרים

שם	סוג	חובה
userId	string	לא
tenantId	string	לא
urlId	string	לא
page	number	לא
direction	SortDirections	לא
lastGenDate	number	לא
repliesToUserId	string	לא
fetchPageForCommentId	string	לא
includei10n	boolean	לא
useFullTranslationIds	boolean	לא
locale	string	לא
includeConfig	boolean	לא
includeNotificationCount	boolean	לא
countAll	boolean	לא
sso	string	לא

תגובה

מחזיר: GetCommentsForUserResponse

דוגמה

דוגמה ל-getCommentsForUser

Copy

const userId: string = 'user_82f9b';
const tenantId: string = 'tenant_22';
const page: number = 2;
const lastGenDate: number = Date.now();
const includei10n: boolean = true;
const useFullTranslationIds: boolean = false;
const locale: string = 'en-US';
const includeConfig: boolean = true;
const includeNotificationCount: boolean = true;
const countAll: boolean = false;
const sso: string = 'sso-token-1a2b';
const commentsResponse: GetCommentsForUserResponse = await getCommentsForUser(userId, tenantId, undefined, page, undefined, lastGenDate, undefined, undefined, includei10n, useFullTranslationIds, locale, includeConfig, includeNotificationCount, countAll, sso);

הוספת תצורת דומיין

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
addDomainConfigParams	AddDomainConfigParams	כן

תגובה

מחזיר: AddDomainConfig200Response

מחיקת תצורת דומיין

פרמטרים

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

(async () => {
  const tenantId: string = 'tenant_9f4a2b';
  const createEmailTemplateBody: CreateEmailTemplateBody = {
    name: 'Weekly Digest',
    subject: 'Your weekly discussion highlights',
    html: '<!doctype html><body><h1>Hello \{{user.name}}</h1><p>Top comments this week...</p></body>',
    fromAddress: 'no-reply@fastcomments-example.com',
    replyTo: 'moderation@fastcomments-example.com',
    isDefault: false
  };
  const result: CreateEmailTemplate200Response = await createEmailTemplate(tenantId, createEmailTemplateBody);
  console.log(result);
})();

מחיקת תבנית דוא"ל

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
id	string	כן

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-deleteEmailTemplate

Copy

const tenantId: string = "acme-corp-42";
const idSuffix: string | undefined = "-archived";
const templateId: string = "email_tmpl_6a1b2c" + (idSuffix ?? "");
const result: FlagCommentPublic200Response = await deleteEmailTemplate(tenantId, templateId);

מחיקת שגיאת הרצת תבנית דוא"ל

פרמטרים

שם	סוג	חובה
tenantId	string	כן
id	string	כן
errorId	string	כן

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה של deleteEmailTemplateRenderError

Copy

const tenantId: string = "tenant_7a1d2f9b";
const id: string = "email_template_42b1";
const errorId: string = "render_err_2026-04-24_7f3c";
const includeStackTrace: boolean | undefined = undefined; // דוגמה לדגל אופציונלי
const response: FlagCommentPublic200Response = await deleteEmailTemplateRenderError(tenantId, id, errorId);
// אם אובייקט אפשרויות אופציונלי היה נתמך, זה עשוי להיראות כך:
// await deleteEmailTemplateRenderError(tenantId, id, errorId /*, { includeStackTrace } */);

קבלת תבנית דוא"ל

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
id	string	כן

תגובה

מחזיר: GetEmailTemplate200Response

דוגמה

דוגמה ל-getEmailTemplate

Copy

const tenantId: string = "acme-marketing-042";
const templateId: string = "tpl_welcome_2026";
const result: GetEmailTemplate200Response = await getEmailTemplate(tenantId, templateId);
const template: CustomEmailTemplate | undefined = result.template;
const subject: string | undefined = template?.subject;
const customParams: CustomConfigParameters | undefined = template?.customConfigParameters;

קבלת הגדרות תבנית דוא"ל

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן

תגובה

מחזיר: GetEmailTemplateDefinitions200Response

דוגמה

getEmailTemplateDefinitions דוגמה

Copy

const tenantId: string = 'tenant_acme_eu_01';
const templates: GetEmailTemplateDefinitions200Response = await getEmailTemplateDefinitions(tenantId);
console.log('Email template definitions loaded for', tenantId, templates);

קבלת שגיאות הרצת תבנית דוא"ל

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
id	string	כן
skip	number	לא

תגובה

מחזיר: GetEmailTemplateRenderErrors200Response

דוגמה

דוגמת getEmailTemplateRenderErrors

Copy

(async () => {
  const tenantId: string = 'acme-tenant-42';
  const id: string = 'tmpl_3fa85f64-5717-4562-b3fc-2c963f66afa6';
  const skip: number = 20;
  const result: GetEmailTemplateRenderErrors200Response = await getEmailTemplateRenderErrors(tenantId, id, skip);
  console.log(result);
})();

קבלת תבניות דוא"ל

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
skip	number	לא

תגובה

מחזיר: GetEmailTemplates200Response

דוגמה

דוגמה ל-getEmailTemplates

Copy

async function main(): Promise<void> {
  const tenantId: string = 'tenant_5f3a9c2b';
  const templates: GetEmailTemplates200Response = await getEmailTemplates(tenantId);
  const skip: number = 20;
  const pagedTemplates: GetEmailTemplates200Response = await getEmailTemplates(tenantId, skip);
  console.log(templates, pagedTemplates);
}
main();

הרצת תבנית דוא"ל

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
renderEmailTemplateBody	RenderEmailTemplateBody	כן
locale	string	לא

תגובה

מחזיר: RenderEmailTemplate200Response

דוגמה

דוגמת renderEmailTemplate

Copy

const tenantId: string = 'acme-corp-987';
const renderEmailTemplateBody: RenderEmailTemplateBody = {
  templateId: 'user-invite',
  subject: "You're invited to Acme",
  placeholders: { firstName: 'Alex' },
  metadata: { source: 'signup-flow' }
};
const locale: string = 'en-US';
const result: RenderEmailTemplate200Response = await renderEmailTemplate(tenantId, renderEmailTemplateBody, locale);

עדכון תבנית דוא"ל

פרמטרים

שם	סוג	חובה
tenantId	string	Yes
id	string	Yes
updateEmailTemplateBody	UpdateEmailTemplateBody	Yes

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמת updateEmailTemplate

Copy

const tenantId: string = "tenant_76a4b2";
const id: string = "template_9f3c1e";
const updateEmailTemplateBody: UpdateEmailTemplateBody = {
  name: "Comment Flag Notification",
  subject: "A comment was flagged on your-site.com",
  bodyHtml: "<p>Admin,</p><p>User \{{commenterName}} flagged a comment: “\{{commentText}}”</p>",
  isEnabled: true,
  description: "Email sent to moderators when a comment is flagged (optional field included)"
};
const result: FlagCommentPublic200Response = await updateEmailTemplate(tenantId, id, updateEmailTemplateBody);

קבלת יומן אירועים

req tenantId urlId userIdWS

פרמטרים

Name	Type	Required
tenantId	string	כן
urlId	string	כן
userIdWS	string	כן
startTime	number	כן
endTime	number	כן

תגובה

מחזיר: GetEventLog200Response

דוגמה

דוגמה ל-getEventLog

Copy

const tenantId: string = 'fastcomments-tenant-01';
const urlId: string = 'article-2026-03-25';
const userIdWS: string | undefined = undefined; // ערך מקור אופציונלי
const startTime: number = Date.parse('2026-03-01T00:00:00Z');
const endTime: number = Date.parse('2026-03-25T23:59:59Z');
const eventLogResponse: GetEventLog200Response = await getEventLog(
  tenantId,
  urlId,
  userIdWS ?? 'ws_user_8b1f',
  startTime,
  endTime
);

קבלת יומן אירועים גלובלי

req tenantId urlId userIdWS

פרמטרים

Name	Type	Required
tenantId	string	כן
urlId	string	כן
userIdWS	string	כן
startTime	number	כן
endTime	number	כן

תגובה

מחזיר: GetEventLog200Response

דוגמה

דוגמה ל-getGlobalEventLog

Copy

const tenantId: string = "tenant-84b2f1";
const urlId: string = "article-6721";
const userIdWS: string = "ws-conn-9a3c";
const startTime: number = Date.now() - 7 * 24 * 60 * 60 * 1000; // לפני 7 ימים
const endTimeOptional: number | undefined = undefined; // סוף טווח זמן אופציונלי
const endTime: number = endTimeOptional ?? Date.now();
const eventLog: GetEventLog200Response = await getGlobalEventLog(tenantId, urlId, userIdWS, startTime, endTime);

יצירת פוסט בפיד

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
createFeedPostParams	CreateFeedPostParams	כן
broadcastId	string	לא
isLive	boolean	לא
doSpamCheck	boolean	לא
skipDupCheck	boolean	לא

תגובה

מחזיר: CreateFeedPost200Response

דוגמה

דוגמת createFeedPost

Copy

const tenantId: string = 'tenant_87f3b2';
const mediaAsset: FeedPostMediaItemAsset = { url: 'https://cdn.example.com/images/post-123.jpg', mimeType: 'image/jpeg', width: 1200, height: 800, size: 245000 };
const mediaItem: FeedPostMediaItem = { id: 'media_1', type: 'image', assets: [mediaAsset], altText: 'Conference keynote stage' };
const link: FeedPostLink = { url: 'https://news.example.com/keynote-recap', title: 'Keynote recap' };
const createFeedPostParams: CreateFeedPostParams = {
  title: 'Product Launch Highlights',
  content: 'Highlights from today’s product launch and roadmap updates.',
  authorId: 'user_42',
  mediaItems: [mediaItem],
  links: [link],
  tags: ['product', 'launch', 'announcement']
};
const broadcastId: string = 'broadcast_20260424';
const isLive: boolean = true;
const doSpamCheck: boolean = true;
const skipDupCheck: boolean = false;
const result: CreateFeedPost200Response = await createFeedPost(tenantId, createFeedPostParams, broadcastId, isLive, doSpamCheck, skipDupCheck);

יצירת פוסט בפיד (ציבורי)

פרמטרים

שם	סוג	חובה
tenantId	string	כן
createFeedPostParams	CreateFeedPostParams	כן
broadcastId	string	לא
sso	string	לא

תגובה

מחזיר: CreateFeedPostPublic200Response

דוגמה

דוגמה ל-createFeedPostPublic

Copy

const tenantId: string = "tenant_987654321";
const asset: FeedPostMediaItemAsset = { url: "https://cdn.fastcomments.com/uploads/team-photo.jpg", mimeType: "image/jpeg", sizeBytes: 324512 };
const mediaItem: FeedPostMediaItem = { type: "image", assets: [asset], caption: "Team launch day" };
const link: FeedPostLink = { url: "https://www.example.com/blog/product-update-march-2026", title: "Product update — March 2026" };
const createFeedPostParams: CreateFeedPostParams = {
  title: "Product update — March 2026",
  content: "<p>We shipped performance improvements and two new integrations.</p>",
  media: [mediaItem],
  link,
  visibility: "public",
  tags: ["product","release","march-2026"],
  customConfig: { allowComments: true, requireTOS: false }
};
const broadcastId: string = "broadcast_2026_03_25_live";
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIxMjM0NSIsImlhdCI6MTY5MDI0MDB9.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
const result: CreateFeedPostPublic200Response = await createFeedPostPublic(tenantId, createFeedPostParams, broadcastId, sso);

מחיקת פוסט בפיד (ציבורי)

פרמטרים

Name	Type	Required
tenantId	string	כן
postId	string	כן
broadcastId	string	לא
sso	string	לא

תגובה

מחזיר: DeleteFeedPostPublic200Response

דוגמה

דוגמה ל-deleteFeedPostPublic

Copy

const tenantId: string = "tenant_5f8a9b3c";
const postId: string = "post_a1b2c3d4";
const broadcastId: string = "broadcast_2026-03-25T10:00:00Z";
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyMTIzIiwiaWF0IjoxNjE5MjM5MjAwfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
const resultWithOptional: DeleteFeedPostPublic200Response = await deleteFeedPostPublic(tenantId, postId, broadcastId, sso);
const resultRequiredOnly: DeleteFeedPostPublic200Response = await deleteFeedPostPublic(tenantId, postId);

קבלת פוסטים בפיד

req tenantId afterId

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
afterId	string	לא
limit	number	לא
tags	Array	לא

תגובה

מחזיר: GetFeedPosts200Response

דוגמה

דוגמת getFeedPosts

Copy

const initialPage: GetFeedPosts200Response = await getFeedPosts('tenant_9f1b3d', undefined, 20, ['sports', 'local']);
const nextPage: GetFeedPosts200Response = await getFeedPosts('tenant_9f1b3d', 'post_abc123', 20, ['sports', 'local']);

קבלת פוסטים בפיד (ציבורי)

req tenantId afterId

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
afterId	string	לא
limit	number	לא
tags	Array	לא
sso	string	לא
isCrawler	boolean	לא
includeUserInfo	boolean	לא

תגובה

מחזיר: GetFeedPostsPublic200Response

דוגמה

דוגמה ל-getFeedPostsPublic

Copy

const tenantId: string = 'tenant_acme_01';
const afterId: string = 'fp_20260301_042';
const limit: number = 25;
const tags: Array<string> = ['technology', 'announcement'];
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjoiamRvZSJ9.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';
const isCrawler: boolean = false;
const includeUserInfo: boolean = true;
const response: GetFeedPostsPublic200Response = await getFeedPostsPublic(tenantId, afterId, limit, tags, sso, isCrawler, includeUserInfo);

קבלת סטטיסטיקות פוסטים בפיד

פרמטרים

Name	Type	Required
tenantId	string	כן
postIds	Array	כן
sso	string	לא

תגובה

מחזיר: GetFeedPostsStats200Response

דוגמה

דוגמת getFeedPostsStats

Copy

const tenantId: string = 'tenant_9b2f1c4a';
const postIds: Array<string> = [
  '8f14e45f-ea82-4c7a-b6b2-1a2b3c4d5e6f',
  'd0e1f2a3-b4c5-6d7e-8f90-1234567890ab'
];
const sso: string = 'sso_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.signature';
const statsWithoutSSO: GetFeedPostsStats200Response = await getFeedPostsStats(tenantId, postIds);
const statsWithSSO: GetFeedPostsStats200Response = await getFeedPostsStats(tenantId, postIds, sso);

קבלת ריאקציות משתמש (ציבורי)

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
postIds	Array	לא
sso	string	לא

תגובה

מחזיר: GetUserReactsPublic200Response

דוגמה

דוגמה ל-getUserReactsPublic

Copy

const tenantId: string = "acme-tenant-8a4d2c";
const postIds: string[] = ["post-645a2f", "post-645a30"];
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyXzEyMyIsImlhdCI6MTY2MTYwMDAwMH0.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
const result: GetUserReactsPublic200Response = await getUserReactsPublic(tenantId, postIds, sso);

הוספת ריאקציה לפוסט (ציבורי)

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
postId	string	כן
reactBodyParams	ReactBodyParams	כן
isUndo	boolean	לא
broadcastId	string	לא
urlId	string	לא
sso	string	לא

תגובה

מחזיר: ReactFeedPostPublic200Response

דוגמה

דוגמה ל-reactFeedPostPublic

Copy

const tenantId: string = "global-markets";
const postId: string = "8e2c3f9a-4b6d-4f1a-9c2d-e8a1b2c3d4e5";
const reactBodyParams: ReactBodyParams = { reactionType: "like", clientApp: "web-ui", timestamp: new Date().toISOString() };
const isUndo: boolean = false;
const broadcastId: string = "broadcast-2026-05-20";
const urlId: string = "feed-post-8e2c";
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.fake.payload";
const result: ReactFeedPostPublic200Response = await reactFeedPostPublic(tenantId, postId, reactBodyParams, isUndo, broadcastId, urlId, sso);

עדכון פוסט בפיד

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
id	string	כן
feedPost	FeedPost	כן

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-updateFeedPost

Copy

const tenantId: string = 'acme-global-tenant-42';
const id: string = 'f47ac10b-58cc-4372-a567-0e02b2c3d479';
const asset: FeedPostMediaItemAsset = {
  url: 'https://cdn.acme.com/images/product-launch.jpg',
  mimeType: 'image/jpeg',
  width: 1200,
  height: 630
};
const mediaItem: FeedPostMediaItem = {
  id: 'media-001',
  type: 'image',
  asset
};
const link: FeedPostLink = {
  url: 'https://acme.com/blog/product-launch',
  title: 'Product Launch Details'
};
const feedPost: FeedPost = {
  title: 'Introducing the Q3 Product Suite',
  body: 'We are excited to unveil our new lineup for Q3, focusing on performance and security improvements.',
  media: [mediaItem],     // כולל מערך אופציונלי
  links: [link],          // כולל קישורים אופציונליים
  isPublished: true       // דגל פרסום אופציונלי משמש כאן
};
const result: FlagCommentPublic200Response = await updateFeedPost(tenantId, id, feedPost);

עדכון פוסט בפיד (ציבורי)

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
postId	string	כן
updateFeedPostParams	UpdateFeedPostParams	כן
broadcastId	string	לא
sso	string	לא

תגובה

מחזיר: CreateFeedPostPublic200Response

דוגמה

דוגמה ל-updateFeedPostPublic

Copy

const tenantId: string = "tenant_9f4b2";
const postId: string = "post_21a8e";
const updateFeedPostParams: UpdateFeedPostParams = {
  title: "Quarterly product update",
  body: "Major performance improvements and bug fixes deployed today. See release notes and schedule.",
  links: [{ url: "https://status.example.com/release-notes", title: "Release notes" }],
  media: [
    {
      type: "image",
      assets: [{ url: "https://cdn.example.com/updates/q2.png", mimeType: "image/png", width: 1200, height: 628 }]
    }
  ]
};
const broadcastId: string = "broadcast_live_202603";
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.signature";
const result: CreateFeedPostPublic200Response = await updateFeedPostPublic(tenantId, postId, updateFeedPostParams, broadcastId, sso);

דיווח על תגובה (ציבורי)

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
commentId	string	כן
isFlagged	boolean	כן
sso	string	לא

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-flagCommentPublic

Copy

const tenantId: string = "tenant_9f8b3c";
const commentId: string = "comment_72a1d4";
const isFlagged: boolean = true;
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI1Njc4OSJ9.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
const result: FlagCommentPublic200Response = await flagCommentPublic(tenantId, commentId, isFlagged, sso);

קבלת GIF גדול

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
largeInternalURLSanitized	string	כן

תשובה

מחזיר: GifGetLargeResponse

דוגמה

דוגמה ל-getGifLarge

Copy

const tenantId: string = 'tenant_8a92f4';
const largeInternalURLSanitized: string = 'https://cdn.streamingco.com/gifs/product-demo-large.gif';
let maybeStatus: APIStatus | undefined = undefined; // מטא-נתונים אופציונליים אם זמינים
const response: GifGetLargeResponse = await getGifLarge(tenantId, largeInternalURLSanitized);

חיפוש גיפים

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
search	string	כן
locale	string	לא
rating	string	לא
page	number	לא

תגובה

מחזיר: GifSearchResponse

דוגמה

דוגמה ל-getGifsSearch

Copy

(async () => {
  const tenantId: string = "global-media";
  const search: string = "laughing baby";
  const locale: string = "en-US";
  const rating: string = "pg";
  const page: number = 2;
  const result: GifSearchResponse = await getGifsSearch(tenantId, search, locale, rating, page);
  console.log(result);
})();

גיפים פופולריים

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
locale	string	לא
rating	string	לא
page	number	לא

תגובה

מחזיר: GifSearchResponse

דוגמה

דוגמה ל-getGifsTrending

Copy

const tenantId: string = 'tenant_42';
const locale: string = 'en-US';
const rating: string = 'PG';
const page: number = 1;
const result: GifSearchResponse = await getGifsTrending(tenantId, locale, rating, page);

הוספת האשטג

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	לא
createHashTagBody	CreateHashTagBody	לא

תגובה

מחזיר: AddHashTag200Response

דוגמה

דוגמת addHashTag

Copy

const tenantId: string | undefined = undefined;
const createHashTagBody: CreateHashTagBody = {
  name: 'release-2026',
  description: 'Feedback and bug reports for the April 2026 product release',
  synonyms: ['v2-release', 'launch-2026'],
  color: '#1d72b8',
  isActive: true,
  createdBy: 'product.manager@acme-corp.com'
};
const result: AddHashTag200Response = await addHashTag(tenantId, createHashTagBody);

הוספת האשטגים באצווה

פרמטרים

שם	סוג	חובה	תיאור
tenantId	string	לא
bulkCreateHashTagsBody	BulkCreateHashTagsBody	לא

תגובה

מחזיר: AddHashTagsBulk200Response

דוגמה

דוגמה ל-addHashTagsBulk

Copy

const tenantId: string = 'tenant_acme_corp_01';
const bulkCreateHashTagsBody: BulkCreateHashTagsBody = {
  tags: [
    { name: 'feature-request', slug: 'feature-request', description: 'Requests for new capabilities', isActive: true, customConfig: { visibility: 'public' } as unknown as CustomConfigParameters }
  ]
};
const addHashTagsResponse: AddHashTagsBulk200Response = await addHashTagsBulk(tenantId, bulkCreateHashTagsBody);
const bulkCreateHashTagsBodyNoTenant: BulkCreateHashTagsBody = {
  tags: [
    { name: 'ux-feedback', slug: 'ux-feedback', description: 'User experience suggestions', isActive: true }
  ]
};
const addHashTagsResponseNoTenant: AddHashTagsBulk200Response = await addHashTagsBulk(undefined, bulkCreateHashTagsBodyNoTenant);

מחיקת האשטג

פרמטרים

שם	סוג	נדרש
tag	string	כן
tenantId	string	לא
deleteHashTagRequest	DeleteHashTagRequest	לא

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמת deleteHashTag

Copy

const tag: string = "spring-sale-2026";
const tenantId: string = "tenant-9876";
const deleteHashTagRequest: DeleteHashTagRequest = {
  requestedBy: "admin@retailco.com",
  reason: "Campaign ended; remove associated auto-tags",
  cascadeDelete: true
};
const result: FlagCommentPublic200Response = await deleteHashTag(tag, tenantId, deleteHashTagRequest);

קבלת האשטגים

פרמטרים

שם	סוג	חובה	תיאור
tenantId	string	כן
page	number	לא

תשובה

מחזיר: GetHashTags200Response

דוגמה

דוגמת getHashTags

Copy

const tenantId: string = 'acme-tenant-42';
const pageNumber: number = 2;
const responseWithPage: GetHashTags200Response = await getHashTags(tenantId, pageNumber);
const responseWithoutPage: GetHashTags200Response = await getHashTags(tenantId);

עדכון חלקי של האשטג

פרמטרים

Name	Type	Required
tag	string	כן
tenantId	string	לא
updateHashTagBody	UpdateHashTagBody	לא

תגובה

מחזיר: PatchHashTag200Response

דוגמה

דוגמה ל-patchHashTag

Copy

const tag: string = "feature-ux-refresh";
const tenantId: string = "tenant_4f92c1";
const updateHashTagBody: UpdateHashTagBody = {
  label: "UX Refresh",
  description: "Track comments related to the 2026 UX redesign",
  isActive: true,
  metadata: { owner: "product-design", rolloutPhase: "phase-2" }
};
const response: PatchHashTag200Response = await patchHashTag(tag, tenantId, updateHashTagBody);

יצירת ממונה

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
createModeratorBody	CreateModeratorBody	כן

תגובה

מחזיר: CreateModerator200Response

דוגמה

דוגמה ל-createModerator

Copy

const tenantId: string = "tenant_8f3b6c";
const optionalConfig: CustomConfigParameters = { moderationThreshold: 5, escalateOnRepeatedOffenses: true };
const newModerator: CreateModeratorBody = {
  email: "lina.gomez@dailynews.com",
  fullName: "Lina Gomez",
  role: "senior_moderator",
  enabled: true,
  notifyByEmail: true,
  customConfig: optionalConfig
};
const response: CreateModerator200Response = await createModerator(tenantId, newModerator);

מחיקת ממונה

פרמטרים

שם	סוג	חובה
tenantId	string	כן
id	string	כן
sendEmail	string	לא

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמת deleteModerator

Copy

const tenantId: string = 'tenant_9f8b7c6d';
const id: string = 'mod_4a3e11ec9d1f0242ac120003';
const sendEmail: string = 'true';
const result: FlagCommentPublic200Response = await deleteModerator(tenantId, id, sendEmail);

קבלת ממונה

פרמטרים

שם	סוג	חובה	תיאור
tenantId	string	כן
id	string	כן

תגובה

מחזיר: GetModerator200Response

דוגמה

דוגמה ל-getModerator

Copy

const tenantId: string = 'acme-corp-tenant-123';
const id: string = 'mod-987654321';
const moderatorResponse: GetModerator200Response = await getModerator(tenantId, id);

קבלת ממונים

פרמטרים

Name	Type	Required	Description
tenantId	string	כן
skip	number	לא

תשובה

מחזיר: GetModerators200Response

דוגמה

דוגמת getModerators

Copy

const tenantId: string = 'tenant-12345-prod';
const moderatorsPage1: GetModerators200Response = await getModerators(tenantId);
const moderatorsPage2: GetModerators200Response = await getModerators(tenantId, 50);

שליחת הזמנה

פרמטרים

שם	סוג	חובה
tenantId	string	כן
id	string	כן
fromName	string	כן

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמת sendInvite

Copy

const tenantId: string = 'acme-corp-128';
const id: string = 'comment-8421f';
const fromName: string = 'Marcus Lindström';
const note: string | undefined = undefined; // דוגמה לפרמטר אופציונלי
const response: FlagCommentPublic200Response = await sendInvite(tenantId, id, fromName);

עדכון ממונה

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
id	string	כן
updateModeratorBody	UpdateModeratorBody	כן

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-updateModerator

Copy

const tenantId: string = "acme-enterprises-42";
const id: string = "moderator_517";
const updateModeratorBody: UpdateModeratorBody = {
  displayName: "Sofia Martinez",
  email: "sofia.martinez@acme.com",
  permissions: ["approve_comments", "flag_spam", "suspend_users"],
  active: true,
  avatarUrl: "https://cdn.acme.com/avatars/sofia.jpg" // optional field demonstrated
};
const result: FlagCommentPublic200Response = await updateModerator(tenantId, id, updateModeratorBody);

מחיקת מונה התראות

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
id	string	כן

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-deleteNotificationCount

Copy

const tenantId: string = "org-72a8f1b9";
const id: string = "notif-8f9c2e4a";
const result: FlagCommentPublic200Response = await deleteNotificationCount(tenantId, id);
console.log(result);

קבלת מונה התראות מהמטמון

פרמטרים

Name	Type	Required	Description
tenantId	string	כן
id	string	כן

תגובה

מחזיר: GetCachedNotificationCount200Response

דוגמה

דוגמת getCachedNotificationCount

Copy

const tenantId: string = 'tenant_acme_42';
const id: string = 'user_00012345';
const includeUnreadOnly: boolean | undefined = true; // דגל פרמטר אופציונלי (להדגמה)
const result: GetCachedNotificationCount200Response = await getCachedNotificationCount(tenantId, id);

קבלת מונה התראות

פרמטרים

Name	Type	Required
tenantId	string	כן
userId	string	לא
urlId	string	לא
fromCommentId	string	לא
viewed	boolean	לא
type	string	לא

תגובה

מחזיר: GetNotificationCount200Response

דוגמה

דוגמה ל-getNotificationCount

Copy

const tenantId: string = 'tenant_abc123';
const userId: string = 'user_987654321';
const urlId: string = 'https://example.com/news/2026/new-features';
const viewed: boolean = false;
const type: string = 'reply';
const notificationCountResponse: GetNotificationCount200Response = await getNotificationCount(tenantId, userId, urlId, undefined, viewed, type);

קבלת התראות

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
userId	string	לא
urlId	string	לא
fromCommentId	string	לא
viewed	boolean	לא
type	string	לא
skip	number	לא

תגובה

מחזיר: GetNotifications200Response

דוגמה

דוגמה ל-getNotifications

Copy

const tenantId: string = "tenant_84b3f2";
const userId: string = "user_1279";
const urlId: string = "https://www.example.com/articles/2026/03/25/new-feature";
const fromCommentId: string = "cmt_5421";
const viewed: boolean = false;
const type: string = "mention";
const skip: number = 0;
const notifications: GetNotifications200Response = await getNotifications(tenantId, userId, urlId, fromCommentId, viewed, type, skip);

עדכון התראה

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
id	string	כן
updateNotificationBody	UpdateNotificationBody	כן
userId	string	לא

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-updateNotification

Copy

const tenantId: string = 'tenant_prod_8f4b2c';
const id: string = 'notification_61a2e9';
const userId: string = 'moderator_107';
const updateNotificationBody: UpdateNotificationBody = {
  name: 'Flagged Comment Notification',
  enabled: true,
  channels: ['email', 'inbox'],
  templateId: 'tmpl_mod_alerts_01',
  severity: 'high'
};
const result: FlagCommentPublic200Response = await updateNotification(tenantId, id, updateNotificationBody, userId);

הוספת דף

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
createAPIPageData	CreateAPIPageData	כן

תגובה

מחזיר: AddPageAPIResponse

מחיקת דף

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
id	string	כן

תשובה

מחזיר: DeletePageAPIResponse

קבלת דף לפי מזהה URL

פרמטרים

Name	Type	Required	Description
tenantId	string	כן
urlId	string	כן

תגובה

מחזיר: GetPageByURLIdAPIResponse

קבלת דפים

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן

תגובה

מחזיר: GetPagesAPIResponse

עדכון חלקי של דף

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
id	string	כן
updateAPIPageData	UpdateAPIPageData	כן

תגובה

מחזיר: PatchPageAPIResponse

מחיקת אירוע Webhook ממתין

פרמטרים

Name	Type	Required	Description
tenantId	string	כן
id	string	כן

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-deletePendingWebhookEvent

Copy

const tenantId: string = "tenant_7f3b2a";
const webhookEventId: string = "wh_evt_9a8c7d1234";
const dryRun: boolean | undefined = undefined; // דוגמה לדגל אופציונלי (אינו נדרש בקריאה זו)
const result: FlagCommentPublic200Response = await deletePendingWebhookEvent(tenantId, webhookEventId);

קבלת מונה אירועי Webhook ממתינים

פרמטרים

Name	Type	Required
tenantId	string	כן
commentId	string	לא
externalId	string	לא
eventType	string	לא
type	string	לא
domain	string	לא
attemptCountGT	number	לא

תגובה

מחזיר: GetPendingWebhookEventCount200Response

דוגמה

דוגמה ל-getPendingWebhookEventCount

Copy

const tenantId: string = "tenant_8d3b7a2f";
const commentId: string | undefined = "comment_79a2b";
const eventType: string | undefined = "comment.created";
const domain: string | undefined = "forum.acme-corp.com";
const attemptCountGT: number | undefined = 1;
const result: GetPendingWebhookEventCount200Response = await getPendingWebhookEventCount(
  tenantId,
  commentId,
  undefined,
  eventType,
  undefined,
  domain,
  attemptCountGT
);

קבלת אירועי Webhook ממתינים

פרמטרים

שם	סוג	דרוש
tenantId	string	כן
commentId	string	לא
externalId	string	לא
eventType	string	לא
type	string	לא
domain	string	לא
attemptCountGT	number	לא
skip	number	לא

תגובה

מחזיר: GetPendingWebhookEvents200Response

דוגמה

דוגמה של getPendingWebhookEvents

Copy

const tenantId: string = 'tenant_9b3f7c';
const commentId: string | undefined = undefined;
const externalId: string | undefined = 'external-572a';
const eventType: string | undefined = 'comment.updated';
const type: string | undefined = 'outbound';
const domain: string | undefined = 'reviews.example.com';
const attemptCountGT: number | undefined = 1;
const skip: number | undefined = 20;
const result: GetPendingWebhookEvents200Response = await getPendingWebhookEvents(
  tenantId,
  commentId,
  externalId,
  eventType,
  type,
  domain,
  attemptCountGT,
  skip
);

יצירת תצורת שאלה

פרמטרים

שם	סוג	חובה	תיאור
tenantId	string	כן
createQuestionConfigBody	CreateQuestionConfigBody	כן

תגובה

מחזיר: CreateQuestionConfig200Response

דוגמה

דוגמה ל-createQuestionConfig

Copy

const tenantId: string = "tenant_acme_01";
const createQuestionConfigBody: CreateQuestionConfigBody = {
  title: "Post-purchase feedback",
  description: "Quick survey about your recent order",
  required: true,
  renderingType: "single_choice",
  options: [
    { label: "Very dissatisfied", value: "1" },
    { label: "Dissatisfied", value: "2" },
    { label: "Neutral", value: "3" },
    { label: "Satisfied", value: "4" },
    { label: "Very satisfied", value: "5" }
  ] as QuestionConfigCustomOptionsInner[]
} as CreateQuestionConfigBody;
const result: CreateQuestionConfig200Response = await createQuestionConfig(tenantId, createQuestionConfigBody);

מחיקת תצורת שאלה

פרמטרים

שם	סוג	חובה	תיאור
tenantId	string	כן
id	string	כן

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-deleteQuestionConfig

Copy

const tenantId: string = "tenant_42fa9b7c";
const id: string = "qcfg-0f8fad5b-d9cb-469f-a165-70867728950e";
const result: FlagCommentPublic200Response = await deleteQuestionConfig(tenantId, id);

קבלת תצורת שאלה

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
id	string	כן

תגובה

מחזיר: GetQuestionConfig200Response

דוגמה

דוגמה ל-getQuestionConfig

Copy

const tenantId: string = 'acme-tenant-92';
const id: string = 'question-2026-07-42';
const response: GetQuestionConfig200Response = await getQuestionConfig(tenantId, id);
function summarize(cfg: GetQuestionConfig200Response, includeDetails?: boolean): string {
  return includeDetails ? 'Question config (detailed)' : 'Question config (summary)';
}
const summary: string = summarize(response);

קבלת תצורות שאלות

פרמטרים

שם	סוג	חובה	תיאור
tenantId	string	כן
skip	number	לא

תגובה

מחזיר: GetQuestionConfigs200Response

דוגמה

דוגמה ל-getQuestionConfigs

Copy

const tenantId: string = "tenant_acme_9876";
const configsWithoutSkip: GetQuestionConfigs200Response = await getQuestionConfigs(tenantId);
const configsWithSkip: GetQuestionConfigs200Response = await getQuestionConfigs(tenantId, 20);

עדכון תצורת שאלה

פרמטרים

Name	Type	Required
tenantId	string	Yes
id	string	Yes
updateQuestionConfigBody	UpdateQuestionConfigBody	Yes

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-updateQuestionConfig

Copy

const tenantId: string = 'tenant_42e8b';
const id: string = 'question_9f4a2';
const updateQuestionConfigBody: UpdateQuestionConfigBody = {
  questionText: 'How helpful was this article?',
  description: 'Shown to users below the question (optional)',
  required: true,
  renderingType: 'Likert' as QuestionRenderingType,
  customOptions: [
    { label: 'Very helpful', value: '5' } as QuestionConfigCustomOptionsInner,
    { label: 'Somewhat helpful', value: '3' } as QuestionConfigCustomOptionsInner,
    { label: 'Not helpful', value: '1' } as QuestionConfigCustomOptionsInner
  ],
  whenSave: 'notify' as QuestionWhenSave
};
const result: FlagCommentPublic200Response = await updateQuestionConfig(tenantId, id, updateQuestionConfigBody);

יצירת תוצאת שאלה

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
createQuestionResultBody	CreateQuestionResultBody	כן

תגובה

מחזיר: CreateQuestionResult200Response

דוגמה

דוגמה ל-createQuestionResult

Copy

const tenantId: string = 'fastcomments-tenant-01';
const createQuestionResultBody: CreateQuestionResultBody = {
  questionId: 'q-34567',
  respondentId: 'user-8923',
  answers: [{ optionId: 'opt_A', text: 'Agree', count: 1 }],
  score: 5,
  meta: [{ key: 'platform', value: 'web' }],
  notifyModerators: false // פרמטר אופציונלי
} as CreateQuestionResultBody;
const result: CreateQuestionResult200Response = await createQuestionResult(tenantId, createQuestionResultBody);

מחיקת תוצאת שאלה

פרמטרים

Name	Type	Required	Description
tenantId	string	כן
id	string	כן

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה של deleteQuestionResult

Copy

const tenantIdEnv: string | undefined = process.env.FASTCOMMENTS_TENANT_ID;
const tenantId: string = tenantIdEnv ?? 'tenant_78b3f2';
const id: string = 'qres-9f2a3b1c';
const response: FlagCommentPublic200Response = await deleteQuestionResult(tenantId, id);

קבלת תוצאת שאלה

פרמטרים

Name	Type	Required	Description
tenantId	string	כן
id	string	כן

תגובה

מחזיר: GetQuestionResult200Response

דוגמה

דוגמה ל-getQuestionResult

Copy

const tenantId: string = 'acme-corp-42';
const id: string = 'question-9f8b7c';
const includeComments: boolean | undefined = true; // דוגמה לפרמטר אופציונלי
const result: GetQuestionResult200Response = await getQuestionResult(tenantId, id);
console.log(result);

קבלת תוצאות שאלות

פרמטרים

שם	סוג	חובה
tenantId	string	כן
urlId	string	לא
userId	string	לא
startDate	string	לא
questionId	string	לא
questionIds	string	לא
skip	number	לא

תגובה

מחזיר: GetQuestionResults200Response

דוגמה

דוגמה ל-getQuestionResults

Copy

(async () => {
  const tenantId: string = "tenant_9b3f";
  const urlId: string = "survey-2026-spring";
  const userId: string = "user_00123";
  const startDate: string = "2026-04-01T00:00:00Z";
  const questionIds: string = "q_42,q_43";
  const skip: number = 0;
  const result: GetQuestionResults200Response = await getQuestionResults(tenantId, urlId, userId, startDate, undefined, questionIds, skip);
  console.log(result);
})();

עדכון תוצאת שאלה

פרמטרים

שם	סוג	חובה
tenantId	string	כן
id	string	כן
updateQuestionResultBody	UpdateQuestionResultBody	כן

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-updateQuestionResult

Copy

const tenantId: string = 'tenant_7f8b3c';
const id: string = 'questionResult_4621';
const updateQuestionResultBody: UpdateQuestionResultBody = {
  questionId: 'q_1024',
  result: 'flagged',
  score: 0.92,
  notes: 'Automated moderation flagged for review',
  meta: [{ key: 'source', value: 'ai-moderator' }] as MetaItem[], // מטא-נתונים אופציונליים
  status: { code: 'review_pending' } as APIStatus
} as UpdateQuestionResultBody;
const result: FlagCommentPublic200Response = await updateQuestionResult(tenantId, id, updateQuestionResultBody);

אגרגציית תוצאות שאלות

פרמטרים

Name	Type	Required
tenantId	string	כן
questionId	string	לא
questionIds	Array	לא
urlId	string	לא
timeBucket	AggregateTimeBucket	לא
startDate	Date	לא
forceRecalculate	boolean	לא

תגובה

מחזיר: AggregateQuestionResults200Response

דוגמה

דוגמה ל-aggregateQuestionResults

Copy

const tenantId: string = "tenant_acme_001";
const questionIds: string[] = ["q-2026-sales", "q-2026-support"];
const urlId: string = "url_7f2c";
const timeBucket: AggregateTimeBucket = { unit: "week", size: 1 };
const startDate: Date = new Date("2026-01-01T00:00:00Z");
const forceRecalculate: boolean = true;
const result: AggregateQuestionResults200Response = await aggregateQuestionResults(
  tenantId,
  undefined,
  questionIds,
  urlId,
  timeBucket,
  startDate,
  forceRecalculate
);

אגרגציית תוצאות שאלות באצווה

פרמטרים

Name	Type	Required
tenantId	string	כן
bulkAggregateQuestionResultsRequest	BulkAggregateQuestionResultsRequest	כן
forceRecalculate	boolean	לא

תשובה

מחזיר: BulkAggregateQuestionResults200Response

דוגמה

דוגמת bulkAggregateQuestionResults

Copy

const tenantId: string = "tenant_acme_42";
const bulkAggregateQuestionResultsRequest: BulkAggregateQuestionResultsRequest = {
  questions: [
    { questionId: "q-001", threadId: "thread-1001", questionType: "rating" },
    { questionId: "q-002", threadId: "thread-1002", questionType: "yes_no" }
  ],
  timeRange: { from: "2026-03-01T00:00:00Z", to: "2026-04-01T00:00:00Z" },
  groupBy: ["questionId", "threadId"]
};
const forceRecalculate: boolean = true;
const result: BulkAggregateQuestionResults200Response = await bulkAggregateQuestionResults(tenantId, bulkAggregateQuestionResultsRequest, forceRecalculate);

שילוב תגובות עם תוצאות שאלות

פרמטרים

Name	Type	Required
tenantId	string	כן
questionId	string	לא
questionIds	Array	לא
urlId	string	לא
startDate	Date	לא
forceRecalculate	boolean	לא
minValue	number	לא
maxValue	number	לא
limit	number	לא

תגובה

מחזיר: CombineCommentsWithQuestionResults200Response

דוגמה

דוגמה ל-combineCommentsWithQuestionResults

Copy

const tenantId: string = 'tenant-acme-001';
const questionId: string | undefined = 'q-analytics-42';
const questionIds: string[] | undefined = ['q-analytics-42', 'q-feedback-17'];
const urlId: string | undefined = 'url-987654';
const startDate: Date | undefined = new Date('2026-01-01T00:00:00Z');
const forceRecalculate: boolean | undefined = true;
const minValue: number | undefined = 1;
const maxValue: number | undefined = 5;
const limit: number | undefined = 250;
const result: CombineCommentsWithQuestionResults200Response = await combineCommentsWithQuestionResults(
  tenantId,
  questionId,
  questionIds,
  urlId,
  startDate,
  forceRecalculate,
  minValue,
  maxValue,
  limit
);

הוספת משתמש SSO

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
createAPISSOUserData	CreateAPISSOUserData	כן

תגובה

מחזיר: AddSSOUserAPIResponse

מחיקת משתמש SSO

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
id	string	כן
deleteComments	boolean	לא
commentDeleteMode	string	לא

תגובה

מחזיר: DeleteSSOUserAPIResponse

קבלת משתמש SSO לפי דוא"ל

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
email	string	כן

תגובה

מחזיר: GetSSOUserByEmailAPIResponse

קבלת משתמש SSO לפי מזהה

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
id	string	כן

תגובה

מחזיר: GetSSOUserByIdAPIResponse

קבלת משתמשי SSO

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
skip	number	לא

תגובה

מחזיר: GetSSOUsers200Response

עדכון חלקי של משתמש SSO

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
id	string	כן
updateAPISSOUserData	UpdateAPISSOUserData	כן
updateComments	boolean	לא

תגובה

מחזיר: PatchSSOUserAPIResponse

החלפת משתמש SSO

פרמטרים

Name	Type	Required
tenantId	string	כן
id	string	כן
updateAPISSOUserData	UpdateAPISSOUserData	כן
updateComments	boolean	לא

תגובה

מחזיר: PutSSOUserAPIResponse

דוגמה

דוגמת putSSOUser

Copy

const tenantId: string = 'acme-enterprises-42';
const id: string = 'usr-73a1b2';
const updateAPISSOUserData: UpdateAPISSOUserData = {
  email: 'marcus.ingram@acme.com',
  givenName: 'Marcus',
  familyName: 'Ingram',
  roles: ['editor', 'project_owner'],
  enabled: true
};
const result: PutSSOUserAPIResponse = await putSSOUser(tenantId, id, updateAPISSOUserData, true);

יצירת מנוי

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
createAPIUserSubscriptionData	CreateAPIUserSubscriptionData	כן

תגובה

מחזיר: CreateSubscriptionAPIResponse

דוגמה

דוגמה ל-createSubscription

Copy

const tenantId: string = "acme-corp-tenant-123";
const createAPIUserSubscriptionData: CreateAPIUserSubscriptionData = {
  userId: "user_98765",
  planId: "pro_monthly",
  paymentMethod: { type: "card", cardId: "card_abc123" },
  autoRenew: true,
  trialDays: 14, // פרמטר אופציונלי להדגמה
  metadata: { campaign: "spring_launch" } // פרמטר אופציונלי להדגמה
};
const result: CreateSubscriptionAPIResponse = await createSubscription(tenantId, createAPIUserSubscriptionData);

מחיקת מנוי

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
id	string	כן
userId	string	לא

תגובה

מחזיר: DeleteSubscriptionAPIResponse

קבלת מנויים

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
userId	string	לא

תגובה

מחזיר: GetSubscriptionsAPIResponse

דוגמה

דוגמה ל-getSubscriptions

Copy

const tenantId: string = "contoso-9a1b2c";
const userId: string = "u-482f6";
const subscriptions: GetSubscriptionsAPIResponse = await getSubscriptions(tenantId);
const userSubscriptions: GetSubscriptionsAPIResponse = await getSubscriptions(tenantId, userId);

עדכון מנוי

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
id	string	כן
updateAPIUserSubscriptionData	UpdateAPIUserSubscriptionData	כן
userId	string	לא

תגובה

מחזיר: UpdateSubscriptionAPIResponse

דוגמה

דוגמה ל-updateSubscription

Copy

const tenantId: string = 'tenant_9f3b2c';
const subscriptionId: string = 'sub_7641a2b3';
const updateData: UpdateAPIUserSubscriptionData = {
  status: 'active',
  planId: 'pro_annual',
  autoRenew: true,
  renewalDate: '2026-04-15T00:00:00Z',
  metadata: { upgradedBy: 'billing-team' }
};
const userId: string = 'user_215';
const result: UpdateSubscriptionAPIResponse = await updateSubscription(tenantId, subscriptionId, updateData, userId);

קבלת שימוש יומי של השוכר

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
yearNumber	number	לא
monthNumber	number	לא
dayNumber	number	לא
skip	number	לא

תגובה

מחזיר: GetTenantDailyUsages200Response

דוגמה

דוגמה ל-getTenantDailyUsages

Copy

const tenantId: string = 'tenant_5f4a3b2c-1d6e-4f9a-b9d8-123456789abc';
const yearNumber: number = 2026;
const monthNumber: number = 3;
const dayNumber: number = 24;
const skip: number = 0;
const result: GetTenantDailyUsages200Response = await getTenantDailyUsages(tenantId, yearNumber, monthNumber, dayNumber, skip);

יצירת חבילת שוכר

פרמטרים

Name	Type	Required	Description
tenantId	string	כן
createTenantPackageBody	CreateTenantPackageBody	כן

תגובה

מחזיר: CreateTenantPackage200Response

דוגמה

דוגמה ל-createTenantPackage

Copy

const tenantId: string = "tenant_acme-corp_001";
const createTenantPackageBody: CreateTenantPackageBody = {
  name: "Acme Standard Package",
  description: "Default package for Acme Corp comments with moderation and SSO enabled",
  enabled: true,
  maxCommentsPerThread: 500,
  voteStyle: "thumbs",
  gifRating: "PG-13",
  tosConfig: { enabled: true, url: "https://acme.example.com/terms" } // פרמטר אופציונלי (להדגמה)
};
const result: CreateTenantPackage200Response = await createTenantPackage(tenantId, createTenantPackageBody);

מחיקת חבילת שוכר

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
id	string	כן

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-deleteTenantPackage

Copy

(async () => {
  const tenantId: string = "tenant_8f3a2b4c9d01";
  const packageId: string = "pkg_2026-04-security-patch";
  const result: FlagCommentPublic200Response = await deleteTenantPackage(tenantId, packageId);
  console.log(result);
})();

קבלת חבילת שוכר

פרמטרים

שם	סוג	חובה	תיאור
tenantId	string	כן
id	string	כן

תגובה

מחזיר: GetTenantPackage200Response

דוגמה

דוגמה ל-getTenantPackage

Copy

const tenantId: string = 'tenant_7f3b2c8';
const packageId: string = 'pkg_standard_2026';
const requestOptions: { includeConfig?: boolean } = { includeConfig: true };
const packageResponse: GetTenantPackage200Response = await getTenantPackage(tenantId, packageId);

קבלת חבילות שוכר

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
skip	number	לא

תגובה

מחזיר: GetTenantPackages200Response

דוגמה

דוגמה ל-getTenantPackages

Copy

const tenantId: string = 'tenant-7b3c2f';
const skipCount: number = 10;
const packages: GetTenantPackages200Response = await getTenantPackages(tenantId, skipCount);
const packagesFromStart: GetTenantPackages200Response = await getTenantPackages(tenantId);

החלפת חבילת שוכר

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
id	string	כן
replaceTenantPackageBody	ReplaceTenantPackageBody	כן

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-replaceTenantPackage

Copy

const tenantId: string = "tenant-9f3c2a";
const id: string = "pkg_4f8b21";
const replaceTenantPackageBody: ReplaceTenantPackageBody = {
  packageName: "Premium Moderation Pack",
  enabled: true,
  apiStatus: { mode: "active" } as APIStatus,
  customConfigParameters: { maxFlagsBeforeReview: 5 } as CustomConfigParameters,
  voteStyle: "thumbs" as VoteStyle,
  tosConfig: { requireAcceptance: true } as TOSConfig
};
const result: FlagCommentPublic200Response = await replaceTenantPackage(tenantId, id, replaceTenantPackageBody);

עדכון חבילת שוכר

פרמטרים

Name	Type	Required
tenantId	string	כן
id	string	כן
updateTenantPackageBody	UpdateTenantPackageBody	כן

Response

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-updateTenantPackage

Copy

(async () => {
  const tenantId: string = "tenant_sf_001";
  const id: string = "pkg-premium-v2";
  const updateTenantPackageBody: UpdateTenantPackageBody = {
    name: "San Francisco Premium",
    enabled: true,
    customConfig: { maxComments: 500 },
    tosConfig: { required: true } // שדות אופציונליים מוצגים כאן; שאר השדות הושמטו
  } as UpdateTenantPackageBody;
  const result: FlagCommentPublic200Response = await updateTenantPackage(tenantId, id, updateTenantPackageBody);
  console.log(result);
})();

יצירת משתמש שוכר

פרמטרים

Name	Type	Required	Description
tenantId	string	כן
createTenantUserBody	CreateTenantUserBody	כן

תגובה

מחזיר: CreateTenantUser200Response

דוגמה

דוגמת createTenantUser

Copy

const tenantId: string = "tenant_74b3a9f4b";
const createTenantUserBody: CreateTenantUserBody = {
  email: "jane.doe@acmecorp.com",
  displayName: "Jane Doe",
  role: "moderator",
  sendWelcomeEmail: true, // פרמטר אופציונלי להדגמה
  metadata: { department: "Customer Support" }
};
const result: CreateTenantUser200Response = await createTenantUser(tenantId, createTenantUserBody);

מחיקת משתמש שוכר

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
id	string	כן
deleteComments	string	לא
commentDeleteMode	string	לא

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמת deleteTenantUser

Copy

async function run(): Promise<void> {
  const tenantId: string = "acme_corp_tenant_9f1a2b";
  const id: string = "user_4d2a1b6c";
  const deleteComments: string = "true"; // הסר גם את תגובות המשתמש
  const commentDeleteMode: string = "permanent"; // "permanent" או "soft"
  const result: FlagCommentPublic200Response = await deleteTenantUser(tenantId, id, deleteComments, commentDeleteMode);
  console.log(result);
}
run();

קבלת משתמש שוכר

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
id	string	כן

תגובה

מחזיר: GetTenantUser200Response

דוגמה

דוגמה ל-getTenantUser

Copy

const tenantId: string = 'tenant_fc5a9b2c';
const userId: string = 'user_0a12b3';
const result: GetTenantUser200Response = await getTenantUser(tenantId, userId);
const user: User | undefined = (result as any).user; // גישה ל-payload
const userEmail: string | undefined = user?.email;
console.log('Fetched user email:', userEmail);

קבלת משתמשי שוכר

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
skip	number	לא

תגובה

מחזיר: GetTenantUsers200Response

דוגמה

דוגמה ל-getTenantUsers

Copy

const tenantId: string = 'tenant_prod_8a3f2c';
const skip: number = 50;
const usersWithSkip: GetTenantUsers200Response = await getTenantUsers(tenantId, skip);
const usersNoSkip: GetTenantUsers200Response = await getTenantUsers(tenantId);

החלפת משתמש שוכר

פרמטרים

Name	Type	Required
tenantId	string	כן
id	string	כן
replaceTenantUserBody	ReplaceTenantUserBody	כן
updateComments	string	לא

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-replaceTenantUser

Copy

const tenantId: string = "tenant_acmeCorp";
const id: string = "user_84b2";
const replaceTenantUserBody: ReplaceTenantUserBody = {
  email: "alice.jenkins@acmecorp.com",
  displayName: "Alice Jenkins",
  roles: ["moderator", "editor"],
  disabled: false
} as ReplaceTenantUserBody;
const updateComments: string = "Migrated user account and reattributed historical comments";
const result: FlagCommentPublic200Response = await replaceTenantUser(tenantId, id, replaceTenantUserBody, updateComments);

שליחת קישור התחברות

פרמטרים

שם	סוג	חובה
tenantId	string	כן
id	string	כן
redirectURL	string	לא

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-sendLoginLink

Copy

const tenantId: string = "tenant_12a9f3b7";
const id: string = "user_84b2c7d1";
const redirectURL: string = "https://app.mycompany.com/welcome?ref=login_email";
const resultWithoutRedirect: FlagCommentPublic200Response = await sendLoginLink(tenantId, id);
const resultWithRedirect: FlagCommentPublic200Response = await sendLoginLink(tenantId, id, redirectURL);

עדכון משתמש שוכר

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
id	string	כן
updateTenantUserBody	UpdateTenantUserBody	כן
updateComments	string	לא

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-updateTenantUser

Copy

const tenantId: string = "tenant_8f3b2a9d";
const id: string = "user_52c9f1ab";
const updateTenantUserBody: UpdateTenantUserBody = {
  email: "jane.doe@example.com",
  displayName: "Jane Doe",
  roles: ["moderator"],
  isActive: true,
  metadata: { signupSource: "sso", locale: "en-US" }
};
const updateComments: string = "Promoted to moderator and updated display name";
const result: FlagCommentPublic200Response = await updateTenantUser(tenantId, id, updateTenantUserBody, updateComments);

יצירת שוכר

פרמטרים

Name	Type	Required	Description
tenantId	string	כן
createTenantBody	CreateTenantBody	כן

תגובה

מחזיר: CreateTenant200Response

דוגמה

דוגמה ל-createTenant

Copy

const tenantId: string = 'acme-corp-001';
const createTenantBody: CreateTenantBody = {
  name: 'Acme Corporation',
  domainConfiguration: { primaryDomain: 'comments.acme.com', enforceHttps: true } as APIDomainConfiguration,
  billingInfo: { planId: 'enterprise', contactEmail: 'billing@acme.com' } as BillingInfo
  // שדות אופציונליים כמו ssoConfig או customConfig הושמטו בכוונה
} as CreateTenantBody;
const result: CreateTenant200Response = await createTenant(tenantId, createTenantBody);

מחיקת שוכר

פרמטרים

שם	סוג	חובה
tenantId	string	כן
id	string	כן
sure	string	לא

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-deleteTenant

Copy

const tenantId: string = 'tenant_42c9f1';
const id: string = 'flag_9a7b3c';
const sure: string = 'confirm-delete';
const result: FlagCommentPublic200Response = await deleteTenant(tenantId, id, sure);

קבלת שוכר

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
id	string	כן

תגובה

מחזיר: GetTenant200Response

דוגמה

דוגמה ל-getTenant

Copy

const tenantId: string = "tenant_9f4b2c1a";
const idOverride: string | undefined = undefined; // החלפה אופציונלית, אם זמינה
const id: string = idOverride ?? "site_3e7a6b2f";
const response: GetTenant200Response = await getTenant(tenantId, id);
console.log(response);

קבלת שוכרים

פרמטרים

שם	סוג	חובה
tenantId	string	כן
meta	string	לא
skip	number	לא

תגובה

מחזיר: GetTenants200Response

דוגמה

דוגמה ל-getTenants

Copy

const tenantId: string = 'tenant_8421e7';
const meta: string = 'include=domains,billing,customConfig';
const skip: number = 20;
const tenantsBasic: GetTenants200Response = await getTenants(tenantId);
const tenantsWithOptions: GetTenants200Response = await getTenants(tenantId, meta, skip);

עדכון שוכר

פרמטרים

שם	סוג	חובה
tenantId	string	כן
id	string	כן
updateTenantBody	UpdateTenantBody	כן

תגובה

מחזיר: FlagCommentPublic200Response

דוגמה

דוגמה ל-updateTenant

Copy

const tenantId: string = 'acme-corp-001';
const id: string = 'tenant-42';
const billingInfo: BillingInfo = { billingEmail: 'billing@acme.com', address: '123 Market St' } as BillingInfo;
const updateTenantBody: UpdateTenantBody = { displayName: 'Acme Corporation', billingInfo } as UpdateTenantBody;
const result: FlagCommentPublic200Response = await updateTenant(tenantId, id, updateTenantBody);

שינוי מצב כרטיס

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
userId	string	כן
id	string	כן
changeTicketStateBody	ChangeTicketStateBody	כן

תגובה

מחזיר: ChangeTicketState200Response

דוגמה

דוגמה ל-changeTicketState

Copy

const tenantId: string = "tenant_7f3b2c9a";
const userId: string = "user_5a1d9fb2";
const id: string = "ticket_3e8a1b6f";
const changeTicketStateBody: ChangeTicketStateBody = {
  state: "closed",
  reason: "Fixed in backend release 2.4.1",
  notifyUsers: true,
  metadata: { resolutionOwner: "agent_12", priority: "high" } // שדות אופציונליים מוצגים
};
const result: ChangeTicketState200Response = await changeTicketState(tenantId, userId, id, changeTicketStateBody);

יצירת כרטיס

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
userId	string	כן
createTicketBody	CreateTicketBody	כן

תגובה

מחזיר: CreateTicket200Response

דוגמה

דוגמת createTicket

Copy

const tenantId: string = 'acme-company-001';
const userId: string = 'u_78f4b2';
const createTicketBody: CreateTicketBody = {
  title: 'Unable to access project dashboard',
  description: 'Receiving 403 when accessing /dashboard for project X',
  priority: 'high',
  tags: ['dashboard', 'access'] // שדה אופציונלי להדגמה
};
const result: CreateTicket200Response = await createTicket(tenantId, userId, createTicketBody);

קבלת כרטיס

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
id	string	כן
userId	string	לא

תגובה

מחזיר: GetTicket200Response

דוגמה

דוגמת getTicket

Copy

const tenantId: string = 'acme-corp-tenant-01';
const ticketId: string = 'tkt-20260325-42';
const userId: string = 'user-8452';
const ticketResponseWithUser: GetTicket200Response = await getTicket(tenantId, ticketId, userId);
const ticketResponseWithoutUser: GetTicket200Response = await getTicket(tenantId, ticketId);

קבלת כרטיסים

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
userId	string	לא
state	number	לא
skip	number	לא
limit	number	לא

תגובה

מחזיר: GetTickets200Response

דוגמה

דוגמה ל-getTickets

Copy

const tenantId: string = "tenant_92f3b4c1";
const userId: string = "user_742a9f3e";
const state: number = 1;
const skip: number = 0;
const limit: number = 25;
const ticketsFull: GetTickets200Response = await getTickets(tenantId, userId, state, skip, limit);
const ticketsMinimal: GetTickets200Response = await getTickets("tenant_92f3b4c1");

קבלת תרגומים

פרמטרים

Name	Type	Required
namespace	string	כן
component	string	כן
locale	string	לא
useFullTranslationIds	boolean	לא

תגובה

מחזיר: GetTranslationsResponse

דוגמה

דוגמה ל-getTranslations

Copy

const translationsDefault: GetTranslationsResponse = await getTranslations("payments", "checkout");
const translationsFrenchDetailed: GetTranslationsResponse = await getTranslations("payments", "checkout", "fr-FR", true);

העלאת תמונה

העלה ושנה גודל תמונה

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
file	Blob	כן
sizePreset	SizePreset	לא
urlId	string	לא

תגובה

מחזיר: UploadImageResponse

קבלת התקדמות תג משתמש לפי מזהה

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
id	string	כן

תגובה

מחזיר: GetUserBadgeProgressById200Response

דוגמה

דוגמה ל-getUserBadgeProgressById

Copy

const optionalTenantSuffix: string | undefined = undefined;
const tenantId: string = `5f8d0d55-1234-4ab1-9e2a-3f2b5c6d7e8f${optionalTenantSuffix ?? ''}`;
const id: string = '3a2b1c4d-5678-4ef0-9abc-def123456789';
const result: GetUserBadgeProgressById200Response = await getUserBadgeProgressById(tenantId, id);

קבלת התקדמות תג משתמש לפי מזהה משתמש

Parameters

Name	Type	Required	Description
tenantId	string	כן
userId	string	כן

Response

מחזיר: GetUserBadgeProgressById200Response

דוגמה

דוגמה ל-getUserBadgeProgressByUserId

Copy

const tenantId: string = 'tenant_7f9c2d3b';
const maybeUserId: string | undefined = 'user_4b8e1f9a'; // מקור אופציונלי (יכול להיות undefined)
const userId: string = maybeUserId ?? 'user_fallback0001';
const result: GetUserBadgeProgressById200Response = await getUserBadgeProgressByUserId(tenantId, userId);
console.log(result);

קבלת רשימת התקדמות תגי משתמש

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
userId	string	לא
limit	number	לא
skip	number	לא

תגובה

מחזיר: GetUserBadgeProgressList200Response

דוגמה

getUserBadgeProgressList דוגמה

Copy

(async () => {
  const tenantId: string = 'tenant_4f8c2b9d';
  const userId: string = 'user_9a7e215c';
  const limit: number = 25;
  const skip: number = 0;
  const resultMinimal: GetUserBadgeProgressList200Response = await getUserBadgeProgressList(tenantId);
  const resultFull: GetUserBadgeProgressList200Response = await getUserBadgeProgressList(tenantId, userId, limit, skip);
  console.log(resultMinimal, resultFull);
})();

יצירת תג משתמש

פרמטרים

שם	סוג	חובה	תיאור
tenantId	string	כן
createUserBadgeParams	CreateUserBadgeParams	כן

תגובה

מחזיר: CreateUserBadge200Response

דוגמה

דוגמה ל-createUserBadge

Copy

const tenantId: string = "tenant_9a8b7c";
const params: CreateUserBadgeParams = {
  name: "Top Contributor",
  slug: "top-contributor",
  description: "Awarded for 100 approved comments",
  iconUrl: "https://cdn.fastcomments.com/badges/top-contributor.png",
  active: true,
  criteria: { approvedComments: 100 },
  customConfig: { showOnProfile: true } // פרמטר אופציונלי
};
const result: CreateUserBadge200Response = await createUserBadge(tenantId, params);

מחיקת תג משתמש

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
id	string	כן

תגובה

מחזיר: UpdateUserBadge200Response

דוגמה

דוגמה ל-deleteUserBadge

Copy

type DeleteOptions = { notifyModerators?: boolean };
const tenantId: string = 'tenant_8a3f21';
const id: string = 'badge_71f2b';
const options: DeleteOptions = { notifyModerators: true };
const result: UpdateUserBadge200Response = await deleteUserBadge(tenantId, id);

קבלת תג משתמש

פרמטרים

שם	סוג	חובה	תיאור
tenantId	string	כן
id	string	כן

תגובה

מחזיר: GetUserBadge200Response

דוגמה

דוגמה ל-getUserBadge

Copy

const tenantId: string = "tenant_acme_01";
const id: string = "badge_8c7d2f";
const response: GetUserBadge200Response = await getUserBadge(tenantId, id);

קבלת תגי משתמש

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
userId	string	לא
badgeId	string	לא
type	number	לא
displayedOnComments	boolean	לא
limit	number	לא
skip	number	לא

תגובה

מחזיר: GetUserBadges200Response

דוגמה

דוגמה ל-getUserBadges

Copy

const tenantId: string = 'tenant_acme_01';
const userId: string = 'user_5f4d3c2a';
const badgeId: string = 'badge_top_contributor';
const type: number = 1;
const displayedOnComments: boolean = true;
const limit: number = 50;
const skip: number = 0;
const result: GetUserBadges200Response = await getUserBadges(tenantId, userId, badgeId, type, displayedOnComments, limit, skip);

עדכון תג משתמש

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
id	string	כן
updateUserBadgeParams	UpdateUserBadgeParams	כן

תשובה

מחזיר: UpdateUserBadge200Response

דוגמה

דוגמה ל-updateUserBadge

Copy

(async () => {
  const tenantId: string = 'tenant_acme_987';
  const id: string = 'badge_top_contributor_42';
  const updateUserBadgeParams: UpdateUserBadgeParams = {
    title: 'Top Contributor',
    description: 'Awarded for reaching 100 high-quality comments',
    color: '#FFD700',
    iconUrl: 'https://cdn.acme.com/badges/top-contributor.svg',
    active: true,
    notifyUsers: true
  } as UpdateUserBadgeParams;
  const result: UpdateUserBadge200Response = await updateUserBadge(tenantId, id, updateUserBadgeParams);
  console.log(result);
})();

קבלת מונה התראות של משתמש

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	Yes
sso	string	No

תגובה

מחזיר: GetUserNotificationCount200Response

דוגמה

דוגמה ל-getUserNotificationCount

Copy

(async () => {
  const tenantId: string = '9f1e2d3c-4b5a-6d7e-8f90-123456789abc';
  const ssoToken: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI0MjMifQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';
  const resultWithSSO: GetUserNotificationCount200Response = await getUserNotificationCount(tenantId, ssoToken);
  const resultWithoutSSO: GetUserNotificationCount200Response = await getUserNotificationCount(tenantId);
  console.log(resultWithSSO, resultWithoutSSO);
})();

קבלת התראות משתמש

פרמטרים

Name	Type	Required
tenantId	string	Yes
pageSize	number	No
afterId	string	No
includeContext	boolean	No
afterCreatedAt	number	No
unreadOnly	boolean	No
dmOnly	boolean	No
noDm	boolean	No
includeTranslations	boolean	No
sso	string	No

תגובה

מחזיר: GetUserNotifications200Response

דוגמה

דוגמה ל-getUserNotifications

Copy

const tenantId: string = 'tenant_7f3b1c';
const pageSize: number = 25;
const afterId: string = 'notif_b2f9e4';
const includeContext: boolean = true;
const afterCreatedAt: number = Date.now() - 24 * 60 * 60 * 1000;
const unreadOnly: boolean = true;
const dmOnly: boolean = false;
const noDm: boolean = false;
const includeTranslations: boolean = true;
const sso: string = 'sso_tok_user_9f8d7c';
const response: GetUserNotifications200Response = await getUserNotifications(
  tenantId,
  pageSize,
  afterId,
  includeContext,
  afterCreatedAt,
  unreadOnly,
  dmOnly,
  noDm,
  includeTranslations,
  sso
);

איפוס מונה התראות משתמש

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
sso	string	לא

תגובה

מחזיר: ResetUserNotifications200Response

דוגמה

דוגמה ל-resetUserNotificationCount

Copy

(async () => {
  const tenantId: string = "tenant_9f3b2c4a";
  const ssoToken: string | undefined = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9._sample_payload_.signature";
  const responseWithSSO: ResetUserNotifications200Response = await resetUserNotificationCount(tenantId, ssoToken);
  const responseWithoutSSO: ResetUserNotifications200Response = await resetUserNotificationCount(tenantId);
  console.log(responseWithSSO, responseWithoutSSO);
})();

איפוס התראות משתמש

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
afterId	string	לא
afterCreatedAt	number	לא
unreadOnly	boolean	לא
dmOnly	boolean	לא
noDm	boolean	לא
sso	string	לא

תגובה

מחזיר: ResetUserNotifications200Response

דוגמה

דוגמה ל-resetUserNotifications

Copy

const tenantId: string = "tenant_prod_4a9f12";
const afterId: string = "notification_87213";
const afterCreatedAt: number = Math.floor(Date.now() / 1000) - 3600;
const unreadOnly: boolean = true;
const dmOnly: boolean = false;
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.payload";
const result: ResetUserNotifications200Response = await resetUserNotifications(tenantId, afterId, afterCreatedAt, unreadOnly, dmOnly, undefined, sso);

עדכון סטטוס מנוי להתראות תגובות של משתמש

הפעל או השבת התראות עבור תגובה מסוימת.

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
notificationId	string	כן
optedInOrOut	UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum	כן
commentId	string	כן
sso	string	לא

תגובה

מחזיר: UpdateUserNotificationStatus200Response

דוגמה

דוגמה ל-updateUserNotificationCommentSubscriptionStatus

Copy

const tenantId: string = 'acme-tenant-001';
const notificationId: string = 'notif-2026-03-25-01';
const commentId: string = 'cmt-8f3a2b';
const optedInOrOut: UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum = UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum.OptIn;
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.sso-payload.signature';
const result: UpdateUserNotificationStatus200Response = await updateUserNotificationCommentSubscriptionStatus(tenantId, notificationId, optedInOrOut, commentId, sso);

עדכון סטטוס מנוי להתראות דף של משתמש

הפעל או השבת התראות עבור עמוד. כאשר משתמשים מנויים לעמוד, ייווצרו התראות עבור תגובות שורש חדשות, וגם

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
urlId	string	כן
url	string	כן
pageTitle	string	כן
subscribedOrUnsubscribed	UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum	כן
sso	string	לא

תגובה

מחזיר: UpdateUserNotificationStatus200Response

דוגמה

דוגמה של updateUserNotificationPageSubscriptionStatus

Copy

const tenantId: string = 'acme-tenant-42';
const urlId: string = 'blog-launch-2026';
const url: string = 'https://acme.example.com/blog/launch-march-2026';
const pageTitle: string = 'Acme Product Launch — March 2026';
const subscribedOrUnsubscribed: UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum = UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum.Subscribed;
const sso: string = 'sso_jwt_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';
const response: UpdateUserNotificationStatus200Response = await updateUserNotificationPageSubscriptionStatus(tenantId, urlId, url, pageTitle, subscribedOrUnsubscribed, sso);

עדכון סטטוס התראות משתמש

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
notificationId	string	כן
newStatus	UpdateUserNotificationStatusNewStatusEnum	כן
sso	string	לא

תגובה

מחזיר: UpdateUserNotificationStatus200Response

דוגמה

דוגמה ל-updateUserNotificationStatus

Copy

const tenantId: string = 'tenant_84a2c3';
const notificationId: string = 'notif_20260325_01';
const newStatus: UpdateUserNotificationStatusNewStatusEnum = UpdateUserNotificationStatusNewStatusEnum.Read;
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.sso_signature_example';
const result: UpdateUserNotificationStatus200Response = await updateUserNotificationStatus(tenantId, notificationId, newStatus, sso);

קבלת מצבי נוכחות משתמש

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
urlIdWS	string	כן
userIds	string	כן

תגובה

מחזיר: GetUserPresenceStatuses200Response

דוגמה

דוגמה ל-getUserPresenceStatuses

Copy

const tenantId: string = 'tenant_7f3a2b';
const urlIdWS: string = 'articles/2026/03/25/fastcomments-integration';
const maybeUserIds: string | undefined = 'user_123,user_456'; // מקור אופציונלי
const userIds: string = maybeUserIds ?? 'user_123';
const presence: GetUserPresenceStatuses200Response = await getUserPresenceStatuses(tenantId, urlIdWS, userIds);

חיפוש משתמשים

פרמטרים

Name	Type	Required
tenantId	string	כן
urlId	string	כן
usernameStartsWith	string	לא
mentionGroupIds	Array	לא
sso	string	לא
searchSection	SearchUsersSearchSectionEnum	לא

תגובה

מוחזר: SearchUsers200Response

דוגמה

דוגמה ל-searchUsers

Copy

const tenantId: string = 'tenant_8392';
const urlId: string = 'articles/2026/03/25/fastcomments-release';
const usernameStartsWith: string = 'jo';
const mentionGroupIds: Array<string> = ['editors', 'senior-writers'];
const sso: string = 'sso_jwt_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';
const searchSection: SearchUsersSearchSectionEnum = SearchUsersSearchSectionEnum.ALL;
const result: SearchUsers200Response = await searchUsers(tenantId, urlId, usernameStartsWith, mentionGroupIds, sso, searchSection);

קבלת משתמש

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
id	string	כן

תגובה

מחזיר: GetUser200Response

דוגמה

דוגמת getUser

Copy

const idSuffix: string | undefined = undefined;
const tenantId: string = "acme-enterprises";
const id: string = idSuffix ?? "user_98765";
const response: GetUser200Response = await getUser({ tenantId, id });

יצירת הצבעה

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
commentId	string	כן
direction	CreateVoteDirectionEnum	כן
userId	string	לא
anonUserId	string	לא

תגובה

מחזיר: VoteComment200Response

דוגמה

דוגמה ל-createVote

Copy

const tenantId: string = 'tenant_5f2a9b';
const commentId: string = 'cmt_3b7e21';
const direction: CreateVoteDirectionEnum = CreateVoteDirectionEnum.Up;
const anonUserId: string = 'anon_9x7k2p';
const voteResult: VoteComment200Response = await createVote(tenantId, commentId, direction, undefined, anonUserId);

מחיקת הצבעה

פרמטרים

שם	סוג	נדרש
tenantId	string	Yes
id	string	Yes
editKey	string	No

תגובה

מחזיר: DeleteCommentVote200Response

דוגמה

דוגמה ל-deleteVote

Copy

const tenantId: string = '123e4567-e89b-12d3-a456-426614174000';
const id: string = 'vote-7a1b2c3d-9f8e-4b6a-8123-abcdef012345';
const editKey: string = 'editKey_4f3e2d1c';
const resultWithEditKey: DeleteCommentVote200Response = await deleteVote(tenantId, id, editKey);
const resultWithoutEditKey: DeleteCommentVote200Response = await deleteVote(tenantId, id);

קבלת הצבעות

פרמטרים

שם	סוג	נדרש	תיאור
tenantId	string	כן
urlId	string	כן

תגובה

מחזיר: GetVotes200Response

דוגמה

דוגמה ל-getVotes

Copy

const tenantId: string = 'tenant-42c-eu';
const urlId: string = 'article-7f9b';
const includeMetadata: boolean | undefined = true;
const votes: GetVotes200Response = await getVotes(tenantId, urlId);

קבלת הצבעות עבור משתמש

פרמטרים

שם	סוג	נדרש
tenantId	string	כן
urlId	string	כן
userId	string	לא
anonUserId	string	לא

תגובה

מחזיר: GetVotesForUser200Response

דוגמה

דוגמה ל-getVotesForUser

Copy

(async (): Promise<void> => {
  const tenantId: string = "local-news-ny";
  const urlId: string = "articles/2026-03-25/ev-infrastructure-update";
  const userId: string = "user_78b6f3d9";
  const anonUserId: string = "anon_9c3f7a1b";
  const result: GetVotesForUser200Response = await getVotesForUser(tenantId, urlId, userId, anonUserId);
  console.log(result);
})();

צריכים עזרה?

אם אתם נתקלים בבעיות או יש לכם שאלות לגבי ה-JavaScript/TypeScript SDK, אנא:

תרומות

תרומות מתקבלות בברכה! אנא בקרו ב-מאגר GitHub לקבלת הנחיות לתרומה.

שפה 🇮🇱 עברית

התחלה מהירה

תיעוד API

תיעוד

שימוש

אגרגציה

יומני ביקורת

חסימה מהתגובה

בדיקת תגובות חסומות

תגובות

תגובות למשתמש

הגדרות דומיין

תבניות דוא"ל

יומן אירועים

פוסטים בפיד

דיווח על תגובה

גיפים

האשטגים

ממונים

מונה התראות

התראות

דפים

אירועי Webhook ממתינים

הגדרות שאלות

תוצאות שאלות

אגרגציית תוצאות שאלות

משתמשי SSO

מנויים

שימוש יומי של השוכר

חבילות שוכר

משתמשי שוכר

שוכרים

כרטיסים

תרגומים

העלאת תמונה

התקדמות תגי משתמש

תגי משתמש

התראות משתמש

סטטוס נוכחות משתמש

חיפוש משתמשים

משתמשים

הצבעות

FastComments SDK ל-JavaScript/TypeScript

מאגר

התקנה

תיעוד ה-API

מדריך API מלא: docs/api/README.md

תאימות דפדפן מול שרת

שימוש

שימוש בדפדפן (צד-לקוח)

שימוש בצד השרת (Node.js)

ייבוא טיפוסים בלבד

שימוש במחלקות API בודדות

סביבה בדפדפן

סביבה בצד השרת

API ציבוריים מול מאובטחים

דוגמה: שימוש ב-Public API (בטוח לדפדפן)

דוגמה: שימוש ב-Default API (צד שרת בלבד)

אינטגרציית SSO (כניסה יחידה)

SSO פשוט (צד שרת בלבד)

SSO מאובטח (צד שרת, מומלץ)

שימוש ב-SSO מהדפדפן (עם טוקן שנוצר בשרת)

SSO עם יצירת תגובה

מקרי שימוש נפוצים

קבלת תגובות לעמוד

יצירת תגובה

הצבעה על תגובה

ניהול משתמשים (דורש מפתח API)

אירועים חיים (עדכונים בזמן אמת)

אירועים ברמת הדף

הירשם לאירועי משתמש

קבלת userIdWS

מזהי שידור

טיפול בשגיאות

אגרגציה

פרמטרים

תגובה

קבלת יומני ביקורת

פרמטרים

תגובה