
Dil 🇹🇷 Türkçe
Dokümantasyon
Başlarken
API Referansı
Kullanım
Toplama
Denetim Günlükleri
Kimlik Doğrulama
Yorumdan Engelleme
Engellenmiş Yorumları Kontrol Et
Yorumlar
Kullanıcı İçin Yorumlar
Alan Adı Yapılandırmaları
E-posta Şablonları
Etkinlik Günlüğü
Akış Gönderileri
Yorumu İşaretle
GIF'ler
Hashtag'ler
Moderasyon
Moderatörler
Bildirim Sayısı
Bildirimler
Sayfa Tepkileri
Sayfalar
Bekleyen Webhook Olayları
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ı Rozet İlerlemesi
Kullanıcı Rozetleri
Kullanıcı Bildirimleri
Kullanıcı Çevrimiçi Durumları
Kullanıcı Arama
Kullanıcılar
Oylar
FastComments Nim SDK
Bu, FastComments için resmi Nim SDK'sıdır.
FastComments API'si için resmi Nim SDK
Depo
Kurulum 
Nimble Kullanımı
nimble install fastcomments
Kaynağından Derleme
nimble build
Kütüphane İçeriği
Bu kütüphane, API ile çalışmayı kolaylaştıran oluşturulmuş API istemcisini ve SSO yardımcı programlarını içerir.
Genel ve Güvenli API'ler
API istemcisi için üç API modülü vardır: api_default, api_public ve api_moderation. api_default, API anahtarınızı gerektiren metodları içerirken, api_public kimlik doğrulama gerektirmeden doğrudan bir tarayıcı/mobil cihaz vb. üzerinden yapılabilen API çağrılarını içerir. api_moderation modülü, moderatör kontrol paneli için metodları içerir.
api_moderation modülü, canlı ve hızlı denetleme API'lerinin kapsamlı bir paketini sunar. Her api_moderation metodu bir sso parametresi alır ve SSO veya bir FastComments.com oturum çerezi aracılığıyla kimlik doğrulaması yapabilir.
Hızlı Başlangıç 
Kimlik Doğrulamalı API'leri Kullanma (DefaultAPI)
Önemli: Kimlik doğrulamalı uç noktalar API anahtarınızın x-api-key başlığı olarak ayarlanmasını gerektirir.
import httpclient
import fastcomments
import fastcomments/apis/api_default
import fastcomments/models/model_comment_data
let client = newHttpClient()
client.headers["x-api-key"] = "your-api-key"
# Kimlik doğrulamalı API çağrıları yapın.
# Gerekli parametreler (ve istek gövdesi) konumsaldır; isteğe bağlı
# parametreler operasyonun seçenekler nesnesi aracılığıyla iletilir.
let (response, httpResponse) = getComments(
httpClient = client,
tenantId = "your-tenant-id",
options = GetCommentsOptions(
urlId: "your-url-id",
direction: SortDirections.DESC
)
)
if response.isSome:
let resp = response.get()
if resp.comments.isSome:
echo "Found ", resp.comments.get().len, " comments"
Genel API'leri Kullanma (PublicAPI)
Genel uç noktalar kimlik doğrulama gerektirmez:
import httpclient
import fastcomments
import fastcomments/apis/api_public
let client = newHttpClient()
# Genel API çağrıları yapın.
# tenantId ve urlId gereklidir (konumsal); diğer tüm parametreler isteğe bağlıdır.
let (response, httpResponse) = getCommentsPublic(
httpClient = client,
tenantId = "your-tenant-id",
urlId = "your-url-id",
options = GetCommentsPublicOptions(
direction: SortDirections.DESC
)
)
if response.isSome:
let resp = response.get()
if resp.comments.isSome:
echo "Found ", resp.comments.get().len, " comments"
Moderasyon API'lerini Kullanma (ModerationAPI)
Moderasyon uç noktaları moderatör panelini çalıştırır ve işlemi yapan moderatör için bir SSO tokenı ile kimlik doğrulaması yapılır:
import httpclient
import fastcomments
import fastcomments/apis/api_moderation
let client = newHttpClient()
# Moderasyon panelindeki yorumları listele.
# Bu işlem için gerekli parametre yoktur, bu yüzden tümü isteğe bağlıdır.
let (response, httpResponse) = getApiComments(
httpClient = client,
options = GetApiCommentsOptions(
count: 30,
tenantId: "your-tenant-id",
sso: "your-sso-token"
)
)
if response.isSome:
let resp = response.get()
echo "Found ", resp.comments.len, " comments"
Yaygın Sorunlar
- 401 kimlik doğrulama hatası: DefaultAPI istekleri yapmadan önce HttpClient'ınızda
x-api-keybaşlığını ayarladığınızdan emin olun:client.headers["x-api-key"] = "your-api-key" - Yanlış API sınıfı: Sunucu tarafı kimlik doğrulamalı istekler için
api_default, istemci/halka açık istekler içinapi_publicve moderatör paneli istekleri içinapi_moderationkullanın.
API Çağrıları Yapma 
All API methods in this SDK return tuples of (Option[ResponseType], Response). The first element contains the parsed response if successful, and the second element is the raw HTTP response.
Required parameters and the request body are passed positionally. The remaining optional parameters are collected into a single Api<Operation>Options object, which is the last argument. Operations with no optional parameters take no options object.
Example: Fetching Comments
import httpclient
import options
import fastcomments
import fastcomments/apis/api_default
let client = newHttpClient()
client.headers["x-api-key"] = "your-api-key"
let (response, httpResponse) = getComments(
httpClient = client,
tenantId = "your-tenant-id",
options = GetCommentsOptions(
urlId: "your-url-id",
direction: SortDirections.DESC
)
)
if httpResponse.code == Http200:
if response.isSome:
let resp = response.get()
if resp.comments.isSome:
echo "Found ", resp.comments.get().len, " comments"
Notlar 
Yayın Kimlikleri
Bazı API çağrılarında broadcastId geçirmeniz gerektiğini göreceksiniz. Olayları aldığınızda bu ID'yi geri alırsınız, böylece istemcide değişiklikleri iyimser şekilde uygulamayı planlıyorsanız olayı görmezden gelebilirsiniz (muhtemelen en iyi deneyimi sunduğu için bunu yapmak isteyeceksiniz). Buraya bir UUID gönderin. ID, bir tarayıcı oturumu içinde iki kez oluşmayacak kadar benzersiz olmalıdır.
SSO (Tek Oturum Açma)
SSO örnekleri için aşağıya bakın.
SSO Kullanımı 
Basit SSO
import fastcomments/sso
let user = newSimpleSSOUserData(
userId = "user-123",
email = "user@example.com",
avatar = "https://example.com/avatar.jpg"
)
let sso = newSimple(simpleUserData = user)
let token = sso.createToken()
echo "SSO Token: ", token
Güvenli SSO
import fastcomments/sso
let user = newSecureSSOUserData(
userId = "user-123",
email = "user@example.com",
username = "johndoe",
avatar = "https://example.com/avatar.jpg"
)
let apiKey = "your-api-key"
let sso = newSecure(apiKey = apiKey, secureUserData = user)
let token = sso.createToken()
echo "Secure SSO Token: ", token
fastcomments için Dokümantasyon 
API Uç Noktaları için Dokümantasyon
Tüm URI'ler https://fastcomments.com adresine göredir.
| Sınıf | Metot | HTTP isteği | Açıklama |
|---|---|---|---|
| DefaultApi | addDomainConfig | POST /api/v1/domain-configs | |
| DefaultApi | addHashTag | POST /api/v1/hash-tags | |
| DefaultApi | addHashTagsBulk | POST /api/v1/hash-tags/bulk | |
| DefaultApi | addPage | POST /api/v1/pages | |
| DefaultApi | addSSOUser | POST /api/v1/sso-users | |
| DefaultApi | aggregate | POST /api/v1/aggregate | Belgeleri (groupBy sağlanmışsa) gruplayarak ve birden fazla işlem uygulayarak toplar. Farklı işlemler (ör. sum, countDistinct, avg vb.) desteklenir. |
| DefaultApi | aggregateQuestionResults | GET /api/v1/question-results-aggregation | |
| DefaultApi | blockUserFromComment | POST /api/v1/comments/{id}/block | |
| DefaultApi | bulkAggregateQuestionResults | POST /api/v1/question-results-aggregation/bulk | |
| DefaultApi | changeTicketState | PATCH /api/v1/tickets/{id}/state | |
| DefaultApi | combineCommentsWithQuestionResults | GET /api/v1/question-results-aggregation/combine/comments | |
| DefaultApi | createEmailTemplate | POST /api/v1/email-templates | |
| DefaultApi | createFeedPost | POST /api/v1/feed-posts | |
| DefaultApi | createModerator | POST /api/v1/moderators | |
| DefaultApi | createQuestionConfig | POST /api/v1/question-configs | |
| DefaultApi | createQuestionResult | POST /api/v1/question-results | |
| DefaultApi | createSubscription | POST /api/v1/subscriptions | |
| DefaultApi | createTenant | POST /api/v1/tenants | |
| DefaultApi | createTenantPackage | POST /api/v1/tenant-packages | |
| DefaultApi | createTenantUser | POST /api/v1/tenant-users | |
| DefaultApi | createTicket | POST /api/v1/tickets | |
| DefaultApi | createUserBadge | POST /api/v1/user-badges | |
| DefaultApi | createVote | POST /api/v1/votes | |
| DefaultApi | deleteComment | DELETE /api/v1/comments/{id} | |
| DefaultApi | deleteDomainConfig | DELETE /api/v1/domain-configs/{domain} | |
| DefaultApi | deleteEmailTemplate | DELETE /api/v1/email-templates/{id} | |
| DefaultApi | deleteEmailTemplateRenderError | DELETE /api/v1/email-templates/{id}/render-errors/{errorId} | |
| DefaultApi | deleteHashTag | DELETE /api/v1/hash-tags/{tag} | |
| DefaultApi | deleteModerator | DELETE /api/v1/moderators/{id} | |
| DefaultApi | deleteNotificationCount | DELETE /api/v1/notification-count/{id} | |
| DefaultApi | deletePage | DELETE /api/v1/pages/{id} | |
| DefaultApi | deletePendingWebhookEvent | DELETE /api/v1/pending-webhook-events/{id} | |
| DefaultApi | deleteQuestionConfig | DELETE /api/v1/question-configs/{id} | |
| DefaultApi | deleteQuestionResult | DELETE /api/v1/question-results/{id} | |
| DefaultApi | deleteSSOUser | DELETE /api/v1/sso-users/{id} | |
| DefaultApi | deleteSubscription | DELETE /api/v1/subscriptions/{id} | |
| DefaultApi | deleteTenant | DELETE /api/v1/tenants/{id} | |
| DefaultApi | deleteTenantPackage | DELETE /api/v1/tenant-packages/{id} | |
| DefaultApi | deleteTenantUser | DELETE /api/v1/tenant-users/{id} | |
| DefaultApi | deleteUserBadge | DELETE /api/v1/user-badges/{id} | |
| DefaultApi | deleteVote | DELETE /api/v1/votes/{id} | |
| DefaultApi | flagComment | POST /api/v1/comments/{id}/flag | |
| DefaultApi | getAuditLogs | GET /api/v1/audit-logs | |
| DefaultApi | getCachedNotificationCount | GET /api/v1/notification-count/{id} | |
| DefaultApi | getComment | GET /api/v1/comments/{id} | |
| DefaultApi | getComments | GET /api/v1/comments | |
| DefaultApi | getDomainConfig | GET /api/v1/domain-configs/{domain} | |
| DefaultApi | getDomainConfigs | GET /api/v1/domain-configs | |
| DefaultApi | getEmailTemplate | GET /api/v1/email-templates/{id} | |
| DefaultApi | getEmailTemplateDefinitions | GET /api/v1/email-templates/definitions | |
| DefaultApi | getEmailTemplateRenderErrors | GET /api/v1/email-templates/{id}/render-errors | |
| DefaultApi | getEmailTemplates | GET /api/v1/email-templates | |
| DefaultApi | getFeedPosts | GET /api/v1/feed-posts | req tenantId afterId |
| DefaultApi | getHashTags | GET /api/v1/hash-tags | |
| DefaultApi | getModerator | GET /api/v1/moderators/{id} | |
| DefaultApi | getModerators | GET /api/v1/moderators | |
| DefaultApi | getNotificationCount | GET /api/v1/notifications/count | |
| DefaultApi | getNotifications | GET /api/v1/notifications | |
| DefaultApi | getPageByURLId | GET /api/v1/pages/by-url-id | |
| DefaultApi | getPages | GET /api/v1/pages | |
| DefaultApi | getPendingWebhookEventCount | GET /api/v1/pending-webhook-events/count | |
| DefaultApi | getPendingWebhookEvents | GET /api/v1/pending-webhook-events | |
| DefaultApi | getQuestionConfig | GET /api/v1/question-configs/{id} | |
| DefaultApi | getQuestionConfigs | GET /api/v1/question-configs | |
| DefaultApi | getQuestionResult | GET /api/v1/question-results/{id} | |
| DefaultApi | getQuestionResults | GET /api/v1/question-results | |
| DefaultApi | getSSOUserByEmail | GET /api/v1/sso-users/by-email/{email} | |
| DefaultApi | getSSOUserById | GET /api/v1/sso-users/by-id/{id} | |
| DefaultApi | getSSOUsers | GET /api/v1/sso-users | |
| DefaultApi | getSubscriptions | GET /api/v1/subscriptions | |
| DefaultApi | getTenant | GET /api/v1/tenants/{id} | |
| DefaultApi | getTenantDailyUsages | GET /api/v1/tenant-daily-usage | |
| DefaultApi | getTenantPackage | GET /api/v1/tenant-packages/{id} | |
| DefaultApi | getTenantPackages | GET /api/v1/tenant-packages | |
| DefaultApi | getTenantUser | GET /api/v1/tenant-users/{id} | |
| DefaultApi | getTenantUsers | GET /api/v1/tenant-users | |
| DefaultApi | getTenants | GET /api/v1/tenants | |
| DefaultApi | getTicket | GET /api/v1/tickets/{id} | |
| DefaultApi | getTickets | GET /api/v1/tickets | |
| DefaultApi | getUser | GET /api/v1/users/{id} | |
| DefaultApi | getUserBadge | GET /api/v1/user-badges/{id} | |
| DefaultApi | getUserBadgeProgressById | GET /api/v1/user-badge-progress/{id} | |
| DefaultApi | getUserBadgeProgressByUserId | GET /api/v1/user-badge-progress/user/{userId} | |
| DefaultApi | getUserBadgeProgressList | GET /api/v1/user-badge-progress | |
| DefaultApi | getUserBadges | GET /api/v1/user-badges | |
| DefaultApi | getVotes | GET /api/v1/votes | |
| DefaultApi | getVotesForUser | GET /api/v1/votes/for-user | |
| DefaultApi | patchDomainConfig | PATCH /api/v1/domain-configs/{domainToUpdate} | |
| DefaultApi | patchHashTag | PATCH /api/v1/hash-tags/{tag} | |
| DefaultApi | patchPage | PATCH /api/v1/pages/{id} | |
| DefaultApi | patchSSOUser | PATCH /api/v1/sso-users/{id} | |
| DefaultApi | putDomainConfig | PUT /api/v1/domain-configs/{domainToUpdate} | |
| DefaultApi | putSSOUser | PUT /api/v1/sso-users/{id} | |
| DefaultApi | renderEmailTemplate | POST /api/v1/email-templates/render | |
| DefaultApi | replaceTenantPackage | PUT /api/v1/tenant-packages/{id} | |
| DefaultApi | replaceTenantUser | PUT /api/v1/tenant-users/{id} | |
| DefaultApi | saveComment | POST /api/v1/comments | |
| DefaultApi | saveCommentsBulk | POST /api/v1/comments/bulk | |
| DefaultApi | sendInvite | POST /api/v1/moderators/{id}/send-invite | |
| DefaultApi | sendLoginLink | POST /api/v1/tenant-users/{id}/send-login-link | |
| DefaultApi | unBlockUserFromComment | POST /api/v1/comments/{id}/un-block | |
| DefaultApi | unFlagComment | POST /api/v1/comments/{id}/un-flag | |
| DefaultApi | updateComment | PATCH /api/v1/comments/{id} | |
| DefaultApi | updateEmailTemplate | PATCH /api/v1/email-templates/{id} | |
| DefaultApi | updateFeedPost | PATCH /api/v1/feed-posts/{id} | |
| DefaultApi | updateModerator | PATCH /api/v1/moderators/{id} | |
| DefaultApi | updateNotification | PATCH /api/v1/notifications/{id} | |
| DefaultApi | updateQuestionConfig | PATCH /api/v1/question-configs/{id} | |
| DefaultApi | updateQuestionResult | PATCH /api/v1/question-results/{id} | |
| DefaultApi | updateSubscription | PATCH /api/v1/subscriptions/{id} | |
| DefaultApi | updateTenant | PATCH /api/v1/tenants/{id} | |
| DefaultApi | updateTenantPackage | PATCH /api/v1/tenant-packages/{id} | |
| DefaultApi | updateTenantUser | PATCH /api/v1/tenant-users/{id} | |
| DefaultApi | updateUserBadge | PUT /api/v1/user-badges/{id} | |
| ModerationApi | deleteModerationVote | DELETE /auth/my-account/moderate-comments/mod_api/vote/{commentId}/{voteId} | |
| ModerationApi | getApiComments | GET /auth/my-account/moderate-comments/mod_api/api/comments | |
| ModerationApi | getApiExportStatus | GET /auth/my-account/moderate-comments/mod_api/api/export/status | |
| ModerationApi | getApiIds | GET /auth/my-account/moderate-comments/mod_api/api/ids | |
| ModerationApi | getBanUsersFromComment | GET /auth/my-account/moderate-comments/mod_api/ban-users/from-comment/{commentId} | |
| ModerationApi | getCommentBanStatus | GET /auth/my-account/moderate-comments/mod_api/get-comment-ban-status/{commentId} | |
| ModerationApi | getCommentChildren | GET /auth/my-account/moderate-comments/mod_api/comment-children/{commentId} | |
| ModerationApi | getCount | GET /auth/my-account/moderate-comments/mod_api/count | |
| ModerationApi | getCounts | GET /auth/my-account/moderate-comments/banned-users/mod_api/counts | |
| ModerationApi | getLogs | GET /auth/my-account/moderate-comments/mod_api/logs/{commentId} | |
| ModerationApi | getManualBadges | GET /auth/my-account/moderate-comments/mod_api/get-manual-badges | |
| ModerationApi | getManualBadgesForUser | GET /auth/my-account/moderate-comments/mod_api/get-manual-badges-for-user | |
| ModerationApi | getModerationComment | GET /auth/my-account/moderate-comments/mod_api/comment/{commentId} | |
| ModerationApi | getModerationCommentText | GET /auth/my-account/moderate-comments/mod_api/get-comment-text/{commentId} | |
| ModerationApi | getPreBanSummary | GET /auth/my-account/moderate-comments/mod_api/pre-ban-summary/{commentId} | |
| ModerationApi | getSearchCommentsSummary | GET /auth/my-account/moderate-comments/mod_api/search/comments/summary | |
| ModerationApi | getSearchPages | GET /auth/my-account/moderate-comments/mod_api/search/pages | |
| ModerationApi | getSearchSites | GET /auth/my-account/moderate-comments/mod_api/search/sites | |
| ModerationApi | getSearchSuggest | GET /auth/my-account/moderate-comments/mod_api/search/suggest | |
| ModerationApi | getSearchUsers | GET /auth/my-account/moderate-comments/mod_api/search/users | |
| ModerationApi | getTrustFactor | GET /auth/my-account/moderate-comments/mod_api/get-trust-factor | |
| ModerationApi | getUserBanPreference | GET /auth/my-account/moderate-comments/mod_api/user-ban-preference | |
| ModerationApi | getUserInternalProfile | GET /auth/my-account/moderate-comments/mod_api/get-user-internal-profile | |
| ModerationApi | postAdjustCommentVotes | POST /auth/my-account/moderate-comments/mod_api/adjust-comment-votes/{commentId} | |
| ModerationApi | postApiExport | POST /auth/my-account/moderate-comments/mod_api/api/export | |
| ModerationApi | postBanUserFromComment | POST /auth/my-account/moderate-comments/mod_api/ban-user/from-comment/{commentId} | |
| ModerationApi | postBanUserUndo | POST /auth/my-account/moderate-comments/mod_api/ban-user/undo | |
| ModerationApi | postBulkPreBanSummary | POST /auth/my-account/moderate-comments/mod_api/bulk-pre-ban-summary | |
| ModerationApi | postCommentsByIds | POST /auth/my-account/moderate-comments/mod_api/comments-by-ids | |
| ModerationApi | postFlagComment | POST /auth/my-account/moderate-comments/mod_api/flag-comment/{commentId} | |
| ModerationApi | postRemoveComment | POST /auth/my-account/moderate-comments/mod_api/remove-comment/{commentId} | |
| ModerationApi | postRestoreDeletedComment | POST /auth/my-account/moderate-comments/mod_api/restore-deleted-comment/{commentId} | |
| ModerationApi | postSetCommentApprovalStatus | POST /auth/my-account/moderate-comments/mod_api/set-comment-approval-status/{commentId} | |
| ModerationApi | postSetCommentReviewStatus | POST /auth/my-account/moderate-comments/mod_api/set-comment-review-status/{commentId} | |
| ModerationApi | postSetCommentSpamStatus | POST /auth/my-account/moderate-comments/mod_api/set-comment-spam-status/{commentId} | |
| ModerationApi | postSetCommentText | POST /auth/my-account/moderate-comments/mod_api/set-comment-text/{commentId} | |
| ModerationApi | postUnFlagComment | POST /auth/my-account/moderate-comments/mod_api/un-flag-comment/{commentId} | |
| ModerationApi | postVote | POST /auth/my-account/moderate-comments/mod_api/vote/{commentId} | |
| ModerationApi | putAwardBadge | PUT /auth/my-account/moderate-comments/mod_api/award-badge | |
| ModerationApi | putCloseThread | PUT /auth/my-account/moderate-comments/mod_api/close-thread | |
| ModerationApi | putRemoveBadge | PUT /auth/my-account/moderate-comments/mod_api/remove-badge | |
| ModerationApi | putReopenThread | PUT /auth/my-account/moderate-comments/mod_api/reopen-thread | |
| ModerationApi | setTrustFactor | PUT /auth/my-account/moderate-comments/mod_api/set-trust-factor | |
| PublicApi | blockFromCommentPublic | POST /block-from-comment/{commentId} | |
| PublicApi | checkedCommentsForBlocked | GET /check-blocked-comments | |
| PublicApi | createCommentPublic | POST /comments/{tenantId} | |
| PublicApi | createFeedPostPublic | POST /feed-posts/{tenantId} | |
| PublicApi | createV1PageReact | POST /page-reacts/v1/likes/{tenantId} | |
| PublicApi | createV2PageReact | POST /page-reacts/v2/{tenantId} | |
| PublicApi | deleteCommentPublic | DELETE /comments/{tenantId}/{commentId} | |
| PublicApi | deleteCommentVote | DELETE /comments/{tenantId}/{commentId}/vote/{voteId} | |
| PublicApi | deleteFeedPostPublic | DELETE /feed-posts/{tenantId}/{postId} | |
| PublicApi | deleteV1PageReact | DELETE /page-reacts/v1/likes/{tenantId} | |
| PublicApi | deleteV2PageReact | DELETE /page-reacts/v2/{tenantId} | |
| PublicApi | flagCommentPublic | POST /flag-comment/{commentId} | |
| PublicApi | getCommentText | GET /comments/{tenantId}/{commentId}/text | |
| PublicApi | getCommentVoteUserNames | GET /comments/{tenantId}/{commentId}/votes | |
| PublicApi | getCommentsForUser | GET /comments-for-user | |
| PublicApi | getCommentsPublic | GET /comments/{tenantId} | req tenantId urlId |
| PublicApi | getEventLog | GET /event-log/{tenantId} | req tenantId urlId userIdWS |
| PublicApi | getFeedPostsPublic | GET /feed-posts/{tenantId} | req tenantId afterId |
| PublicApi | getFeedPostsStats | GET /feed-posts/{tenantId}/stats | |
| PublicApi | getGifLarge | GET /gifs/get-large/{tenantId} | |
| PublicApi | getGifsSearch | GET /gifs/search/{tenantId} | |
| PublicApi | getGifsTrending | GET /gifs/trending/{tenantId} | |
| PublicApi | getGlobalEventLog | GET /event-log/global/{tenantId} | req tenantId urlId userIdWS |
| PublicApi | getOfflineUsers | GET /pages/{tenantId}/users/offline | Sayfada daha önce yorum yapmış fakat şu anda çevrim dışı olan yorumcular. displayName'e göre sıralanır. “/users/online” sonlandığında “Members” (Üyeler) bölümünü oluşturmak için kullanın. commenterName üzerinde imleç sayfalama: sunucu, partial {tenantId, urlId, commenterName} indeksini afterName'den $gt ile ileri yürütür, $skip maliyeti yoktur. |
| PublicApi | getOnlineUsers | GET /pages/{tenantId}/users/online | Bir sayfanın şu anda çevrimiçi izleyicileri: WebSocket oturumu şu anda sayfaya abone olan kişiler. anonCount + totalCount değerlerini döndürür (oda genelindeki aboneler, saymadığımız anonim izleyiciler dahil). |
| PublicApi | getPagesPublic | GET /pages/{tenantId} | Bir tenant için sayfaları listeler. FChat masaüstü istemcisi tarafından oda listesini doldurmak için kullanılır. Her sayfanın çözülen özel yapılandırmasında enableFChat true olmalıdır. SSO gerektiren sayfalar, istek yapan kullanıcının grup erişimine göre filtrelenir. |
| PublicApi | getTranslations | GET /translations/{namespace}/{component} | |
| PublicApi | getUserNotificationCount | GET /user-notifications/get-count | |
| PublicApi | getUserNotifications | GET /user-notifications | |
| PublicApi | getUserPresenceStatuses | GET /user-presence-status | |
| PublicApi | getUserReactsPublic | GET /feed-posts/{tenantId}/user-reacts | |
| PublicApi | getUsersInfo | GET /pages/{tenantId}/users/info | Bulk user info for a tenant. Given userIds, return display info from User / SSOUser. Used by the comment widget to enrich users that just appeared via a presence event. No page context: privacy is enforced uniformly (private profiles are masked). |
| PublicApi | getV1PageLikes | GET /page-reacts/v1/likes/{tenantId} | |
| PublicApi | getV2PageReactUsers | GET /page-reacts/v2/{tenantId}/list | |
| PublicApi | getV2PageReacts | GET /page-reacts/v2/{tenantId} | |
| PublicApi | lockComment | POST /comments/{tenantId}/{commentId}/lock | |
| PublicApi | logoutPublic | PUT /auth/logout | |
| PublicApi | pinComment | POST /comments/{tenantId}/{commentId}/pin | |
| PublicApi | reactFeedPostPublic | POST /feed-posts/{tenantId}/react/{postId} | |
| PublicApi | resetUserNotificationCount | POST /user-notifications/reset-count | |
| PublicApi | resetUserNotifications | POST /user-notifications/reset | |
| PublicApi | searchUsers | GET /user-search/{tenantId} | |
| PublicApi | setCommentText | POST /comments/{tenantId}/{commentId}/update-text | |
| PublicApi | unBlockCommentPublic | DELETE /block-from-comment/{commentId} | |
| PublicApi | unLockComment | POST /comments/{tenantId}/{commentId}/unlock | |
| PublicApi | unPinComment | POST /comments/{tenantId}/{commentId}/unpin | |
| PublicApi | updateFeedPostPublic | PUT /feed-posts/{tenantId}/{postId} | |
| PublicApi | updateUserNotificationCommentSubscriptionStatus | POST /user-notifications/{notificationId}/mark-opted/{optedInOrOut} | Belirli bir yorum için bildirimleri etkinleştirir veya devre dışı bırakır. |
| PublicApi | updateUserNotificationPageSubscriptionStatus | POST /user-notifications/set-subscription-state/{subscribedOrUnsubscribed} | Bir sayfa için bildirimleri etkinleştirir veya devre dışı bırakır. Kullanıcılar bir sayfaya abone olduğunda, yeni ana yorumlar için bildirimler oluşturulur ve ayrıca |
| PublicApi | updateUserNotificationStatus | POST /user-notifications/{notificationId}/mark/{newStatus} | |
| PublicApi | uploadImage | POST /upload-image/{tenantId} | Bir resmi yükler ve yeniden boyutlandırır. |
| PublicApi | voteComment | POST /comments/{tenantId}/{commentId}/vote |
Modeller için Dokümantasyon
- APIAuditLog
- APIBanUserChangeLog
- APIBanUserChangedValues
- APIBannedUser
- APIBannedUserWithMultiMatchInfo
- APIComment
- APICommentBase
- APICommentBase_meta
- APICommentCommonBannedUser
- APICreateUserBadgeResponse
- APIDomainConfiguration
- APIEmptyResponse
- APIEmptySuccessResponse
- APIError
- APIGetCommentResponse
- APIGetCommentsResponse
- APIGetUserBadgeProgressListResponse
- APIGetUserBadgeProgressResponse
- APIGetUserBadgeResponse
- APIGetUserBadgesResponse
- APIModerateGetUserBanPreferencesResponse
- APIModerateUserBanPreferences
- APIPage
- APISSOUser
- APISaveCommentResponse
- APIStatus
- APITenant
- APITenantDailyUsage
- APITicket
- APITicketDetail
- APITicketFile
- APIUserSubscription
- AddDomainConfigParams
- AddDomainConfigResponse
- AddDomainConfigResponse_anyOf
- AddPageAPIResponse
- AddSSOUserAPIResponse
- AdjustCommentVotesParams
- AdjustVotesResponse
- [AggregateQuestionResultsResponse](https://github.com/FastComments/fastcomments-nim/blob/master/docs/Models
aggregate 
Belgeleri gruplandırarak (eğer groupBy sağlanmışsa) ve birden fazla işlem uygulayarak toplar.
Farklı işlemler (ör. sum, countDistinct, avg, vb.) desteklenir.
Parametreler
| Ad | Tür | Gerekli | Açıklama |
|---|---|---|---|
| tenantId | string | Evet | |
| aggregationRequest | AggregationRequest | Hayır | |
| options | AggregateOptions | Hayır |
Yanıt
Döndürür: Option[AggregateResponse]
Örnek

getAuditLogs 
Parametreler
| Ad | Tür | Gerekli | Açıklama |
|---|---|---|---|
| tenantId | string | Evet | |
| options | GetAuditLogsOptions | Hayır |
Yanıt
Döndürür: Option[GetAuditLogsResponse]
Örnek

logoutPublic 
Yanıt
Döndürülen: Option[APIEmptyResponse]
Örnek

blockFromCommentPublic 
Parametreler
| Ad | Tür | Gerekli | Açıklama |
|---|---|---|---|
| tenantId | string | Yes | |
| commentId | string | Yes | |
| publicBlockFromCommentParams | PublicBlockFromCommentParams | No | |
| sso | string = "" | No |
Yanıt
Döndürür: Option[BlockSuccess]
Örnek

unBlockCommentPublic 
Parametreler
| Ad | Tür | Gerekli | Açıklama |
|---|---|---|---|
| tenantId | string | Yes | |
| commentId | string | Yes | |
| publicBlockFromCommentParams | PublicBlockFromCommentParams | No | |
| sso | string = "" | No |
Yanıt
Döndürür: Option[UnblockSuccess]
Örnek

checkedCommentsForBlocked 
Parametreler
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Yes | |
| commentIds | string | No | |
| sso | string = "" | No |
Yanıt
Döndürür: Option[CheckBlockedCommentsResponse]
Örnek

blockUserFromComment 
Parametreler
| İsim | Tür | Gerekli | Açıklama |
|---|---|---|---|
| tenantId | string | Evet | |
| id | string | Hayır | |
| blockFromCommentParams | BlockFromCommentParams | Hayır | |
| options | BlockUserFromCommentOptions | Hayır |
Yanıt
Döndürür: Option[BlockSuccess]
Örnek

createCommentPublic 
Parametreler
| Ad | Tür | Gerekli | Açıklama |
|---|---|---|---|
| tenantId | string | Yes | |
| urlId | string | Yes | |
| broadcastId | string | No | |
| commentData | CommentData | No | |
| options | CreateCommentPublicOptions | No |
Yanıt
Döndürür: Option[SaveCommentsResponseWithPresence]
Örnek

deleteComment 
Parametreler
| Ad | Tür | Gerekli | Açıklama |
|---|---|---|---|
| tenantId | string | Yes | |
| id | string | No | |
| options | DeleteCommentOptions | No |
Yanıt
Döndürür: Option[DeleteCommentResult]
Örnek

deleteCommentPublic 
Parametreler
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Yes | |
| commentId | string | Yes | |
| broadcastId | string | No | |
| options | DeleteCommentPublicOptions | No |
Yanıt
Döndürür: Option[PublicAPIDeleteCommentResponse]
Örnek

deleteCommentVote 
Parametreler
| Ad | Tür | Gerekli | Açıklama |
|---|---|---|---|
| tenantId | string | Yes | |
| commentId | string | Yes | |
| voteId | string | No | |
| urlId | string | Yes | |
| broadcastId | string | No | |
| options | DeleteCommentVoteOptions | No |
Yanıt
Döndürür: Option[VoteDeleteResponse]
Örnek

flagComment 
Parametreler
| Ad | Tür | Gerekli | Açıklama |
|---|---|---|---|
| tenantId | string | Evet | |
| id | string | Hayır | |
| options | FlagCommentOptions | Hayır |
Yanıt
Döndürür: Option[FlagCommentResponse]
Örnek

getComment 
Parametreler
| İsim | Tür | Gerekli | Açıklama |
|---|---|---|---|
| tenantId | string | Yes | |
| id | string | No |
Yanıt
Döndürür: Option[APIGetCommentResponse]
Örnek

getComments 
Parametreler
| Ad | Tür | Gerekli | Açıklama |
|---|---|---|---|
| tenantId | string | Yes | |
| options | GetCommentsOptions | No |
Yanıt
Döndürür: Option[APIGetCommentsResponse]
Örnek

getCommentsPublic 
istek tenantId urlId
Parametreler
| İsim | Tür | Gerekli | Açıklama |
|---|---|---|---|
| tenantId | string | Evet | |
| urlId | string | Evet | |
| options | GetCommentsPublicOptions | Hayır |
Yanıt
Döndürür: Option[GetCommentsResponseWithPresencePublicComment]
Örnek

getCommentText 
Parametreler
| Ad | Tür | Gerekli | Açıklama |
|---|---|---|---|
| tenantId | string | Yes | |
| commentId | string | Yes | |
| options | GetCommentTextOptions | No |
Yanıt
Döndürür: Option[PublicAPIGetCommentTextResponse]
Örnek

getCommentVoteUserNames 
Parametreler
| Ad | Tür | Gerekli | Açıklama |
|---|---|---|---|
| tenantId | string | Evet | |
| commentId | string | Evet | |
| dir | int | Hayır | |
| sso | string = "" | Hayır |
Yanıt
Döndürür: Option[GetCommentVoteUserNamesSuccessResponse]
Örnek

lockComment 
Parametreler
| Ad | Tür | Gerekli | Açıklama |
|---|---|---|---|
| tenantId | string | Yes | |
| commentId | string | Yes | |
| broadcastId | string | No | |
| sso | string = "" | No |
Yanıt
Döndürür: Option[APIEmptyResponse]
Örnek

pinComment 
Parametreler
| Ad | Tür | Gerekli | Açıklama |
|---|---|---|---|
| tenantId | string | Yes | |
| commentId | string | Yes | |
| broadcastId | string | No | |
| sso | string = "" | No |
Yanıt
Döndürür: Option[ChangeCommentPinStatusResponse]
Örnek

saveComment 
Parametreler
| Ad | Tür | Gerekli | Açıklama |
|---|---|---|---|
| tenantId | string | Evet | |
| createCommentParams | CreateCommentParams | Hayır | |
| options | SaveCommentOptions | Hayır |
Yanıt
Döndürür: Option[APISaveCommentResponse]
Örnek

saveCommentsBulk 
Parametreler
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Yes | |
| createCommentParams | seq[CreateCommentParams] | No | |
| options | SaveCommentsBulkOptions): (Option[seq[SaveCommentsBulkResponse]] | No | |
| id | string | No | |
| fromName | string | No |
Yanıt
Döndürür: Option[APIEmptyResponse]
Örnek

setCommentText 
Parametreler
| Ad | Tür | Gerekli | Açıklama |
|---|---|---|---|
| tenantId | string | Yes | |
| commentId | string | Yes | |
| broadcastId | string | No | |
| commentTextUpdateRequest | CommentTextUpdateRequest | No | |
| options | SetCommentTextOptions | No |
Yanıt
Döndürür: Option[PublicAPISetCommentTextResponse]
Örnek

unBlockUserFromComment 
Parametreler
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Yes | |
| id | string | No | |
| unBlockFromCommentParams | UnBlockFromCommentParams | No | |
| options | UnBlockUserFromCommentOptions | No |
Yanıt
Döner: Option[UnblockSuccess]
Örnek

unFlagComment 
Parametreler
| Ad | Tür | Gerekli | Açıklama |
|---|---|---|---|
| tenantId | string | Evet | |
| id | string | Hayır | |
| options | UnFlagCommentOptions | Hayır |
Yanıt
Döndürür: Option[FlagCommentResponse]
Örnek

unLockComment 
Parametreler
| Ad | Tür | Gerekli | Açıklama |
|---|---|---|---|
| tenantId | string | Evet | |
| commentId | string | Evet | |
| broadcastId | string | Hayır | |
| sso | string = "" | Hayır |
Yanıt
Döndürür: Option[APIEmptyResponse]
Örnek

unPinComment 
Parametreler
| Ad | Tür | Gerekli | Açıklama |
|---|---|---|---|
| tenantId | string | Evet | |
| commentId | string | Evet | |
| broadcastId | string | Hayır | |
| sso | string = "" | Hayır |
Yanıt
Döndürür: Option[ChangeCommentPinStatusResponse]
Örnek

updateComment 
Parametreler
| İsim | Tür | Gerekli | Açıklama |
|---|---|---|---|
| tenantId | string | Yes | |
| id | string | No | |
| updatableCommentParams | UpdatableCommentParams | No | |
| options | UpdateCommentOptions | No |
Yanıt
Döndürür: Option[APIEmptyResponse]
Örnek

voteComment 
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Yes | |
| commentId | string | Yes | |
| urlId | string | Yes | |
| broadcastId | string | No | |
| voteBodyParams | VoteBodyParams | No | |
| options | VoteCommentOptions | No |
Response
Döndürür: Option[VoteResponse]
Example

getCommentsForUser 
Parametreler
| Ad | Tür | Gerekli | Açıklama |
|---|---|---|---|
| options | GetCommentsForUserOptions | Hayır |
Yanıt
Döner: Option[GetCommentsForUserResponse]
Örnek

addDomainConfig 
Parametreler
| Ad | Tür | Gerekli | Açıklama |
|---|---|---|---|
| tenantId | string | Evet | |
| addDomainConfigParams | AddDomainConfigParams | Hayır |
Yanıt
Döndürür: Option[AddDomainConfigResponse]
Örnek

deleteDomainConfig 
Parametreler
| Ad | Tür | Gerekli | Açıklama |
|---|---|---|---|
| tenantId | string | Yes | |
| domain | string | No |
Yanıt
Döndürür: Option[DeleteDomainConfigResponse]
Örnek

getDomainConfig 
Parametreler
| Ad | Tip | Gerekli | Açıklama |
|---|---|---|---|
| tenantId | string | Yes | |
| domain | string | No |
Yanıt
Döndürür: Option[GetDomainConfigResponse]
Örnek

getDomainConfigs 
Parametreler
| Ad | Tür | Gerekli | Açıklama |
|---|---|---|---|
| tenantId | string | Evet |
Yanıt
Döndürür: Option[GetDomainConfigsResponse]
Örnek

patchDomainConfig 
Parameters
| İsim | Tür | Gerekli | Açıklama |
|---|---|---|---|
| tenantId | string | Evet | |
| domainToUpdate | string | Hayır | |
| patchDomainConfigParams | PatchDomainConfigParams | Hayır |
Response
Döndürür: Option[PatchDomainConfigResponse]
Example

putDomainConfig 
Parametreler
| Ad | Tür | Gerekli | Açıklama |
|---|---|---|---|
| tenantId | string | Evet | |
| domainToUpdate | string | Hayır | |
| updateDomainConfigParams | UpdateDomainConfigParams | Hayır |
Yanıt
Döndürür: Option[PutDomainConfigResponse]
Örnek

createEmailTemplate 
Parametreler
| Ad | Tip | Gerekli | Açıklama |
|---|---|---|---|
| tenantId | string | Evet | |
| createEmailTemplateBody | CreateEmailTemplateBody | Hayır |
Yanıt
Döndürür: Option[CreateEmailTemplateResponse]
Örnek

deleteEmailTemplate 
Parametreler
| Ad | Tür | Gerekli | Açıklama |
|---|---|---|---|
| tenantId | string | Evet | |
| id | string | Hayır |
Yanıt
Döndürür: Option[APIEmptyResponse]
Örnek

deleteEmailTemplateRenderError 
Parametreler
| Ad | Tür | Gerekli | Açıklama |
|---|---|---|---|
| tenantId | string | Evet | |
| id | string | Hayır | |
| errorId | string | Hayır |
Yanıt
Döndürür: Option[APIEmptyResponse]
Örnek

getEmailTemplate 
Parametreler
| İsim | Tür | Gerekli | Açıklama |
|---|---|---|---|
| tenantId | string | Yes | |
| id | string | No |
Yanıt
Döndürür: Option[GetEmailTemplateResponse]
Örnek

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

getEmailTemplateRenderErrors 
Parametreler
| Ad | Tür | Gerekli | Açıklama |
|---|---|---|---|
| tenantId | string | Yes | |
| id | string | No | |
| skip | float64 | No |
Yanıt
Döndürür: Option[GetEmailTemplateRenderErrorsResponse]
Örnek

getEmailTemplates 
Parametreler
| Ad | Tür | Gerekli | Açıklama |
|---|---|---|---|
| tenantId | string | Evet | |
| skip | float64 | Hayır |
Yanıt
Döndürür: Option[GetEmailTemplatesResponse]
Örnek

renderEmailTemplate 
Parametreler
| Ad | Tür | Gerekli | Açıklama |
|---|---|---|---|
| tenantId | string | Evet | |
| renderEmailTemplateBody | RenderEmailTemplateBody | Hayır | |
| locale | string = "" | Hayır |
Yanıt
Döndürür: Option[RenderEmailTemplateResponse]
Örnek

updateEmailTemplate 
Parametreler
| Ad | Tür | Gerekli | Açıklama |
|---|---|---|---|
| tenantId | string | Evet | |
| id | string | Hayır | |
| updateEmailTemplateBody | UpdateEmailTemplateBody | Hayır |
Yanıt
Döndürür: Option[APIEmptyResponse]
Örnek

getEventLog 
req tenantId urlId userIdWS
Parametreler
| Ad | Tip | Gereklilik | Açıklama |
|---|---|---|---|
| tenantId | string | Evet | |
| urlId | string | Evet | |
| userIdWS | string | Hayır | |
| startTime | int64 | Hayır | |
| endTime | int64 | Hayır |
Yanıt
Döndürür: Option[GetEventLogResponse]
Örnek

getGlobalEventLog 
req tenantId urlId userIdWS
Parametreler
| Ad | Tür | Gerekli | Açıklama |
|---|---|---|---|
| tenantId | string | Yes | |
| urlId | string | Yes | |
| userIdWS | string | No | |
| startTime | int64 | No | |
| endTime | int64 | No |
Yanıt
Döndürür: Option[GetEventLogResponse]
Örnek

createFeedPost 
Parametreler
| Ad | Tür | Gerekli | Açıklama |
|---|---|---|---|
| tenantId | string | Yes | |
| createFeedPostParams | CreateFeedPostParams | No | |
| options | CreateFeedPostOptions | No |
Yanıt
Döndürür: Option[CreateFeedPostsResponse]
Örnek

createFeedPostPublic 
Parametreler
| Ad | Tür | Gerekli | Açıklama |
|---|---|---|---|
| tenantId | string | Yes | |
| createFeedPostParams | CreateFeedPostParams | No | |
| options | CreateFeedPostPublicOptions | No |
Yanıt
Döndürür: Option[CreateFeedPostResponse]
Örnek

deleteFeedPostPublic 
Parametreler
| Ad | Tür | Zorunlu | Açıklama |
|---|---|---|---|
| tenantId | string | Yes | |
| postId | string | No | |
| options | DeleteFeedPostPublicOptions | No |
Yanıt
Döndürür: Option[DeleteFeedPostPublicResponse]
Örnek

getFeedPosts 
req tenantId afterId
Parametreler
| Ad | Tür | Gerekli | Açıklama |
|---|---|---|---|
| tenantId | string | Evet | |
| options | GetFeedPostsOptions | Hayır |
Yanıt
Döndürür: Option[GetFeedPostsResponse]
Örnek

getFeedPostsPublic 
req tenantId afterId
Parametreler
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Yes | |
| options | GetFeedPostsPublicOptions | No |
Yanıt
Returns: Option[PublicFeedPostsResponse]
Örnek

getFeedPostsStats 
Parameters
| Ad | Tür | Gerekli | Açıklama |
|---|---|---|---|
| tenantId | string | Evet | |
| postIds | seq[string] | Hayır | |
| sso | string = "" | Hayır |
Yanıt
Döndürür: Option[FeedPostsStatsResponse]
Örnek
