SDK FastComments JavaScript/TypeScript

npm install fastcomments-sdk

Référence complète de l’API : docs/api/README.md

Ce SDK utilise des points d'entrée doubles pour garantir une compatibilité optimale et éviter les erreurs d'exécution :

• fastcomments-sdk/browser - Version adaptée au navigateur utilisant fetch natif
• fastcomments-sdk/server - Version complète pour Node.js avec prise en charge du SSO
• fastcomments-sdk (par défaut) - Contient uniquement des types, sûr à importer n'importe où

Le SDK fournit trois classes d'API principales :

• DefaultApi - Points de terminaison sécurisés qui nécessitent votre clé API pour l'authentification. Utilisez-les pour les opérations côté serveur.
• PublicApi - Points de terminaison publics accessibles sans clé API. Ils peuvent être appelés directement depuis les navigateurs/appareils mobiles/etc.
• HiddenApi - Points de terminaison internes/admin destinés aux cas d'utilisation avancés.

Exemple : Utilisation de Public API (adaptée au navigateur)

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

const publicApi = new PublicApi();

// Récupérer les commentaires d'une page (aucune clé API requise)
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Exemple : Utilisation de Default API (uniquement côté serveur)

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

const config = new Configuration({
  apiKey: 'your-api-key' // Gardez cette clé secrète !
});
const defaultApi = new DefaultApi(config);

// Récupérer les commentaires avec un accès administrateur complet
const response = await defaultApi.getComments({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

FastComments prend en charge le SSO pour s'intégrer à votre système d'authentification utilisateur existant. La fonctionnalité SSO n'est disponible que dans l'export serveur car elle requiert les fonctionnalités crypto de Node.js.

SSO simple (côté serveur uniquement)

Le SSO simple doit être généré côté serveur et envoyé au client :

// Code côté serveur (Node.js/back-end)
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

// Crée un SSO simple en utilisant l'assistant intégré  
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();

// Envoyez ssoToken à votre code côté client
// Le code côté client peut ensuite utiliser ce jeton avec le SDK pour navigateur

SSO sécurisé (côté serveur, recommandé)

Le SSO sécurisé doit être implémenté côté serveur et offre une meilleure sécurité :

// Code côté serveur (Node.js/back-end)
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

// Crée un SSO sécurisé en utilisant l'assistant intégré
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();

// À utiliser avec des appels d'API côté serveur
const publicApi = new PublicApi();
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id',
  sso: JSON.stringify(ssoConfig)
});

// Ou envoyez ssoConfig au client pour une utilisation dans le navigateur

Utiliser le SSO depuis le navigateur (avec un jeton généré par le serveur)

// Code côté client (navigateur)
import { PublicApi } from 'fastcomments-sdk/browser';

// Récupérez le jeton SSO depuis votre point de terminaison serveur
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 // Utilisez le jeton SSO généré par le serveur
});

SSO avec création de commentaire

// Côté serveur : créer le SSO et le commentaire
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)
});

Récupérer les commentaires d'une page

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

Créer un commentaire

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

Voter sur un commentaire

const voteResponse = await sdk.publicApi.voteComment({
  voteBodyParams: {
    commentId: 'comment-id',
    direction: 1 // 1 pour un vote positif, -1 pour un vote négatif
  }
});

Gestion des utilisateurs (Nécessite une clé API)

// Recherche d'utilisateurs (nécessite DefaultApi)
const users = await sdk.defaultApi.searchUsers({
  tenantId: 'your-tenant-id',
  urlId: 'page-id',
  usernameStartsWith: 'john'
});

Abonnez-vous aux événements en direct pour recevoir des mises à jour en temps réel sur les commentaires, les votes et d'autres activités.

Événements au niveau de la page

Écoutez les événements en direct sur une page spécifique (commentaires, votes, etc.) :

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

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

// S'abonner aux événements en direct pour une page
const subscription = subscribeToChanges(
  config,
  'your-tenant-id', // tenantIdWS
  'page-url-id',    // urlIdWS  
  'user-session-id', // userIdWS (obtenez ceci à partir de la réponse de getComments)
  (event: LiveEvent) => {
    console.log('Live event received:', event);
    
    switch (event.type) {
      case LiveEventType.new_comment:
        console.log('New comment:', event.comment);
        // Mettez à jour votre interface utilisateur avec le nouveau commentaire
        break;
      case LiveEventType.new_vote:
        console.log('New vote:', event.vote);
        // Mettez à jour les compteurs de votes dans votre interface utilisateur
        break;
      case LiveEventType.updated_comment:
        console.log('Comment updated:', event.comment);
        break;
      default:
        console.log('Other event type:', event.type);
    }
    
    return true; // Retournez true si l'événement a été traité
  },
  (isConnected: boolean) => {
    console.log('Connection status:', isConnected ? 'Connected' : 'Disconnected');
  }
);

// Fermez l'abonnement lorsque terminé
subscription.close();

S'abonner aux événements utilisateur

Écoutez les événements spécifiques à un utilisateur (notifications, mentions, etc.) :

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

const userConfig = {
  userIdWS: 'user-session-id', // Obtenez ceci à partir de la réponse de getComments
};

// Abonnez-vous au fil personnel de l'utilisateur
const userSubscription = subscribeToUserFeed(
  userConfig,
  (event: LiveEvent) => {
    console.log('User event received:', event);
    
    switch (event.type) {
      case LiveEventType.notification:
        console.log('New notification:', event.notification);
        // Affichez la notification dans votre interface utilisateur
        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');
  }
);

// Fermez lorsque terminé
userSubscription.close();

Obtenir userIdWS

Le paramètre userIdWS est requis pour les événements en direct et peut être obtenu à partir des réponses de l'API :

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

// Extraire userIdWS de la réponse
const userIdWS = response.data?.userSessionInfo?.userIdWS;

if (userIdWS) {
  // Vous pouvez maintenant vous abonner aux événements en direct
  const subscription = subscribeToChanges(config, tenantIdWS, urlIdWS, userIdWS, handleEvent);
}

Vous verrez que vous devez transmettre un broadcastId dans certains appels d'API. Lorsque vous recevrez des événements, vous recevrez cet ID en retour, ce qui vous permet d'ignorer l'événement si vous prévoyez d'appliquer les modifications de façon optimiste sur le client (ce que vous voudrez probablement faire, car cela offre la meilleure expérience). Fournissez un UUID ici. L'ID doit être suffisamment unique pour ne pas apparaître deux fois lors d'une session de navigateur.

import { v4 as uuidv4 } from 'uuid';

const response = await sdk.publicApi.createCommentPublic({
  createCommentParams: {
    tenantId: 'your-tenant-id',
    urlId: 'page-id',
    comment: 'My comment',
    broadcastId: uuidv4() // ID unique pour cette opération
  }
});

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

Agrège des documents en les regroupant (si groupBy est fourni) et en appliquant plusieurs opérations. Différentes opérations (p. ex. sum, countDistinct, avg, etc.) sont prises en charge.

Paramètres

Réponse

Retourne : AggregationResponse

Paramètres

Réponse

Renvoie : GetAuditLogs200Response

Exemple

Exemple de getAuditLogs

Copy

1

2const tenantId: string = 'tenant_9a8b7c';

3const limit: number = 100;

4const skip: number = 0;

5const after: number = Date.now() - 30 * 24 * 60 * 60 * 1000; // il y a 30 jours

6const before: number = Date.now();

7const auditLogs: GetAuditLogs200Response = await getAuditLogs(tenantId, limit, skip, undefined, after, before);

8

Paramètres

Réponse

Renvoie : BlockFromCommentPublic200Response

Exemple

Exemple de blockFromCommentPublic

Copy

1

2const tenantId: string = "site_7f9b2e";

3const commentId: string = "comment_2026-03-25_001";

4const publicBlockFromCommentParams: PublicBlockFromCommentParams = {

5 reason: "Repeated harassment and targeted abuse",

6 blockDurationDays: 90,

7 includeHistory: true,

8 notifyModeratorTeam: true

9};

10const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.fakePayload.signature";

11const result: BlockFromCommentPublic200Response = await blockFromCommentPublic(tenantId, commentId, publicBlockFromCommentParams, sso);

12

Paramètres

Réponse

Retourne: UnBlockCommentPublic200Response

Exemple

Exemple de unBlockCommentPublic

Copy

1

2const tenantId: string = 'tenant_42e8a1';

3const commentId: string = 'cmt_9b3f2d';

4const publicBlockFromCommentParams: PublicBlockFromCommentParams = {

5 reason: 'abusive_language',

6 blockedByModeratorId: 'mod_17',

7 note: 'Targeted harassment; review complete',

8 unblockRequestedAt: new Date().toISOString()

9};

10const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.signature';

11const result: UnBlockCommentPublic200Response = await unBlockCommentPublic(tenantId, commentId, publicBlockFromCommentParams, sso);

12

Paramètres

Réponse

Renvoie : CheckedCommentsForBlocked200Response

Exemple

Exemple de checkedCommentsForBlocked

Copy

1

2const tenantId: string = 'tenant_4f3b2a1e';

3const commentIds: string = 'c_1001,c_1002,c_1003';

4const ssoToken: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyMTIzIn0.Sf4ke7nQP3mZx9v2';

5

6const resultWithoutSSO: CheckedCommentsForBlocked200Response = await checkedCommentsForBlocked(tenantId, commentIds);

7const resultWithSSO: CheckedCommentsForBlocked200Response = await checkedCommentsForBlocked(tenantId, commentIds, ssoToken);

8

Paramètres

Réponse

Renvoie : BlockFromCommentPublic200Response

Exemple

Exemple de blockUserFromComment

Copy

1

2const tenantId: string = 'acme-corp';

3const id: string = 'comment_7f3b2a9c';

4const blockFromCommentParams: BlockFromCommentParams = {

5 reason: 'Repeated abusive language and targeted harassment',

6 durationDays: 90,

7 preventReposting: true

8};

9const userId: string = 'user_12345';

10const anonUserId: string = 'anon_98765';

11

12const result: BlockFromCommentPublic200Response = await blockUserFromComment(

13 tenantId,

14 id,

15 blockFromCommentParams,

16 userId,

17 anonUserId

18);

19

Paramètres

Réponse

Renvoie : CreateCommentPublic200Response

Exemple

Exemple de createCommentPublic

Copy

1

2const tenantId: string = 'tenant_prod_42';

3const urlId: string = 'article-2026-03-25-tech-deep-dive';

4const broadcastId: string = 'live-broadcast-001';

5const sessionId: string = 'sess_9f8e7d6a3b';

6const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.signature';

7const commentData: CommentData = {

8 content: 'Great reporting — appreciated the depth on performance tradeoffs.',

9 authorName: 'Jordan M.',

10 language: 'en-US',

11 metadata: { client: 'web' }

12};

13const result: CreateCommentPublic200Response = await createCommentPublic(tenantId, urlId, broadcastId, commentData, sessionId, sso);

14

Paramètres

Réponse

Retourne: DeleteComment200Response

Exemple

Exemple de deleteComment

Copy

1

2const tenantId: string = "tenant_acme_01";

3const id: string = "comment_5f3a2b7c";

4const contextUserId: string = "user_1229";

5const isLive: boolean = true;

6const response: DeleteComment200Response = await deleteComment(tenantId, id, contextUserId, isLive);

7

Paramètres

Réponse

Renvoie : DeleteCommentPublic200Response

Exemple

Exemple de deleteCommentPublic

Copy

1

2const tenantId: string = 'tenant_4f2c9b';

3const commentId: string = 'comment-7c3a9f2d';

4const broadcastId: string = 'article-2026-03-20';

5const editKey: string | undefined = 'ek_pub_abc12345';

6const sso: string | undefined = 'sso_eyJhbGciOiJIUzI1Ni';

7

8const result: DeleteCommentPublic200Response = await deleteCommentPublic(

9 tenantId,

10 commentId,

11 broadcastId,

12 editKey,

13 sso

14);

15

Paramètres

Réponse

Retourne: DeleteCommentVote200Response

Exemple

Exemple de deleteCommentVote

Copy

1

2const tenantId: string = 'acme-tenant-87e4fd';

3const commentId: string = 'cmt-9a12b3f4';

4const voteId: string = 'vote-4f6d21b9';

5const urlId: string = 'https://www.acme.com/articles/2026/03/25/how-to-test';

6const broadcastId: string = 'broadcast-20260325-01';

7const editKey: string = 'editkey-6b7c8d9e';

8const sso: string = 'sso-jwt-eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';

9

10const response: DeleteCommentVote200Response = await deleteCommentVote(

11 tenantId,

12 commentId,

13 voteId,

14 urlId,

15 broadcastId,

16 editKey,

17 sso

18);

19

Paramètres

Réponse

Retourne: FlagComment200Response

Exemple

Exemple de flagComment

Copy

1

2const tenantId: string = 'tenant_7f3b21';

3const commentId: string = 'cmt_9a2b4';

4const userId: string = 'user_1024';

5const result: FlagComment200Response = await flagComment(tenantId, commentId, userId);

6

Paramètres

Réponse

Renvoie : GetComment200Response

Exemple

Exemple de getComment

Copy

1

2const tenantId: string = "acme-publishing-001";

3const commentId: string = "f3b2c1d0-9a8e-4b7c-8123-6d5f0a1e2b3c";

4const result: GetComment200Response = await getComment(tenantId, commentId);

5const wrapper: GetComment200Response & { comment?: APIComment } = result;

6const comment: APIComment | undefined = wrapper.comment;

7const authorBadge: CommentUserBadgeInfo | undefined = comment?.user?.badge;

8const userHashTags: CommentUserHashTagInfo[] | undefined = comment?.user?.hashTags

9

Paramètres

Réponse

Renvoie: GetComments200Response

Exemple

Exemple de getComments

Copy

1

2const tenantId: string = 'tenant_acme_42';

3const response: GetComments200Response = await getComments(

4 tenantId,

5 1, // page

6 20, // limit

7 0, // skip

8 true, // asTree

9 1, // skipChildren

10 3, // limitChildren

11 4, // maxTreeDepth

12 'articles/2026/new-product-launch', // urlId

13 'user_7890', // userId

14 'anon_4f3b2', // anonUserId

15 undefined, // contextUserId

16 '#launch', // hashTag

17 undefined // parentId

18);

19

req tenantId urlId

Paramètres

Réponse

Retourne: GetCommentsPublic200Response

Exemple

Exemple getCommentsPublic

Copy

1

2const tenantId: string = 'tenant_eu-west_01';

3const urlId: string = 'https://www.financialtimes.com/articles/2026/market-update-q1';

4const response: GetCommentsPublic200Response = await getCommentsPublic(

5 tenantId,

6 urlId,

7 2,

8 undefined,

9 'eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.tokenPayload.signature',

10 undefined,

11 0,

12 50,

13 5,

14 true,

15 undefined,

16 true,

17 false,

18 true,

19 'en-US',

20 'reactions,moderation',

21 false,

22 true,

23 true,

24 3,

25 false,

26 undefined,

27 'performance',

28 ['feature','fastcomments'],

29 'user_9876',

30 undefined,

31 undefined,

32 undefined

33);

34

Paramètres

Réponse

Renvoie : GetCommentText200Response

Exemple

Exemple de getCommentText

Copy

1

2const tenantId: string = 'tenant_acme_001';

3const commentId: string = 'cmt_7890b';

4const editKey: string = 'edit_4f2d9b7c';

5const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';

6

7const result: GetCommentText200Response = await getCommentText(tenantId, commentId, editKey, sso);

8

Paramètres

Réponse

Renvoie : GetCommentVoteUserNames200Response

Exemple

Exemple d'utilisation de getCommentVoteUserNames

Copy

1

2(async () => {

3 const tenantId: string = 'tenant_4f2c1e';

4 const commentId: string = 'cmt_9a7b3d';

5 const dir: number = 1;

6 const resultUpvotes: GetCommentVoteUserNames200Response = await getCommentVoteUserNames(tenantId, commentId, dir);

7 const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.fakepayload.signature';

8 const dirDown: number = -1;

9 const resultDownvotes: GetCommentVoteUserNames200Response = await getCommentVoteUserNames(tenantId, commentId, dirDown, sso);

10 console.log(resultUpvotes, resultDownvotes);

11})();

12

Paramètres

Réponse

Retourne: LockComment200Response

Exemple

Exemple de lockComment

Copy

1

2const tenantId: string = "tenant_prod_8f3a2b";

3const commentId: string = "cmt_5d7e9a92";

4const broadcastId: string = "broadcast_2026_03_25_1400";

5const ssoToken: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.signature";

6const resultWithSso: LockComment200Response = await lockComment(tenantId, commentId, broadcastId, ssoToken);

7const resultWithoutSso: LockComment200Response = await lockComment(tenantId, commentId, broadcastId);

8

Paramètres

Réponse

Retourne : PinComment200Response

Exemple

Exemple de pinComment

Copy

1

2const tenantId: string = "tenant_4f2b9a";

3const commentId: string = "cmt_9f8e7d6c";

4const broadcastId: string = "brd_live_concert_2026-03-25";

5const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.sso_payload_signature";

6

7const result: PinComment200Response = await pinComment(tenantId, commentId, broadcastId, sso);

8

Paramètres

Réponse

Renvoie : SaveComment200Response

Exemple

Exemple de saveComment

Copy

1

2const tenantId: string = 'tenant_acme_001';

3const createCommentParams: CreateCommentParams = {

4 content: 'Great article — helped me fix a production issue in minutes.',

5 url: 'https://app.acme.com/blog/performance-tips',

6 author: { name: 'Maya Chen', email: 'maya.chen@acme.com' },

7 metadata: { locale: 'en-US', appVersion: '4.2.1' }

8} as CreateCommentParams;

9const isLive: boolean = true;

10const doSpamCheck: boolean = true;

11const sendEmails: boolean = false;

12const populateNotifications: boolean = true;

13const result: SaveComment200Response = await saveComment(tenantId, createCommentParams, isLive, doSpamCheck, sendEmails, populateNotifications);

14

Paramètres

Réponse

Renvoie: Array<SaveComment200Response

Exemple

Exemple de saveCommentsBulk

Copy

1

2const tenantId: string = 'acme-corp-01';

3const mentions1: CommentUserMentionInfo[] = [{ userId: 'user-123', displayName: 'Jane Doe' }];

4const hashtags1: CommentUserHashTagInfo[] = [{ tag: 'typescript' }];

5const createCommentParams: CreateCommentParams[] = [

6 {

7 content: 'Great insights on async/await patterns.',

8 authorName: 'John Smith',

9 authorEmail: 'john.smith@acme.com',

10 externalId: 'comment-001',

11 createdAt: '2026-03-25T10:15:00Z',

12 userMentions: mentions1,

13 userHashTags: hashtags1

14 },

15 {

16 content: 'I prefer using Promise.all for bulk ops.',

17 authorName: 'Emily Turner',

18 authorEmail: 'emily.turner@acme.com',

19 externalId: 'comment-002',

20 createdAt: '2026-03-25T10:20:00Z'

21 }

22];

23const result: SaveComment200Response[] = await saveCommentsBulk(tenantId, createCommentParams, true, true, false, true);

24

Paramètres

Réponse

Renvoie: SetCommentText200Response

Exemple

Exemple de setCommentText

Copy

1

2const tenantId: string = 'tenant-42';

3const commentId: string = 'cmt-8932';

4const broadcastId: string = 'brd-2023-07';

5const updateRequest: CommentTextUpdateRequest = {

6 text: 'Updated comment text for the product launch — congrats team!',

7 mentions: [{ userId: 'user-17', displayName: 'Ava Nguyen' }] as CommentUserMentionInfo[],

8 hashtags: [{ tag: 'ProductLaunch' }] as CommentUserHashTagInfo[]

9};

10const editKey: string = 'edtk-9f7b';

11const sso: string = 'sso-token-abc123';

12const result: SetCommentText200Response = await setCommentText(tenantId, commentId, broadcastId, updateRequest, editKey, sso);

13

Paramètres

Réponse

Retourne: UnBlockCommentPublic200Response

Exemple

Exemple unBlockUserFromComment

Copy

1

2const tenantId: string = 'tenant_87f3e1';

3const id: string = 'comment_9b2a4f';

4const unBlockFromCommentParams: UnBlockFromCommentParams = {

5 reason: 'Reviewed by moderation team — reinstated',

6 moderatorId: 'mod_21',

7 unblockedAt: new Date().toISOString()

8};

9const userId: string = 'user_42';

10const anonUserId: string = 'anon_e7f9';

11const result: UnBlockCommentPublic200Response = await unBlockUserFromComment(tenantId, id, unBlockFromCommentParams, userId, anonUserId);

12

Paramètres

Réponse

Retourne : FlagComment200Response

Exemple

Exemple de unFlagComment

Copy

1

2const tenantId: string = 'acme-tenant-001';

3const commentId: string = 'cmt_9f8e7d6c';

4const userId: string = 'user_72b4a1c9';

5const anonUserId: string = 'anon_3d2c1b0a';

6const response: FlagComment200Response = await unFlagComment(tenantId, commentId, userId, anonUserId);

7

Paramètres

Réponse

Renvoie: LockComment200Response

Exemple

Exemple pour unLockComment

Copy

1

2const tenantId: string = 'tenant_9d4f2b';

3const commentId: string = 'cmt_8a3e1f';

4const broadcastId: string = 'broadcast_2026_03_25';

5const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.signature';

6

7const result: LockComment200Response = await unLockComment(tenantId, commentId, broadcastId, sso);

8

Paramètres

Réponse

Renvoie : PinComment200Response

Exemple

unPinComment Exemple

Copy

1

2const tenantId: string = 'tenant_7f9d2a3b';

3const commentId: string = 'comment_842b9c1f';

4const broadcastId: string = 'bcast_frontpage_202603';

5const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.exampleSignature';

6

7const result: PinComment200Response = await unPinComment(tenantId, commentId, broadcastId, sso);

8

Paramètres

Réponse

Renvoie : FlagCommentPublic200Response

Exemple

Exemple de updateComment

Copy

1

2const tenantId: string = "tenant_3f47b2a1";

3const id: string = "comment_9a12b3c4";

4const updatableCommentParams: UpdatableCommentParams = {

5 body: "Thanks for the update — I've adjusted my view accordingly."

6};

7const contextUserId: string = "user_8721";

8const doSpamCheck: boolean = true;

9const isLive: boolean = false;

10const result: FlagCommentPublic200Response = await updateComment(tenantId, id, updatableCommentParams, contextUserId, doSpamCheck, isLive);

11

Paramètres

Réponse

Renvoie : VoteComment200Response

Exemple

Exemple de voteComment

Copy

1

2const tenantId: string = 'tenant_9f8b7c';

3const commentId: string = 'cmt_42f3a1';

4const urlId: string = 'articles/ai-trends-2026';

5const broadcastId: string = 'web';

6const voteBodyParams: VoteBodyParams = { vote: 1, reason: 'Insightful and on-topic' };

7const sessionId: string = 'sess_6d2b4c9e';

8const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';

9const result: VoteComment200Response = await voteComment(tenantId, commentId, urlId, broadcastId, voteBodyParams, sessionId, sso);

10

Paramètres

Réponse

Renvoie : GetCommentsForUserResponse

Exemple

Exemple de getCommentsForUser

Copy

1

2const userId: string = 'user_82f9b';

3const tenantId: string = 'tenant_22';

4const page: number = 2;

5const lastGenDate: number = Date.now();

6const includei10n: boolean = true;

7const useFullTranslationIds: boolean = false;

8const locale: string = 'en-US';

9const includeConfig: boolean = true;

10const includeNotificationCount: boolean = true;

11const countAll: boolean = false;

12const sso: string = 'sso-token-1a2b';

13const commentsResponse: GetCommentsForUserResponse = await getCommentsForUser(userId, tenantId, undefined, page, undefined, lastGenDate, undefined, undefined, includei10n, useFullTranslationIds, locale, includeConfig, includeNotificationCount, countAll, sso);

14

Paramètres

Réponse

Renvoie: AddDomainConfig200Response

Paramètres

Réponse

Renvoie: DeleteDomainConfig200Response

Paramètres

Réponse

Renvoie: GetDomainConfig200Response

Paramètres

Réponse

Retourne: GetDomainConfigs200Response

Paramètres

Réponse

Retourne : GetDomainConfig200Response

Paramètres

Réponse

Renvoie : GetDomainConfig200Response

Paramètres

Réponse

Renvoie : CreateEmailTemplate200Response

Exemple

Exemple de createEmailTemplate

Copy

1

2(async () => {

3 const tenantId: string = 'tenant_9f4a2b';

4 const createEmailTemplateBody: CreateEmailTemplateBody = {

5 name: 'Weekly Digest',

6 subject: 'Your weekly discussion highlights',

7 html: '<!doctype html><body><h1>Hello \{{user.name}}</h1><p>Top comments this week...</p></body>',

8 fromAddress: 'no-reply@fastcomments-example.com',

9 replyTo: 'moderation@fastcomments-example.com',

10 isDefault: false

11 };

12 const result: CreateEmailTemplate200Response = await createEmailTemplate(tenantId, createEmailTemplateBody);

13 console.log(result);

14})();

15

Paramètres

Réponse

Retourne: FlagCommentPublic200Response

Exemple

Exemple de deleteEmailTemplate

Copy

1

2const tenantId: string = "acme-corp-42";

3const idSuffix: string | undefined = "-archived";

4const templateId: string = "email_tmpl_6a1b2c" + (idSuffix ?? "");

5const result: FlagCommentPublic200Response = await deleteEmailTemplate(tenantId, templateId);

6

Paramètres

Réponse

Renvoie: FlagCommentPublic200Response

Exemple

Exemple de deleteEmailTemplateRenderError

Copy

1

2const tenantId: string = "tenant_7a1d2f9b";

3const id: string = "email_template_42b1";

4const errorId: string = "render_err_2026-04-24_7f3c";

5const includeStackTrace: boolean | undefined = undefined; // exemple d'option facultative

6

7const response: FlagCommentPublic200Response = await deleteEmailTemplateRenderError(tenantId, id, errorId);

8// Si un objet d'options facultatif était pris en charge, il pourrait ressembler à :

9// await deleteEmailTemplateRenderError(tenantId, id, errorId /*, { includeStackTrace } */);

10

Paramètres

Réponse

Renvoie : GetEmailTemplate200Response

Exemple

Exemple de getEmailTemplate

Copy

1

2const tenantId: string = "acme-marketing-042";

3const templateId: string = "tpl_welcome_2026";

4const result: GetEmailTemplate200Response = await getEmailTemplate(tenantId, templateId);

5const template: CustomEmailTemplate | undefined = result.template;

6const subject: string | undefined = template?.subject;

7const customParams: CustomConfigParameters | undefined = template?.customConfigParameters;

8

Paramètres

Réponse

Renvoie: GetEmailTemplateDefinitions200Response

Exemple

Exemple de getEmailTemplateDefinitions

Copy

1

2const tenantId: string = 'tenant_acme_eu_01';

3const templates: GetEmailTemplateDefinitions200Response = await getEmailTemplateDefinitions(tenantId);

4console.log('Email template definitions loaded for', tenantId, templates);

5

Paramètres

Réponse

Retourne: GetEmailTemplateRenderErrors200Response

Exemple

Exemple de getEmailTemplateRenderErrors

Copy

1

2(async () => {

3 const tenantId: string = 'acme-tenant-42';

4 const id: string = 'tmpl_3fa85f64-5717-4562-b3fc-2c963f66afa6';

5 const skip: number = 20;

6 const result: GetEmailTemplateRenderErrors200Response = await getEmailTemplateRenderErrors(tenantId, id, skip);

7 console.log(result);

8})();

9

Paramètres

Réponse

Renvoie: GetEmailTemplates200Response

Exemple

Exemple de getEmailTemplates

Copy

1

2async function main(): Promise<void> {

3 const tenantId: string = 'tenant_5f3a9c2b';

4 const templates: GetEmailTemplates200Response = await getEmailTemplates(tenantId);

5 const skip: number = 20;

6 const pagedTemplates: GetEmailTemplates200Response = await getEmailTemplates(tenantId, skip);

7 console.log(templates, pagedTemplates);

8}

9main();

10

Paramètres

Réponse

Renvoie : RenderEmailTemplate200Response

Exemple

Exemple de renderEmailTemplate

Copy

1

2const tenantId: string = 'acme-corp-987';

3const renderEmailTemplateBody: RenderEmailTemplateBody = {

4 templateId: 'user-invite',

5 subject: "You're invited to Acme",

6 placeholders: { firstName: 'Alex' },

7 metadata: { source: 'signup-flow' }

8};

9const locale: string = 'en-US';

10const result: RenderEmailTemplate200Response = await renderEmailTemplate(tenantId, renderEmailTemplateBody, locale);

11

Paramètres

Réponse

Retourne : FlagCommentPublic200Response

Exemple

Exemple pour updateEmailTemplate

Copy

1

2const tenantId: string = "tenant_76a4b2";

3const id: string = "template_9f3c1e";

4const updateEmailTemplateBody: UpdateEmailTemplateBody = {

5 name: "Comment Flag Notification",

6 subject: "A comment was flagged on your-site.com",

7 bodyHtml: "<p>Admin,</p><p>User \{{commenterName}} flagged a comment: “\{{commentText}}”</p>",

8 isEnabled: true,

9 description: "Email sent to moderators when a comment is flagged (optional field included)"

10};

11const result: FlagCommentPublic200Response = await updateEmailTemplate(tenantId, id, updateEmailTemplateBody);

12

req tenantId urlId userIdWS

Paramètres

Réponse

Renvoie: GetEventLog200Response

Exemple

Exemple de getEventLog

Copy

1

2const tenantId: string = 'fastcomments-tenant-01';

3const urlId: string = 'article-2026-03-25';

4const userIdWS: string | undefined = undefined; // valeur en amont facultative

5const startTime: number = Date.parse('2026-03-01T00:00:00Z');

6const endTime: number = Date.parse('2026-03-25T23:59:59Z');

7

8const eventLogResponse: GetEventLog200Response = await getEventLog(

9 tenantId,

10 urlId,

11 userIdWS ?? 'ws_user_8b1f',

12 startTime,

13 endTime

14);

15

req tenantId urlId userIdWS

Paramètres

Réponse

Renvoie: GetEventLog200Response

Exemple

Exemple de getGlobalEventLog

Copy

1

2const tenantId: string = "tenant-84b2f1";

3const urlId: string = "article-6721";

4const userIdWS: string = "ws-conn-9a3c";

5const startTime: number = Date.now() - 7 * 24 * 60 * 60 * 1000; // il y a 7 jours

6const endTimeOptional: number | undefined = undefined; // fin de la période (optionnelle)

7const endTime: number = endTimeOptional ?? Date.now();

8const eventLog: GetEventLog200Response = await getGlobalEventLog(tenantId, urlId, userIdWS, startTime, endTime);

9

Paramètres

Réponse

Renvoie : CreateFeedPost200Response

Exemple

Exemple de createFeedPost

Copy

1

2const tenantId: string = 'tenant_87f3b2';

3const mediaAsset: FeedPostMediaItemAsset = { url: 'https://cdn.example.com/images/post-123.jpg', mimeType: 'image/jpeg', width: 1200, height: 800, size: 245000 };

4const mediaItem: FeedPostMediaItem = { id: 'media_1', type: 'image', assets: [mediaAsset], altText: 'Conference keynote stage' };

5const link: FeedPostLink = { url: 'https://news.example.com/keynote-recap', title: 'Keynote recap' };

6const createFeedPostParams: CreateFeedPostParams = {

7 title: 'Product Launch Highlights',

8 content: 'Highlights from today’s product launch and roadmap updates.',

9 authorId: 'user_42',

10 mediaItems: [mediaItem],

11 links: [link],

12 tags: ['product', 'launch', 'announcement']

13};

14const broadcastId: string = 'broadcast_20260424';

15const isLive: boolean = true;

16const doSpamCheck: boolean = true;

17const skipDupCheck: boolean = false;

18const result: CreateFeedPost200Response = await createFeedPost(tenantId, createFeedPostParams, broadcastId, isLive, doSpamCheck, skipDupCheck);

19

Paramètres

Réponse

Renvoie : CreateFeedPostPublic200Response

Exemple

Exemple de createFeedPostPublic

Copy

1

2const tenantId: string = "tenant_987654321";

3const asset: FeedPostMediaItemAsset = { url: "https://cdn.fastcomments.com/uploads/team-photo.jpg", mimeType: "image/jpeg", sizeBytes: 324512 };

4const mediaItem: FeedPostMediaItem = { type: "image", assets: [asset], caption: "Team launch day" };

5const link: FeedPostLink = { url: "https://www.example.com/blog/product-update-march-2026", title: "Product update — March 2026" };

6const createFeedPostParams: CreateFeedPostParams = {

7 title: "Product update — March 2026",

8 content: "<p>We shipped performance improvements and two new integrations.</p>",

9 media: [mediaItem],

10 link,

11 visibility: "public",

12 tags: ["product","release","march-2026"],

13 customConfig: { allowComments: true, requireTOS: false }

14};

15const broadcastId: string = "broadcast_2026_03_25_live";

16const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIxMjM0NSIsImlhdCI6MTY5MDI0MDB9.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";

17const result: CreateFeedPostPublic200Response = await createFeedPostPublic(tenantId, createFeedPostParams, broadcastId, sso);

18

Paramètres

Réponse

Retourne: DeleteFeedPostPublic200Response

Exemple

Exemple de deleteFeedPostPublic

Copy

1

2const tenantId: string = "tenant_5f8a9b3c";

3const postId: string = "post_a1b2c3d4";

4const broadcastId: string = "broadcast_2026-03-25T10:00:00Z";

5const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyMTIzIiwiaWF0IjoxNjE5MjM5MjAwfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";

6

7const resultWithOptional: DeleteFeedPostPublic200Response = await deleteFeedPostPublic(tenantId, postId, broadcastId, sso);

8const resultRequiredOnly: DeleteFeedPostPublic200Response = await deleteFeedPostPublic(tenantId, postId);

9

req tenantId afterId

Paramètres

Réponse

Renvoie : GetFeedPosts200Response

Exemple

Exemple de getFeedPosts

Copy

1

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

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

4

req tenantId afterId

Paramètres

Réponse

Renvoie: GetFeedPostsPublic200Response

Exemple

Exemple getFeedPostsPublic

Copy

1

2const tenantId: string = 'tenant_acme_01';

3const afterId: string = 'fp_20260301_042';

4const limit: number = 25;

5const tags: Array<string> = ['technology', 'announcement'];

6const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjoiamRvZSJ9.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';

7const isCrawler: boolean = false;

8const includeUserInfo: boolean = true;

9const response: GetFeedPostsPublic200Response = await getFeedPostsPublic(tenantId, afterId, limit, tags, sso, isCrawler, includeUserInfo);

10

Paramètres

Réponse

Renvoie: GetFeedPostsStats200Response

Exemple

Exemple de getFeedPostsStats

Copy

1

2const tenantId: string = 'tenant_9b2f1c4a';

3const postIds: Array<string> = [

4 '8f14e45f-ea82-4c7a-b6b2-1a2b3c4d5e6f',

5 'd0e1f2a3-b4c5-6d7e-8f90-1234567890ab'

6];

7const sso: string = 'sso_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.signature';

8const statsWithoutSSO: GetFeedPostsStats200Response = await getFeedPostsStats(tenantId, postIds);

9const statsWithSSO: GetFeedPostsStats200Response = await getFeedPostsStats(tenantId, postIds, sso);

10

Paramètres

Réponse

Renvoie : GetUserReactsPublic200Response

Exemple

Exemple de getUserReactsPublic

Copy

1

2const tenantId: string = "acme-tenant-8a4d2c";

3const postIds: string[] = ["post-645a2f", "post-645a30"];

4const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyXzEyMyIsImlhdCI6MTY2MTYwMDAwMH0.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";

5const result: GetUserReactsPublic200Response = await getUserReactsPublic(tenantId, postIds, sso);

6

Paramètres

Réponse

Renvoie : ReactFeedPostPublic200Response

Exemple

Exemple de reactFeedPostPublic

Copy

1

2const tenantId: string = "global-markets";

3const postId: string = "8e2c3f9a-4b6d-4f1a-9c2d-e8a1b2c3d4e5";

4const reactBodyParams: ReactBodyParams = { reactionType: "like", clientApp: "web-ui", timestamp: new Date().toISOString() };

5const isUndo: boolean = false;

6const broadcastId: string = "broadcast-2026-05-20";

7const urlId: string = "feed-post-8e2c";

8const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.fake.payload";

9

10const result: ReactFeedPostPublic200Response = await reactFeedPostPublic(tenantId, postId, reactBodyParams, isUndo, broadcastId, urlId, sso);

11

Paramètres

Réponse

Renvoie: FlagCommentPublic200Response

Exemple

Exemple de updateFeedPost

Copy

1

2const tenantId: string = 'acme-global-tenant-42';

3const id: string = 'f47ac10b-58cc-4372-a567-0e02b2c3d479';

4

5const asset: FeedPostMediaItemAsset = {

6 url: 'https://cdn.acme.com/images/product-launch.jpg',

7 mimeType: 'image/jpeg',

8 width: 1200,

9 height: 630

10};

11

12const mediaItem: FeedPostMediaItem = {

13 id: 'media-001',

14 type: 'image',

15 asset

16};

17

18const link: FeedPostLink = {

19 url: 'https://acme.com/blog/product-launch',

20 title: 'Product Launch Details'

21};

22

23const feedPost: FeedPost = {

24 title: 'Introducing the Q3 Product Suite',

25 body: 'We are excited to unveil our new lineup for Q3, focusing on performance and security improvements.',

26 media: [mediaItem], // tableau optionnel inclus

27 links: [link], // liens optionnels inclus

28 isPublished: true // indicateur de publication optionnel utilisé ici

29};

30

31const result: FlagCommentPublic200Response = await updateFeedPost(tenantId, id, feedPost);

32

Paramètres

Réponse

Renvoie : CreateFeedPostPublic200Response

Exemple

Exemple de updateFeedPostPublic

Copy

1

2const tenantId: string = "tenant_9f4b2";

3const postId: string = "post_21a8e";

4const updateFeedPostParams: UpdateFeedPostParams = {

5 title: "Quarterly product update",

6 body: "Major performance improvements and bug fixes deployed today. See release notes and schedule.",

7 links: [{ url: "https://status.example.com/release-notes", title: "Release notes" }],

8 media: [

9 {

10 type: "image",

11 assets: [{ url: "https://cdn.example.com/updates/q2.png", mimeType: "image/png", width: 1200, height: 628 }]

12 }

13 ]

14};

15const broadcastId: string = "broadcast_live_202603";

16const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.signature";

17const result: CreateFeedPostPublic200Response = await updateFeedPostPublic(tenantId, postId, updateFeedPostParams, broadcastId, sso);

18

Paramètres

Réponse

Renvoie : FlagCommentPublic200Response

Exemple

Exemple flagCommentPublic

Copy

1

2const tenantId: string = "tenant_9f8b3c";

3const commentId: string = "comment_72a1d4";

4const isFlagged: boolean = true;

5const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI1Njc4OSJ9.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";

6const result: FlagCommentPublic200Response = await flagCommentPublic(tenantId, commentId, isFlagged, sso);

7

Paramètres

Réponse

Renvoie : GifGetLargeResponse

Exemple

Exemple de getGifLarge

Copy

1

2const tenantId: string = 'tenant_8a92f4';

3const largeInternalURLSanitized: string = 'https://cdn.streamingco.com/gifs/product-demo-large.gif';

4let maybeStatus: APIStatus | undefined = undefined; // métadonnées facultatives lorsqu'elles sont disponibles

5const response: GifGetLargeResponse = await getGifLarge(tenantId, largeInternalURLSanitized);

6

Paramètres

Réponse

Renvoie : GifSearchResponse

Exemple

Exemple getGifsSearch

Copy

1

2(async () => {

3 const tenantId: string = "global-media";

4 const search: string = "laughing baby";

5 const locale: string = "en-US";

6 const rating: string = "pg";

7 const page: number = 2;

8 const result: GifSearchResponse = await getGifsSearch(tenantId, search, locale, rating, page);

9 console.log(result);

10})();

11

Paramètres

Réponse

Renvoie: GifSearchResponse

Exemple

Exemple de getGifsTrending

Copy

1

2const tenantId: string = 'tenant_42';

3const locale: string = 'en-US';

4const rating: string = 'PG';

5const page: number = 1;

6const result: GifSearchResponse = await getGifsTrending(tenantId, locale, rating, page);

7

Paramètres

Réponse

Retourne: AddHashTag200Response

Exemple

Exemple pour addHashTag

Copy

1

2const tenantId: string | undefined = undefined;

3const createHashTagBody: CreateHashTagBody = {

4 name: 'release-2026',

5 description: 'Feedback and bug reports for the April 2026 product release',

6 synonyms: ['v2-release', 'launch-2026'],

7 color: '#1d72b8',

8 isActive: true,

9 createdBy: 'product.manager@acme-corp.com'

10};

11const result: AddHashTag200Response = await addHashTag(tenantId, createHashTagBody);

12

Paramètres

Réponse

Renvoie : AddHashTagsBulk200Response

Exemple

Exemple addHashTagsBulk

Copy

1

2const tenantId: string = 'tenant_acme_corp_01';

3const bulkCreateHashTagsBody: BulkCreateHashTagsBody = {

4 tags: [

5 { name: 'feature-request', slug: 'feature-request', description: 'Requests for new capabilities', isActive: true, customConfig: { visibility: 'public' } as unknown as CustomConfigParameters }

6 ]

7};

8const addHashTagsResponse: AddHashTagsBulk200Response = await addHashTagsBulk(tenantId, bulkCreateHashTagsBody);

9

10const bulkCreateHashTagsBodyNoTenant: BulkCreateHashTagsBody = {

11 tags: [

12 { name: 'ux-feedback', slug: 'ux-feedback', description: 'User experience suggestions', isActive: true }

13 ]

14};

15const addHashTagsResponseNoTenant: AddHashTagsBulk200Response = await addHashTagsBulk(undefined, bulkCreateHashTagsBodyNoTenant);

16

Paramètres

Réponse

Renvoie : FlagCommentPublic200Response

Exemple

Exemple de deleteHashTag

Copy

1

2const tag: string = "spring-sale-2026";

3const tenantId: string = "tenant-9876";

4const deleteHashTagRequest: DeleteHashTagRequest = {

5 requestedBy: "admin@retailco.com",

6 reason: "Campaign ended; remove associated auto-tags",

7 cascadeDelete: true

8};

9const result: FlagCommentPublic200Response = await deleteHashTag(tag, tenantId, deleteHashTagRequest);

10

Paramètres

Réponse

Renvoie : GetHashTags200Response

Exemple

Exemple de getHashTags

Copy

1

2const tenantId: string = 'acme-tenant-42';

3const pageNumber: number = 2;

4const responseWithPage: GetHashTags200Response = await getHashTags(tenantId, pageNumber);

5const responseWithoutPage: GetHashTags200Response = await getHashTags(tenantId);

6

Paramètres

Réponse

Renvoie: PatchHashTag200Response