
Dil 🇹🇷 Türkçe
Dokümantasyon
Başlarken
Ajan Kiracıları
Toplama
Denetim Kayıtları
Kimlik Doğrulama
Toplu İşler
Yorumu Engelle
Engellenen Yorumları Kontrol Et
Yorumlar
Kullanıcı İçin Yorumlar
Alan Adı Yapılandırmaları
E-posta Şablonları
Olay Günlüğü
Akış Gönderileri
Yorumu İşaretle
Gif'ler
Etiketler
Ben
Moderasyon
Moderatörler
Bildirim Sayısı
Bildirimler
Sayfa Tepkileri
Sayfalar
Bekleyen Webhook Olayları
Anket Oyları
Anketler
Soru Yapılandırmaları
Soru Sonuçları
Soru Sonuçları Toplaması
SSO Kullanıcıları
Abonelikler
Kiracı Günlük Kullanımı
Kiracı Paketleri
Kiracı Kullanıcıları
Kiracılar
Biletler
Çeviriler
Resim Yükle
Kullanıcı Rozeti İlerlemesi
Kullanıcı Rozetleri
Kullanıcı Bildirimleri
Kullanıcı Durumları
Kullanıcı Arama
Kullanıcılar
Oylar
Webhook'lar
FastComments Java SDK
Bu, FastComments için resmi Java SDK'sıdır.
FastComments API'si için resmi Java SDK
Depo
AI kodlama ajanları 
Kodlama ajanınıza FastComments bağlamını sağlayın - widget'lar, yapılandırma, Güvenli SSO, REST API ve SDK'lar:
npx skills add fastcomments/skills
Claude Code, Codex, Cursor, Copilot, Gemini ve skills CLI tarafından desteklenen diğer tüm ajanlarla çalışır.
Kurulum 
Maven
Repsy deposunu projenizin POM dosyasına ekleyin:
<repositories>
<repository>
<id>repsy</id>
<name>FastComments Maven Repository on Repsy</name>
<url>https://repo.repsy.io/mvn/winrid/fastcomments</url>
</repository>
</repositories>
Ardından ihtiyacınız olan bağımlılıkları ekleyin:
<dependencies>
<!-- API Client -->
<dependency>
<groupId>com.fastcomments</groupId>
<artifactId>client</artifactId>
<version>3.1.1</version>
</dependency>
<!-- Core Library (SSO içerir) -->
<dependency>
<groupId>com.fastcomments</groupId>
<artifactId>core</artifactId>
<version>3.1.1</version>
</dependency>
<!-- PubSub Library (canlı etkinlikler için) -->
<dependency>
<groupId>com.fastcomments</groupId>
<artifactId>pubsub</artifactId>
<version>3.1.1</version>
</dependency>
</dependencies>
Gradle
Repsy deposunu build.gradle dosyanıza ekleyin:
repositories {
mavenCentral()
maven {
url "https://repo.repsy.io/mvn/winrid/fastcomments"
}
}
dependencies {
// API Client
implementation "com.fastcomments:client:3.1.1"
// Core Library (SSO içerir)
implementation "com.fastcomments:core:3.1.1"
// PubSub Library (canlı etkinlikler için)
implementation "com.fastcomments:pubsub:3.1.1"
}
Kütüphane İçeriği
Bu kütüphane üç modül içerir. Üretilmiş API istemcisi, API ile çalışmayı kolaylaştıran elle yazılmış yardımcı araçlar içeren çekirdek Java kütüphanesi ve değişiklik akışlarına abone olmak için bir kütüphane olan pubsub modülü.
- API Client Library Dokümantasyonu
- SSO Örnekleri Dahil Core Library Dokümantasyonu
- PubSub Library Dokümantasyonu
Herkese Açık ve Güvenli API'ler
API istemcisi için üç sınıf vardır: DefaultApi, PublicApi ve ModerationApi. DefaultApi, API anahtarınızı gerektiren metotları içerir; PublicApi ise kimlik doğrulama olmadan doğrudan bir tarayıcıdan/mobil cihazdan vb. yapılabilecek metotları içerir.
ModerationApi, canlı ve hızlı moderasyon için kapsamlı bir API paketi sunar. Her ModerationApi metodu bir sso parametresi kabul eder ve SSO veya bir FastComments.com oturum çerezi aracılığıyla kimlik doğrulaması yapabilir.
Hızlı Başlangıç 
Kimlik Doğrulamalı API'lerin Kullanımı (DefaultApi)
Önemli: Kimlik doğrulamalı istekler yapmadan önce ApiClient üzerinde API anahtarınızı ayarlamanız gerekir. Aksi takdirde istekler 401 hatasıyla başarısız olur.
import com.fastcomments.invoker.ApiClient;
import com.fastcomments.invoker.ApiException;
import com.fastcomments.api.DefaultApi;
import com.fastcomments.model.*;
public class Example {
public static void main(String[] args) {
// API istemcisini oluştur ve yapılandır
ApiClient apiClient = new ApiClient();
// GEREKLİ: API anahtarınızı ayarlayın (bunu FastComments panonuzdan alın)
apiClient.setApiKey("YOUR_API_KEY_HERE");
// Yapılandırılmış istemci ile API örneğini oluştur
DefaultApi api = new DefaultApi(apiClient);
// Artık kimlik doğrulamalı API çağrıları yapabilirsiniz
try {
// Örnek: Bir SSO kullanıcısı ekleyin
CreateAPISSOUserData userData = new CreateAPISSOUserData();
userData.setId("user-123");
userData.setEmail("user@example.com");
userData.setDisplayName("John Doe");
AddSSOUserAPIResponse response = api.addSSOUser("YOUR_TENANT_ID", userData)
.execute();
System.out.println("User created: " + response);
} catch (ApiException e) {
System.err.println("Error: " + e.getResponseBody());
// Yaygın hatalar:
// - 401: API anahtarı eksik veya geçersiz
// - 400: İstek doğrulaması başarısız oldu
}
}
}
Genel API'lerin Kullanımı (PublicApi)
Herkese açık uç noktalar kimlik doğrulaması gerektirmez:
import com.fastcomments.api.PublicApi;
import com.fastcomments.invoker.ApiException;
PublicApi publicApi = new PublicApi();
try {
var response = publicApi.getCommentsPublic("YOUR_TENANT_ID", "page-url-id")
.execute();
System.out.println(response);
} catch (ApiException e) {
e.printStackTrace();
}
Moderasyon API'lerinin Kullanımı (ModerationApi)
ModerationApi, moderatör panelini yönetir. Her metot, isteğin yapıldığı SSO kimlik doğrulamalı moderatörü tanımlayan bir sso parametresi alır:
import com.fastcomments.api.ModerationApi;
import com.fastcomments.invoker.ApiException;
import com.fastcomments.model.*;
ModerationApi moderationApi = new ModerationApi();
try {
// Moderasyon bekleyen yorumları listele
ModerationAPIGetCommentsResponse response = moderationApi.getApiComments()
.sso("YOUR_SSO_TOKEN")
.execute();
System.out.println(response);
} catch (ApiException e) {
e.printStackTrace();
}
Yaygın Sorunlar
- 401 "missing-api-key" hatası: DefaultApi örneğini oluşturmadan önce
apiClient.setApiKey("YOUR_KEY")çağrısını yaptığınızdan emin olun. - Yanlış API sınıfı: Sunucu tarafı kimlik doğrulamalı istekler için
DefaultApi, istemci tarafı/herkese açık istekler içinPublicApikullanın. - Null API anahtarı: API anahtarı null ise SDK kimlik doğrulamasını sessizce atlar ve bu da 401 hatalarına yol açar.
Notlar 
Broadcast Kimlikleri
Bazı API çağrılarında bir broadcastId geçirmeniz gerektiğini göreceksiniz. Olayları aldığınızda bu ID size geri dönecek, böylece istemci tarafında değişiklikleri iyimserce uygulamayı planlıyorsanız olayı görmezden geleceğinizi bilirsiniz
(muhtemelen en iyi deneyimi sağladığı için bunu yapmak isteyeceksiniz). Burada bir UUID gönderin. ID, bir tarayıcı oturumunda iki kez tekrar etmeyecek kadar benzersiz olmalıdır.
createAgentTenant 
İnsan kaydı olmadan bir AI ajanı için yeni bir deneme hesabı oluşturur. Bu çağrı için API anahtarı gerekmez.
Yanıt, tenant id, REST API ve MCP sunucusuna karşı hemen çalışabilen bir API anahtarı ve bir claim URL içerir. Claim URL'sini sizin için çalışan insana verin: FastComments'a giriş yapmışken açtığında hesap ona bağlanır. Talep edilmemiş (unclaimed) hesaplar ve anahtarları, oluşturulduktan 72 saat sonra silinir. Talep edilene kadar hesap standart deneme limitlerine sahiptir.
Yanıt
Döndürür: CreateAgentTenantResponse
Örnek

aggregate 
Belgeleri (groupBy sağlanmışsa) gruplandırarak ve birden çok işlem uygulayarak toplar. Farklı işlemler (örn. sum, countDistinct, avg, vb.) desteklenir.
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| parentTenantId | string | query | Hayır | |
| includeStats | boolean | query | Hayır |
Yanıt
Döndürür: AggregateResponse
Örnek

getAuditLogs 
Parameters
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | Denetim günlüklerini okunacak kiracı. |
| limit | integer | query | Hayır | Döndürülecek günlük sayısı. Maksimum 10000, varsayılan 1000. |
| skip | integer | query | Hayır | Sayfalama için atlanacak günlük sayısı. |
| order | string | query | Hayır | Olay zamanına göre sıralama yönü. Varsayılan DESC (en yeni önce). |
| after | integer | query | Hayır | |
| before | integer | query | Hayır | |
| username | string | query | Hayır | Yalnızca bu kullanıcı adıyla gerçekleştirilen olayları döndür. |
| ip | string | query | Hayır | Yalnızca bu IP adresinden gelen olayları döndür. |
| crudType | string | query | Hayır | Yalnızca bu türdeki olayları döndür: c, r, u, d veya giriş. |
| resourceName | string | query | Hayır | Yalnızca bu kaynak için olayları döndür, ör. Kullanıcı veya Moderatör. |
| targetId | string | query | Hayır | Yalnızca etkilenen nesnenin bu kimliğe sahip olduğu olayları döndür. |
| target | string | query | Hayır | Etkilenen nesnenin etiketinde büyük/küçük harfe duyarsız alt dize eşleşmesi, ör. bir kullanıcı adı veya e-posta. |
| includeManagedTenants | boolean | query | Hayır | Ayrıca bu kiracının yönettiği kiracılardan gelen olayları da döndür. |
Response
Döndürür: GetAuditLogsResponse
Example

logoutPublic 
Yanıt
Döndürür: APIEmptyResponse
Örnek

getBatchJob 
Bir toplu işin durumu, ilerlemesi ve tamamlandığında sonucu.
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Yanıt
Döndürür: GetBatchJobAPIResponse
Örnek

getBatchJobs 
The tenant's batch jobs (imports, exports, page migrations...), newest first.
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| type | string | query | Hayır | Yalnızca bu türdeki işler, örneğin migrate-pages. |
| status | string | query | Hayır | Yalnızca bu durumdaki işler: requested, running, success veya failed. |
| skip | integer | query | Hayır | Sayfalama için atlanacak iş sayısı. |
Yanıt
Döndürür: GetBatchJobsAPIResponse
Örnek

blockFromCommentPublic 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| commentId | string | path | Evet | |
| sso | string | query | Hayır |
Yanıt
Döndürür: BlockSuccess
Örnek

unBlockCommentPublic 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| commentId | string | path | Evet | |
| sso | string | query | Hayır |
Yanıt
Döndürür: UnblockSuccess
Örnek

checkedCommentsForBlocked 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentIds | string | query | Yes | Yorum kimliklerinin virgülle ayrılmış listesi. |
| sso | string | query | No |
Yanıt
Döndürür: CheckBlockedCommentsResponse
Örnek

blockUserFromComment 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet | |
| userId | string | query | Hayır | |
| anonUserId | string | query | Hayır |
Yanıt
Döndürür: BlockSuccess
Örnek

createCommentPublic 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| urlId | string | query | Evet | |
| broadcastId | string | query | Evet | |
| sessionId | string | query | Hayır | |
| sso | string | query | Hayır | |
| locale | string | query | Hayır |
Yanıt
Döndürür: SaveCommentsResponseWithPresence
Örnek

deleteComment 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet | |
| contextUserId | string | query | Hayır | |
| isLive | boolean | query | Hayır |
Yanıt
Döndürür: DeleteCommentResult
Örnek

deleteCommentPublic 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| commentId | string | path | Evet | |
| broadcastId | string | query | Evet | |
| editKey | string | query | Hayır | |
| sso | string | query | Hayır |
Yanıt
Döndürür: PublicAPIDeleteCommentResponse
Örnek

deleteCommentVote 
Parametreler
| Ad | Tür | Location | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| commentId | string | path | Evet | |
| voteId | string | path | Evet | |
| urlId | string | query | Evet | |
| broadcastId | string | query | Evet | |
| editKey | string | query | Hayır | |
| sso | string | query | Hayır |
Yanıt
Döndürür: VoteDeleteResponse
Örnek

flagComment 
Parametreler
| Ad | Tür | Konum | Zorunlu | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet | |
| userId | string | query | Hayır | |
| anonUserId | string | query | Hayır |
Yanıt
Döndürür: FlagCommentResponse
Örnek

getComment 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet |
Yanıt
Döndürür: APIGetCommentResponse
Örnek

getComments 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| page | integer | query | Hayır | |
| limit | integer | query | Hayır | |
| skip | integer | query | Hayır | |
| asTree | boolean | query | Hayır | |
| skipChildren | integer | query | Hayır | |
| limitChildren | integer | query | Hayır | |
| maxTreeDepth | integer | query | Hayır | |
| urlId | string | query | Hayır | |
| userId | string | query | Hayır | |
| anonUserId | string | query | Hayır | |
| contextUserId | string | query | Hayır | |
| hashTag | string | query | Hayır | |
| parentId | string | query | Hayır | |
| direction | string | query | Hayır | |
| fromDate | integer | query | Hayır | |
| toDate | integer | query | Hayır |
Yanıt
Döndürür: APIGetCommentsResponse
Örnek

getCommentsPublic 
req tenantId urlId
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| page | integer | query | No | |
| direction | string | query | No | |
| sso | string | query | No | |
| skip | integer | query | No | |
| skipChildren | integer | query | No | |
| limit | integer | query | No | |
| limitChildren | integer | query | No | |
| countChildren | boolean | query | No | |
| fetchPageForCommentId | string | query | No | |
| includeConfig | boolean | query | No | |
| countAll | boolean | query | No | |
| includei10n | boolean | query | No | |
| locale | string | query | No | |
| modules | string | query | No | |
| isCrawler | boolean | query | No | |
| includeNotificationCount | boolean | query | No | |
| asTree | boolean | query | No | |
| maxTreeDepth | integer | query | No | |
| useFullTranslationIds | boolean | query | No | |
| parentId | string | query | No | |
| searchText | string | query | No | |
| hashTags | array | query | No | |
| userId | string | query | No | |
| customConfigStr | string | query | No | |
| afterCommentId | string | query | No | |
| beforeCommentId | string | query | No | |
| questionId | string | query | No | |
| questionValue | integer | query | No |
Yanıt
Döndürür: GetCommentsResponseWithPresencePublicComment
Örnek

getCommentText 
Parametreler
| Ad | Tip | Konum | Zorunlu | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| commentId | string | path | Evet | |
| editKey | string | query | Hayır | |
| sso | string | query | Hayır |
Yanıt
Döndürür: PublicAPIGetCommentTextResponse
Örnek

getCommentVoteUserNames 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| dir | integer | query | Yes | |
| sso | string | query | No |
Yanıt
Döndürür: GetCommentVoteUserNamesSuccessResponse
Örnek

lockComment 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| commentId | string | path | Evet | |
| broadcastId | string | query | Evet | |
| sso | string | query | Hayır |
Yanıt
Döndürür: APIEmptyResponse
Örnek

pinComment 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| sso | string | query | No |
Yanıt
Döndürür: ChangeCommentPinStatusResponse
Örnek

saveComment 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| isLive | boolean | query | Hayır | |
| doSpamCheck | boolean | query | Hayır | |
| sendEmails | boolean | query | Hayır | |
| populateNotifications | boolean | query | Hayır |
Yanıt
Döndürür: APISaveCommentResponse
Örnek

saveCommentsBulk 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| sendEmails | boolean | query | No | |
| populateNotifications | boolean | query | No |
Yanıt
Döndürür: SaveCommentsBulkResponse
Örnek

setCommentText 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| commentId | string | path | Evet | |
| broadcastId | string | query | Evet | |
| editKey | string | query | Hayır | |
| sso | string | query | Hayır |
Yanıt
Dönen Değer: PublicAPISetCommentTextResponse
Örnek

translateComments 
Verilen yorumları widget yerel diline çevirir. Yalnızca eşleşen widget özelleştirme kuralında Comment Translation (Yorum Çevirisi) Automatic (Otomatik) veya Manual (Manuel) olarak ayarlandığında kullanılabilir.
Parametreler
| Ad | Tür | Konum | Zorunlu | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| urlId | string | query | Evet | |
| sso | string | query | Hayır | |
| locale | string | query | Hayır |
Yanıt
Döndürür: CommentTranslationsResponse
Örnek

unBlockUserFromComment 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet | |
| userId | string | query | Hayır | |
| anonUserId | string | query | Hayır |
Yanıt
Döndürür: UnblockSuccess
Örnek

unFlagComment 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet | |
| userId | string | query | Hayır | |
| anonUserId | string | query | Hayır |
Yanıt
Döndürür: FlagCommentResponse
Örnek

unLockComment 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| sso | string | query | No |
Yanıt
Döndürür: APIEmptyResponse
Örnek

unPinComment 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| commentId | string | path | Evet | |
| broadcastId | string | query | Evet | |
| sso | string | query | Hayır |
Yanıt
Döndürür: ChangeCommentPinStatusResponse
Örnek

updateComment 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet | |
| contextUserId | string | query | Hayır | |
| doSpamCheck | boolean | query | Hayır | |
| isLive | boolean | query | Hayır |
Yanıt
Döndürür: APIEmptyResponse
Örnek

voteComment 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| commentId | string | path | Evet | |
| urlId | string | query | Evet | |
| broadcastId | string | query | Evet | |
| sessionId | string | query | Hayır | |
| sso | string | query | Hayır |
Yanıt
Dönen değer: VoteResponse
Örnek

getCommentsForUser 
Parametreler
| Ad | Tür | Konum | Zorunlu | Açıklama |
|---|---|---|---|---|
| userId | string | query | Hayır | |
| direction | string | query | Hayır | |
| repliesToUserId | string | query | Hayır | |
| page | number | query | Hayır | |
| includei10n | boolean | query | Hayır | |
| locale | string | query | Hayır | |
| isCrawler | boolean | query | Hayır |
Yanıt
Döndürür: GetCommentsForUserResponse
Örnek

addDomainConfig 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet |
Yanıt
Döndürür: AddDomainConfigResponse
Örnek

deleteDomainConfig 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | sorgu | Evet | |
| domain | string | yol | Evet |
Yanıt
Döndürür: DeleteDomainConfigResponse
Örnek

getDomainConfig 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| domain | string | path | Evet |
Yanıt
Döndürür: GetDomainConfigResponse
Örnek

getDomainConfigs 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet |
Yanıt
Döndürür: GetDomainConfigsResponse
Örnek

patchDomainConfig 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| domainToUpdate | string | path | Evet |
Yanıt
Döndürür: PatchDomainConfigResponse
Örnek

putDomainConfig 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| domainToUpdate | string | path | Evet |
Yanıt
Döndürür: PutDomainConfigResponse
Örnek

createEmailTemplate 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet |
Yanıt
Döndürür: CreateEmailTemplateResponse
Örnek

deleteEmailTemplate 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet |
Yanıt
Döndürür: APIEmptyResponse
Örnek

deleteEmailTemplateRenderError 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet | |
| errorId | string | path | Evet |
Yanıt
Döndürür: APIEmptyResponse
Örnek

getEmailTemplate 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet |
Yanıt
Döndürür: GetEmailTemplateResponse
Örnek

getEmailTemplateDefinitions 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet |
Yanıt
Döndürür: GetEmailTemplateDefinitionsResponse
Örnek

getEmailTemplateRenderErrors 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet | |
| skip | number | query | Hayır |
Yanıt
Döndürür: GetEmailTemplateRenderErrorsResponse
Örnek

getEmailTemplates 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| skip | number | query | Hayır |
Yanıt
Döndürür: GetEmailTemplatesResponse
Örnek

renderEmailTemplate 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| locale | string | query | Hayır |
Yanıt
Döndürür: RenderEmailTemplateResponse
Örnek

updateEmailTemplate 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | sorgu | Evet | |
| id | string | yol | Evet |
Yanıt
Döndürür: APIEmptyResponse
Örnek

getEventLog 
req tenantId urlId userIdWS
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| urlId | string | query | Evet | |
| userIdWS | string | query | Evet | |
| startTime | integer | query | Evet | |
| endTime | integer | query | Hayır |
Yanıt
Döndürür: GetEventLogResponse
Örnek

getGlobalEventLog 
req tenantId urlId userIdWS
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| urlId | string | query | Evet | |
| userIdWS | string | query | Evet | |
| startTime | integer | query | Evet | |
| endTime | integer | query | Hayır |
Yanıt
Döndürür: GetEventLogResponse
Örnek

createFeedPost 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| broadcastId | string | query | Hayır | |
| isLive | boolean | query | Hayır | |
| doSpamCheck | boolean | query | Hayır | |
| skipDupCheck | boolean | query | Hayır |
Yanıt
Döndürür: CreateFeedPostsResponse
Örnek

createFeedPostPublic 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | yol | Evet | |
| broadcastId | string | sorgu | Hayır | |
| sso | string | sorgu | Hayır |
Yanıt
Döndürür: CreateFeedPostResponse
Örnek

deleteFeedPostPublic 
Parametreler
| İsim | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| postId | string | path | Evet | |
| broadcastId | string | query | Hayır | |
| sso | string | query | Hayır |
Yanıt
Döndürür: DeleteFeedPostPublicResponse
Örnek

getFeedPosts 
req tenantId afterId
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| afterId | string | query | Hayır | |
| limit | integer | query | Hayır | |
| tags | array | query | Hayır |
Yanıt
Döndürür: GetFeedPostsResponse
Örnek

getFeedPostsPublic 
req tenantId afterId
Parametreler
| Ad | Tür | Konum | Zorunlu | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| afterId | string | query | Hayır | |
| limit | integer | query | Hayır | |
| tags | array | query | Hayır | |
| sso | string | query | Hayır | |
| isCrawler | boolean | query | Hayır | |
| includeUserInfo | boolean | query | Hayır |
Yanıt
Döndürür: PublicFeedPostsResponse
Örnek

getFeedPostsStats 
Parametreler
| Adı | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| postIds | array | query | Evet | |
| sso | string | query | Hayır |
Yanıt
Döndürür: FeedPostsStatsResponse
Örnek

getUserReactsPublic 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| postIds | array | query | Hayır | |
| sso | string | query | Hayır |
Yanıt
Döndürür: UserReactsResponse
Örnek

reactFeedPostPublic 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| postId | string | path | Evet | |
| isUndo | boolean | query | Hayır | |
| broadcastId | string | query | Hayır | |
| sso | string | query | Hayır |
Yanıt
Döndürür: ReactFeedPostResponse
Örnek

updateFeedPost 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Yanıt
Döndürür: APIEmptyResponse
Örnek

updateFeedPostPublic 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| postId | string | path | Evet | |
| broadcastId | string | query | Hayır | |
| sso | string | query | Hayır |
Yanıt
Döndürür: CreateFeedPostResponse
Örnek

flagCommentPublic 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| commentId | string | path | Evet | |
| isFlagged | boolean | query | Evet | |
| sso | string | query | Hayır |
Yanıt
Döndürür: APIEmptyResponse
Örnek

getGifLarge 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| largeInternalURLSanitized | string | query | Evet |
Yanıt
Döndürür: GifGetLargeResponse
Örnek

getGifsSearch 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| search | string | query | Evet | |
| locale | string | query | Hayır | |
| rating | string | query | Hayır | |
| page | number | query | Hayır |
Yanıt
Döndürür: GetGifsSearchResponse
Örnek

getGifsTrending 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| locale | string | query | Hayır | |
| rating | string | query | Hayır | |
| page | number | query | Hayır |
Yanıt
Döndürür: GetGifsTrendingResponse
Örnek

addHashTag 
Parameters
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Response
Döndürür: CreateHashTagResponse
Example

addHashTagsBulk 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet |
Yanıt
Döndürür: BulkCreateHashTagsResponse
Örnek

deleteHashTag 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| tag | string | path | Yes |
Yanıt
Döndürür: APIEmptyResponse
Örnek

getHashTags 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| page | number | query | Hayır |
Yanıt
Döndürür: GetHashTagsResponse
Örnek

patchHashTag 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| tag | string | path | Yes |
Yanıt
Döndürür: UpdateHashTagResponse
Örnek

getMe 
Kullanılan kimlik bilgisini tanımlar: ait olduğu kiracıyı (tenant) ve OAuth token'ları için onu yetkilendiren kullanıcıyı belirtir. Entegrasyonlar bunu bir bağlantıyı test etmek ve etiketlemek için kullanır.
Parametreler
| Ad | Tür | Konum | Zorunlu | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet |
Yanıt
Döndürür: GetMeResponse
Örnek

deleteModerationVote 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| commentId | string | path | Evet | |
| voteId | string | path | Evet | |
| broadcastId | string | query | Hayır | |
| sso | string | query | Hayır |
Yanıt
Döndürür: VoteDeleteResponse
Örnek

getApiComments 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| page | number | query | Hayır | |
| count | number | query | Hayır | |
| text-search | string | query | Hayır | |
| byIPFromComment | string | query | Hayır | |
| filters | string | query | Hayır | |
| searchFilters | string | query | Hayır | |
| sorts | string | query | Hayır | |
| demo | boolean | query | Hayır | |
| sso | string | query | Hayır |
Yanıt
Döndürür: ModerationAPIGetCommentsResponse
Örnek

getApiExportStatus 
Parameters
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| batchJobId | string | query | No | |
| sso | string | query | No |
Response
Döndürür: ModerationExportStatusResponse
Example

getApiIds 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| text-search | string | query | Hayır | |
| byIPFromComment | string | query | Hayır | |
| filters | string | query | Hayır | |
| searchFilters | string | query | Hayır | |
| afterId | string | query | Hayır | |
| demo | boolean | query | Hayır | |
| sso | string | query | Hayır |
Yanıt
Döndürür: ModerationAPIGetCommentIdsResponse
Örnek

getBanUsersFromComment 
Parameters
| İsim | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Response
Döndürür: GetBannedUsersFromCommentResponse
Örnek

getCommentBanStatus 
Parametreler
| İsim | Tip | Konum | Gereklidir | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Yanıt
Döndürür: GetCommentBanStatusResponse
Örnek

getCommentChildren 
Parametreler
| Ad | Tip | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| commentId | string | path | Evet | |
| sso | string | query | Hayır |
Yanıt
Döner: ModerationAPIChildCommentsResponse
Örnek

getCount 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filter | string | query | No | |
| searchFilters | string | query | No | |
| demo | boolean | query | No | |
| sso | string | query | No |
Yanıt
Döndürür: ModerationAPICountCommentsResponse
Örnek

getCounts 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Yanıt
Döndürür: GetBannedUsersCountResponse
Örnek

getLogs 
Parameters
| İsim | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| commentId | string | path | Evet | |
| sso | string | query | Hayır |
Response
Döndürür: ModerationAPIGetLogsResponse
Example

getManualBadges 
Parametreler
| İsim | Tür | Konum | Gereklidir | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| sso | string | query | Hayır |
Yanıt
Döndürür: GetTenantManualBadgesResponse
Örnek

getManualBadgesForUser 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| badgesUserId | string | query | Hayır | |
| commentId | string | query | Hayır | |
| sso | string | query | Hayır |
Yanıt
Döndürür: GetUserManualBadgesResponse
Örnek

getModerationComment 
Parametreler
| Ad | Tür | Konum | Zorunlu | Açıklama |
|---|---|---|---|---|
| tenantId | string | sorgu | Evet | |
| commentId | string | yol | Evet | |
| includeEmail | boolean | sorgu | Hayır | |
| includeIP | boolean | sorgu | Hayır | |
| sso | string | sorgu | Hayır |
Yanıt
Döndürür: ModerationAPICommentResponse
Örnek

getModerationCommentText 
Parameters
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Response
Döndürür: GetCommentTextResponse
Example

getPreBanSummary 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| includeByUserIdAndEmail | boolean | query | No | |
| includeByIP | boolean | query | No | |
| includeByEmailDomain | boolean | query | No | |
| sso | string | query | No |
Yanıt
Returns: PreBanSummary
Örnek

getSearchCommentsSummary 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| value | string | query | Hayır | |
| filters | string | query | Hayır | |
| searchFilters | string | query | Hayır | |
| sso | string | query | Hayır |
Yanıt
Döndürür: ModerationCommentSearchResponse
Örnek

getSearchPages 
Parameters
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| value | string | query | Hayır | |
| sso | string | query | Hayır |
Response
Döndürür: ModerationPageSearchResponse
Example

getSearchSites 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| sso | string | query | No |
Yanıt
Döndürür: ModerationSiteSearchResponse
Örnek

getSearchSuggest 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| text-search | string | query | Hayır | |
| sso | string | query | Hayır |
Yanıt
Döndürür: ModerationSuggestResponse
Örnek

getSearchUsers 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| sso | string | query | No |
Yanıt
Döndürür: ModerationUserSearchResponse
Örnek

getTrustFactor 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| sso | string | query | No |
Yanıt
Döndürür: GetUserTrustFactorResponse
Örnek

getUserBanPreference 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| sso | string | query | Hayır |
Yanıt
Döndürür: APIModerateGetUserBanPreferencesResponse
Örnek

getUserInternalProfile 
Parameters
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| commentId | string | query | Hayır | |
| sso | string | query | Hayır |
Response
Döndürür: GetUserInternalProfileResponse
Example

postAdjustCommentVotes 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| commentId | string | path | Evet | |
| broadcastId | string | query | Hayır | |
| sso | string | query | Hayır |
Response
Returns: AdjustVotesResponse
Example

postApiExport 
Parameters
| İsim | Tip | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sorts | string | query | No | |
| sso | string | query | No |
Response
Döndürür: ModerationExportResponse
Example

postBanUserFromComment 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| commentId | string | path | Evet | |
| banEmail | boolean | query | Hayır | |
| banEmailDomain | boolean | query | Hayır | |
| banIP | boolean | query | Hayır | |
| deleteAllUsersComments | boolean | query | Hayır | |
| bannedUntil | string | query | Hayır | |
| isShadowBan | boolean | query | Hayır | |
| updateId | string | query | Hayır | |
| banReason | string | query | Hayır | |
| sso | string | query | Hayır |
Yanıt
Döndürür: BanUserFromCommentResult
Örnek

postBanUserUndo 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| sso | string | query | Hayır |
Yanıt
Döndürür: APIEmptyResponse
Örnek

postBulkPreBanSummary 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| includeByUserIdAndEmail | boolean | query | No | |
| includeByIP | boolean | query | No | |
| includeByEmailDomain | boolean | query | No | |
| sso | string | query | No |
Yanıt
Döndürür: BulkPreBanSummary
Örnek

postCommentsByIds 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| sso | string | query | Hayır |
Yanıt
Döndürür: ModerationAPIChildCommentsResponse
Örnek

postFlagComment 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Yanıt
Döndürür: APIEmptyResponse
Örnek

postRemoveComment 
Parametreler
| İsim | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| commentId | string | path | Evet | |
| broadcastId | string | query | Hayır | |
| sso | string | query | Hayır |
Yanıt
Döndürür: PostRemoveCommentApiResponse
Örnek

postRestoreDeletedComment 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Yanıt
Returns: APIEmptyResponse
Örnek

postSetCommentApprovalStatus 
Parameters
| İsim | Tip | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| commentId | string | path | Evet | |
| approved | boolean | query | Hayır | |
| broadcastId | string | query | Hayır | |
| sso | string | query | Hayır |
Response
Döndürür: SetCommentApprovedResponse
Örnek

postSetCommentReviewStatus 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| commentId | string | path | Evet | |
| reviewed | boolean | query | Hayır | |
| broadcastId | string | query | Hayır | |
| sso | string | query | Hayır |
Yanıt
Returns: APIEmptyResponse
Örnek

postSetCommentSpamStatus 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | sorgu | Evet | |
| commentId | string | yol | Evet | |
| spam | boolean | sorgu | Hayır | |
| permNotSpam | boolean | sorgu | Hayır | |
| broadcastId | string | sorgu | Hayır | |
| sso | string | sorgu | Hayır |
Yanıt
Döndürür: APIEmptyResponse
Örnek

postSetCommentText 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Yanıt
Döndürür: SetCommentTextResponse
Örnek

postUnFlagComment 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| commentId | string | path | Evet | |
| broadcastId | string | query | Hayır | |
| sso | string | query | Hayır |
Yanıt
Döndürür: APIEmptyResponse
Örnek

postVote 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| direction | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Yanıt
Döner: VoteResponse
Örnek

putAwardBadge 
Parametreler
| Ad | Tür | Yer | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgeId | string | query | Yes | |
| userId | string | query | No | |
| commentId | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Yanıt
Döndürür: AwardUserBadgeResponse
Örnek

putCloseThread 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| urlId | string | query | Evet | |
| sso | string | query | Hayır |
Yanıt
Döndürür: APIEmptyResponse
Örnek

putRemoveBadge 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| badgeId | string | query | Evet | |
| userId | string | query | Hayır | |
| commentId | string | query | Hayır | |
| broadcastId | string | query | Hayır | |
| sso | string | query | Hayır |
Yanıt
Döndürür: RemoveUserBadgeResponse
Örnek

putReopenThread 
Parametreler
| Ad | Tür | Yer | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| sso | string | query | No |
Yanıt
Döndürür: APIEmptyResponse
Örnek

setTrustFactor 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| trustFactor | string | query | No | |
| sso | string | query | No |
Yanıt
Döndürür: SetUserTrustFactorResponse
Örnek

createModerator 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Yanıt
Döndürür: CreateModeratorResponse
Örnek

deleteModerator 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet | |
| sendEmail | string | query | Hayır |
Yanıt
Döndürür: APIEmptyResponse
Örnek

getModerator 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet |
Yanıt
Döndürür: GetModeratorResponse
Örnek

getModerators 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| skip | number | query | Hayır |
Yanıt
Döndürür: GetModeratorsResponse
Örnek

sendInvite 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet | |
| fromName | string | query | Evet |
Yanıt
Döndürür: APIEmptyResponse
Örnek

updateModerator 
Parametreler
| Ad | Tür | Konum | Zorunlu | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet |
Yanıt
Döndürür: APIEmptyResponse
Örnek

deleteNotificationCount 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet |
Yanıt
Döndürür: APIEmptyResponse
Örnek

getCachedNotificationCount 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet |
Yanıt
Döndürür: GetCachedNotificationCountResponse
Örnek

getNotificationCount 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| userId | string | query | Hayır | |
| urlId | string | query | Hayır | |
| fromCommentId | string | query | Hayır | |
| viewed | boolean | query | Hayır | |
| type | string | query | Hayır |
Yanıt
Dönen değer: GetNotificationCountResponse
Örnek

getNotifications 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| userId | string | query | Hayır | |
| urlId | string | query | Hayır | |
| fromCommentId | string | query | Hayır | |
| viewed | boolean | query | Hayır | |
| type | string | query | Hayır | |
| skip | number | query | Hayır |
Yanıt
Döndürür: GetNotificationsResponse
Örnek

updateNotification 
Parameters
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet | |
| userId | string | query | Hayır |
Yanıt
Döndürür: APIEmptyResponse
Örnek

createV1PageReact 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| urlId | string | query | Evet | |
| title | string | query | Hayır | |
| sso | string | query | Hayır |
Yanıt
Döndürür: CreateV1PageReact
Örnek

createV2PageReact 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| id | string | query | Yes | |
| title | string | query | No | |
| sso | string | query | No |
Yanıt
Döndürür: CreateV1PageReact
Örnek

deleteV1PageReact 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| urlId | string | query | Evet | |
| sso | string | query | Hayır |
Yanıt
Döndürür: CreateV1PageReact
Örnek

deleteV2PageReact 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| urlId | string | query | Evet | |
| id | string | query | Evet | |
| sso | string | query | Hayır |
Yanıt
Döndürür: CreateV1PageReact
Örnek

getV1PageLikes 
Parameters
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| urlId | string | query | Evet | |
| sso | string | query | Hayır | |
| includeUserInfo | string | query | Hayır | Ayarlandığında, sayfayı beğenen kullanıcıları (avatarlar ve kullanıcı adları) döndürür. Yalnızca "public" kabul edilir, bu da özel profilleri dışlar. |
Response
Döndürür: GetV1PageLikes
Example

getV2PageReacts 
Parametreler
| Ad | Tip | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| urlId | string | query | Evet | |
| sso | string | query | Hayır | |
| includeUserInfo | string | query | Hayır | Ayarlanırsa, her reaksiyon kimliği için kullanıcıları (avatarlar ve kullanıcı adları) döndürür. Yalnızca "public" kabul edilir ve bu, özel profilleri dışlar. |
Yanıt
Döndürür: GetV2PageReacts
Örnek

getV2PageReactUsers 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| urlId | string | query | Evet | |
| id | string | query | Evet | |
| sso | string | query | Hayır |
Yanıt
Döndürür: GetV2PageReactUsersResponse
Örnek

addPage 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet |
Yanıt
Döndürür: AddPageAPIResponse
Örnek

deletePage 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet |
Yanıt
Döndürür: DeletePageAPIResponse
Örnek

getOfflineUsers 
Sayfadaki, şu anda çevrimiçi olmayan önceki yorumcular. displayName'e göre sıralanır. Bu, bir "Üyeler" bölümü oluşturmak için /users/online tükendiğinde kullanın. commenterName üzerinde imleçli sayfalama: sunucu, kısmi {tenantId, urlId, commenterName} indeksinde afterName'den başlayarak $gt ile ileri doğru tarar, $skip maliyeti yok.
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | Sayfa URL tanımlayıcısı (sunucu tarafında temizlenir). |
| afterName | string | query | No | İmleç: önceki yanıttan nextAfterName değerini gönderin. |
| afterUserId | string | query | No | İmleç eşitlik kırıcı: önceki yanıttan nextAfterUserId değerini gönderin. afterName ayarlandığında, aynı ada sahip girişlerin düşmemesi için gereklidir. |
Yanıt
Döndürür: PageUsersOfflineResponse
Örnek

getOnlineUsers 
Bir sayfanın şu anda çevrimiçi izleyicileri: websocket oturumu şu anda sayfaya abone olan kişiler. anonCount + totalCount döndürür (oda genelindeki aboneler; anonim izleyicileri dahil eder, ancak onları listelemiyoruz).
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | Sayfa URL tanımlayıcısı (sunucu tarafında temizlenir). |
| afterName | string | query | No | İmleç: önceki yanıttan nextAfterName değerini iletin. |
| afterUserId | string | query | No | İmleç eşitlik kırıcı: önceki yanıttan nextAfterUserId değerini iletin. afterName ayarlandığında, isim bağları nedeniyle girişlerin düşmemesi için gereklidir. |
Response
Döndürür: PageUsersOnlineResponse
Örnek

getPageByURLId 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes |
Yanıt
Döndürür: GetPageByURLIdAPIResponse
Örnek

getPageLikes 
Bir sayfa için beğeni sayısı, isteğe bağlı olarak beğenen kullanıcılarla birlikte.
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| urlId | string | query | Evet | |
| includeUserInfo | string | query | Hayır | "public" özel profillere sahip kullanıcıları hariç tutar, "include-private" onları dahil eder. |
Yanıt
Döndürür: GetPageLikesAPIResponse
Örnek

getPageReacts 
Bir sayfa için özel reaksiyon sayıları, isteğe bağlı olarak reaksiyon veren kullanıcılarla birlikte.
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| urlId | string | query | Evet | |
| includeUserInfo | string | query | Hayır | "public" özel profillere sahip kullanıcıları hariç tutar, "include-private" onları dahil eder. |
Yanıt
Döndürür: GetPageReactsAPIResponse
Örnek

getPages 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet |
Yanıt
Döndürür: GetPagesAPIResponse
Örnek

getPagesPublic 
Bir kiracı için sayfaları listeler. FChat masaüstü istemcisi tarafından oda listesini doldurmak için kullanılır.
Her sayfa için çözümlenen özel yapılandırmada enableFChat'in true olmasını gerektirir.
SSO gerektiren sayfalar, istekte bulunan kullanıcının grup erişimine göre filtrelenir.
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| cursor | string | query | No | Önceki bir istekte nextCursor olarak döndürülen opak sayfalama imleci. Aynı sortBy ile ilişkilidir. |
| limit | integer | query | No | 1..200, varsayılan 50 |
| q | string | query | No | İsteğe bağlı, büyük/küçük harf duyarsız başlık öneki filtresi. |
| sortBy | string | query | No | Sıralama düzeni. updatedAt (varsayılan, en yeniler önce), commentCount (en çok yorum önce), veya title (alfabetik). |
| hasComments | boolean | query | No | Eğer true ise, yalnızca en az bir yorumu olan sayfaları döndürür. |
Yanıt
Döndürür: GetPublicPagesResponse
Örnek

getUsersInfo 
Bir kiracı için toplu kullanıcı bilgisi. Given userIds, return display info from User / SSOUser. Yorum bileşeni tarafından, bir presence etkinliği yoluyla yeni görünen kullanıcıları zenginleştirmek için kullanılır. Sayfa bağlamı yok: gizlilik tutarlı şekilde uygulanır (özel profiller maskelenir).
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| ids | string | query | Evet | Virgülle ayrılmış userIds. |
Yanıt
Döndürür: PageUsersInfoResponse
Örnek

migratePages 
Bir urlId veya domain'den diğerine yorumları, sayfaları ve ilgili kayıtları taşıyan bir toplu iş (batch job) kuyruğa alır. "urlId" migrasyonları yalnızca tam urlId ile eşleşir. "domain" migrasyonları her urlId ve url içindeki değeri bulur/değiştirir. GET /api/v1/batch-jobs/{batchJobId} uç noktasını polling yapın: tamamlandığında migrasyon başına sonuçlar ve bir undoId içerir.
Parametreler
| Ad | Tür | Konum | Zorunlu | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet |
Yanıt
Döndürür: QueuePageMigrationJobAPIResponse
Örnek

patchPage 
Parametreler
| Ad | Tür | Konum | Zorunlu | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet |
Yanıt
Döndürür: PatchPageAPIResponse
Örnek

undoPageMigrations 
Tek bir migrate-pages işinin tüm geçişlerini, en yeniden başlayarak tersine çeviren bir toplu iş kuyruğa alır. 90 gün boyunca kullanılabilir. Geçişten sonra değişen kayıtlara dokunulmaz, böylece sonraki bir düzenleme asla üzerine yazılmaz. Geri yüklenen/atlanan sayıları için GET /api/v1/batch-jobs/{batchJobId} uç noktasını yoklayın.
Parametreler
| Ad | Tür | Konum | Zorunlu | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| undoId | string | path | Evet |
Yanıt
Döndürür: QueuePageMigrationJobAPIResponse
Örnek

deletePendingWebhookEvent 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet |
Yanıt
Döndürür: APIEmptyResponse
Örnek

getPendingWebhookEventCount 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| commentId | string | query | Hayır | |
| externalId | string | query | Hayır | |
| eventType | string | query | Hayır | |
| type | string | query | Hayır | |
| domain | string | query | Hayır | |
| attemptCountGT | number | query | Hayır |
Yanıt
Döndürür: GetPendingWebhookEventCountResponse
Örnek

getPendingWebhookEvents 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| commentId | string | query | Hayır | |
| externalId | string | query | Hayır | |
| eventType | string | query | Hayır | |
| type | string | query | Hayır | |
| domain | string | query | Hayır | |
| attemptCountGT | number | query | Hayır | |
| skip | number | query | Hayır |
Yanıt
Döndürür: GetPendingWebhookEventsResponse
Örnek

createPollVote 
Record a vote on a poll, or move an existing one to a different option. A voter has at most one vote per poll, so calling this again for the same voter moves their vote rather than adding one.
Bu, sitenin anket ayarlarına uyar: oy verme yalnızca oturum açmış kullanıcılarla sınırlıysa, sadece anonUserId içeren bir oy kabul edilmez ve anonim oylar IP başına anket başına oran sınırlamasına tabidir.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Response
Returns: CreatePollVoteResponse
Example

deletePollVote 
Bir oyu geri çek. Oylamanın yapıldığı seçenek sayısını geri verir.
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Yanıt
Döndürür: DeletePollVoteResponse
Örnek

getPollVote 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet |
Yanıt
Döndürür: GetPollVoteResponse
Örnek

getPollVotes 
The individual votes behind one poll's tallies, oldest first.
Bir anket bir yoruma aittir, bu yüzden oylar her zaman bir anket başına okunur - commentId gereklidir. Bu, her sorgunun zaten koleksiyonun sahip olduğu indekslerde kalmasını sağlar.
Obeys the poll's privacy: an anonymous poll's votes cannot be read (poll-anonymous), here or by id.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| commentId | string | query | Evet | |
| voterId | string | query | Hayır | |
| optionId | string | query | Hayır | |
| skip | integer | query | Hayır |
Yanıt
Döndürür: GetPollVotesResponse
Örnek

deletePoll 
Bir anketi, üzerinde verilmiş tüm oylarla birlikte yorumundan kaldırır. Yorumun kendisine dokunulmaz.
Parametreler
| Ad | Tür | Konum | Zorunlu | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| commentId | string | path | Evet |
Yanıt
Döndürür: APIEmptyResponse
Örnek

getPoll 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| commentId | string | path | Evet |
Yanıt
Döndürür: GetPollResponse
Örnek

getPollVoters 
Who voted for which option. Anonymous polls never answer, admins-only polls answer only for an admin or moderator.
Parameters
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| urlId | string | query | No | |
| page | integer | query | No | |
| search | string | query | No | |
| sso | string | query | No |
Response
Döndürür: GetPollVoterNamesSuccessResponse
Example

patchPoll 
Edit a poll in place, keeping its tallies: change the question, relabel an option, close or reopen it, or change who may see the voters. Options are addressed by id - to add, remove or reorder them, PUT the full list.
Parameters
| Ad | Tip | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| commentId | string | path | Evet |
Response
Returns: SavePollResponse
Example

putPoll 
Bir ankete yorum ekleyin veya yorumun zaten sahip olduğu anketin tam durumunu ayarlayın.
Seçenekler id ile eşleştirilir: mevcut bir seçeneğin id'si ile gönderilen seçenek oylarını korur (yeni etiketi ve konumu alır), id olmadan gönderilen seçenek eklenir ve listede yer almayan mevcut seçenekler üzerindeki oylarla birlikte kaldırılır.
Oyu olan bir ankette mevcut hiçbir seçenek id'sinin tutulmaması tüm oyları siler, bu nedenle replaceVotes=true olması gerekir.
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| replaceVotes | boolean | query | No |
Yanıt
Döndürür: SavePollResponse
Örnek

votePoll 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| commentId | string | path | Evet | |
| urlId | string | query | Hayır | |
| broadcastId | string | query | Hayır | |
| sso | string | query | Hayır |
Yanıt
Döndürür: VotePollResponse
Örnek

createQuestionConfig 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet |
Yanıt
Döndürür: CreateQuestionConfigResponse
Örnek

deleteQuestionConfig 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet |
Yanıt
Döndürür: APIEmptyResponse
Örnek

getQuestionConfig 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet |
Yanıt
Döndürür: GetQuestionConfigResponse
Örnek

getQuestionConfigs 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| skip | number | query | Hayır |
Yanıt
Döndürür: GetQuestionConfigsResponse
Örnek

updateQuestionConfig 
Parametreler
| Ad | Tür | Konum | Zorunlu | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet |
Yanıt
Döndürür: APIEmptyResponse
Örnek

createQuestionResult 
Parametreler
| Ad | Tür | Konum | Zorunlu | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet |
Yanıt
Döndürür: CreateQuestionResultResponse
Örnek

deleteQuestionResult 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet |
Yanıt
Döndürür: APIEmptyResponse
Örnek

getQuestionResult 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | sorgu | Evet | |
| id | string | yol | Evet |
Yanıt
Döndürür: GetQuestionResultResponse
Örnek

getQuestionResults 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| urlId | string | query | Hayır | |
| userId | string | query | Hayır | |
| startDate | string | query | Hayır | |
| questionId | string | query | Hayır | |
| questionIds | string | query | Hayır | |
| skip | number | query | Hayır |
Yanıt
Döndürür: GetQuestionResultsResponse
Örnek

updateQuestionResult 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet |
Yanıt
Döndürür: APIEmptyResponse
Örnek

aggregateQuestionResults 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| questionId | string | query | Hayır | |
| questionIds | array | query | Hayır | |
| urlId | string | query | Hayır | |
| timeBucket | string | query | Hayır | |
| startDate | string | query | Hayır | |
| forceRecalculate | boolean | query | Hayır |
Yanıt
Döndürür: AggregateQuestionResultsResponse
Örnek

bulkAggregateQuestionResults 
Parametreler
| Ad | Tip | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| forceRecalculate | boolean | query | Hayır |
Yanıt
Döndürür: BulkAggregateQuestionResultsResponse
Örnek

combineCommentsWithQuestionResults 
Parametreler
| Ad | Type | Location | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| questionId | string | query | Hayır | |
| questionIds | array | query | Hayır | |
| urlId | string | query | Hayır | |
| startDate | string | query | Hayır | |
| forceRecalculate | boolean | query | Hayır | |
| minValue | number | query | Hayır | |
| maxValue | number | query | Hayır | |
| limit | number | query | Hayır |
Yanıt
Döndürür: CombineQuestionResultsWithCommentsResponse
Örnek

addSSOUser 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet |
Yanıt
Dönen değer: AddSSOUserAPIResponse
Örnek

deleteSSOUser 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| deleteComments | boolean | query | No | |
| commentDeleteMode | string | query | No |
Yanıt
Döndürür: DeleteSSOUserAPIResponse
Örnek

getSSOUserByEmail 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| string | path | Evet |
Yanıt
Döndürür: GetSSOUserByEmailAPIResponse
Örnek

getSSOUserById 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet |
Yanıt
Döndürür: GetSSOUserByIdAPIResponse
Örnek

getSSOUsers 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| skip | integer | query | Hayır |
Yanıt
Döndürür: GetSSOUsersResponse
Örnek

patchSSOUser 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet | |
| updateComments | boolean | query | Hayır |
Response
Döndürür: PatchSSOUserAPIResponse
Örnek

putSSOUser 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet | |
| updateComments | boolean | query | Hayır |
Yanıt
Döndürür: PutSSOUserAPIResponse
Örnek

createSubscription 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet |
Yanıt
Döndürür: CreateSubscriptionAPIResponse
Örnek

deleteSubscription 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet | |
| userId | string | query | Hayır |
Yanıt
Döndürür: DeleteSubscriptionAPIResponse
Örnek

getSubscriptions 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| userId | string | query | Hayır |
Yanıt
Döndürür: GetSubscriptionsAPIResponse
Örnek

updateSubscription 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet | |
| userId | string | query | Hayır |
Yanıt
Döndürür: UpdateSubscriptionAPIResponse
Örnek

getTenantDailyUsages 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| yearNumber | number | query | Hayır | |
| monthNumber | number | query | Hayır | |
| dayNumber | number | query | Hayır | |
| skip | number | query | Hayır |
Yanıt
Döndürür: GetTenantDailyUsagesResponse
Örnek

createTenantPackage 
Parametreler
| Ad | Tür | Konum | Zorunlu | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet |
Yanıt
Döndürür: CreateTenantPackageResponse
Örnek

deleteTenantPackage 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet |
Yanıt
Dönüş: APIEmptyResponse
Örnek

getTenantPackage 
Parametreler
| Ad | Tür | Location | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet |
Yanıt
Döndürür: GetTenantPackageResponse
Örnek

getTenantPackages 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| skip | number | query | Hayır |
Yanıt
Döndürür: GetTenantPackagesResponse
Örnek

replaceTenantPackage 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet |
Yanıt
Döndürür: APIEmptyResponse
Örnek

updateTenantPackage 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet |
Yanıt
Döndürür: APIEmptyResponse
Örnek

createTenantUser 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet |
Yanıt
Döndürür: CreateTenantUserResponse
Örnek

deleteTenantUser 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet | |
| deleteComments | string | query | Hayır | |
| commentDeleteMode | string | query | Hayır |
Yanıt
Döndürür: APIEmptyResponse
Örnek

getTenantUser 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet |
Yanıt
Döndürür: GetTenantUserResponse
Örnek

getTenantUsers 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| skip | number | query | Hayır |
Yanıt
Döndürür: GetTenantUsersResponse
Örnek

replaceTenantUser 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet | |
| updateComments | string | query | Hayır |
Yanıt
Döndürür: APIEmptyResponse
Örnek

sendLoginLink 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet | |
| redirectURL | string | query | Hayır |
Yanıt
Döndürür: APIEmptyResponse
Örnek

updateTenantUser 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet | |
| updateComments | string | query | Hayır |
Yanıt
Döndürür: APIEmptyResponse
Örnek

createTenant 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | sorgu | Evet |
Yanıt
Döndürür: CreateTenantResponse
Örnek

deleteTenant 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet | |
| sure | string | query | Hayır |
Yanıt
Döndürür: APIEmptyResponse
Örnek

getTenant 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Yanıt
Döndürür: GetTenantResponse
Örnek

getTenants 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| meta | string | query | Hayır | |
| skip | number | query | Hayır |
Yanıt
Döndürür: GetTenantsResponse
Örnek

updateTenant 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet |
Yanıt
Dönüş değeri: APIEmptyResponse
Örnek

changeTicketState 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| userId | string | query | Evet | |
| id | string | path | Evet |
Yanıt
Döndürür: ChangeTicketStateResponse
Örnek

createTicket 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| userId | string | query | Evet |
Yanıt
Döndürür: CreateTicketResponse
Örnek

getTicket 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet | |
| userId | string | query | Hayır |
Yanıt
Döndürür: GetTicketResponse
Örnek

getTickets 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| userId | string | query | Hayır | |
| state | number | query | Hayır | |
| skip | number | query | Hayır | |
| limit | number | query | Hayır |
Yanıt
Dönüş: GetTicketsResponse
Örnek

getTranslations 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| namespace | string | path | Yes | |
| component | string | path | Yes | |
| locale | string | query | No | |
| useFullTranslationIds | boolean | query | No |
Yanıt
Dönüş değeri: GetTranslationsResponse
Örnek

uploadImage 
Bir resmi yükleyin ve yeniden boyutlandırın
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| sizePreset | string | query | No | Boyut ön ayarı: "Default" (1000x1000px) veya "CrossPlatform" (popüler cihazlar için boyutlar oluşturur) |
| urlId | string | query | No | Yüklemenin gerçekleştiği sayfanın id'si; yapılandırma için kullanılır |
Yanıt
Döndürür: UploadImageResponse
Örnek

getUserBadgeProgressById 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | sorgu | Evet | |
| id | string | yol | Evet |
Yanıt
Döndürür: APIGetUserBadgeProgressResponse
Örnek

getUserBadgeProgressByUserId 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| userId | string | path | Evet |
Yanıt
Döndürür: APIGetUserBadgeProgressResponse
Örnek

getUserBadgeProgressList 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| userId | string | query | Hayır | |
| limit | number | query | Hayır | |
| skip | number | query | Hayır |
Yanıt
Döndürür: APIGetUserBadgeProgressListResponse
Örnek

createUserBadge 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet |
Yanıt
Döndürür: APICreateUserBadgeResponse
Örnek

deleteUserBadge 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet |
Yanıt
Döndürür: APIEmptySuccessResponse
Örnek

getUserBadge 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet |
Yanıt
Döndürür: APIGetUserBadgeResponse
Örnek

getUserBadges 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| userId | string | query | Hayır | |
| badgeId | string | query | Hayır | |
| type | number | query | Hayır | |
| displayedOnComments | boolean | query | Hayır | |
| limit | number | query | Hayır | |
| skip | number | query | Hayır |
Yanıt
Döndürür: APIGetUserBadgesResponse
Örnek

updateUserBadge 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet |
Yanıt
Döndürür: APIEmptySuccessResponse
Örnek

getUserNotificationCount 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | sorgu | Evet | |
| sso | string | sorgu | Hayır |
Yanıt
Döndürür: GetUserNotificationCountResponse
Örnek

getUserNotifications 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | No | Geçerli sayfanın abone olup olmadığını belirlemek için kullanılır. |
| pageSize | integer | query | No | |
| afterId | string | query | No | |
| includeContext | boolean | query | No | |
| afterCreatedAt | integer | query | No | |
| unreadOnly | boolean | query | No | |
| dmOnly | boolean | query | No | |
| noDm | boolean | query | No | |
| includeTranslations | boolean | query | No | |
| includeTenantNotifications | boolean | query | No | |
| sso | string | query | No |
Yanıt
Döndürür: GetMyNotificationsResponse
Örnek

resetUserNotificationCount 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| sso | string | query | Hayır |
Yanıt
Döndürür: ResetUserNotificationsResponse
Örnek

resetUserNotifications 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| afterId | string | query | Hayır | |
| afterCreatedAt | integer | query | Hayır | |
| unreadOnly | boolean | query | Hayır | |
| dmOnly | boolean | query | Hayır | |
| noDm | boolean | query | Hayır | |
| sso | string | query | Hayır |
Yanıt
Dönüş: ResetUserNotificationsResponse
Örnek

updateUserNotificationCommentSubscriptionStatus 
Belirli bir yorum için bildirimleri etkinleştirin veya devre dışı bırakın.
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| notificationId | string | path | Evet | |
| optedInOrOut | string | path | Evet | |
| commentId | string | query | Evet | |
| sso | string | query | Hayır |
Yanıt
Döndürür: UpdateUserNotificationCommentSubscriptionStatusResponse
Örnek

updateUserNotificationPageSubscriptionStatus 
Sayfa için bildirimleri etkinleştirin veya devre dışı bırakın. Kullanıcılar bir sayfaya abone olduğunda, yeni kök yorumlar için bildirimler oluşturulur ve ayrıca
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| url | string | query | Yes | |
| pageTitle | string | query | Yes | |
| subscribedOrUnsubscribed | string | path | Yes | |
| sso | string | query | No |
Yanıt
Döndürür: UpdateUserNotificationPageSubscriptionStatusResponse
Örnek

updateUserNotificationStatus 
Parametreler
| Ad | Tür | Konum | Zorunlu | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| notificationId | string | path | Evet | |
| newStatus | string | path | Evet | |
| sso | string | query | Hayır |
Yanıt
Döndürür: UpdateUserNotificationStatusResponse
Örnek

getUserPresenceStatuses 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| urlIdWS | string | query | Evet | |
| userIds | string | query | Evet |
Yanıt
Döndürür: GetUserPresenceStatusesResponse
Örnek

searchUsers 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| urlId | string | query | Evet | |
| usernameStartsWith | string | query | Hayır | |
| mentionGroupIds | array | query | Hayır | |
| sso | string | query | Hayır | |
| searchSection | string | query | Hayır |
Yanıt
Döndürür: SearchUsersResult
Örnek

getUser 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet |
Yanıt
Döndürür: GetUserResponse
Örnek

createVote 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| commentId | string | query | Evet | |
| direction | string | query | Evet | |
| userId | string | query | Hayır | |
| anonUserId | string | query | Hayır |
Yanıt
Döndürür: VoteResponse
Örnek

deleteVote 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | sorgu | Evet | |
| id | string | yol | Evet | |
| editKey | string | sorgu | Hayır |
Yanıt
Döndürür: VoteDeleteResponse
Örnek

getVotes 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| urlId | string | query | Evet |
Yanıt
Döndürür: GetVotesResponse
Örnek

getVotesForUser 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| urlId | string | query | Evet | |
| userId | string | query | Hayır | |
| anonUserId | string | query | Hayır |
Yanıt
Döndürür: GetVotesForUserResponse
Örnek

createWebhook 
Bir URL'yi bir yorum olayına abone eder (REST hook subscribe). Aynı URL'yi aynı olay ve alan adına tekrar abone etmek mevcut aboneliği döndürür. Teslimatlar HMAC ile imzalanır, webhooks kılavuzuna bakın; eski token başlığı API aboneliklerine asla gönderilmez.
Parametreler
| Ad | Tür | Konum | Zorunlu | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet |
Yanıt
Döndürür: CreateWebhookResponse
Örnek

deleteWebhook 
Unsubscribes (REST hook unsubscribe). Only subscriptions created through this API can be deleted here; dashboard-managed webhooks are edited in the dashboard.
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet |
Yanıt
Döndürür: APIEmptyResponse
Örnek

getWebhooks 
Kiracı için yapılandırılmış webhook'ları listeler, hem kontrol paneli yönetimli satırları hem de API aboneliklerini.
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| event | string | query | No | |
| domain | string | query | No | |
| source | string | query | No | |
| skip | number | query | No |
Yanıt
Döndürür: GetWebhooksResponse
Örnek

getWebhookSamplePayloads 
Recent comments in exactly the shape webhook deliveries use, for building integrations (for example Zapier sample data). Every event delivers the same comment object, so event only has to be valid.
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| event | string | query | No | |
| limit | number | query | No |
Yanıt
Döndürür: GetWebhookSamplePayloadsResponse
Örnek

Yardıma mı ihtiyacınız var?
Java SDK ile ilgili herhangi bir sorunla karşılaşırsanız veya sorularınız olursa lütfen:
Katkıda Bulunma
Katkılar memnuniyetle karşılanır! Katkı yönergeleri için lütfen GitHub deposunu ziyaret edin.