FastComments JavaScript/TypeScript SDK

Dies ist das offizielle JavaScript/TypeScript-SDK für FastComments.

Offizielles JavaScript/TypeScript-SDK für die FastComments-API

Repository

Installation

npm install fastcomments-sdk

API-Dokumentation

Vollständige API-Referenz: docs/api/README.md

Browser- vs. Server-Kompatibilität

Dieses SDK verwendet zwei Einstiegspunkte, um optimale Kompatibilität sicherzustellen und Laufzeitfehler zu vermeiden:

fastcomments-sdk/browser - Browser-sichere Version mit nativer fetch-Unterstützung
fastcomments-sdk/server - Vollständige Node.js-Version mit SSO-Unterstützung
fastcomments-sdk (Standard) - Nur Typen, sicher überall zu importieren

Verwendung

Dieses SDK bietet getrennte Einstiegspunkte für Browser- und Server-Umgebungen, um optimale Kompatibilität und Sicherheit zu gewährleisten:

Browser-Nutzung (Clientseitig)

Für Browser-/Frontend-Anwendungen verwenden Sie den browser-sicheren Export, der Node.js-Abhängigkeiten ausschließt:

// Browser-sicherer Import (keine Node.js-Abhängigkeiten)
import { createFastCommentsBrowserSDK } from 'fastcomments-sdk/browser';

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

// Verwende öffentliche APIs (kein API-Schlüssel erforderlich - sicher für Browser)
const comments = await sdk.publicApi.getCommentsPublic({ 
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Server-Nutzung (Node.js)

Für Server-/Backend-Anwendungen verwenden Sie das vollständige SDK mit SSO- und Authentifizierungsfunktionen:

// Serverseitiger Import (inkl. SSO und für NodeJS ausgelegt)
import { createFastCommentsSDK } from 'fastcomments-sdk/server';

// Create server SDK instance
const sdk = createFastCommentsSDK({
  apiKey: 'your-api-key', // Halten Sie diesen geheim auf dem Server!
  basePath: 'https://fastcomments.com' // optional, Standardwert ist https://fastcomments.com
});

// Verwenden Sie geschützte APIs mit Ihrem API-Schlüssel
const comments = await sdk.defaultApi.getComments({ 
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Nur Typen-Import

Wenn Sie nur TypeScript-Typen benötigen (kein Laufzeitcode), verwenden Sie den Standardimport:

// Nur Typen (keine Laufzeitabhängigkeiten - überall sicher)
import type { 
  PublicComment, 
  CreateCommentParams, 
  GetCommentsPublic200Response 
} from 'fastcomments-sdk';

Verwendung einzelner API-Klassen

Browser-Umgebung

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

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

const publicApi = new PublicApi(config);

Server-Umgebung

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

Öffentliche vs. geschützte APIs

Das SDK stellt drei Haupt-API-Klassen bereit:

DefaultApi - Gesicherte Endpunkte, die deinen API-Schlüssel zur Authentifizierung erfordern. Verwende diese für serverseitige Operationen.
PublicApi - Öffentliche Endpunkte, die ohne API-Schlüssel zugänglich sind. Diese können direkt aus Browsern/Mobilgeräten/etc. aufgerufen werden.
HiddenApi - Interne/Admin-Endpunkte für fortgeschrittene Anwendungsfälle.

Beispiel: Verwendung der Public API (browser-sicher)

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

const publicApi = new PublicApi();

// Kommentare für eine Seite abrufen (kein API-Schlüssel erforderlich)
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Beispiel: Verwendung der Default API (nur serverseitig)

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

const config = new Configuration({
  apiKey: 'your-api-key' // Dies geheim halten!
});
const defaultApi = new DefaultApi(config);

// Kommentare mit vollem Admin-Zugriff abrufen
const response = await defaultApi.getComments({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

SSO (Single Sign-On)-Integration

FastComments unterstützt SSO, um sich in Ihr bestehendes Benutzerauthentifizierungssystem zu integrieren. Die SSO-Funktionalität ist nur im Server-Export verfügbar, da sie Node.js-Crypto-Funktionen benötigt.

Einfache SSO (nur serverseitig)

Einfache SSO sollte serverseitig erzeugt und an den Client gesendet werden:

// Server-seitiger Code (Node.js/Backend)
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

// Erstelle einfache SSO mit dem eingebauten Helfer  
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();

// Sende ssoToken an Ihren Client-Code
// Der Client-Code kann dieses Token dann mit dem Browser-SDK verwenden

Sichere SSO (serverseitig, empfohlen)

Sichere SSO sollte serverseitig implementiert werden und bietet bessere Sicherheit:

// Server-seitiger Code (Node.js/Backend)
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

// Erstelle sichere SSO mit dem eingebauten Helfer
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();

// Mit API-Aufrufen auf dem Server verwenden
const publicApi = new PublicApi();
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id',
  sso: JSON.stringify(ssoConfig)
});

// Oder sende ssoConfig an den Client zur Browser-Verwendung

Verwendung von SSO im Browser (mit servergeneriertem Token)

// Client-seitiger Code (Browser)
import { PublicApi } from 'fastcomments-sdk/browser';

// Hole SSO-Token von Ihrem Server-Endpunkt
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 // Use the server-generated SSO token
});

SSO mit Kommentar-Erstellung

// Server-seitig: SSO und Kommentar erstellen
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)
});

Gängige Anwendungsfälle

Kommentare für eine Seite abrufen

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

Einen Kommentar erstellen

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

Für einen Kommentar abstimmen

const voteResponse = await sdk.publicApi.voteComment({
  voteBodyParams: {
    commentId: 'comment-id',
    direction: 1 // 1 für Upvote, -1 für Downvote
  }
});

Benutzerverwaltung (erfordert API-Schlüssel)

// Benutzer suchen (erfordert DefaultApi)
const users = await sdk.defaultApi.searchUsers({
  tenantId: 'your-tenant-id',
  urlId: 'page-id',
  usernameStartsWith: 'john'
});

Live-Ereignisse (Echtzeit-Aktualisierungen)

Abonnieren Sie Live-Ereignisse, um Echtzeit-Updates für Kommentare, Abstimmungen und andere Aktivitäten zu erhalten.

Ereignisse auf Seitenebene

Abonnieren Sie Live-Ereignisse für eine bestimmte Seite (Kommentare, Abstimmungen usw.):

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

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

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

    switch (event.type) {
      case LiveEventType.new_comment:
        console.log('New comment:', event.comment);
        // Aktualisieren Sie Ihre UI mit dem neuen Kommentar
        break;
      case LiveEventType.new_vote:
        console.log('New vote:', event.vote);
        // Aktualisieren Sie die Abstimmungszahlen in Ihrer UI
        break;
      case LiveEventType.updated_comment:
        console.log('Comment updated:', event.comment);
        break;
      default:
        console.log('Other event type:', event.type);
    }

    return true; // Geben Sie true zurück, wenn das Ereignis verarbeitet wurde
  },
  (isConnected: boolean) => {
    console.log('Connection status:', isConnected ? 'Connected' : 'Disconnected');
  }
);

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

Benutzerbezogene Ereignisse abonnieren

Abonnieren Sie benutzerspezifische Ereignisse (Benachrichtigungen, Erwähnungen usw.):

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

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

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

    switch (event.type) {
      case LiveEventType.notification:
        console.log('New notification:', event.notification);
        // Benachrichtigung in Ihrer UI anzeigen
        break;
      case LiveEventType.notification_update:
        console.log('Notification updated:', event.notification);
        break;
      default:
        console.log('Other user event:', event.type);
    }

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

// Close when done
userSubscription.close();

Abrufen von userIdWS

Der userIdWS Parameter wird für Live-Ereignisse benötigt und kann aus API-Antworten abgerufen werden:

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

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

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

Broadcast-IDs

Sie werden sehen, dass Sie in einigen API-Aufrufen eine broadcastId übergeben sollen. Wenn Sie Ereignisse erhalten, bekommen Sie diese ID zurück, sodass Sie das Ereignis ignorieren können, falls Sie Änderungen auf dem Client optimistisch anwenden möchten (was Sie wahrscheinlich tun sollten, da es die beste Erfahrung bietet). Geben Sie hier eine UUID an. Die ID sollte so eindeutig sein, dass sie in einer Browsersitzung nicht zweimal vorkommt.

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() // Eindeutige ID für diese Operation
  }
});

Fehlerbehandlung

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

aggregieren

Fasst Dokumente zusammen, indem sie gruppiert werden (falls groupBy angegeben ist) und mehrere Operationen angewendet werden. Verschiedene Operationen (z. B. sum, countDistinct, avg usw.) werden unterstützt.

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
aggregationRequest	AggregationRequest	Ja
parentTenantId	string	Nein
includeStats	boolean	Nein

Antwort

Gibt zurück: AggregationResponse

Audit-Protokolle abrufen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
limit	number	Nein
skip	number	Nein
order	SORTDIR	Nein
after	number	Nein
before	number	Nein

Antwort

Gibt zurück: GetAuditLogs200Response

Vom Kommentar sperren (öffentlich)

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentId	string	Ja
publicBlockFromCommentParams	PublicBlockFromCommentParams	Ja
sso	string	Nein

Antwort

Gibt zurück: BlockFromCommentPublic200Response

Kommentar entsperren (öffentlich)

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentId	string	Ja
publicBlockFromCommentParams	PublicBlockFromCommentParams	Ja
sso	string	Nein

Antwort

Gibt zurück: UnBlockCommentPublic200Response

Kommentare auf Sperrstatus prüfen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentIds	string	Ja
sso	string	Nein

Antwort

Gibt zurück: CheckedCommentsForBlocked200Response

Benutzer vom Kommentar sperren

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
blockFromCommentParams	BlockFromCommentParams	Ja
userId	string	Nein
anonUserId	string	Nein

Antwort

Gibt zurück: BlockFromCommentPublic200Response

Öffentlichen Kommentar erstellen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
urlId	string	Ja
broadcastId	string	Ja
commentData	CommentData	Ja
sessionId	string	Nein
sso	string	Nein

Antwort

Gibt zurück: CreateCommentPublic200Response

Kommentar löschen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
contextUserId	string	Nein
isLive	boolean	Nein

Antwort

Gibt zurück: DeleteComment200Response

Öffentlichen Kommentar löschen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentId	string	Ja
broadcastId	string	Ja
editKey	string	Nein
sso	string	Nein

Antwort

Gibt zurück: DeleteCommentPublic200Response

Kommentar-Stimme löschen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentId	string	Ja
voteId	string	Ja
urlId	string	Ja
broadcastId	string	Ja
editKey	string	Nein
sso	string	Nein

Antwort

Gibt zurück: DeleteCommentVote200Response

Kommentar melden

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
userId	string	Nein
anonUserId	string	Nein

Antwort

Gibt zurück: FlagComment200Response

Kommentar abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Ja

Antwort

Gibt zurück: GetComment200Response

Kommentare abrufen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
page	number	Nein
limit	number	Nein
skip	number	Nein
asTree	boolean	Nein
skipChildren	number	Nein
limitChildren	number	Nein
maxTreeDepth	number	Nein
urlId	string	Nein
userId	string	Nein
anonUserId	string	Nein
contextUserId	string	Nein
hashTag	string	Nein
parentId	string	Nein
direction	SortDirections	Nein

Antwort

Gibt zurück: GetComments200Response

Öffentliche Kommentare abrufen

req tenantId urlId

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
urlId	string	Ja
page	number	Nein
direction	SortDirections	Nein
sso	string	Nein
skip	number	Nein
skipChildren	number	Nein
limit	number	Nein
limitChildren	number	Nein
countChildren	boolean	Nein
fetchPageForCommentId	string	Nein
includeConfig	boolean	Nein
countAll	boolean	Nein
includei10n	boolean	Nein
locale	string	Nein
modules	string	Nein
isCrawler	boolean	Nein
includeNotificationCount	boolean	Nein
asTree	boolean	Nein
maxTreeDepth	number	Nein
useFullTranslationIds	boolean	Nein
parentId	string	Nein
searchText	string	Nein
hashTags	Array	Nein
userId	string	Nein
customConfigStr	string	Nein
afterCommentId	string	Nein
beforeCommentId	string	Nein

Antwort

Gibt zurück: GetCommentsPublic200Response

Kommentartext abrufen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentId	string	Ja
editKey	string	Nein
sso	string	Nein

Antwort

Gibt zurück: GetCommentText200Response

Benutzernamen der Kommentar-Stimmen abrufen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentId	string	Ja
dir	number	Ja
sso	string	Nein

Antwort

Gibt zurück: GetCommentVoteUserNames200Response

Kommentar sperren

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentId	string	Ja
broadcastId	string	Ja
sso	string	Nein

Antwort

Gibt zurück: LockComment200Response

Kommentar anpinnen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentId	string	Ja
broadcastId	string	Ja
sso	string	Nein

Antwort

Gibt zurück: PinComment200Response

Kommentar speichern

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
createCommentParams	CreateCommentParams	Ja
isLive	boolean	Nein
doSpamCheck	boolean	Nein
sendEmails	boolean	Nein
populateNotifications	boolean	Nein

Antwort

Gibt zurück: SaveComment200Response

Kommentare massenhaft speichern

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
createCommentParams	Array	Ja
isLive	boolean	Nein
doSpamCheck	boolean	Nein
sendEmails	boolean	Nein
populateNotifications	boolean	Nein

Antwort

Gibt zurück: Array<SaveComment200Response

Kommentartext setzen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentId	string	Ja
broadcastId	string	Ja
commentTextUpdateRequest	CommentTextUpdateRequest	Ja
editKey	string	Nein
sso	string	Nein

Antwort

Gibt zurück: SetCommentText200Response

Benutzer vom Kommentar entsperren

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
unBlockFromCommentParams	UnBlockFromCommentParams	Ja
userId	string	Nein
anonUserId	string	Nein

Antwort

Gibt zurück: UnBlockCommentPublic200Response

Kommentarmeldung aufheben

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
userId	string	Nein
anonUserId	string	Nein

Antwort

Gibt zurück: FlagComment200Response

Kommentar entsperren

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentId	string	Ja
broadcastId	string	Ja
sso	string	Nein

Antwort

Gibt zurück: LockComment200Response

Kommentar entpinnen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentId	string	Ja
broadcastId	string	Ja
sso	string	Nein

Antwort

Gibt zurück: PinComment200Response

Kommentar aktualisieren

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
body	PickAPICommentUpdatableCommentFields	Ja
contextUserId	string	Nein
doSpamCheck	boolean	Nein
isLive	boolean	Nein

Antwort

Gibt zurück: FlagCommentPublic200Response

Kommentar bewerten

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentId	string	Ja
urlId	string	Ja
broadcastId	string	Ja
voteBodyParams	VoteBodyParams	Ja
sessionId	string	Nein
sso	string	Nein

Antwort

Gibt zurück: VoteComment200Response

Domain-Konfiguration hinzufügen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
addDomainConfigParams	AddDomainConfigParams	Ja

Antwort

Gibt zurück: AddDomainConfig200Response

Domain-Konfiguration löschen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
domain	string	Ja

Antwort

Gibt zurück: DeleteDomainConfig200Response

Domain-Konfiguration abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
domain	string	Ja

Antwort

Gibt zurück: GetDomainConfig200Response

Domain-Konfigurationen abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja

Antwort

Gibt zurück: GetDomainConfigs200Response

Domain-Konfiguration teilweise aktualisieren

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
domainToUpdate	string	Ja
patchDomainConfigParams	PatchDomainConfigParams	Ja

Antwort

Gibt zurück: GetDomainConfig200Response

Domain-Konfiguration ersetzen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
domainToUpdate	string	Ja
updateDomainConfigParams	UpdateDomainConfigParams	Ja

Antwort

Gibt zurück: GetDomainConfig200Response

E-Mail-Vorlage erstellen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
createEmailTemplateBody	CreateEmailTemplateBody	Ja

Antwort

Gibt zurück: CreateEmailTemplate200Response

Beispiel

createEmailTemplate Beispiel

Copy

const tenantId: string = "tenant_7a9f2b3d";
const createEmailTemplateBody: CreateEmailTemplateBody = {
  name: "Comment Notification",
  subject: "New comment on your article: ",
  htmlBody: "<p> left a comment:</p><blockquote></blockquote>",
  enabled: true,
  defaultLocale: "en-US",
  metadata: { createdBy: "admin@example.com", purpose: "notify_comment" } // optionale zusätzliche Daten
};
const result: CreateEmailTemplate200Response = await createEmailTemplate(tenantId, createEmailTemplateBody);

E-Mail-Vorlage löschen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Ja

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

Beispiel für deleteEmailTemplate

Copy

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

Renderfehler der E-Mail-Vorlage löschen

Parameter

Name	Type	Erforderlich
tenantId	string	Ja
id	string	Ja
errorId	string	Ja

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

Beispiel für deleteEmailTemplateRenderError

Copy

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

E-Mail-Vorlage abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Ja

Antwort

Gibt zurück: GetEmailTemplate200Response

Beispiel

getEmailTemplate Beispiel

Copy

(async () => {
  const tenantId: string = 'acme-enterprises-123';
  const id: string = 'welcome-email-template-v2';
  const locale: string | undefined = 'en-US'; // Beispiel für einen optionalen Parameter
  const template: GetEmailTemplate200Response = await getEmailTemplate(tenantId, id);
  console.log(template, locale);
})();

Definitionen der E-Mail-Vorlagen abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja

Antwort

Gibt zurück: GetEmailTemplateDefinitions200Response

Beispiel

Beispiel für getEmailTemplateDefinitions

Copy

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

Renderfehler der E-Mail-Vorlagen abrufen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
skip	number	Nein

Antwort

Gibt zurück: GetEmailTemplateRenderErrors200Response

Beispiel

getEmailTemplateRenderErrors Beispiel

Copy

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

E-Mail-Vorlagen abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
skip	number	Nein

Antwort

Gibt zurück: GetEmailTemplates200Response

Beispiel

getEmailTemplates Beispiel

Copy

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

E-Mail-Vorlage rendern

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
renderEmailTemplateBody	RenderEmailTemplateBody	Ja
locale	string	Nein

Antwort

Gibt zurück: RenderEmailTemplate200Response

Beispiel

renderEmailTemplate Beispiel

Copy

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

E-Mail-Vorlage aktualisieren

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
updateEmailTemplateBody	UpdateEmailTemplateBody	Ja

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

updateEmailTemplate Beispiel

Copy

const tenantId: string = 'acme-corp-tenant-01';
const id: string = 'email_tpl_42b7a9';
const updateEmailTemplateBody: UpdateEmailTemplateBody = {
  name: 'Comment Flag Notification',
  subject: 'A comment was flagged on acme.com',
  html: '<p>A comment by  was flagged. Review at </p>',
  replyTo: 'noreply@acme.com', // optionales Feld zur Demonstration
  enabled: true,
  customConfig: { priority: 'high' } // optionale benutzerdefinierte Parameter
};
const response: FlagCommentPublic200Response = await updateEmailTemplate(tenantId, id, updateEmailTemplateBody);

Ereignisprotokoll abrufen

req tenantId urlId userIdWS

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
urlId	string	Ja
userIdWS	string	Ja
startTime	number	Ja
endTime	number	Ja

Antwort

Gibt zurück: GetEventLog200Response

Globales Ereignisprotokoll abrufen

req tenantId urlId userIdWS

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
urlId	string	Ja
userIdWS	string	Ja
startTime	number	Ja
endTime	number	Ja

Antwort

Gibt zurück: GetEventLog200Response

Feed-Beitrag erstellen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
createFeedPostParams	CreateFeedPostParams	Ja
broadcastId	string	Nein
isLive	boolean	Nein
doSpamCheck	boolean	Nein
skipDupCheck	boolean	Nein

Antwort

Gibt zurück: CreateFeedPost200Response

Öffentlichen Feed-Beitrag erstellen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
createFeedPostParams	CreateFeedPostParams	Ja
broadcastId	string	Nein
sso	string	Nein

Antwort

Gibt zurück: CreateFeedPostPublic200Response

Öffentlichen Feed-Beitrag löschen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
postId	string	Ja
broadcastId	string	Nein
sso	string	Nein

Antwort

Gibt zurück: DeleteFeedPostPublic200Response

Feed-Beiträge abrufen

req tenantId afterId

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
afterId	string	Nein
limit	number	Nein
tags	Array	Nein

Antwort

Gibt zurück: GetFeedPosts200Response

Öffentliche Feed-Beiträge abrufen

req tenantId afterId

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
afterId	string	Nein
limit	number	Nein
tags	Array	Nein
sso	string	Nein
isCrawler	boolean	Nein
includeUserInfo	boolean	Nein

Antwort

Gibt zurück: GetFeedPostsPublic200Response

Feed-Beitragsstatistiken abrufen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
postIds	Array	Ja
sso	string	Nein

Antwort

Gibt zurück: GetFeedPostsStats200Response

Öffentliche Nutzerreaktionen abrufen

Parameter

Name	Type	Erforderlich
tenantId	string	Ja
postIds	Array	Nein
sso	string	Nein

Antwort

Gibt zurück: GetUserReactsPublic200Response

Auf öffentlichen Feed-Beitrag reagieren

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
postId	string	Ja
reactBodyParams	ReactBodyParams	Ja
isUndo	boolean	Nein
broadcastId	string	Nein
sso	string	Nein

Antwort

Gibt zurück: ReactFeedPostPublic200Response

Feed-Beitrag aktualisieren

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
feedPost	FeedPost	Ja

Antwort

Gibt zurück: FlagCommentPublic200Response

Öffentlichen Feed-Beitrag aktualisieren

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
postId	string	Ja
updateFeedPostParams	UpdateFeedPostParams	Ja
broadcastId	string	Nein
sso	string	Nein

Antwort

Gibt zurück: CreateFeedPostPublic200Response

Öffentlichen Kommentar melden

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentId	string	Ja
isFlagged	boolean	Ja
sso	string	Nein

Antwort

Gibt zurück: FlagCommentPublic200Response

Hashtag hinzufügen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	No
createHashTagBody	CreateHashTagBody	No

Antwort

Gibt zurück: AddHashTag200Response

Beispiel

addHashTag Beispiel

Copy

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

Hashtags massenhaft hinzufügen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Nein
bulkCreateHashTagsBody	BulkCreateHashTagsBody	Nein

Antwort

Gibt zurück: AddHashTagsBulk200Response

Beispiel

addHashTagsBulk Beispiel

Copy

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

Hashtag löschen

Parameter

Name	Typ	Erforderlich
tag	string	Ja
tenantId	string	Nein
deleteHashTagRequest	DeleteHashTagRequest	Nein

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

deleteHashTag Beispiel

Copy

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

Hashtags abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
page	number	Nein

Antwort

Gibt zurück: GetHashTags200Response

Beispiel

getHashTags Beispiel

Copy

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

Hashtag teilweise aktualisieren

Parameter

Name	Typ	Erforderlich
tag	string	Ja
tenantId	string	Nein
updateHashTagBody	UpdateHashTagBody	Nein

Antwort

Gibt zurück: PatchHashTag200Response

Beispiel

patchHashTag Beispiel

Copy

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

Moderator erstellen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
createModeratorBody	CreateModeratorBody	Ja

Rückgabe

Gibt zurück: CreateModerator200Response

Beispiel

createModerator Beispiel

Copy

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

Moderator löschen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
sendEmail	string	Nein

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

deleteModerator Beispiel

Copy

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

Moderator abrufen

Parameter

Name	Type	Required	Description
tenantId	string	Ja
id	string	Ja

Antwort

Gibt zurück: GetModerator200Response

Beispiel

getModerator Beispiel

Copy

const tenantId: string = "tenant_eu_4f8d2b9e";
const maybeModeratorId: string | undefined = "mod_91c3b7a2"; // optionale Quelle (kann undefined sein)
const moderator: GetModerator200Response = await getModerator(tenantId, maybeModeratorId!);

Moderatoren abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
skip	number	Nein

Antwort

Gibt zurück: GetModerators200Response

Beispiel

Beispiel für getModerators

Copy

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

Einladung senden

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
fromName	string	Ja

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

sendInvite Beispiel

Copy

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

Moderator aktualisieren

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
updateModeratorBody	UpdateModeratorBody	Ja

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

updateModerator Beispiel

Copy

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

Benachrichtigungsanzahl löschen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Ja

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

deleteNotificationCount Beispiel

Copy

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

Zwischengespeicherte Benachrichtigungsanzahl abrufen

Parameter

Name	Type	Required	Description
tenantId	string	Ja
id	string	Ja

Antwort

Gibt zurück: GetCachedNotificationCount200Response

Beispiel

getCachedNotificationCount Beispiel

Copy

const tenantId: string = 'acme-tenant-01';
const baseNotificationId: string = 'notif-000123';
const idSuffix: string | undefined = undefined; // Beispiel für optionalen Parameter
const notificationId: string = idSuffix ? `${baseNotificationId}-${idSuffix}` : baseNotificationId;
const result: GetCachedNotificationCount200Response = await getCachedNotificationCount(tenantId, notificationId);
console.log(result);

Benachrichtigungsanzahl abrufen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
userId	string	Nein
urlId	string	Nein
fromCommentId	string	Nein
viewed	boolean	Nein
type	string	Nein

Antwort

Gibt zurück: GetNotificationCount200Response

Beispiel

getNotificationCount Beispiel

Copy

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

Benachrichtigungen abrufen

Parameter

Name	Type	Erforderlich
tenantId	string	Ja
userId	string	Nein
urlId	string	Nein
fromCommentId	string	Nein
viewed	boolean	Nein
type	string	Nein
skip	number	Nein

Antwort

Gibt zurück: GetNotifications200Response

Beispiel

getNotifications Beispiel

Copy

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

Benachrichtigung aktualisieren

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
updateNotificationBody	UpdateNotificationBody	Ja
userId	string	Nein

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

updateNotification Beispiel

Copy

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

Seite hinzufügen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
createAPIPageData	CreateAPIPageData	Ja

Antwort

Gibt zurück: AddPageAPIResponse

Seite löschen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Ja

Antwort

Gibt zurück: DeletePageAPIResponse

Seite nach URL-ID abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
urlId	string	Ja

Antwort

Gibt zurück: GetPageByURLIdAPIResponse

Seiten abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja

Antwort

Gibt zurück: GetPagesAPIResponse

Seite teilweise aktualisieren

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
updateAPIPageData	UpdateAPIPageData	Ja

Antwort

Gibt zurück: PatchPageAPIResponse

Ausstehendes Webhook-Ereignis löschen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Ja

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

Beispiel für deletePendingWebhookEvent

Copy

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

Anzahl ausstehender Webhook-Ereignisse abrufen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
commentId	string	Nein
externalId	string	Nein
eventType	string	Nein
type	string	Nein
domain	string	Nein
attemptCountGT	number	Nein

Antwort

Gibt zurück: GetPendingWebhookEventCount200Response

Beispiel

getPendingWebhookEventCount Beispiel

Copy

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

Ausstehende Webhook-Ereignisse abrufen

Parameter

Name	Type	Erforderlich
tenantId	string	Ja
commentId	string	Nein
externalId	string	Nein
eventType	string	Nein
type	string	Nein
domain	string	Nein
attemptCountGT	number	Nein
skip	number	Nein

Antwort

Gibt zurück: GetPendingWebhookEvents200Response

Beispiel

getPendingWebhookEvents Beispiel

Copy

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

Frage-Konfiguration erstellen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
createQuestionConfigBody	CreateQuestionConfigBody	Ja

Antwort

Gibt zurück: CreateQuestionConfig200Response

Beispiel

Beispiel für createQuestionConfig

Copy

const tenantId: string = "tenant_live_7f8b3c2a";
const customOptions: QuestionConfigCustomOptionsInner[] = [
  { value: "under18", label: "Under 18" },
  { value: "18-24", label: "18-24" },
  { value: "25-34", label: "25-34", defaultSelected: true }
];
const createQuestionConfigBody: CreateQuestionConfigBody = {
  key: "age_range",
  label: "What is your age range?",
  required: false, // optional: demonstriert ausgelassene vs. eingeschlossene optionale Felder
  renderingType: QuestionRenderingType.Dropdown,
  options: customOptions,
  whenSave: QuestionWhenSave.Always
};
const result: CreateQuestionConfig200Response = await createQuestionConfig(tenantId, createQuestionConfigBody);

Frage-Konfiguration löschen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Ja

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

Beispiel für deleteQuestionConfig

Copy

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

Frage-Konfiguration abrufen

Parameter

Name	Type	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Ja

Antwort

Gibt zurück: GetQuestionConfig200Response

Beispiel

getQuestionConfig-Beispiel

Copy

const tenantId: string = 'acme-corp-47';
const questionId: string = 'q-2026-01-12-01';
const result: GetQuestionConfig200Response = await getQuestionConfig(tenantId, questionId);
function summarizeConfig(cfg: GetQuestionConfig200Response, includeMetadata?: boolean): QuestionConfig | undefined {
  // includeMetadata ist optional; Implementierung der Kürze halber weggelassen
  return undefined;
}
const summarizedWithMeta: QuestionConfig | undefined = summarizeConfig(result, true);
const summarizedDefault: QuestionConfig | undefined = summarizeConfig(result);

Frage-Konfigurationen abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
skip	number	Nein

Antwort

Gibt zurück: GetQuestionConfigs200Response

Beispiel

getQuestionConfigs Beispiel

Copy

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

Frage-Konfiguration aktualisieren

Parameter

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

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

updateQuestionConfig Beispiel

Copy

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

Frageergebnis erstellen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
createQuestionResultBody	CreateQuestionResultBody	Ja

Antwort

Gibt zurück: CreateQuestionResult200Response

Beispiel

createQuestionResult Beispiel

Copy

const tenantId: string = "fc_tenant_7a3c_us-east-1";
const metaItem: MetaItem = { key: "referrer", value: "/blog/how-to-comment" };
const createQuestionResultBody: CreateQuestionResultBody = {
  questionId: "q_42",
  commenterId: "user_1984",
  answer: "yes",
  score: 4,
  meta: [metaItem] // optionale Metadaten demonstriert
} as CreateQuestionResultBody;
const result: CreateQuestionResult200Response = await createQuestionResult(tenantId, createQuestionResultBody);

Frageergebnis löschen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Ja

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

Beispiel für deleteQuestionResult

Copy

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

Frageergebnis abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Ja

Antwort

Gibt zurück: GetQuestionResult200Response

Beispiel

getQuestionResult Beispiel

Copy

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

Frageergebnisse abrufen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
urlId	string	Nein
userId	string	Nein
startDate	string	Nein
questionId	string	Nein
questionIds	string	Nein
skip	number	Nein

Antwort

Gibt zurück: GetQuestionResults200Response

Beispiel

getQuestionResults Beispiel

Copy

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

Frageergebnis aktualisieren

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
updateQuestionResultBody	UpdateQuestionResultBody	Ja

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

updateQuestionResult Beispiel

Copy

const tenantId: string = 'tenant_84f2b9';
const id: string = 'question_3a7c1d';
const updateQuestionResultBody: UpdateQuestionResultBody = {
  result: { verdict: 'helpful', confidence: 0.92 },
  reviewer: { id: 'mod_102', name: 'Aisha Rahman' },
  notifyUser: true // optionaler Parameter enthalten
};
const response: FlagCommentPublic200Response = await updateQuestionResult(tenantId, id, updateQuestionResultBody);

Frageergebnisse aggregieren

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
questionId	string	Nein
questionIds	Array	Nein
urlId	string	Nein
timeBucket	AggregateTimeBucket	Nein
startDate	Date	Nein
forceRecalculate	boolean	Nein

Antwort

Gibt zurück: AggregateQuestionResults200Response

Frageergebnisse massenhaft aggregieren

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
bulkAggregateQuestionResultsRequest	BulkAggregateQuestionResultsRequest	Ja
forceRecalculate	boolean	Nein

Antwort

Gibt zurück: BulkAggregateQuestionResults200Response

Kommentare mit Frageergebnissen kombinieren

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
questionId	string	Nein
questionIds	Array	Nein
urlId	string	Nein
startDate	Date	Nein
forceRecalculate	boolean	Nein
minValue	number	Nein
maxValue	number	Nein
limit	number	Nein

Antwort

Gibt zurück: CombineCommentsWithQuestionResults200Response

SSO-Benutzer hinzufügen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
createAPISSOUserData	CreateAPISSOUserData	Ja

Antwort

Gibt zurück: AddSSOUserAPIResponse

SSO-Benutzer löschen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
deleteComments	boolean	Nein
commentDeleteMode	string	Nein

Antwort

Gibt zurück: DeleteSSOUserAPIResponse

SSO-Benutzer per E-Mail abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
email	string	Ja

Antwort

Gibt zurück: GetSSOUserByEmailAPIResponse

SSO-Benutzer per ID abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Ja

Antwort

Gibt zurück: GetSSOUserByIdAPIResponse

SSO-Benutzer abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
skip	number	Nein

Antwort

Gibt zurück: GetSSOUsers200Response

SSO-Benutzer teilweise aktualisieren

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
updateAPISSOUserData	UpdateAPISSOUserData	Ja
updateComments	boolean	Nein

Antwort

Gibt zurück: PatchSSOUserAPIResponse

SSO-Benutzer ersetzen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
updateAPISSOUserData	UpdateAPISSOUserData	Ja
updateComments	boolean	Nein

Antwort

Gibt zurück: PutSSOUserAPIResponse

Abonnement erstellen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
createAPIUserSubscriptionData	CreateAPIUserSubscriptionData	Ja

Antwort

Gibt zurück: CreateSubscriptionAPIResponse

Abonnement löschen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
userId	string	Nein

Antwort

Gibt zurück: DeleteSubscriptionAPIResponse

Abonnements abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
userId	string	Nein

Antwort

Gibt zurück: GetSubscriptionsAPIResponse

Tägliche Nutzungen des Mandanten abrufen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
yearNumber	number	Nein
monthNumber	number	Nein
dayNumber	number	Nein
skip	number	Nein

Antwort

Gibt zurück: GetTenantDailyUsages200Response

Beispiel

getTenantDailyUsages Beispiel

Copy

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

Mandantenpaket erstellen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
createTenantPackageBody	CreateTenantPackageBody	Ja

Antwort

Gibt zurück: CreateTenantPackage200Response

Beispiel

createTenantPackage Beispiel

Copy

const tenantId: string = "tenant_7f3b1a9c";
const tenantPackage: TenantPackage = { id: "pkg_001", name: "Premium Plan", seats: 100 };
const customConfig: CustomConfigParameters = { enableImages: true, maxImageSizeMb: 10 };
const createTenantPackageBody: CreateTenantPackageBody = {
  packageName: "Premium Plus",
  tenantPackage,
  customConfig,
  notes: "Enable advanced moderation and image uploads" // optionaler Parameter demonstriert
};
const result: CreateTenantPackage200Response = await createTenantPackage(tenantId, createTenantPackageBody);

Mandantenpaket löschen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Ja

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

Beispiel für deleteTenantPackage

Copy

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

Mandantenpaket abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Yes
id	string	Yes

Antwort

Gibt zurück: GetTenantPackage200Response

Beispiel

getTenantPackage Beispiel

Copy

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

Mandantenpakete abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Yes
skip	number	No

Antwort

Gibt zurück: GetTenantPackages200Response

Beispiel

getTenantPackages Beispiel

Copy

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

Mandantenpaket ersetzen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
replaceTenantPackageBody	ReplaceTenantPackageBody	Ja

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

replaceTenantPackage Beispiel

Copy

const tenantId: string = 'tenant-9b72f2';
const packageId: string = 'pkg-prod-v2';
const replaceTenantPackageBody: ReplaceTenantPackageBody = {
  name: 'Premium Moderation Bundle',
  enabled: true,
  maxModerators: 4,
  // optionale Felder wie "notes" oder "trialExpiry" sind hier absichtlich weggelassen
} as ReplaceTenantPackageBody;
const result: FlagCommentPublic200Response = await replaceTenantPackage(
  tenantId,
  packageId,
  replaceTenantPackageBody
);

Mandantenpaket aktualisieren

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
updateTenantPackageBody	UpdateTenantPackageBody	Ja

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

Beispiel für updateTenantPackage

Copy

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

Mandantenbenutzer erstellen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
createTenantUserBody	CreateTenantUserBody	Ja

Antwort

Gibt zurück: CreateTenantUser200Response

Beispiel

createTenantUser Beispiel

Copy

const tenantId: string = "tenant_9a8c7e4b";
const createTenantUserBody: CreateTenantUserBody = {
  email: "julia.smith@acme-corp.com",
  displayName: "Julia Smith",
  role: "moderator",
  password: "Str0ngP@ssword!23",
  sendInviteEmail: true, // optionaler Parameter zur Demonstration
  locale: "en-US",
  metadata: { department: "Customer Success" }
};
const result: CreateTenantUser200Response = await createTenantUser(tenantId, createTenantUserBody);

Mandantenbenutzer löschen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
deleteComments	string	Nein
commentDeleteMode	string	Nein

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

deleteTenantUser Beispiel

Copy

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

Mandantenbenutzer abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Ja

Antwort

Gibt zurück: GetTenantUser200Response

Beispiel

getTenantUser Beispiel

Copy

const tenantId: string = "tenant_9f7d4b2a-1c3e";
const id: string = "user_6a12b3c4d5";
const includeProfile: boolean | undefined = true; // Beispiel für optionalen Parameter
const response: GetTenantUser200Response = await getTenantUser(tenantId, id);
console.log("Tenant user fetched", response);

Mandantenbenutzer abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
skip	number	Nein

Antwort

Gibt zurück: GetTenantUsers200Response

Beispiel

getTenantUsers Beispiel

Copy

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

Mandantenbenutzer ersetzen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
replaceTenantUserBody	ReplaceTenantUserBody	Ja
updateComments	string	Nein

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

Beispiel für replaceTenantUser

Copy

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

Login-Link senden

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
redirectURL	string	Nein

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

Beispiel für sendLoginLink

Copy

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

Mandantenbenutzer aktualisieren

Parameter

Name	Type	Erforderlich
tenantId	string	Ja
id	string	Ja
updateTenantUserBody	UpdateTenantUserBody	Ja
updateComments	string	Nein

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

updateTenantUser Beispiel

Copy

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

Mandanten erstellen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
createTenantBody	CreateTenantBody	Ja

Antwort

Gibt zurück: CreateTenant200Response

Beispiel

createTenant Beispiel

Copy

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

Mandanten löschen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
sure	string	Nein

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

deleteTenant Beispiel

Copy

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

Mandant abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Ja

Antwort

Gibt zurück: GetTenant200Response

Beispiel

getTenant Beispiel

Copy

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

Mandanten abrufen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
meta	string	Nein
skip	number	Nein

Antwort

Gibt zurück: GetTenants200Response

Beispiel

getTenants Beispiel

Copy

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

Mandant aktualisieren

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
updateTenantBody	UpdateTenantBody	Ja

Antwort

Gibt zurück: FlagCommentPublic200Response

Beispiel

updateTenant Beispiel

Copy

const tenantId: string = "tenant_01H4ZQ7KABCD";
const id: string = "site_9f8e7d6c";
const apiDomainConfiguration: APIDomainConfiguration = {
  primaryDomain: "comments.acme.com",
  allowSubdomains: true
};
const billingInfo: BillingInfo = {
  planName: "Business",
  billingContactEmail: "billing@acme.com",
  seats: 25
};
const updateTenantBody: UpdateTenantBody = {
  displayName: "Acme Corporation Comments",
  apiDomainConfiguration,
  billingInfo, // optionaler Parameter zur Demonstration
  enableModeration: true
};
const result: FlagCommentPublic200Response = await updateTenant(tenantId, id, updateTenantBody);

Bild hochladen

Bild hochladen und skalieren

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
file	Blob	Ja
sizePreset	SizePreset	Nein
urlId	string	Nein

Antwort

Gibt zurück: UploadImageResponse

Fortschritt des Benutzerabzeichens nach ID abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Ja

Antwort

Gibt zurück: GetUserBadgeProgressById200Response

Fortschritt des Benutzerabzeichens nach Benutzer-ID abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
userId	string	Ja

Antwort

Gibt zurück: GetUserBadgeProgressById200Response

Fortschrittsliste der Benutzerabzeichen abrufen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
userId	string	Nein
limit	number	Nein
skip	number	Nein

Antwort

Gibt zurück: GetUserBadgeProgressList200Response

Benutzerabzeichen erstellen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
createUserBadgeParams	CreateUserBadgeParams	Ja

Antwort

Gibt zurück: CreateUserBadge200Response

Benutzerabzeichen löschen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Ja

Antwort

Gibt zurück: UpdateUserBadge200Response

Benutzerabzeichen abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Ja

Antwort

Gibt zurück: GetUserBadge200Response

Benutzerabzeichen abrufen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
userId	string	Nein
badgeId	string	Nein
type	number	Nein
displayedOnComments	boolean	Nein
limit	number	Nein
skip	number	Nein

Antwort

Gibt zurück: GetUserBadges200Response

Benutzerabzeichen aktualisieren

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
updateUserBadgeParams	UpdateUserBadgeParams	Ja

Antwort

Gibt zurück: UpdateUserBadge200Response

Benutzer-Benachrichtigungsanzahl abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
sso	string	Nein

Antwort

Gibt zurück: GetUserNotificationCount200Response

Benutzerbenachrichtigungen abrufen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
pageSize	number	Nein
afterId	string	Nein
includeContext	boolean	Nein
afterCreatedAt	number	Nein
unreadOnly	boolean	Nein
dmOnly	boolean	Nein
noDm	boolean	Nein
includeTranslations	boolean	Nein
sso	string	Nein

Antwort

Gibt zurück: GetUserNotifications200Response

Benutzer-Benachrichtigungsanzahl zurücksetzen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
sso	string	Nein

Antwort

Gibt zurück: ResetUserNotifications200Response

Benutzerbenachrichtigungen zurücksetzen

Parameter

Name	Type	Erforderlich
tenantId	string	Ja
afterId	string	Nein
afterCreatedAt	number	Nein
unreadOnly	boolean	Nein
dmOnly	boolean	Nein
noDm	boolean	Nein
sso	string	Nein

Antwort

Gibt zurück: ResetUserNotifications200Response

Status des Kommentarabonnements der Benutzerbenachrichtigung aktualisieren

Benachrichtigungen für einen bestimmten Kommentar aktivieren oder deaktivieren.

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
notificationId	string	Ja
optedInOrOut	UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum	Ja
commentId	string	Ja
sso	string	Nein

Antwort

Gibt zurück: UpdateUserNotificationStatus200Response

Status des Seitenabonnements der Benutzerbenachrichtigung aktualisieren

Aktivieren oder Deaktivieren von Benachrichtigungen für eine Seite. Wenn Nutzer eine Seite abonniert haben, werden Benachrichtigungen erstellt für neue Root-Kommentare, und auch

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
urlId	string	Ja
url	string	Ja
pageTitle	string	Ja
subscribedOrUnsubscribed	UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum	Ja
sso	string	Nein

Antwort

Gibt zurück: UpdateUserNotificationStatus200Response

Status der Benutzerbenachrichtigung aktualisieren

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
notificationId	string	Ja
newStatus	UpdateUserNotificationStatusNewStatusEnum	Ja
sso	string	Nein

Antwort

Gibt zurück: UpdateUserNotificationStatus200Response

Präsenzstatus der Benutzer abrufen

Parameter

Name	Type	Required
tenantId	string	Ja
urlIdWS	string	Ja
userIds	string	Ja

Antwort

Gibt zurück: GetUserPresenceStatuses200Response

Benutzer suchen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
urlId	string	Ja
usernameStartsWith	string	Ja
mentionGroupIds	Array	Nein
sso	string	Nein

Antwort

Gibt zurück: SearchUsers200Response

Benutzer abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
id	string	Ja

Antwort

Gibt zurück: GetUser200Response

Beispiel

getUser-Beispiel

Copy

const tenantId: string = "acme-publishing-42";
const userIdOptional: string | undefined = "user_9d7b4c"; // kann in einigen Abläufen undefiniert sein (optional)
const id: string = userIdOptional ?? "user_default_0001";
const result: GetUser200Response = await getUser(tenantId, id);
console.log(result);

Abstimmung erstellen

Parameter

Name	Type	Required
tenantId	string	Ja
commentId	string	Ja
direction	CreateVoteDirectionEnum	Ja
userId	string	Nein
anonUserId	string	Nein

Antwort

Gibt zurück: VoteComment200Response

Beispiel

createVote Beispiel

Copy

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

Abstimmung löschen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
id	string	Ja
editKey	string	Nein

Antwort

Gibt zurück: DeleteCommentVote200Response

Beispiel

deleteVote Beispiel

Copy

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

Abstimmungen abrufen

Parameter

Name	Typ	Erforderlich	Beschreibung
tenantId	string	Ja
urlId	string	Ja

Antwort

Gibt zurück: GetVotes200Response

Beispiel

getVotes Beispiel

Copy

const tenantId: string = 'tenant_9f8b3c_prod';
const urlId: string = '/news/2026/typescript-ecosystem-update';
const votes: GetVotes200Response = await getVotes(tenantId, urlId);
// Wenn ein optionaler Parameter existierte, z. B. includeHidden, könnte er so verwendet werden:
// const votesWithHidden: GetVotes200Response = await getVotes(tenantId, urlId, { includeHidden: true });

Abstimmungen für Benutzer abrufen

Parameter

Name	Typ	Erforderlich
tenantId	string	Ja
urlId	string	Ja
userId	string	Nein
anonUserId	string	Nein

Antwort

Gibt zurück: GetVotesForUser200Response

Beispiel

getVotesForUser Beispiel

Copy

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

Benötigen Sie Hilfe?

Wenn Sie auf Probleme stoßen oder Fragen zum JavaScript-/TypeScript-SDK haben, bitte:

Mitwirken

Beiträge sind willkommen! Bitte besuchen Sie das GitHub-Repository für Richtlinien zur Mitarbeit.

Sprache 🇩🇪 Deutsch

Erste Schritte

API-Referenz

Dokumentation

Verwendung

Aggregation

Audit-Protokolle

Vom Kommentar sperren

Gesperrte Kommentare prüfen

Kommentare

Domain-Konfigurationen

E-Mail-Vorlagen

Ereignisprotokoll

Feed-Beiträge

Kommentar melden

Hashtags

Moderatoren

Benachrichtigungsanzahl

Benachrichtigungen

Seiten

Ausstehende Webhook-Ereignisse

Fragekonfigurationen

Frageergebnisse

Aggregation von Frageergebnissen

SSO-Benutzer

Abonnements

Tägliche Nutzung des Mandanten

Mandantenpakete

Mandantenbenutzer

Mandanten

Bild hochladen

Fortschritt der Benutzerabzeichen

Benutzerabzeichen

Benutzerbenachrichtigungen

Präsenzstatus der Benutzer

Benutzersuche

Benutzer

Abstimmungen

FastComments JavaScript/TypeScript SDK

Repository

Installation

API-Dokumentation

Vollständige API-Referenz: docs/api/README.md

Browser- vs. Server-Kompatibilität

Verwendung

Browser-Nutzung (Clientseitig)

Server-Nutzung (Node.js)

Nur Typen-Import

Verwendung einzelner API-Klassen

Browser-Umgebung

Server-Umgebung

Öffentliche vs. geschützte APIs

Beispiel: Verwendung der Public API (browser-sicher)

Beispiel: Verwendung der Default API (nur serverseitig)

SSO (Single Sign-On)-Integration

Einfache SSO (nur serverseitig)

Sichere SSO (serverseitig, empfohlen)

Verwendung von SSO im Browser (mit servergeneriertem Token)

SSO mit Kommentar-Erstellung

Gängige Anwendungsfälle

Kommentare für eine Seite abrufen

Einen Kommentar erstellen

Für einen Kommentar abstimmen

Benutzerverwaltung (erfordert API-Schlüssel)

Live-Ereignisse (Echtzeit-Aktualisierungen)

Ereignisse auf Seitenebene

Benutzerbezogene Ereignisse abonnieren

Abrufen von userIdWS

Broadcast-IDs

Fehlerbehandlung

aggregieren

Parameter

Antwort

Audit-Protokolle abrufen

Parameter

Antwort

Vom Kommentar sperren (öffentlich)

Parameter

Antwort

Kommentar entsperren (öffentlich)