FastComments API
FastComments, birçok kaynakla etkileşim kurmak için bir API sağlar. Platformumuzla entegrasyonlar oluşturun veya kendi istemcilerinizi dahi yazın!
Bu dokümantasyonda, API tarafından desteklenen tüm kaynakları ve bunların istek ve yanıt tiplerini bulacaksınız.
Kurumsal (Enterprise) müşteriler için, tüm API erişimleri Denetim Günlüğü'ne (Audit Log) kaydedilir.
Oluşturulan SDK'lar
FastComments artık kodumuzdan bir API Spec üretiyor (bu henüz tamamlanmadı, ancak birçok API'yi içeriyor).
Ayrıca popüler diller için SDK'larımız da mevcut:
- fastcomments-cpp
- fastcomments-go
- fastcomments-java
- fastcomments-sdk-js
- fastcomments-nim
- fastcomments-php
- fastcomments-php-sso
- fastcomments-python
- fastcomments-ruby
- fastcomments-rust
- fastcomments-swift
Kimlik Doğrulama
API, api key değerini ya X-API-KEY başlığı olarak ya da API_KEY sorgu parametresi olarak ileyerek kimlik doğrulaması yapar. API çağrıları yapmak için ayrıca tenantId değerine de ihtiyacınız olacaktır. Bu değer, api key ile aynı sayfadan alınabilir.
Güvenlik Notu
Bu yolların bir sunucudan çağrılması amaçlanmıştır. YAPMAYIN bunları bir tarayıcıdan çağırmayın. Bunu yapmak API key'inizi açığa çıkarır - bir sayfanın kaynak kodunu görebilen herkese hesabınıza tam erişim sağlar!
Kimlik Doğrulama Seçeneği Bir - Başlıklar
- Başlık:
X-API-KEY - Başlık:
X-TENANT-ID
Kimlik Doğrulama Seçeneği İki - Sorgu Parametreleri
- Sorgu Parametresi:
API_KEY - Sorgu Parametresi:
tenantId
API Kaynakları 
Kaynak Kullanımı
API'den veri getirilmesinin hesabınızda kullanım olarak sayıldığını belirtmek gerekir.
Her kaynak, o kullanımın ne olduğunu kendi bölümünde listeleyecektir.
Bazı kaynakların sunulması diğerlerinden daha pahalıya mal olur. Her uç noktanın API çağrısı başına belirlenmiş kredi maliyeti vardır. Bazı uç noktalar için kredi sayısı, seçeneklere ve yanıt boyutlarına bağlı olarak değişir.
API kullanımını Faturalama Analitiği sayfasından kontrol edebilir ve birkaç dakikada bir güncellendiğini görebilirsiniz.
Not!
Yorum API'sinde urlId için hangi değerlerin iletileceğine karar verirken karışıklığı azaltmak için Pages dokümantasyonunu önce okumanızı öneririz.
Verilerinizi Toplayın
Resource: Aggregate as GET /api/v1/aggregate Credit Cost: 1
Bu API, belgeleri (groupBy sağlanmışsa) gruplayarak ve birden fazla işlem uygulayarak toplar (aggregate eder). Farklı işlemler (ör. sum, countDistinct, avg, vb.) desteklenir.
Maliyet değişkendir. Taranan her 500 nesne 1 API kredisi tutar.
Varsayılan olarak her API çağrısı için izin verilen maksimum bellek kullanımı 64MB'dir ve varsayılan olarak aynı anda yalnızca bir toplama işlemi çalıştırabilirsiniz. Eğer birden fazla toplama işlemini aynı anda gönderirseniz, bunlar sıraya alınır ve gönderildikleri sırayla çalıştırılır. Beklemede olan toplama işlemleri en fazla 60 saniye bekler; bundan sonra istek zaman aşımına uğrar. Bireysel toplama işlemleri en fazla 5 dakika çalışabilir.
Yönetilen kiracılarınız varsa, parentTenantId sorgu parametresini geçirerek tüm alt kiracı kaynaklarını tek bir çağrıda toplayabilirsiniz.
Örnekler
Örnek: Benzersiz Değerleri Sayma
Benzersiz Değerleri Sayma cURL Örneği
Copy 
1
2curl --request POST --url 'https://fastcomments.com/api/v1/aggregate?tenantId=demo&API_KEY=DEMO_API_SECRET&includeStats=true' --header 'Content-Type: application/json' --data '{
3 "resourceName": "Comment",
4 "operations": [
5 { "op": "distinct", "field": "urlId", "alias": "urlId" },
6 { "op": "distinct", "field": "commenterEmail", "alias": "commenterEmail" }
7 ]
8}'
9
Benzersiz Değerleri Sayma Yanıtı
Copy
1
2{
3 "status": "success",
4 "data": [
5 {
6 "commenterEmail": {
7 "distinctCounts": {
8 "someone@somewhere.com": 1,
9 "someone2@somewhere.com": 1
10 }
11 }
12 },
13 {
14 "urlId": {
15 "distinctCounts": {
16 "some-page": 2
17 }
18 }
19 }
20 ],
21 "stats": { "scanned": 2 }
22}
23
Örnek: Farklı Değerleri Sayma
Farklı Değerleri Sayma cURL Örneği
Copy
1
2curl --request POST --url 'https://fastcomments.com/api/v1/aggregate?tenantId=demo&API_KEY=DEMO_API_SECRET&includeStats=true' --header 'Content-Type: application/json' --data '{
3 "resourceName": "Comment",
4 "operations": [
5 { "op": "countDistinct", "field": "urlId", "alias": "urlId" },
6 { "op": "countDistinct", "field": "commenterEmail", "alias": "commenterEmail" }
7 ]
8}'
9
Yanıt:
Farklı Değerleri Sayma Yanıtı
Copy
1
2{
3 "status": "success",
4 "data": [
5 {
6 "commenterEmail": { "distinctCount": 2 },
7 "urlId": { "distinctCount": 1 }
8 }
9 ],
10 "stats": { "scanned": 2 }
11}
12
Örnek: Birden Fazla Alanın Değerlerini Toplama
Değerleri Toplama cURL Örneği
Copy
1
2curl --request POST --url 'https://fastcomments.com/api/v1/aggregate?tenantId=demo&API_KEY=DEMO_API_SECRET&includeStats=true' --header 'Content-Type: application/json' --data '{
3 "resourceName": "Comment",
4 "operations": [
5 { "op": "sum", "field": "votes", "alias": "votes" },
6 { "op": "sum", "field": "votesUp", "alias": "votesUp" }
7 ]
8}'
9
Yanıt:
Değerleri Toplama Yanıtı
Copy
1
2{
3 "status": "success",
4 "data": [
5 {
6 "votes": { "numericValue": 2 },
7 "votesUp": { "numericValue": 2 }
8 }
9 ],
10 "stats": { "scanned": 2 }
11}
12
Örnek: Birden Fazla Alanın Ortalama Değerleri
Ortalama Değerler cURL Örneği
Copy
1
2curl --request POST --url 'https://fastcomments.com/api/v1/aggregate?tenantId=demo&API_KEY=DEMO_API_SECRET&includeStats=true' --header 'Content-Type: application/json' --data '{
3 "resourceName": "Comment",
4 "operations": [
5 { "op": "avg", "field": "votes", "alias": "votes" },
6 { "op": "avg", "field": "votesUp", "alias": "votesUp" }
7 ]
8}'
9
Yanıt:
Ortalama Değerler Yanıtı
Copy
1
2{
3 "status": "success",
4 "data": [
5 {
6 "votes": { "numericValue": 1 },
7 "votesUp": { "numericValue": 1 }
8 }
9 ],
10 "stats": { "scanned": 2 }
11}
12
Örnek: Birden Fazla Alanın Min/Max Değerleri
Min/Max Değerler cURL Örneği
Copy
1
2curl --request POST --url 'https://fastcomments.com/api/v1/aggregate?tenantId=demo&API_KEY=DEMO_API_SECRET&includeStats=true' --header 'Content-Type: application/json' --data '{
3 "resourceName": "Comment",
4 "operations": [
5 { "op": "min", "field": "votes", "alias": "votes" },
6 { "op": "min", "field": "votesUp", "alias": "votesUp" },
7 { "op": "max", "field": "votes", "alias": "votes" },
8 { "op": "max", "field": "votesUp", "alias": "votesUp" }
9 ]
10}'
11
Yanıt:
Min/Max Değerler Yanıtı
Copy
1
2{
3 "status": "success",
4 "data": [
5 {
6 "votes": { "numericValue": 0 },
7 "votesUp": { "numericValue": 0 },
8 "votes": { "numericValue": 2 },
9 "votesUp": { "numericValue": 2 }
10 }
11 ],
12 "stats": { "scanned": 2 }
13}
14
Örnek: Birden Fazla Alanın Benzersiz Değerlerini Sayma
Benzersiz Değerleri Sayma cURL Örneği
Copy
1
2curl --request POST --url 'https://fastcomments.com/api/v1/aggregate?tenantId=demo&API_KEY=DEMO_API_SECRET&includeStats=true' --header 'Content-Type: application/json' --data '{
3 "resourceName": "Comment",
4 "operations": [
5 { "op": "distinct", "field": "urlId", "alias": "urlId" },
6 { "op": "distinct", "field": "commenterEmail", "alias": "commenterEmail" }
7 ]
8}'
9
Yanıt:
Benzersiz Değerleri Sayma Yanıtı
Copy
1
2{
3 "status": "success",
4 "data": [
5 {
6 "commenterEmail": {
7 "distinctCounts": {
8 "someone@somewhere.com": 1,
9 "someone2@somewhere.com": 1
10 }
11 },
12 "urlId": {
13 "distinctCounts": {
14 "some-page": 2
15 }
16 }
17 }
18 ],
19 "stats": { "scanned": 2 }
20}
21
Örnek: Sorgu Oluşturma
Sorgu Oluşturma cURL Örneği
Copy
1
2curl --request POST --url 'https://fastcomments.com/api/v1/aggregate?tenantId=demo&API_KEY=DEMO_API_SECRET&includeStats=true' --header 'Content-Type: application/json' --data '{
3 "resourceName": "Comment",
4 "groupBy": ["commenterName"],
5 "query": [
6 { "key": "approved", "value": true, "operator": "eq" },
7 { "key": "commenterName", "value": "some-username-2", "operator": "eq" }
8 ],
9 "operations": [
10 { "op": "sum", "field": "votes", "alias": "votes" }
11 ]
12}'
13
Yanıt:
Sorgu Oluşturma Yanıtı
Copy
1
2{
3 "status": "success",
4 "data": [
5 {
6 "groups": { "commenterName": "some-username-2" },
7 "votes": { "numericValue": 2 }
8 }
9 ],
10 "stats": { "scanned": 1 }
11}
12
Örnek: İnceleme Bekleyen Yorumları Sayma
İnceleme Bekleyen Yorumları Sayma cURL Örneği
Copy
1
2curl --request POST --url 'https://fastcomments.com/api/v1/aggregate?tenantId=demo&API_KEY=DEMO_API_SECRET&includeStats=true' --header 'Content-Type: application/json' --data '{
3 "resourceName": "Comment",
4 "query": [
5 { "key": "reviewed", "value": true, "operator": "not_eq" }
6 ],
7 "operations": [
8 { "op": "count", "field": "id", "alias": "count" }
9 ]
10}'
11
Yanıt:
İnceleme Bekleyen Yorumları Sayma Yanıtı
Copy
1
2{
3 "status": "success",
4 "data": [
5 { "count": { "numericValue": 2 } }
6 ],
7 "stats": { "scanned": 2 }
8}
9
Örnek: Onaylanmış, İncelenmiş ve Spam Yorumların Dağılımı
Yorumların Dağılımı cURL Örneği
Copy
1
2curl --request POST --url 'https://fastcomments.com/api/v1/aggregate?tenantId=demo&API_KEY=DEMO_API_SECRET&includeStats=true' --header 'Content-Type: application/json' --data '{
3 "resourceName": "Comment",
4 "operations": [
5 { "op": "distinct", "field": "approved", "alias": "approved" },
6 { "op": "distinct", "field": "reviewed", "alias": "reviewed" },
7 { "op": "distinct", "field": "isSpam", "alias": "isSpam" }
8 ]
9}'
10
Yanıt:
Yorumların Dağılımı Yanıtı
Copy
1
2{
3 "status": "success",
4 "data": [
5 {
6 "approved": { "distinctCounts": { "true": 2 } },
7 "reviewed": { "distinctCounts": { "false": 2 } },
8 "isSpam": { "distinctCounts": { "false": 2 } }
9 }
10 ],
11 "stats": { "scanned": 2 }
12}
13
Yapılar
Toplama İstek Yapısı
Copy
1
2export type AggregationOpType = 'sum' | 'countDistinct' | 'distinct' | 'avg' | 'min' | 'max' | 'count';
3
4/** Bir alana uygulanacak işlem */
5export interface AggregationOperation {
6 /** Üzerinde işlem yapılacak alan */
7 field: string;
8 /** İşlem türü */
9 op: AggregationOpType;
10 /** Çıktı için isteğe bağlı takma ad; sağlanmazsa varsayılan bir takma ad hesaplanır */
11 alias?: string;
12 expandArray?: boolean;
13}
14
15export interface QueryPredicate {
16 key: string
17 value: string | number | boolean
18 operator: 'eq' | 'not_eq' | 'greater_than' | 'less_than' | 'contains'
19}
20
21export interface AggregationRequest {
22 query?: QueryPredicate[];
23 resourceName: string;
24 groupBy?: string[];
25 operations: AggregationOperation[];
26 sort?: {
27 field: string;
28 dir: 'asc' | 'desc';
29 };
30}
31
32type DistinctAccumulator = Record<string, number>;
33type GroupValues = Record<string, string>;
34
35export type AggregationValue = {
36 distinctCounts?: DistinctAccumulator
37 distinctCount?: number
38 numericValue?: number
39 stringValue?: string
40 groups?: GroupValues
41};
42
Toplama Yanıt Yapısı
Copy
1
2export type AggregationItem = Record<string, AggregationValue> & { groups?: GroupValues };
3
4export interface AggregationResponse {
5 status: APIStatus,
6 data: AggregationItem[];
7 stats?: {
8 scanned: number;
9 timeMS: number;
10 };
11}
12
Aşağıdaki kaynaklar üzerinde toplama yapılabilir:
- AffiliateEvent
- AnonymousVote
- BannedUser
- BatchJob
- BlockedUser
- Comment
- CommentDeleted
- CommentIdToSyncOutbound
- CommentScheduled
- CommentSyncLog
- CustomConfig
- CustomEmailTemplateRenderError
- EmailToSend
- EventLogEntry
- ImportedCommentScheduled
- ModerationGroup
- Moderator
- Page
- PageReact
- PendingVote
- QuestionResult
- SSOUser
- SentEmail
- SpamEvent
- Tenant
- TenantAuditLog
- TenantBadge
- TenantDailyUsage
- TenantInvoiceHistory
- TenantPackage
- User
- UserBadge
- UserBadgeProgress
- UserNotification
- UserSubscription
- UserUsage
- Vote
AuditLog Yapısı
Bir AuditLog, bu özelliğe erişimi olan kiracılar için denetlenmiş bir olayı temsil eden bir nesnedir.
AuditLog nesnesinin yapısı aşağıdaki gibidir:
AuditLog Yapısı
Copy
1
2interface AuditLog {
3 id: string;
4 userId?: string;
5 username?: string;
6 resourceName: string;
7 crudType: 'c' | 'r' | 'u' | 'd' | 'login';
8 from: string;
9 url?: string;
10 ip?: string;
11 when: string;
12 description?: string;
13 serverStartDate: string;
14 objectDetails?: object;
15}
16
Denetim günlüğü değiştirilemez. Ayrıca elle yazılamaz. FastComments.com yalnızca denetim günlüğüne ne zaman yazılacağına karar verebilir. Ancak bu API aracılığıyla ondan okuyabilirsiniz.
Denetim günlüğündeki olayların geçerliliği iki yıl sonra sona erer.
GET /api/v1/audit-logs
Resource: AuditLog as GET /api/v1/audit-logs Credit Cost: 10
Bu API, skip, before ve after parametreleriyle sağlanan sayfalandırmayı kullanır. AuditLogs, 1000 öğelik sayfalar halinde, when ve id sırasına göre döndürülür.
Her 1000 logu almak kredi maliyeti 10'dur.
Varsayılan olarak, size en yeni öğeler ilk olacak şekilde bir liste verilir. Bu şekilde, skip=0 ile başlayıp, tükettiğiniz son kaydı bulana kadar sayfalandırma yapabilirsiniz.
Alternatif olarak, en eski ilk olacak şekilde sıralayabilir ve kayıt kalmayana kadar sayfalandırabilirsiniz.
Sıralama, order'ı ASC veya DESC olarak ayarlayarak yapılabilir. Varsayılan ASC'dir.
Tarihe göre sorgulama, before ve after'ı milisaniye içeren zaman damgaları olarak kullanarak mümkündür. before ve after dahil değildir.
AuditLog cURL Örneği
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/audit-logs?tenantId=demo&API_KEY=DEMO_API_SECRET&skip=0&order=ASC&before=123&after=456'
4
AuditLog İstek Yapısı
Copy
1
2interface CommentsRequestQueryParams {
3 tenantId: string
4 API_KEY: string
5 order?: 'ASC' | 'DESC'
6 skip?: number
7 before?: number
8 after?: number
9}
10
AuditLog Yanıt Yapısı
Copy
1
2interface CommentsResponse {
3 status: 'success' | 'failed'
4 /** Başarısızlık halinde eklenir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
6 /** Başarısızlık halinde eklenir. **/
7 reason?: string
8 /** Loglar! **/
9 auditLogs: AuditLog[]
10}
11
Yorum Yapısı
A Comment object represents a comment left by a user.
The relationship between parent and child comments is defined via parentId.
The structure for the Comment object is as follows:
Yorum Yapısı
Copy
1
2interface Comment {
3 /** READONLY: Set to true if the spam engine determined the comment was spam. **/
4 aiDeterminedSpam?: boolean
5 /** Whether the comment is approved to show. Set to true when saving the comment, else it will be hidden. **/
6 approved?: boolean
7 /** The user's avatar. **/
8 avatarSrc?: string
9 /** Child comments. Not populated in all scenarios. Used when asTree is set to true via the API. **/
10 children: Comment[]
11 /** The commenter's raw comment. **/
12 comment: string
13 /** READONLY: The commenter's comment parsed into HTML. **/
14 commentHTML?: string
15 /** The commenter's email. Required if anonymous commenting is off. **/
16 commenterEmail?: string
17 /** The commenter's link (for example, their blog). **/
18 commenterLink?: string
19 /** The commenter's name. Always required. If not available, set to something like "Anonymous". **/
20 commenterName: string
21 /** The date the comment was left, in UTC epoch. **/
22 date: number
23 /** The "display label" for the comment - for example "Admin", "Moderator", or something like "VIP User". **/
24 displayLabel?: string
25 /** The domain the comment was posted on. **/
26 domain?: string
27 /** READONLY: The number of times the comment was flagged. **/
28 flagCount?: number
29 /** The #hashtags written in the comment that were successfully parsed. You can also manually add hashtags, for querying, but they won't display in the comment text automatically. **/
30 hashTags?: CommentHashTag[]
31 /** READONLY: Does the comment contain images? **/
32 hasImages?: boolean
33 /** READONLY: Does the comment contain links? **/
34 hasLinks?: boolean
35 /** READONLY: The unique comment id. **/
36 id: string
37 /** Only on create! This is hashed for storage. **/
38 ip?: string
39 /** READONLY: Did the current user block the user that wrote this comment? **/
40 isBlocked?: boolean
41 /** READONLY: Is the comment by an admin? Automatically set based on userId. **/
42 isByAdmin?: boolean
43 /** READONLY: Is the comment by a moderator? Automatically set based on userId. **/
44 isByModerator?: boolean
45 /** Set to true if the comment was soft deleted (placeholder had to be left due to some other configuration). **/
46 isDeleted?: boolean
47 /** Set to true if the user's account was deleted and the comment had to be retained. **/
48 isDeletedUser?: boolean
49 /** READONLY: Is the flagged by the currently logged-in user (contextUserId)? **/
50 isFlagged?: boolean
51 /** Is the comment pinned? **/
52 isPinned?: boolean
53 /** Is the comment locked for new replies (moderators still can reply)? **/
54 isLocked?: boolean
55 /** Is the comment spam? **/
56 isSpam?: boolean
57 /** READONLY: Is the comment voted down for the current user (contextUserId)? **/
58 isVotedDown?: boolean
59 /** READONLY: Is the comment voted up for the current user (contextUserId)? **/
60 isVotedUp?: boolean
61 /** The locale the comment is in. If not provided, will be derived from the language accept HTTP header. **/
62 locale?: 'de_de' | 'en_us' | 'es_es' | 'fr_fr' | 'it_it' | 'ja_jp' | 'ko_kr' | 'pl_pl' | 'pt_br' | 'ru_ru' | 'tr_tr' | 'zh_cn' | 'zh_tw'
63 /** READONLY: The @mentions written in the comment that were successfully parsed. **/
64 mentions?: CommentUserMention[]
65 /** Optional metadata associated with the comment. **/
66 meta?: Record<string, string | number | boolean>
67 /** The optional list of moderation group ids associated with this comment. **/
68 moderationGroupIds?: string[]|null
69 /** READONLY: The id of the vote object that corresponds to the vote from the current user (contextUserId) on this comment. **/
70 myVoteId?: string
71 /** Whether notifications were sent for this comment for commenters. To prevent notifications being sent on imports, set this to true. **/
72 notificationSentForParent?: boolean
73 /** Whether notifications were sent for this comment for tenant users. To prevent notifications being sent on imports, set this to true. **/
74 notificationSentForParentTenant?: boolean
75 /** The title of the page this comment was on. **/
76 pageTitle?: string
77 /** If we're replying to a comment, this is the ID that we are replying to. **/
78 parentId?: string|null
79 /** Whether the comment is marked reviewed. **/
80 reviewed: boolean
81 /** The tenant id where the comment belongs. **/
82 tenantId: string
83 /** The user that wrote the comment. Created automatically when saving a comment with a name/email. **/
84 userId?: string|null
85 /** The URL to the location that this comment is visible, like a blog post. **/
86 url: string
87 /** A "cleaned" version of the urlId you passed us. When saving, you specify this field, but when you fetch the comment back this will be "cleaned" and your original value moved to "urlIdRaw". **/
88 urlId: string
89 /** READONLY: The original urlId you passed us. **/
90 urlIdRaw?: string
91 /** Is the user and this comment verified? **/
92 verified: boolean
93 /** Number of votes up. **/
94 votesUp?: number
95 /** Number of votes down. **/
96 votesDown?: number
97 /** The "karma" of the comment (= votes up - votes down). **/
98 votes?: number
99}
100
Some of these fields are marked READONLY - these are returned by the API but cannot be set.
Comment Text Structure
Comments are written in a FastComments flavor of markdown, which is just markdown plus traditional bbcode style tags for images, like [img]path[/img].
Text is stored in two fields. The text the user entered is stored unmodified in the comment field. This is rendered and stored in the commentHTML field.
The allowed HTML tags are b, u, i, strike, pre, span, code, img, a, strong, ul, ol, li, and br.
It's recommended to render the HTML, since it is a very small subset of HTML, building a renderer is pretty straightforward. There are multiple libraries for React Native and Flutter, for instance, to help with this
You may choose to render the un-normalized value of the comment field. An example parser is here..
The example parser could also be adjusted to work with HTML, and transform the HTML tags into expected elements to render for your platform.
Tagging
When users are tagged in a comment, the information is stored in a list called mentions. Each object in that list
has the following structure.
Yorumdaki Kullanıcı Etiketi Nesnesi
Copy Run 
Run 1
2interface CommentUserMention {
3 /** The user id. For SSO users, this will have your tenant id prefixed. **/
4 id: string
5 /** The final @mention tag text, including the @ symbol. **/
6 tag: string
7 /** The original @mention tag text, including the @ symbol. **/
8 rawTag: string
9 /** What type of user was tagged. user = FastComments.com account. sso = SSOUser. **/
10 type: 'user'|'sso'
11 /** If the user opts out of notifications, this will still be set to true. **/
12 sent: boolean
13}
14
HashTags
When hashtags are used and successfully parsed, the information is stored in a list called hashTags. Each object in that list
has the following structure. Hashtags can also be manually added to the comment hashTags array for querying, if retain is set.
Yorum Hashtag Nesnesi
Copy Run
Run 1
2interface CommentHashTag {
3 /** The hashtag id. **/
4 id: string
5 /** The final #hashtag tag text, including the # symbol. **/
6 tag: string
7 /** If the hashtag is associated with a custom URL, this will be defined. **/
8 url?: string
9 /** If we should retain the hashtag, even if it does not exist in the comment text, when the comment is updated. Useful for tagging comments without changing comment text. **/
10 retain?: boolean
11}
12
GET /api/v1/comments
Resource: Comment as GET /api/v1/comments Credit Cost: 1
Bu API, bir kullanıcıya gösterim için yorumları almak amacıyla kullanılır. Örneğin, onaylanmamış veya spam yorumları otomatik olarak filtreler.
Sayfalama
Sayfalama, performans gereksinimlerine ve kullanım durumuna bağlı olarak iki yoldan biriyle yapılabilir:
- En Hızlı: Önceden Hesaplanmış Sayfalama:
- Bu, önceden oluşturulmuş widget'larımızı ve istemcilerimizi kullandığınızda FastComments'in nasıl çalıştığıdır.
- "İleri"ye tıklamak yalnızca sayfa sayısını artırır.
- Bunu bir anahtar-değer deposundan getiriliyormuş gibi düşünebilirsiniz.
- Bu şekilde,
pageparametresini0'dan başlayarak ve bir sıralama yönünüdirectionolarak tanımlamanız yeterlidir. - Sayfa boyutları özelleştirme kurallarıyla ayarlanabilir.
- En Esnek: Esnek Sayfalama:
- Bu şekilde özel
limitveskipparametreleri tanımlayabilirsiniz.pagegöndermeyin. directionsıralama yönü de desteklenir.limit,skipuygulandıktan sonra döndürülecek toplam sayıdır.- Örnek:
sayfa boyutu = 100vepage = 2olduğundaskip = 200, limit = 100olarak ayarlayın.
- Örnek:
- Alt yorumlar (child) yine sayfalama içinde sayılır. Bunu
asTreeseçeneğini kullanarak aşabilirsiniz.- Alt yorumları
limitChildrenveskipChildrenile sayfalandırabilirsiniz. - Döndürülecek konuların derinliğini
maxTreeDepthile sınırlayabilirsiniz.
- Alt yorumları
- Bu şekilde özel
Konular (Threads)
Önceden Hesaplanmış Sayfalamakullanıldığında, yorumlar sayfa bazında gruplanır ve konulardaki yorumlar genel sayfayı etkiler.- Bu şekilde, konular
parentId'ye göre istemci tarafında belirlenebilir. - Örneğin; bir sayfada bir üst düzey yorum ve 29 cevap varsa ve API'de
page=0ayarlanmışsa — sadece üst düzey yorumu ve 29 çocuğu alırsınız. - Çoklu sayfaları gösteren örnek resim burada.
- Bu şekilde, konular
Esnek Sayfalamakullanıldığında, birparentIdparametresi tanımlayabilirsiniz.- Sadece üst düzey yorumları almak için bunu null olarak ayarlayın.
- Konuları görüntülemek için API'yi tekrar çağırın ve
parentIdgönderin. - Yaygın bir çözüm, üst düzey yorumlar için bir API çağrısı yapmak ve ardından her yorumun çocuk yorumlarını almak için paralel API çağrıları yapmaktır.
- YENİ Şubat 2023 itibarıyla!
&asTree=truekullanarak ağaç olarak getirin.- Bunu
Ağaç Olarak Esnek Sayfalamaolarak düşünebilirsiniz. - Sadece üst düzey yorumlar sayfalamada sayılır.
- Ağacı kökten başlatmak için
parentId=nullayarlayın (bu parametreyi ayarlamanız gerekir). - Sayfalama için
skipvelimitayarlayın. asTreedeğerinitrueyapın.- Bu senaryoda, altyapımızın daha fazla işlem yapması gerektiği için kredi maliyeti
2xartar. - İstediğiniz şekilde
maxTreeDepth,limitChildrenveskipChildrenayarlayın.
- Bunu
Ağaçlar Açıklaması
asTree kullanıldığında, sayfalama hakkında akıl yürütmek zor olabilir. İşte faydalı bir görsel:
Ağaç Sayfalama Diyagramı
Yorumları Bir Kullanıcı Bağlamında Getirme
/comments API'si, farklı kullanım durumları için iki bağlamda kullanılabilir:
- Kendi istemcinizi oluşturmak için sıralanmış ve bilgi ile etiketlenmiş yorumları döndürmek için.
- Bu durumda, bir
contextUserIdsorgu parametresi tanımlayın.
- Bu durumda, bir
- Özel entegrasyonlar için backend'inizden yorumları almak için.
- Platform,
contextUserIdolmadan buna varsayılan davranır.
- Platform,
Yorumlar Önceden Hesaplanmış Sayfalama
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/comments?tenantId=demo&page=0&urlId=test&API_KEY=DEMO_API_SECRET&direction=MR'
4
Yorumlar Esnek Sayfalama
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/comments?tenantId=demo&urlId=test&API_KEY=DEMO_API_SECRET&direction=MR&skip=20&limit=10'
4
Kullanıcı Bağlamında Yorumlar — Esnek Sayfalama
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/comments?tenantId=demo&urlId=test&API_KEY=DEMO_API_SECRET&direction=MR&skip=20&limit=10&contextUserId=my-user-id'
4
Kullanıcı Bağlamında Yalnızca Üst Düzey Yorumlar için Esnek Sayfalama
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/comments?tenantId=demo&urlId=test&API_KEY=DEMO_API_SECRET&direction=MR&skip=20&limit=10&contextUserId=my-user-id&parentId=null'
4
Yorumları Ağaç Olarak Alma
Yorumların, sayfalama yalnızca üst düzey yorumları sayacak şekilde ağaç olarak dönmesi mümkündür.
Kullanıcı Bağlamında Yorumlar — Ağaç Olarak
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/comments?tenantId=demo&urlId=test&API_KEY=DEMO_API_SECRET&direction=MR&skip=20&limit=10&contextUserId=my-user-id&parentId=null&asTree=true'
4
Sadece üst düzey yorumları ve bunların hemen çocuklarını mı almak istiyorsunuz? İşte bir yol:
Yorumlar Ağaç Olarak — Maksimum Derinlik
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/comments?tenantId=demo&urlId=test&API_KEY=DEMO_API_SECRET&direction=MR&skip=20&limit=10&contextUserId=my-user-id&parentId=null&asTree=true&maxTreeDepth=1&limitChildren=10'
4
Ancak, UI'nizde her yorumda bir "cevapları göster" düğümü gösterip göstermeyeceğinizi bilmeniz gerekebilir. Yorumları ağaç olarak alırken, ilgili olduğunda yorumlara eklenen hasChildren özelliği vardır.
Etiket (Hash Tag) ile Ağaç Olarak Yorum Alma
API ile tüm kiracı (tenant) kapsamında (tek bir sayfa veya urlId ile sınırlı olmadan) etiket ile arama yapmak mümkündür.
Bu örnekte urlId'yi atlıyoruz ve birden fazla etiket ile arama yapıyoruz. API yalnızca istenen tüm etiketlere sahip yorumları döndürecektir.
Kullanıcı Bağlamında Yorumlar Ağaç Olarak, Etikete Göre
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/comments?tenantId=demo&API_KEY=DEMO_API_SECRET&direction=MR&skip=20&limit=10&contextUserId=my-user-id&parentId=null&asTree=true&hashTag=TestTag&hashTag=OtherTestTag'
4
Tüm İstek Parametreleri
Yorumlar İstek Yapısı
Copy
1
2interface CommentsRequestQueryParams {
3 tenantId: string
4 API_KEY: string
5 /** The urlId (page url, or article id) the comments are associated with. **/
6 urlId?: string
7 /** Limit the comments returned by this user. **/
8 userId?: string
9 /** Use this to search by hashtag. To drill down to the intersection of multiple hashtags, do &hashTag=a&hashTag=b. **/
10 hashTag?: string
11 /** The sort direction. Default is MR (Most Relevant). Other options are OF (Oldest First) and NF (Newest First). **/
12 direction?: 'MR' | 'OF' | 'NF'
13 /** Precalculated Pagination: The page to fetch, starting with 0. Pass -1 for all comments (up to 250). **/
14 page?: number
15 /** Flexible Pagination: How many comments should we return? **/
16 limit?: number
17 /** Flexible Pagination: How many child comments should we return for each parent? **/
18 limitChildren?: number
19 /** Flexible Pagination: How many comments should we skip? **/
20 skip?: number
21 /** Flexible Pagination: How many child comments should we skip for each parent? **/
22 skipChildren?: number
23 /** For determining blocked and flagged comments. **/
24 contextUserId?: string
25 /** For determining blocked and flagged comments. **/
26 anonUserId?: string
27 /** For fetching child comments. **/
28 parentId?: string
29 /** For fetching as a tree. **/
30 asTree?: boolean
31 /** How far into the tree should we return data? 0 returns no children. 1 returns immediate children, etc. **/
32 maxTreeDepth?: number
33}
34
Yanıt
Yorumlar Yanıt Yapısı
Copy
1
2interface CommentsResponse {
3 status: 'success' | 'failed'
4 /** Included on failure. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-url-id' | 'missing-date' | 'unauthorized-page' | 'invalid-pagination-request' | 'invalid-limit' | 'invalid-limit-children' | 'invalid-skip' | 'invalid-skip-children' | 'invalid-max-tree-depth'
6 /** Included on failure. **/
7 reason?: string
8 /** The comments! **/
9 comments: Comment[]
10}
11
Faydalı İpuçları
URL ID
Muhtemelen urlId parametresiyle Comment API'sini kullanmak isteyeceksiniz. Hangi urlId değerlerinin size sunulduğunu görmek için önce Pages API'sini çağırabilirsiniz.
Anonim İşlemler
Anonim yorum için muhtemelen yorumları alırken ve bayraklama (flagging) ve engelleme (blocking) işlemlerini yaparken anonUserId göndermek isteyeceksiniz.
(!) Bu, birçok uygulama mağazası için gereklidir çünkü kullanıcılar giriş yapmamış olsalar bile görebildikleri kullanıcı tarafından oluşturulmuş içeriği işaretleyebilmelidir. Bunu yapmamak uygulamanızın ilgili mağazadan kaldırılmasına neden olabilir.
Yorumlar Döndürülmüyor
Yorumlarınızın onaylandığını ve spam olmadığını kontrol edin.
GET /api/v1/comments/:id
Resource: Comment as GET /api/v1/comments/:id Credit Cost: 1
Bu API, bir yorumu id ile almanızı sağlar.
Yorumu ID ile Getirme cURL Örneği
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/comments/some-id?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
Yorumu ID ile Getirme İstek Yapısı
Copy
1
2interface CommentsGetByIdQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
Yorumu ID ile Getirme Yanıt Yapısı
Copy
1
2interface CommentGetByIdResponse {
3 status: 'success' | 'failed'
4 /** Başarısızlık halinde dahil edilir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'not-found' | 'missing-id'
6 /** Başarısızlık halinde dahil edilir. **/
7 reason?: string
8 /** Yorum! **/
9 comment?: Comment
10}
11
POST /api/v1/comments
Resource: Comment as POST /api/v1/comments Credit Cost: 1
Bu API uç noktası yorum oluşturma yeteneği sağlar.
Yaygın kullanım durumları özel kullanıcı arayüzleri, entegrasyonlar veya içe aktarımlardır.
Notlar:
- Bu API, istenirse yorum widget'ını "canlı" olarak güncelleyebilir (bu,
creditsCost'u1'den2'ye çıkarır). - E-posta sağlanırsa bu API sistemimizde otomatik olarak kullanıcı nesneleri oluşturur.
- Farklı e-postalara sahip iki yorumu, fakat aynı kullanıcı adıyla kaydetmeye çalışmak, ikinci yorum için bir hata ile sonuçlanır.
- Eğer
parentIdbelirtiyorsanız ve bir alt yorumunnotificationSentForParentdeğeri false ise, ebeveyn yorum için bildirimler göndereceğiz. Bu her saat yapılır (gönderilen e-posta sayısını azaltmak için bildirimleri toplu olarak gönderiyoruz). - Kullanıcı oluşturulurken karşılama e-postaları veya yorum doğrulama e-postaları göndermek istiyorsanız, sorgu parametrelerinde
sendEmailsdeğerinitrueolarak ayarlayın. - Bu API aracılığıyla oluşturulan yorumlar yönetici uygulamasının Analytics ve Moderation sayfalarında görünecektir.
- Ayar açık ise, "bad words" yorumcu isimlerinde ve yorum metninde hâlâ maskelenir.
- Bu API ile oluşturulan yorumlar istenirse yine de spam için kontrol edilebilir.
- Özelleştirme Kuralı yönetici sayfası aracılığıyla yapılandırıldıysa, maksimum yorum uzunluğu gibi yapılandırmalar burada uygulanır.
Yorum widget'ında görüntülenecek şekilde göndermek için gereken minimum veriler aşağıdaki gibidir:
Minimum Yorum POST cURL Örneği
Copy
1
2curl --request POST \
3 --url 'https://fastcomments.com/api/v1/comments?tenantId=demo&API_KEY=DEMO_API_SECRET&isLive=true' \
4 --header 'Content-Type: application/json' \
5 --data '{
6 "approved": true,
7 "comment": "some-comment",
8 "commenterName": "some-commenter-name",
9 "date": 1622644382148,
10 "urlId": "some-place",
11 "url": "https://exmaple.com/some-page",
12 "verified": true
13}'
14
Daha gerçekçi bir istek şöyle görünebilir:
Yorum POST cURL Örneği
Copy
1
2curl --request POST \
3 --url 'https://fastcomments.com/api/v1/comments?tenantId=demo&API_KEY=DEMO_API_SECRET&isLive=true&doSpamCheck=true' \
4 --header 'Content-Type: application/json' \
5 --data '{
6 "approved": true,
7 "avatarSrc": "https://static.fastcomments.com/1605337537848-DSC_0841.JPG",
8 "comment": "some-comment",
9 "commenterName": "some-commenter-name",
10 "commenterEmail": "fordperfect@spaceship.com",
11 "date": 1622644382148,
12 "isSpam": false,
13 "locale": "en_us",
14 "notificationSentForParent": true,
15 "notificationSentForParentTenant": true,
16 "reviewed": true,
17 "urlId": "some-place",
18 "url": "https://exmaple.com/some-page",
19 "verified": true,
20 "votes": 1,
21 "votesUp": 2,
22 "votesDown": 1,
23 "ip": "123.456.789.000"
24}'
25
Yorum POST İstek Yapısı
Copy
1
2interface CommentPostQueryParams {
3 tenantId: string
4 API_KEY: string
5 doSpamCheck?: 'true' | 'false'
6 /** Yorumun aynı urlId'ye sahip yorum widget örneklerini görüntüleyen kullanıcılara "canlı" olarak görünmesi gerekip gerekmediği. NOT: Kredi maliyetini 1'den 2'ye çıkarır. **/
7 isLive?: 'true' | 'false'
8 sendEmails?: 'true' | 'false'
9 populateNotifications?: 'true' | 'false'
10}
11
Yorum POST Yanıt Yapısı
Copy
1
2
3interface CommentPostResponse {
4 status: 'success' | 'failed'
5 /** Başarısızlık durumunda eklenir. **/
6 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-url-id' | 'empty-comment' | 'comment-too-big' | 'hash-tags-readonly' | 'mentions-readonly' | 'invalid-user' | 'unauthorized' | 'invalid-date' | 'invalid-name' | 'invalid-name-is-email' | 'banned' | 'invalid-email';
7 /** Başarısızlık durumunda eklenir. **/
8 reason?: string
9 /** Oluşturulan yorum. **/
10 comment?: Comment
11 /** İlişkili kullanıcı; önceden var olup olmadığı değişebilir. **/
12 user?: User
13}
14
PATCH /api/v1/comments/:id
Resource: Comment as PATCH /api/v1/comments/:id Credit Cost: 1
Bu API uç noktası tek bir yorumu güncelleme yeteneği sağlar.
Notlar:
- Bu API, istenirse yorum widget'ını "canlı" olarak güncelleyebilir (bu, temel
creditsCostdeğerini1'den2'ye yükseltir).- Bu, yorumları sayfalar arasında "canlı" olarak taşımayı sağlayabilir (
urlId'yi değiştirmek). - Taşımalar, sayfalar önceden hesaplandığı ve bu CPU yoğun olduğu için ek
2kredi maliyeti getirir.
- Bu, yorumları sayfalar arasında "canlı" olarak taşımayı sağlayabilir (
- Oluşturma API'sinin aksine, bu API e-posta sağlanmış olsa bile sistemimizde kullanıcı nesnelerini OTOMATİK olarak oluşturmaz.
- Bu API aracılığıyla güncellenen yorumlar istenirse yine de spam için kontrol edilebilir.
- Özelleştirme Kuralı yönetici sayfası aracılığıyla yapılandırılmışsa maksimum yorum uzunluğu gibi yapılandırmalar burada uygulanır.
- Kullanıcıların yorum metinlerini güncellemelerine izin vermek için istek gövdesinde yalnızca
comment'i belirtebilirsiniz. Ortaya çıkacakcommentHTML'i biz oluşturacağız.- Hem
commenthem decommentHTMLbelirlerseniz HTML'i otomatik olarak oluşturmayacağız. - Kullanıcı yeni metnine bahsetmeler veya hashtag'ler eklerse, bu yine
POSTAPI'si gibi işlenecektir.
- Hem
- Bir yorumda
commenterEmailgüncellenirken,userId'yi de belirtmek en iyisidir. Aksi takdirde, bu e-postaya sahip kullanıcının kiracınıza ait olduğundan emin olmanız gerekir; aksi halde istek başarısız olur.
Minimum Yorum PATCH cURL Örneği
Copy
1
2curl --request PATCH \
3 --url 'https://fastcomments.com/api/v1/comments/some-comment-id?tenantId=demo&API_KEY=DEMO_API_SECRET&isLive=true' \
4 --header 'Content-Type: application/json' \
5 --data '{
6 "comment": "some-new-comment-text"
7}'
8
Yorum PATCH İstek Yapısı
Copy
1
2interface CommentPatchQueryParams {
3 tenantId: string
4 API_KEY: string
5 /** Güncellemeyi yapan kullanıcı. İstenirse yorumun düzenleyip düzenleyemeyeceğini kontrol etmek için kullanılabilir. **/
6 contextUserId?: string
7 /** Yeni yorumun spam gibi görünüp görünmediğini kontrol etmeli miyiz? **/
8 doSpamCheck?: 'true' | 'false'
9 /** Yorumun aynı urlId ile yorum widget'ı örneklerini görüntüleyen kullanıcılara "canlı" olarak görünüp görünmeyeceği. NOT: Kredi maliyetini 1'den 2'ye katlar. **/
10 isLive?: 'true' | 'false'
11}
12
Yorum PATCH Yanıt Yapısı
Copy
1
2
3interface CommentPatchResponse {
4 status: 'success' | 'failed'
5 /** Başarısızlık durumunda dahil edilir. **/
6 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-url-id' | 'empty-comment' | 'comment-too-big' | 'hash-tags-readonly' | 'mentions-readonly' | 'invalid-user' | 'unauthorized' | 'invalid-date' | 'invalid-name' | 'invalid-name-is-email' | 'banned' | 'invalid-email' | 'invalid-input' | 'missing-id' | 'not-found'
7 /** Başarısızlık durumunda dahil edilir. **/
8 reason?: string
9}
10
DELETE /api/v1/comments/:id
Resource: Comment as DELETE /api/v1/comments/:id Credit Cost: 1
Bu API uç noktası bir yorumu silme yeteneği sağlar.
Notlar:
- İstenirse bu API yorum bileşenini "live" olarak güncelleyebilir (bu,
creditsCostdeğerini1'den2'ye çıkarır). - Bu API tüm alt yorumları siler.
Yorum Silme cURL Örneği
Copy
1
2curl --request DELETE \
3 --url 'https://fastcomments.com/api/v1/comments/some-comment-id?tenantId=demo&API_KEY=DEMO_API_SECRET' \
4 --header 'Content-Type: application/json'
5
Yorum Silme İstek Yapısı
Copy
1
2interface CommentDeleteQueryParams {
3 tenantId: string
4 API_KEY: string
5 /** Güncellemeyi yapan kullanıcı. İstenirse bu, kullanıcının yorumu silebileceğini kontrol etmek için kullanılabilir. **/
6 contextUserId?: string
7 /** Yorumun aynı urlId'ye sahip yorum bileşeni örneklerini görüntüleyen kullanıcılara "live" olarak silinip silinmeyeceği. NOT: Kredi maliyetini 1'den 2'ye iki katına çıkarır. **/
8 isLive?: 'true' | 'false'
9}
10
Yorum Silme Yanıt Yapısı
Copy
1
2
3interface CommentDeleteResponse {
4 status: 'success' | 'failed'
5 /** Başarısızlık durumunda dahil edilir. **/
6 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found'
7 /** Başarısızlık durumunda dahil edilir. **/
8 reason?: string
9}
10
POST /api/v1/comments/:id/flag
Resource: Comment as POST /api/v1/comments/:id/flag Credit Cost: 1
Bu API uç noktası, belirli bir kullanıcı için bir yorumu işaretleme (flag) yeteneği sağlar.
Notes:
- Bu çağrı her zaman bir kullanıcı bağlamında yapılmalıdır. Kullanıcı FastComments.com Kullanıcısı, SSO Kullanıcısı veya Tenant Kullanıcısı olabilir.
- Eğer bir flag-to-hide eşiği ayarlanmışsa, yorum tanımlanan sayıda işaretlendikten sonra canlı olarak otomatik gizlenecektir.
- Otomatik olarak onayı kaldırıldıktan (gizlendikten) sonra - yorum yalnızca bir yönetici veya moderatör tarafından yeniden onaylanabilir. İşaretin kaldırılması yorumu yeniden onaylamaz.
Yorum İşaretleme cURL Örneği
Copy
1
2curl --request POST \
3 --url 'https://fastcomments.com/api/v1/comments/some-comment-id/flag?tenantId=demo&API_KEY=DEMO_API_SECRET&userId=some-user-id' \
4 --header 'Content-Type: application/json'
5
Anonim işaretleme için bir anonUserId belirtmemiz gerekir. Bu, anonim oturumu temsil eden bir kimlik veya rastgele bir UUID olabilir. Bu, bir kullanıcı giriş yapmamış olsa bile yorumları işaretleme ve işaret kaldırmayı desteklememizi sağlar. Bu şekilde, aynı anonUserId ile yorumlar alındığında yorum işaretlenmiş olarak işaretlenebilir.
Anonim Yorum İşaretleme cURL Örneği
Copy
1
2curl --request POST \
3 --url 'https://fastcomments.com/api/v1/comments/some-comment-id/flag?tenantId=demo&API_KEY=DEMO_API_SECRET&anonUserId=some-anon-user-id' \
4 --header 'Content-Type: application/json'
5
Yorum İşaretleme İstek Yapısı
Copy
1
2interface CommentFlagQueryParams {
3 tenantId: string
4 API_KEY: string
5 userId?: string
6 anonUserId?: string
7}
8
Yorum İşaretleme Yanıt Yapısı
Copy
1
2
3interface CommentFlagResponse {
4 status: 'success' | 'failed'
5 /** Hata durumunda dahil edilir. **/
6 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found' | 'missing-user-id' | 'missing-anon-user-id'
7 /** Hata durumunda dahil edilir. **/
8 reason?: string
9 /** Yorum belirlenen sayıda işaretlendiği için onayı kaldırıldı (gizlendi) mı? **/
10 wasUnapproved?: boolean;
11}
12
POST /api/v1/comments/:id/un-flag
Resource: Comment as POST /api/v1/comments/:id/un-flag Credit Cost: 1
Bu API uç noktası, belirli bir kullanıcı için bir yorumun bayrağını kaldırma yeteneği sağlar.
Notlar:
- Bu çağrı her zaman bir kullanıcı bağlamında yapılmalıdır. Kullanıcı, FastComments.com Kullanıcısı, SSO Kullanıcısı veya Kiracı (Tenant) Kullanıcısı olabilir.
- Bir yorum otomatik olarak onaydan çıkarıldıktan (gizlendikten) sonra — yorum yalnızca bir yönetici veya moderatör tarafından yeniden onaylanabilir. Bayrağın kaldırılması yorumu yeniden onaylamaz.
Yorum Bayrağını Kaldırma cURL Örneği
Copy
1
2curl --request POST \
3 --url 'https://fastcomments.com/api/v1/comments/some-comment-id/un-flag?tenantId=demo&API_KEY=DEMO_API_SECRET&userId=some-user-id' \
4 --header 'Content-Type: application/json'
5
Anonim bayraklama için bir anonUserId belirtmeliyiz. Bu, anonim oturumu temsil eden bir kimlik olabilir veya rastgele bir UUID olabilir.
Anonim Yorum Bayraklama cURL Örneği
Copy
1
2curl --request POST \
3 --url 'https://fastcomments.com/api/v1/comments/some-comment-id/un-flag?tenantId=demo&API_KEY=DEMO_API_SECRET&anonUserId=some-anon-user-id' \
4 --header 'Content-Type: application/json'
5
Yorum Bayrağını Kaldırma İstek Yapısı
Copy
1
2interface CommentFlagQueryParams {
3 tenantId: string
4 API_KEY: string
5 userId?: string
6 anonUserId?: string
7}
8
Yorum Bayrağını Kaldırma Yanıt Yapısı
Copy
1
2
3interface CommentUnFlagResponse {
4 status: 'success' | 'failed'
5 /** Hata durumunda dahil edilir. **/
6 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found' | 'missing-user-id' | 'missing-anon-user-id'
7 /** Hata durumunda dahil edilir. **/
8 reason?: string
9}
10
POST /api/v1/comments/:id/block
Resource: Comment as POST /api/v1/comments/:id/block Credit Cost: 1
Bu API uç noktası, belirli bir yorumu yazan kullanıcıyı engelleme yeteneği sağlar. FastComments.com Kullanıcıları, SSO Kullanıcıları ve Tenant Kullanıcıları tarafından yazılan yorumlardan engellemeyi destekler.
Ayrıca, bu işlem gerçekleştirildikten sonra istemcide potansiyel olarak görünür başka hangi yorumların engellenmesi/engeli kaldırılması gerektiğini kontrol etmek için bir commentIdsToCheck gövde parametresini destekler.
Notlar:
- Bu çağrı her zaman bir kullanıcı bağlamında yapılmalıdır. Kullanıcı FastComments.com Kullanıcısı, SSO Kullanıcısı veya Tenant Kullanıcısı olabilir.
- İstek içindeki
userId, engelleme işlemini yapan kullanıcıdır. Örneğin:User A,User B'yi Engellemek istiyor.userId=User AveUser Bnin yazdığı yorum kimliğini gönderin. - Tamamen anonim yorumlar (kullanıcı kimliği yok, e‑posta yok) engellenemez ve bir hata döndürülecektir.
Yorum Engelleme cURL Örneği
Copy
1
2curl --request POST \
3 --url 'https://fastcomments.com/api/v1/comments/some-comment-id/block?tenantId=demo&API_KEY=DEMO_API_SECRET&userId=some-user-id' \
4 --header 'Content-Type: application/json'
5
Anonim engelleme için bir anonUserId belirtmeliyiz. Bu, anonim oturumu temsil eden bir kimlik veya rastgele bir UUID olabilir.
Bu, bir kullanıcı oturum açmamış olsa bile aynı anonUserId ile yorumlar alınarak yorumları engellemeyi desteklememizi sağlar.
Anonim Yorum Engelleme cURL Örneği
Copy
1
2curl --request POST \
3 --url 'https://fastcomments.com/api/v1/comments/some-comment-id/block?tenantId=demo&API_KEY=DEMO_API_SECRET&anonUserId=some-anon-user-id' \
4 --header 'Content-Type: application/json'
5
Yorum Engelleme İstek Yapısı
Copy
1
2interface CommentBlockQueryParams {
3 tenantId: string
4 API_KEY: string
5 userId?: string
6 anonUserId?: string
7 commentIdsToCheck?: string[]
8}
9
Yorum Engelleme Yanıt Yapısı
Copy
1
2
3interface CommentBlockResponse {
4 status: 'success' | 'failed'
5 /** Başarısızlık durumunda dahil edilir. **/
6 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found' | 'missing-user-id' | 'missing-anon-user-id' | 'comment-cannot-be-blocked'
7 /** Başarısızlık durumunda dahil edilir. **/
8 reason?: string
9 /** Eğer commentIdsToCheck tanımlanmışsa, bu eşleştirmede true olan girdiler de engellenir. **/
10 commentStatuses?: Record<string, boolean>;
11}
12
POST /api/v1/comments/:id/un-block
Resource: Comment as POST /api/v1/comments/:id/un-block Credit Cost: 1
Bu API uç noktası, belirli bir yorumu yazmış bir kullanıcının engellemesini kaldırma yeteneği sağlar. FastComments.com Users, SSO Users, and Tenant Users tarafından yazılmış yorumların engellemesini kaldırmayı destekler.
Bu işlem gerçekleştirildikten sonra istemcideki diğer potansiyel olarak görünür yorumların engellenip/engellenmeyeceğini kontrol etmek için commentIdsToCheck gövde parametresini destekler.
Notlar:
- Bu çağrı her zaman bir kullanıcı bağlamında yapılmalıdır. Kullanıcı FastComments.com User, SSO User, veya Tenant User olabilir.
- İstek içindeki
userId, engelleme kaldırma işlemini yapan kullanıcıdır. Örneğin:User AUser B'nin engellemesini kaldırmak istiyor.userId=User AveUser Btarafından yazılan yorumun id'sini gönderin. - Tamamen anonim yorumlar (kullanıcı kimliği yok, e-posta yok) engellenemez ve bir hata döndürülecektir.
Yorumun Engellenmesini Kaldırma cURL Örneği
Copy
1
2curl --request POST \
3 --url 'https://fastcomments.com/api/v1/comments/some-comment-id/un-block?tenantId=demo&API_KEY=DEMO_API_SECRET&userId=some-user-id' \
4 --header 'Content-Type: application/json'
5
Anonim Yorumun Engellenmesini Kaldırma cURL Örneği
Copy
1
2curl --request POST \
3 --url 'https://fastcomments.com/api/v1/comments/some-comment-id/un-block?tenantId=demo&API_KEY=DEMO_API_SECRET&anonUserId=some-anon-user-id' \
4 --header 'Content-Type: application/json'
5
Yorumun Engellenmesini Kaldırma İstek Yapısı
Copy
1
2interface CommentUnBlockQueryParams {
3 tenantId: string
4 API_KEY: string
5 userId?: string
6 anonUserId?: string
7 commentIdsToCheck?: string[]
8}
9
Yorumun Engellenmesini Kaldırma Yanıt Yapısı
Copy
1
2
3interface CommentUnBlockResponse {
4 status: 'success' | 'failed'
5 /** Başarısızlık durumunda dahil edilir. **/
6 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found' | 'missing-user-id' | 'missing-anon-user-id' | 'comment-cannot-be-blocked'
7 /** Başarısızlık durumunda dahil edilir. **/
8 reason?: string
9 /** Eğer commentIdsToCheck tanımlıysa, bu haritadaki true olan girdiler hâlâ engellenmiştir. False ise, kullanıcıların sayfayı yenilemek zorunda kalmamaları için yorumların görünürlüğünü geri açmak isteyebilirsiniz. **/
10 commentStatuses?: Record<string, boolean>;
11}
12
E-posta Şablonu Yapısı
Bir EmailTemplate nesnesi, bir kiracı için özel bir e-posta şablonunun yapılandırmasını temsil eder.
Sistem, kullanılacak e-posta şablonunu şu yolla seçer:
- Türünü belirten tanımlayıcı, buna
emailTemplateIddiyoruz. Bunlar sabittir. domain. İlgili nesnenin (ör. birComment) bağlı olduğu domain için önce bir şablon bulmaya çalışacağız; eşleşme bulunmazsa domain'in null veya*olduğu bir şablon arayacağız.
EmailTemplate nesnesinin yapısı aşağıdaki gibidir:
E-posta Şablon Yapısı
Copy
1
2interface EmailTemplate {
3 id: string
4 tenantId: string
5 emailTemplateId: string
6 displayName: string
7 /** SADECE OKUNUR **/
8 createdAt: string
9 /** SADECE OKUNUR **/
10 updatedAt: string
11 /** SADECE OKUNUR **/
12 updatedByUserId: string
13 /** Şablonun ilişkilendirileceği domain. **/
14 domain?: string | '*' | null
15 /** EJS sözdiziminde e-posta şablonu içeriği. **/
16 ejs: string
17 /** Her desteklenen yerel için geçersiz kılınmış çeviri anahtarlarının değerlerini içeren bir harita. **/
18 translationOverridesByLocale: Record<string, Record<string, string>>
19 /** Şablonun render bağlamını temsil eden bir nesne. **/
20 testData: object
21}
22
Notlar
- Geçerli
emailTemplateIddeğerlerini/definitionsuç noktasından alabilirsiniz. /definitionsuç noktası ayrıca varsayılan çevirileri ve test verilerini içerir.- Geçersiz yapı veya test verileri durumunda şablonlar kaydedilemez.
GET /api/v1/email-templates/:id
Resource: EmailTemplate as GET /api/v1/email-templates/:id Credit Cost: 1
Bireysel EmailTemplates, karşılık gelen id ile alınabilir (NOT emailTemplateId).
ID ile EmailTemplate cURL Örneği
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/email-templates/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
ID ile EmailTemplate İstek Yapısı
Copy
1
2interface EmailTemplatesByIdRequestQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
ID ile EmailTemplate Yanıt Yapısı
Copy
1
2interface EmailTemplateResponse {
3 status: 'success' | 'failed'
4 /** Başarısızlık durumunda dahil edilir. **/
5 code?: 'internal' | 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'not-found'
6 /** Başarısızlık durumunda dahil edilir. **/
7 reason?: string
8 emailTemplate?: EmailTemplate | null
9}
10
GET /api/v1/email-templates
Resource: EmailTemplate as GET /api/v1/email-templates Credit Cost: 1
Bu API, page sorgu parametresiyle sağlanan sayfalandırma kullanır. EmailTemplate'ler, createdAt sonra id sırasına göre, her sayfada 100 öğe olacak şekilde döndürülür.
EmailTemplate cURL Örneği
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/email-templates?tenantId=demo&page=0&API_KEY=DEMO_API_SECRET'
4
EmailTemplate İstek Yapısı
Copy
1
2interface EmailTemplatesRequestQueryParams {
3 tenantId: string
4 API_KEY: string
5 /** Alınacak sayfa, 0'dan başlar. **/
6 page: number
7}
8
EmailTemplate Yanıt Yapısı
Copy
1
2interface EmailTemplatesResponse {
3 status: 'success' | 'failed'
4 /** Başarısızlık durumunda dahil edilir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
6 /** Başarısızlık durumunda dahil edilir. **/
7 reason?: string
8 emailTemplates: EmailTemplate[]
9}
10
PATCH /api/v1/email-templates/:id
Resource: EmailTemplate as PATCH /api/v1/email-templates/:id Credit Cost: 1
Bu API uç noktası, yalnızca id'yi ve güncellenecek özellikleri belirterek bir e-posta şablonunu güncelleme olanağı sağlar.
Bir şablon oluştururken uygulanan aynı doğrulamalar da geçerlidir, örneğin:
- Şablonun render olması gerekir. Bu, her güncellemede kontrol edilir.
- Aynı alan adı için çoğaltılmış şablonlara sahip olamazsınız (aksi takdirde biri sessizce yoksayılır).
EmailTemplate PATCH cURL Örneği
Copy
1
2curl --request PATCH \
3 --url 'https://fastcomments.com/api/v1/email-templates/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET' \
4 --header 'Content-Type: application/json' \
5 --data '{
6 "displayName": "Some New Name",
7}'
8
EmailTemplate PATCH İstek Yapısı
Copy
1
2interface EmailTemplatePatchQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
EmailTemplate PATCH Yanıt Yapısı
Copy
1
2
3interface EmailTemplatePatchResponse {
4 status: 'success' | 'failed'
5 /** Başarısızlık durumunda dahil edilir. **/
6 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'empty-request' | 'internal' | 'invalid-input' | 'not-found' | 'unexpected-param' | 'invalid-email-template-id' | 'unauthorized' | 'domain-invalid' | 'duplicate' | 'does-not-render';
7 /** Başarısızlık durumunda dahil edilir. **/
8 reason?: string
9 /** Güncellenmiş e-posta şablonu. **/
10 emailTemplate?: EmailTemplate
11}
12
POST /api/v1/email-templates
Resource: EmailTemplate as POST /api/v1/email-templates Credit Cost: 1
Bu API uç noktası e-posta şablonları oluşturma olanağı sağlar.
Notlar:
- Aynı domain ile aynı
emailTemplateId'ye sahip birden fazla şablon olamaz. - Ancak bir joker şablon (
domain=*) ile aynıemailTemplateIdiçin alan adı özel bir şablon birlikte bulunabilir. domainbelirtmek yalnızca farklı alan adlarınız varsa veya test için belirli şablonlar kullanmak istiyorsanız önemlidir (domainset tolocalhostetc).domainbelirtirseniz, bunun birDomainConfigile eşleşmesi gerekir. Hata durumunda geçerli alan adlarının bir listesi sağlanır.- Şablon sözdizimi EJS'tir ve 500ms zaman aşımı ile render edilir. Render süresi için P99 <5ms'dir, bu nedenle 500ms'ye ulaşıyorsanız bir sorun var demektir.
- Kaydetmek için şablonunuz verilen
testDataile render olmalıdır. Render hataları birleştirilir ve kontrol panelinde raporlanır (yakında API üzerinden de kullanılabilir).
Bir şablon eklemek için gereken minimum veriler aşağıdaki gibidir:
Minimum EmailTemplate POST cURL Örneği
Copy
1
2curl --request POST \
3 --url 'https://fastcomments.com/api/v1/email-templates?tenantId=demo&API_KEY=DEMO_API_SECRET' \
4 --header 'Content-Type: application/json' \
5 --data '{
6 "emailTemplateId": "comment-user-mention",
7 "displayName": "I'm a custom template.",
8 "ejs": "This is an @mention notification! My name is <%= comment.commenterName %>."
9}'
10
Site başına şablonlar isteyebilirsiniz; bu durumda domain tanımlarsınız:
EmailTemplate POST cURL Örneği
Copy
1
2curl --request POST \
3 --url 'https://fastcomments.com/api/v1/email-templates?tenantId=demo&API_KEY=DEMO_API_SECRET' \
4 --header 'Content-Type: application/json' \
5 --data '{
6 "emailTemplateId": "comment-user-mention",
7 "displayName": "I'm a custom template.",
8 "ejs": "This is some email content!",
9 "domain": "somespecificsite.com",
10}'
11
EmailTemplate POST İstek Yapısı
Copy
1
2interface EmailTemplatePostQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
EmailTemplate POST Yanıt Yapısı
Copy
1
2
3interface EmailTemplatePostResponse {
4 status: 'success' | 'failed'
5 /** Hata durumunda dahil edilir. **/
6 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'unauthorized' | 'unexpected-param' | 'invalid-email-template-id' | 'domain-invalid' | 'duplicate' | 'does-not-render';
7 /** Hata durumunda dahil edilir. **/
8 reason?: string
9 /** Oluşturulan şablon. **/
10 emailTemplate?: EmailTemplate
11}
12
POST /api/v1/email-templates/render
Resource: EmailTemplate as POST /api/v1/email-templates/render Credit Cost: 1
Bu API uç noktası e-posta şablonlarını önizleme olanağı sağlar.
Minimum EmailTemplate Önizleme POST cURL Örneği
Copy
1
2curl --request POST \
3 --url 'https://fastcomments.com/api/v1/email-templates/render?tenantId=demo&API_KEY=DEMO_API_SECRET' \
4 --header 'Content-Type: application/json' \
5 --data '{
6 "emailTemplateId": "comment-user-mention",
7 "displayName": "I'm a custom template.",
8 "ejs": "This is an @mention notification! My name is <%= comment.commenterName %>."
9}'
10
EmailTemplate POST İstek Yapısı
Copy
1
2interface EmailTemplatePostQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
EmailTemplate POST Yanıt Yapısı
Copy
1
2
3interface EmailTemplatePostResponse {
4 status: 'success' | 'failed'
5 /** Başarısızlık durumunda dahil edilir. **/
6 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'unauthorized' | 'unexpected-param' | 'does-not-render';
7 /** Başarısızlık durumunda dahil edilir. **/
8 reason?: string
9 /** Başarı durumunda oluşturulan HTML. **/
10 html?: string
11}
12
DELETE /api/v1/email-templates/:id
Resource: EmailTemplate as DELETE /api/v1/email-templates/:id Credit Cost: 1
Bu rota, bir EmailTemplate'in id ile kaldırılmasını sağlar.
EmailTemplate Kaldırma cURL Örneği
Copy
1
2curl --request DELETE \
3 --url 'https://fastcomments.com/api/v1/email-templates/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
EmailTemplate Kaldırma İstek Yapısı
Copy
1
2interface EmailTemplateRequestQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
EmailTemplate Kaldırma Yanıt Yapısı
Copy
1
2interface EmailTemplateDeleteResponse {
3 status: 'success' | 'failed'
4 /** Hata durumunda dahil edilir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'not-found' | 'unauthorized'
6 /** Hata durumunda dahil edilir. **/
7 reason?: string
8}
9
Hashtag Yapısı
Bir HashTag nesnesi, bir kullanıcı tarafından bırakılabilecek bir etiketi temsil eder. HashTags harici bir içeriğe bağlamak veya ilişkili yorumları birbirine bağlamak için kullanılabilir.
HashTag nesnesinin yapısı aşağıdaki gibidir:
HashTag Yapısı
Copy
1
2interface HashTag {
3 /** "#" veya istenen karakterle başlamalı. **/
4 tag: string
5 /** Hashtag'in işaret edebileceği isteğe bağlı bir URL. Yorumları hashtag ile filtrelemek yerine, kullanıcı arayüzü tıklanınca buna yönlendirir. **/
6 url?: string
7 /** SADECE OKUNUR **/
8 createdAt: string
9}
10
Notlar:
- Bazı API uç noktalarında hashtag'in URL içinde kullanıldığını göreceksiniz. Değerleri URI ile kodlamayı unutmayın. Örneğin,
#yerine%23olarak temsil edilmelidir. - Bu alanların bazıları
READONLYolarak işaretlenmiştir - bunlar API tarafından döndürülür ancak ayarlanamaz.
GET /api/v1/hash-tags
Resource: HashTag as GET /api/v1/hash-tags Credit Cost: 1
Bu API, page sorgu parametresi ile sağlanan sayfalama kullanır. HashTag'ler tage göre sıralanmış şekilde, 100 öğelik sayfalar halinde döndürülür.
HashTag cURL Örneği
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/hash-tags?tenantId=demo&page=0&API_KEY=DEMO_API_SECRET'
4
HashTag İstek Yapısı
Copy
1
2interface HashTagsRequestQueryParams {
3 tenantId: string
4 API_KEY: string
5 /** Alınacak sayfa, 0'dan başlar. **/
6 page: number
7}
8
HashTag Yanıt Yapısı
Copy
1
2interface HashTagsResponse {
3 status: 'success' | 'failed'
4 /** Hata durumunda dahil edilir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
6 /** Hata durumunda dahil edilir. **/
7 reason?: string
8 /** Hashtag'ler! **/
9 hashTags: HashTag[]
10}
11
PATCH /api/v1/hash-tags/:tag
Resource: HashTag as PATCH /api/v1/hash-tags/:tag Credit Cost: 1
Bu rota tek bir HashTag'ı güncelleme olanağı sağlar.
HashTag Güncelleme cURL Örneği
Copy
1
2curl --request PATCH \
3 --url 'https://fastcomments.com/api/v1/hash-tags/%23example_hash_tag?tenantId=demo&API_KEY=DEMO_API_SECRET' \
4 --header 'Content-Type: application/json' \
5 --data '{
6 "url": "https://example.com/some-`page`"
7}'
8
HashTag Güncelleme İstek Yapısı
Copy
1
2interface HashTagPatchQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
HashTag Güncelleme Yanıt Yapısı
Copy
1
2interface HashTagPatchResponse {
3 status: 'success' | 'failed'
4 /** Başarısızlık durumunda dahil edilir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-hash-tag' | 'tag-does-not-exist' | 'url-too-long' | 'invalid-tag' | 'already-exists'
6 /** Başarısızlık durumunda dahil edilir. **/
7 reason?: string
8 hashTag?: HashTag; // Başarılı olduğunda güncellenen hashtag'in tamamını döneriz.
9}
10
POST /api/v1/hash-tags
Resource: HashTag as POST /api/v1/hash-tags Credit Cost: 1
Bu rota tek bir HashTag ekleme yeteneği sağlar.
HashTag Oluşturma cURL Örneği
Copy
1
2curl --request POST \
3 --url 'https://fastcomments.com/api/v1/hash-tags?tenantId=demo&API_KEY=DEMO_API_SECRET' \
4 --header 'Content-Type: application/json' \
5 --data '{
6 "tag": "#example",
7 "url": "https://example.com/some-page"
8}'
9
HashTag Oluşturma İstek Yapısı
Copy
1
2interface HashTagPostQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
HashTag Oluşturma Yanıt Yapısı
Copy
1
2interface HashTagPostResponse {
3 status: 'success' | 'failed'
4 /** Başarısızlık durumunda dahil edilir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-hash-tag' | 'tag-does-not-exist' | 'url-too-long' | 'invalid-tag'
6 /** Başarısızlık durumunda dahil edilir. **/
7 reason?: string
8 hashTag?: HashTag; // Başarı durumunda oluşturulan hashtag'in tamamını döneriz.
9}
10
POST /api/v1/hash-tags/bulk
Resource: HashTag as POST /api/v1/hash-tags/bulk Credit Cost: 1
Bu yol aynı anda en fazla 100 HashTag nesnesi ekleme yeteneği sağlar.
HashTag Toplu Oluşturma cURL Örneği
Copy
1
2curl --request PATCH \
3 --url 'https://fastcomments.com/api/v1/hash-tags/bulk?tenantId=demo&API_KEY=DEMO_API_SECRET' \
4 --header 'Content-Type: application/json' \
5 --data '{
6 "tags": [
7 {
8 "tag": "#example",
9 "url": "https://example.com/some-page"
10 }
11 ]
12}'
13
HashTag Toplu Oluşturma İstek Yapısı
Copy
1
2interface HashTagPostQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
HashTag Toplu Oluşturma Yanıt Yapısı
Copy
1
2interface HashTagBulkPostResponse {
3 status: 'success' | 'failed'
4 /** Başarısızlık durumunda dahil edilir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-hash-tag' | 'tag-does-not-exist' | 'url-too-long' | 'invalid-tag'
6 /** Başarısızlık durumunda dahil edilir. **/
7 reason?: string
8 results?: HashTagPostResponse[]; // Sağlanan her etiket için bir HashTagPostResponse nesnesi listesi döndürürüz.
9}
10
DELETE /api/v1/hash-tags/:tag
Resource: HashTag as DELETE /api/v1/hash-tags/:tag Credit Cost: 1
Bu rota, sağlanan etiket ile bir HashTag kullanıcısının kaldırılmasını sağlar.
Otomatik HashTag oluşturma devre dışı bırakılmadığı sürece, kullanıcılar yorum yaparken hashtag'i sağlayarak hashtag'leri yeniden oluşturabilir.
HashTag Kaldırma cURL Örneği
Copy
1
2curl --request DELETE \
3 --url 'https://fastcomments.com/api/v1/hash-tags/%23example_hash_tag?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
HashTag Kaldırma İstek Yapısı
Copy
1
2interface HashTagDeleteQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
HashTag Kaldırma Yanıt Yapısı
Copy
1
2interface HashTagDeleteResponse {
3 status: 'success' | 'failed'
4 /** Başarısızlık durumunda dahil edilir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-hash-tag' | 'tag-does-not-exist'
6 /** Başarısızlık durumunda dahil edilir. **/
7 reason?: string
8}
9
Moderatör Yapısı
Bir Moderator object represents configuration for a moderator.
There are three types of moderators:
isCommentModeratorAdminbayrağına sahip yönetici kullanıcılar.isCommentModeratorAdminbayrağına sahip SSO kullanıcıları.- Moderatör olarak davet edilen normal yorumcular veya FastComments.com kullanıcıları.
The Moderator structure is used to represent the Moderation State of use case 3.
If you want to invite a user to be a moderator, via the API, use the Moderator API by creating a Moderator and inviting them.
If the user does not have a FastComments.com account, the invite email will help them get setup. If they already have an account, they will
be given moderation access to your tenant and the Moderator object's userId will be updated to point to their user. You will not have API
access to their user, as in this case it belongs to themselves and managed by FastComments.com.
If you require complete management of the user's account, we recommend either using SSO, or adding them as a Tenant Kullanıcısı and
then adding a Moderator object to track their stats.
The Moderator structure can be used as a stat tracking mechanism for use cases 1 and 2. After creating the user, add a Moderator
object with their userId defined and their stats will be tracked on the Yorum Moderatörleri Sayfası.
The structure for the Moderator object is as follows:
Moderatör Yapısı
Copy
1
2interface Moderator {
3 name: string
4 email: string
5 tenantId: string
6 userId?: string|null
7 acceptedInvite?: boolean
8 markReviewedCount?: number
9 deletedCount?: number
10 markedSpamCount?: number
11 approvedCount?: number
12 editedCount?: number
13 bannedCount?: number
14 createdAt: string
15 moderationGroupIds?: string[]|null
16}
17
GET /api/v1/moderators/:id
Resource: Moderator as GET /api/v1/moderators/:id Credit Cost: 1
Bu rota belirtilen id'ye sahip tek bir moderatörü döndürür.
ID ile Moderatör cURL Örneği
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/moderators/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
Moderatör İstek Yapısı
Copy
1
2interface ModeratorByIdQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
Moderatör Yanıt Yapısı
Copy
1
2interface ModeratorByIdResponse {
3 status: 'success' | 'failed'
4 /** Başarısızlık durumunda dahil edilir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found'
6 /** Başarısızlık durumunda dahil edilir. **/
7 reason?: string
8 moderator?: Moderator
9}
10
GET /api/v1/moderators
Resource: Moderator as GET /api/v1/moderators Credit Cost: 1
Bu API, skip sorgu parametresi tarafından sağlanan sayfalandırmayı kullanır. Moderators, createdAt ve id'ye göre sıralanmış olarak 100lük sayfalar halinde döndürülür.
Maliyet, döndürülen moderatör sayısına göre belirlenir; döndürülen moderatörler için maliyet 1 credit per 10'dur.
Moderator cURL Örneği
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/moderators?tenantId=demo&skip=0&API_KEY=DEMO_API_SECRET'
4
Moderator İstek Yapısı
Copy
1
2interface ModeratorsRequestQueryParams {
3 tenantId: string
4 API_KEY: string
5 /** Sayfalandırma için atlanacak moderatör sayısı. **/
6 skip?: number
7}
8
Moderator Yanıt Yapısı
Copy
1
2interface ModeratorsResponse {
3 status: 'success' | 'failed'
4 /** Başarısızlık durumunda dahil edilir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
6 /** Başarısızlık durumunda dahil edilir. **/
7 reason?: string
8 moderators?: Moderator[]
9}
10
PATCH /api/v1/moderators/:id
Resource: Moderator as PATCH /api/v1/moderators/:id Credit Cost: 1
Bu API uç noktası, bir Moderator'ı id ile güncelleme olanağı sağlar.
Bir Moderator'ın güncellenmesi aşağıdaki kısıtlamalara tabidir:
- Bir
Moderatorgüncellenirken, aşağıdaki değerler sağlanamaz:acceptedInvitemarkReviewedCountdeletedCountmarkedSpamCountapprovedCounteditedCountbannedCountverificationIdcreatedAt
- Bir
userIdbelirtildiğinde, o kullanıcı mevcut olmalıdır. - Bir
userIdbelirtildiğinde, sorgu parametrelerinde belirtilen aynıtenantId'e ait olmalıdırlar. - Aynı tenant içinde iki moderator aynı
emailile eklenemez. - Bir
Moderatorile ilişkilitenantId'yi değiştiremezsiniz.
Moderator PATCH cURL Örneği
Copy
1
2curl --request PATCH \
3 --url 'https://fastcomments.com/api/v1/moderators/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET' \
4 --header 'Content-Type: application/json' \
5 --data '{
6 "name": "Some New Name",
7}'
8
Moderator PATCH İstek Yapısı
Copy
1
2interface ModeratorPatchQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
Moderator PATCH Yanıt Yapısı
Copy
1
2
3interface ModeratorPatchResponse {
4 status: 'success' | 'failed'
5 /** Başarısızlık halinde dahil edilir. **/
6 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'name-required' | 'email-required' | 'unexpected-param' | 'not-found';
7 /** Başarısızlık halinde dahil edilir. **/
8 reason?: string
9}
10
POST /api/v1/moderators
Resource: Moderator as POST /api/v1/moderators Credit Cost: 1
Bu rota tek bir Moderator ekleme yeteneği sağlar.
Bir Moderator oluşturmanın aşağıdaki kısıtlamaları vardır:
- Bir
nameveemailher zaman sağlanmalıdır. BiruserIdisteğe bağlıdır. - Aşağıdaki değerler
Moderatoroluşturulurken sağlanamaz:acceptedInvitemarkReviewedCountdeletedCountmarkedSpamCountapprovedCounteditedCountbannedCountverificationIdcreatedAt
- Bir
userIdbelirtildiğinde, o kullanıcı mevcut olmalıdır. - Bir
userIdbelirtildiğinde, sorgu parametrelerinde belirtilen aynıtenantId'ye ait olmalıdır. - Aynı tenant içindeki iki moderatör aynı
emailile eklenemez.
Sadece e-postasını bildiğimiz bir kullanıcı için bir Moderator oluşturabiliriz:
E-posta ile Moderator Oluşturma cURL Örneği
Copy
1
2curl --request POST \
3 --url 'https://fastcomments.com/api/v1/moderators?tenantId=demo&API_KEY=DEMO_API_SECRET' \
4 --header 'Content-Type: application/json' \
5 --data '{
6 "name": "Some Name",
7 "email": "someone@someone.com"
8}'
9
Veya moderasyon istatistiklerini takip etmek için tenant'ımıza ait bir kullanıcı için bir Moderator oluşturabiliriz:
Tenant Kullanıcısı ile Moderator Oluşturma cURL Örneği
Copy
1
2curl --request POST \
3 --url 'https://fastcomments.com/api/v1/moderators?tenantId=demo&API_KEY=DEMO_API_SECRET' \
4 --header 'Content-Type: application/json' \
5 --data '{
6 "name": "Some Name",
7 "email": "someone@someone.com",
8 "userId": "some-tenant-user-id"
9}'
10
Moderator Oluşturma İstek Yapısı
Copy
1
2interface ModeratorPostQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
Moderator Oluşturma Yanıt Yapısı
Copy
1
2interface ModeratorPostResponse {
3 status: 'success' | 'failed'
4 /** Başarısızlık durumunda dahil edilir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'name-required' | 'email-required' | 'unexpected-param' | 'not-found'
6 /** Başarısızlık durumunda dahil edilir. **/
7 reason?: string
8 moderator?: Moderator; // Başarılı olduğunda oluşturulan moderatorun tamamını döndürürüz.
9}
10
POST /api/v1/moderators/:id/send-invite
Resource: Moderator as POST /api/v1/moderators/:id/send-invite Credit Cost: 10
Bu rota tek bir Moderator davet etme imkânı sağlar.
Bir Moderator'a davet e-postası göndermek için aşağıdaki kısıtlamalar vardır:
Moderatorzaten mevcut olmalıdır.fromName100 characters'den uzun olamaz.
Notlar:
- Sağlanan e-postaya sahip bir kullanıcı zaten varsa, kiracınızın yorumlarını yönetmesi için davet edilir.
- Sağlanan e-postaya sahip bir kullanıcı yoksa, davet bağlantısı onları hesap oluşturmaya yönlendirecektir.
- Davet
30 dayssonra sona erecektir.
Sadece e-postasını bildiğimiz bir kullanıcı için bir Moderator oluşturabiliriz:
Moderator Davet cURL Örneği
Copy
1
2curl --request POST \
3 --url 'https://fastcomments.com/api/v1/moderators/xyz/send-invite?tenantId=demo&API_KEY=DEMO_API_SECRET&fromName=Bob' \
4 --header 'Content-Type: application/json'
5
Bu, Bob at TenantName is inviting you to be a moderator... gibi bir e-posta gönderecektir.
Moderator Davet İsteği Yapısı
Copy
1
2interface ModeratorSendInviteQueryParams {
3 tenantId: string
4 API_KEY: string
5 /** Kullanıcıya gönderilen e-posta bu isimden gönderilmiş gibi görünecektir. **/
6 fromName: string
7}
8
Moderator Davet Yanıt Yapısı
Copy
1
2interface ModeratorSendInviteResponse {
3 status: 'success' | 'failed'
4 /** Başarısızlık durumunda dahil edilir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'unauthorized' | 'not-found | 'from-name-required' | 'from-name-invalid'
6 /** Başarısızlık durumunda dahil edilir. **/
7 reason?: string
8}
9
DELETE /api/v1/moderators/:id
Resource: Moderator as DELETE /api/v1/moderators/:id Credit Cost: 5
Bu rota, bir Moderator'ın id ile kaldırılmasını sağlar.
Moderator Kaldırma cURL Örneği
Copy
1
2curl --request DELETE \
3 --url 'https://fastcomments.com/api/v1/moderators/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
Moderator Kaldırma İstek Yapısı
Copy
1
2interface ModeratorDeleteQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
Moderator Kaldırma Yanıt Yapısı
Copy
1
2interface ModeratorDeleteResponse {
3 status: 'success' | 'failed'
4 /** Başarısızlık durumunda dahil edilir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'not-found'
6 /** Başarısızlık durumunda dahil edilir. **/
7 reason?: string
8}
9
Bildirim Sayısı Yapısı
A NotificationCount object represents the unread notification count and metadata for a user.
If there are no unread notifications, there will be no NotificationCount for the user.
NotificationCount objects are created automatically and cannot be created via the API. They also expire after one year.
You can clear a user's unread notification count by deleting their NotificationCount.
The structure for the NotificationCount object is as follows:
NotificationCount Yapısı
Copy
1
2interface NotificationCount {
3 id: string // kullanıcı kimliği
4 count: number
5 createdAt: string // tarih dizesi
6 expireAt: string // tarih dizesi
7}
8
GET /api/v1/notification-count/:user_id
Resource: NotificationCount as GET /api/v1/notification-count/:user_id Credit Cost: 1
Bu rota kullanıcı kimliğine göre tek bir NotificationCount döndürür. SSO ile, kullanıcı kimliği <tenant id>:<user id> formatındadır.
Okunmamış bildirim yoksa bir NotificationCount olmayacaktır - bu nedenle 404 alırsınız.
Bu, notifications/count'den farklıdır: çok daha hızlıdır, ancak filtrelemeye izin vermez.
NotificationCount ID ile cURL Örneği
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/notification-count/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'
4# -> {"status":"success","data":{"count":1,"createdAt":"2023-03-06T18:45:01.726Z","expireAt":"2024-03-06T01:25:01.726Z","id":"example"}}
5
NotificationCount İstek Yapısı
Copy
1
2interface NotificationCountGetQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
NotificationCount Yanıt Yapısı
Copy
1
2interface NotificationCountGetResponse {
3 status: 'success' | 'failed'
4 /** Başarısızlık halinde dahil edilir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'unauthorized' | 'not-found'
6 /** Başarısızlık halinde dahil edilir. **/
7 reason?: string
8 data?: NotificationCount
9}
10
DELETE /api/v1/notification-count/:user_id
Resource: NotificationCount as DELETE /api/v1/notification-count/:user_id Credit Cost: 1
Bu rota, kullanıcı kimliğine göre tek bir NotificationCount'ı siler. SSO ile, kullanıcı kimliği <tenant id>:<user id> biçimindedir.
Bu, kullanıcının okunmamış bildirim sayısını temizler (yorum widget'ındaki kırmızı zil solacak ve sayı kaybolacaktır).
NotificationCount Silme cURL Örneği
Copy
1
2curl --request DELETE \
3 --url 'https://fastcomments.com/api/v1/notification-count/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'
4# -> {"status":"success"}
5
NotificationCount Silme İstek Yapısı
Copy
1
2interface NotificationCountDeleteQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
NotificationCount Silme Yanıt Yapısı
Copy
1
2interface NotificationCountDeleteResponse {
3 status: 'success' | 'failed'
4 /** Başarısızlık durumunda eklenir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'unauthorized' | 'not-found'
6 /** Başarısızlık durumunda eklenir. **/
7 reason?: string
8}
9
Bildirim Yapısı
A Notification object represents a notification for a user.
Notification objects are created automatically and cannot be created via the API. They also expire after one year.
Notifications cannot be deleted. They can however be updated to set viewed to false, and you can query by viewed.
A user may also opt out of notifications for a specific comment by setting optedOut in the notification to true. You can opt in again by setting it to false.
There are different notification types - check relatedObjectType and type.
The ways notifications are created is quite flexible and can be triggered by many scenarios (see NotificationType).
As of today, the existence of a Notification does not actually imply an email is or should be sent. Rather, the notifications
are used for the notification feed and related integrations.
The structure for the Notification object is as follows:
Bildirim Yapısı
Copy
1
2enum NotificationObjectType {
3 Comment = 0,
4 Profile = 1,
5 Tenant = 2
6}
7
8enum NotificationType {
9 /** Birisi size yanıt verdiğinde. **/
10 RepliedToMe = 0,
11 /** Birisi, yorum yaptığınız bir dizide (alt diziler dahil) herhangi bir yere yanıt verdiğinde. **/
12 RepliedTransientChild = 1,
13 /** Yorumunuza oy verildiğinde. **/
14 VotedMyComment = 2,
15 /** Abone olduğunuz bir sayfanın köküne yeni bir yorum bırakıldığında. **/
16 SubscriptionReplyRoot = 3,
17 /** Birisi profilinize yorum yaptığında. **/
18 CommentedOnProfile = 4,
19 /** Size bir DM geldiğinde. **/
20 DirectMessage = 5,
21 /** TrialLimits yalnızca tenant kullanıcıları için. **/
22 TrialLimits = 6,
23 /** Eğer size @ ile bahsedildiyse. **/
24 Mentioned = 7
25}
26
27interface Notification {
28 id: string
29 tenantId: string
30 /** SSO ile, kullanıcı kimliği formatı `<tenant id>:<user id>` şeklindedir. **/
31 userId?: string
32 /** SSO ile çalışırken yalnızca `userId` ile ilgilenmeniz gerekir. **/
33 anonUserId?: string
34 /** urlId neredeyse her zaman tanımlıdır. Yalnızca tenant düzeyindeki bildirimler için isteğe bağlıdır; bunlar nadirdir. **/
35 urlId?: string
36 /** Bildirimin kaynağına hızlı gezinme için URL önbelleğe alınır. **/
37 url?: string
38 /** Bildirim kaynağının hızlı okunması için sayfa başlığı önbelleğe alınır. **/
39 pageTitle?: string
40 relatedObjectType: NotificationObjectType
41 /** Örneğin, yorum kimliği. **/
42 relatedObjectId: string
43 viewed: boolean
44 createdAt: string // tarih dizesi
45 type: NotificationType
46 fromCommentId?: string
47 fromVoteId?: string
48 /** fromUserName ve fromUserAvatarSrc bildirimin hızlı görüntülenmesi için burada önbelleğe alınır. Kullanıcı güncellendiğinde güncellenirler. **/
49 fromUserName: string
50 fromUserId: string
51 fromUserAvatarSrc?: string
52 /** Bu nesne için bildirim almamak için bunu true olarak ayarlayın. **/
53 optedOut?: boolean
54}
55
GET /api/v1/notifications
Resource: Notification as GET /api/v1/notifications Credit Cost: 1
Bu rota en yeni önce olacak şekilde createdAt'e göre sıralanmış en fazla 30 Notification nesnesi döndürür.
userId ile filtreleyebilirsiniz. SSO ile, kullanıcı kimliği <tenant id>:<user id> formatındadır.
Kullanıcı İçin Okunmamış Bildirimler cURL Örneği
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/notifications?tenantId=demo&API_KEY=DEMO_API_SECRET&userId=SOME_USER_ID&viewed=false'
4
Bildirimler İçin İstek Yapısı
Copy
1
2interface NotificationsGetQueryParams {
3 tenantId: string
4 API_KEY: string
5 /** Kayıtları atlayarak sayfalandırma. **/
6 skip?: number
7 /** Kullanıcıya göre filtrele. **/
8 userId?: string
9 /** urlId'ye göre filtrele. **/
10 urlId?: string
11 /** Kaynak yoruma göre filtrele. **/
12 fromCommentId?: string
13 /** Okundu/okunmadı durumuna göre filtrele. **/
14 viewed?: 'true' | 'false'
15 /** Türe göre filtrele. **/
16 type?: NotificationType
17}
18
Bildirimler İçin Yanıt Yapısı
Copy
1
2interface NotificationsGetResponse {
3 status: 'success' | 'failed'
4 /** Hata durumunda dahil edilir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'unauthorized' | 'unexpected-param' | 'not-found'
6 /** Hata durumunda dahil edilir. **/
7 reason?: string
8 notifications?: Notification[]
9}
10
GET /api/v1/notifications/count
Resource: Notification as GET /api/v1/notifications/count Credit Cost: 2
Bu rota, bildirim sayısını count parametresi altında içeren bir nesne döndürür.
Bu, /notification-count/'den daha yavaştır ve kredi maliyeti iki katıdır, ancak daha fazla boyuta göre filtrelemeye izin verir.
/notifications uç noktasındaki userId gibi aynı parametrelere göre filtreleyebilirsiniz. SSO ile kullanıcı kimliği <tenant id>:<user id> formatındadır.
Kullanıcı İçin Okunmamış Bildirim Sayısı cURL Örneği
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/notifications/count?tenantId=demo&API_KEY=DEMO_API_SECRET&userId=SOME_USER_ID&viewed=false'
4
Belirli Sayfa İçin Kullanıcının Okunmamış Bildirim Sayısı cURL Örneği
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/notifications/count?tenantId=demo&API_KEY=DEMO_API_SECRET&userId=SOME_USER_ID&viewed=false&urlId=some-article-id-or-url'
4
Bildirim Sayısı İstek Yapısı
Copy
1
2interface NotificationCountGetQueryParams {
3 tenantId: string
4 API_KEY: string
5 /** Kullanıcıya göre filtreleme. **/
6 userId?: string
7 /** urlId'ye göre filtreleme. **/
8 urlId?: string
9 /** Kaynak yoruma göre filtreleme. **/
10 fromCommentId?: string
11 /** Okunmuş/okunmamış durumuna göre filtreleme. **/
12 viewed?: 'true' | 'false'
13 /** Türüne göre filtreleme. **/
14 type?: NotificationType
15}
16
Bildirim Sayısı Yanıt Yapısı
Copy
1
2interface NotificationCountGetResponse {
3 status: 'success' | 'failed'
4 /** Başarısızlık halinde dahil edilir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'unauthorized' | 'unexpected-param' | 'not-found'
6 /** Başarısızlık halinde dahil edilir. **/
7 reason?: string
8 count?: number
9}
10
PATCH /api/v1/notifications/:id
Resource: Notification as PATCH /api/v1/notifications/:id Credit Cost: 1
Bu API uç noktası bir Notification'ı id ile güncelleme yeteneği sağlar.
Bir Notification'ın güncellenmesi aşağıdaki kısıtlamalara tabidir:
- Sadece aşağıdaki alanları güncelleyebilirsiniz:
viewedoptedOut
Notification PATCH cURL Örneği
Copy
1
2curl --request PATCH \
3 --url 'https://fastcomments.com/api/v1/notifications/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET' \
4 --header 'Content-Type: application/json' \
5 --data '{
6 "viewed": false,
7}'
8
Notification PATCH İstek Yapısı
Copy
1
2interface NotificationPatchQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
Notification PATCH Yanıt Yapısı
Copy
1
2
3interface NotificationPatchResponse {
4 status: 'success' | 'failed'
5 /** Başarısızlık durumunda dahil edilir. **/
6 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'unexpected-param' | 'unauthorized' | 'not-found';
7 /** Başarısızlık durumunda dahil edilir. **/
8 reason?: string
9}
10
Sayfa Yapısı
Bir Page nesnesi, birçok yorumun ait olabileceği sayfayı temsil eder. Bu ilişki şu şekilde tanımlanır
urlId.
Bir Page, sayfa başlığı, yorum sayısı ve urlId gibi bilgileri saklar.
Page nesnesinin yapısı aşağıdaki gibidir:
Sayfa Yapısı
Copy
1
2interface Page {
3 id: string
4 urlId: string
5 url: string
6 title?: string
7 createdAt: string
8 commentCount: number
9 rootCommentCount: number
10 /** Bunu null olarak ayarlamak, tüm SSO kullanıcılarının sayfayı görebileceği anlamına gelir. Boş bir liste ise tüm kullanıcılara kapalı olduğu anlamına gelir. **/
11 accessibleByGroupIds?: string[] | null
12 /** Bu sayfa yeni yorumlara kapalı mı? **/
13 isClosed?: boolean
14}
15
GET /api/v1/pages
Resource: Page as GET /api/v1/pages Credit Cost: 10
Şu anda yalnızca hesabınıza bağlı tüm sayfaları (veya /by-url-id ile tek bir sayfayı) alabilirsiniz. Daha ayrıntılı arama isterseniz, bize ulaşın.
Sayfalar cURL Örneği
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/pages?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
Sayfalar İstek Yapısı
Copy
1
2interface PagesRequestQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
Sayfalar Yanıt Yapısı
Copy
1
2interface PagesResponse {
3 status: 'success' | 'failed'
4 /** Başarısızlık durumunda dahil edilir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
6 /** Başarısızlık durumunda dahil edilir. **/
7 reason?: string
8 pages: Page[]
9}
10
Yararlı İpucu
Comment API'si bir urlId gerektirir. Hangi urlId değerlerinin size sunulduğunu görmek için önce Pages API'sini çağırabilirsiniz.
GET /api/v1/pages/by-url-id
Resource: Page as GET /api/v1/pages/by-url-id Credit Cost: 1
Bireysel sayfalar ilgili urlId ile getirilebilir. Bu, sayfa başlıklarını veya yorum sayılarını aramak için faydalı olabilir.
URL ID ile Sayfa cURL Örneği
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/pages/by-url-id?tenantId=demo&API_KEY=DEMO_API_SECRET&urlId=example-id-or-url'
4
URL ID ile Sayfa İstek Yapısı
Copy
1
2interface PagesRequestQueryParams {
3 tenantId: string
4 API_KEY: string
5 urlId: string
6}
7
URL ID ile Sayfa Yanıt Yapısı
Copy
1
2interface PagesResponse {
3 status: 'success' | 'failed'
4 /** Başarısızlık durumunda dahil edilir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-url-id'
6 /** Başarısızlık durumunda dahil edilir. **/
7 reason?: string
8 page?: Page[] | null
9}
10
Yararlı İpucu
urlId gibi değerleri URI Encode (URI Kodlama) yapmayı unutmayın.
PATCH /api/v1/pages/:id
Resource: Page as PATCH /api/v1/pages/:id Credit Cost: 1
Bu rota tek bir Page'i güncelleme yeteneği sağlar. İlgili yorumlar da güncellenecektir.
Sayfa Güncelleme cURL Örneği
Copy
1
2curl --request PATCH \
3 --url 'https://fastcomments.com/api/v1/pages/my-page-id?tenantId=demo&API_KEY=DEMO_API_SECRET' \
4 --header 'Content-Type: application/json' \
5 --data '{
6 "url": "https://example.com/some-page"
7}'
8
Sayfa Güncelleme İstek Yapısı
Copy
1
2interface PagePatchQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
Sayfa Güncelleme Yanıt Yapısı
Copy
1
2interface PagePatchResponse {
3 status: 'success' | 'failed'
4 /** Included on failure. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-url-id' | 'missing-id' | 'page-does-not-exist' | 'empty-request' | 'internal' | 'invalid-input' | 'invalid-title' | 'extra-params' | 'accessible-by-group-ids-not-array' | 'too-many-group-ids' | 'group-id-too-large'
6 /** Included on failure. **/
7 reason?: string
8 user?: Page; // We return the complete updated page on success.
9}
10
Not
Sayfa nesnesindeki bazı parametreler otomatik olarak güncellenir. Bunlar sayaçlar (counts) ve title öznitelikleridir. Sayaçlar API aracılığıyla güncellenemez
çünkü bunlar hesaplanan değerlerdir. Sayfanın title alanı API ile ayarlanabilir, ancak yorum bileşeni aynı urlId'ye sahip ve farklı bir sayfa başlığı olan bir sayfada kullanılırsa üzerine yazılır.
POST /api/v1/pages
Resource: Page as POST /api/v1/pages Credit Cost: 1
This API endpoint provides the ability to create pages.
A common use cases is access control.
Notes:
- If you've commented on a comment thread, or called the API to create a
Comment, you've already created aPageobject! You can try fetching it via the/by-url-idPageroute, passing in the sameurlIdpassed to the comment widget. - The
Pagestructure contains some calculated values. Currently, these arecommentCountandrootCommentCount. They are populated automatically and cannot be set by the API. Attempting to do so will cause the API to return an error.
Sayfa POST cURL Örneği
Copy
1
2curl --request POST \
3 --url 'https://fastcomments.com/api/v1/pages?tenantId=demo&API_KEY=DEMO_API_SECRET' \
4 --header 'Content-Type: application/json' \
5 --data '{
6 "title": "Test Page",
7 "url": "some0-url",
8 "urlId": "page2",
9 "accessibleByGroupIds": ["SOME_GROUP_ID"]
10}'
11
Sayfa POST İstek Yapısı
Copy
1
2interface PagePostQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
Sayfa POST Yanıt Yapısı
Copy
1
2
3interface PagePostResponse {
4 status: 'success' | 'failed'
5 /** Başarısızlık durumunda dahil edilir. **/
6 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-url-id' | 'empty-request' | 'internal' | 'invalid-input' | 'invalid-title' | 'extra-params' | 'accessible-by-group-ids-not-array' | 'too-many-group-ids' | 'group-id-too-large';
7 /** Başarısızlık durumunda dahil edilir. **/
8 reason?: string
9 /** Oluşturulan sayfa. **/
10 page?: Page
11}
12
DELETE /api/v1/pages/:id
Resource: Page as DELETE /api/v1/pages/:id Credit Cost: 1
Bu rota, id ile tek bir sayfanın silinmesini sağlar.
Aynı urlId'ye sahip bir sayfanın yorum widget'ı ile etkileşimde bulunmanın Page'i sorunsuzca yeniden oluşturacağını unutmayın.
Sayfa Silme cURL Örneği
Copy
1
2curl --request DELETE \
3 --url 'https://fastcomments.com/api/v1/pages/some-page-id?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
Sayfa Silme İstek Yapısı
Copy
1
2interface PageDeleteQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
Sayfa Silme Yanıt Yapısı
Copy
1
2interface PageDeleteResponse {
3 status: 'success' | 'failed'
4 /** Başarısızlık durumunda dahil edilir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'page-does-not-exist'
6 /** Başarısızlık durumunda dahil edilir. **/
7 reason?: string
8}
9
Bekleyen Webhook Olayı Yapısı
A PendingWebhookEvent object represents a queued webhook event that is pending.
PendingWebhookEvent objects are created automatically and cannot be manually created via the API. They also expire after one year.
They can be deleted which removes the task from the queue.
There are different event types - check eventType (OutboundSyncEventType) and type (OutboundSyncType).
A common use case for this API is to implement custom monitoring. You may want to call the /count endpoint periodically
to poll the outstanding count for given filters.
The structure for the PendingWebhookEvent object is as follows:
PendingWebhookEvent Yapısı
Copy
1
2enum OutboundSyncEventType {
3 Create: 0,
4 Delete: 1,
5 Update: 2
6}
7
8enum OutboundSyncType {
9 /** WordPress'e özgü senkronizasyon görevi. **/
10 WP: 0,
11 Webhook: 1
12}
13
14interface PendingWebhookEvent {
15 id: string
16 /** Olayla ilişkili yorum kimliği. **/
17 commentId: string
18 /** Olay anındaki yorum nesnesi. Bunları Kasım 2023'te eklemeye başladık. **/
19 comment: Comment
20 /** Yorumla ilişkilendirilebilecek harici bir kimlik. **/
21 externalId: string | null
22 createdAt: Date
23 tenantId: string
24 attemptCount: number
25 /** İlk denemeden önce ve her hata sonrası ayarlanır. **/
26 nextAttemptAt: Date
27 /** Bunun bir oluşturma, silme veya güncelleme olayı olup olmadığı... **/
28 eventType: OutboundSyncEventType
29 /** Yapılacak senkronizasyon türü (WordPress, API çağrısı, vb.). **/
30 type: OutboundSyncType
31 /** Yorumla eşleşen alan adı. API anahtarını seçmek için bu alan adını kullanıyoruz. **/
32 domain: string
33 /** Oluşan son hata. Bu tür tiplenmemiştir ve olanların bir "dump"ıdır. Genellikle statusCode, body ve bir headers haritası içeren bir nesne içerir. **/
34 lastError: object | null
35}
36
GET /api/v1/pending-webhook-events
Resource: PendingWebhookEvent as GET /api/v1/pending-webhook-events Credit Cost: 2
Bu rota, pendingWebhookEvents parametresi altında bekleyen webhook olaylarının bir listesini döndürür.
Bu API, skip parametresiyle sağlanan sayfalama kullanır. PendingWebhookEvents 100 öğe halinde sayfalanmış şekilde döndürülür, createdAt alanına göre en yeniler ilk sırada olacak şekilde sıralanır.
PendingWebhookEvent cURL Örneği
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/pending-webhook-events?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
PendingWebhookEvent İstek Yapısı
Copy
1
2interface PendingWebhookEventsGetQueryParams {
3 tenantId: string
4 API_KEY: string
5 commentId?: string
6 externalId?: string
7 eventType?: OutboundSyncEventType
8 type?: OutboundSyncType
9 domain?: string
10 /** Deneme sayısı belirtilen sayıdan daha yüksek olan olayları sorgular. **/
11 attemptCountGT?: number
12}
13
PendingWebhookEvent Yanıt Yapısı
Copy
1
2interface PendingWebhookEventsGetResponse {
3 status: 'success' | 'failed'
4 /** Başarısızlık durumunda eklenir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'unauthorized' | 'unexpected-param' | 'not-found'
6 /** Başarısızlık durumunda eklenir. **/
7 reason?: string
8 pendingWebhookEvents?: PendingWebhookEvent[]
9}
10
GET /api/v1/pending-webhook-events/count
Resource: PendingWebhookEvent as GET /api/v1/pending-webhook-events/count Credit Cost: 2
Bu rota, bekleyen webhook olaylarının sayısını count parametresi altında içeren bir nesne döndürür.
Aynı parametrelere göre /pending-webhook-events uç noktasıyla filtreleyebilirsiniz.
PendingWebhookEvent Sayısı cURL Örneği
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/pending-webhook-events/count?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
PendingWebhookEvent Sayısı İstek Yapısı
Copy
1
2interface PendingWebhookEventsCountQueryParams {
3 tenantId: string
4 API_KEY: string
5 commentId?: string
6 externalId?: string
7 eventType?: OutboundSyncEventType
8 type?: OutboundSyncType
9 domain?: string
10 /** Belirtilen sayıdan daha yüksek deneme sayısına sahip olayları sorgular. **/
11 attemptCountGT?: number
12}
13
PendingWebhookEvent Sayısı Yanıt Yapısı
Copy
1
2interface PendingWebhookEventsCountResponse {
3 status: 'success' | 'failed'
4 /** Hata durumunda dahil edilir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'unauthorized' | 'unexpected-param' | 'not-found'
6 /** Hata durumunda dahil edilir. **/
7 reason?: string
8 count?: number
9}
10
DELETE /api/v1/pending-webhook-events/:id
Resource: PendingWebhookEvent as DELETE /api/v1/pending-webhook-events/:id Credit Cost: 1
Bu rota tek bir PendingWebhookEvent öğesinin silinmesine olanak tanır.
Toplu silme yapmanız gerekiyorsa, GET API'sini sayfalandırma ile çağırın ve ardından bu API'yi art arda çağırın.
PendingWebhookEvent Silme cURL Örneği
Copy
1
2curl --request DELETE \
3 --url 'https://fastcomments.com/api/v1/pending-webhook-events/some-id?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
PendingWebhookEvent Silme İstek Yapısı
Copy
1
2interface PendingWebhookEventDeleteQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
PendingWebhookEvent Silme Yanıt Yapısı
Copy
1
2interface PendingWebhookEventDeleteResponse {
3 status: 'success' | 'failed'
4 /** Başarısızlık durumunda dahil edilir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'unauthorized' | 'unexpected-param' | 'not-found'
6 /** Başarısızlık durumunda dahil edilir. **/
7 reason?: string
8}
9
SSO Kullanıcısı Yapısı
FastComments provides an easy to use SSO solution. Updating a user's information with the HMAC-based integration is as simple as having the user load the page with an updated payload.
However, it may be desirable to manage a user outside that flow, to improve consistency of your application.
The SSO User API provides a way to CRUD objects that we call SSOUsers. These objects are different from regular Users and kept separate for type safety.
The structure for the SSOUser object is as follows:
SSOUser Yapısı
Copy
1
2interface SSOUser {
3 id: string
4 username: string
5 email?: string
6 websiteUrl?: string
7 signUpDate: number
8 createdFromUrlId?: string
9 loginCount?: number
10 avatarSrc?: string
11 optedInNotifications?: boolean
12 optedInSubscriptionNotifications?: boolean
13 displayLabel?: string
14 displayName?: string
15 isAccountOwner?: boolean // Yönetici izni - Bu bayrağa sahip SSO kullanıcıları SSO Admins olarak faturalandırılır (normal SSO kullanıcılarından ayrı)
16 isAdminAdmin?: boolean // Yönetici izni - Bu bayrağa sahip SSO kullanıcıları SSO Admins olarak faturalandırılır (normal SSO kullanıcılarından ayrı)
17 isCommentModeratorAdmin?: boolean // Moderatör izni - Bu bayrağa sahip SSO kullanıcıları SSO Moderators olarak faturalandırılır (normal SSO kullanıcılarından ayrı)
18 /** Eğer null ise, Erişim Kontrolü kullanıcıya uygulanmaz. Eğer boş bir liste ise, bu kullanıcı herhangi bir sayfayı göremeyecek veya diğer kullanıcıları @mention yapamayacaktır. **/
19 groupIds?: string[] | null
20 createdFromSimpleSSO?: boolean
21 /** Diğer kullanıcıların bu kullanıcının profilindeki etkinlikleri, yorumlar dahil, görmesini engelle. Varsayılan olarak güvenli profiller sağlamak için true'dur. **/
22 isProfileActivityPrivate?: boolean
23 /** Diğer kullanıcıların kullanıcının profiline yorum bırakmasını veya mevcut profil yorumlarını görmesini engelle. Varsayılan false. **/
24 isProfileCommentsPrivate?: boolean
25 /** Diğer kullanıcıların bu kullanıcıya doğrudan mesaj göndermesini engelle. Varsayılan false. **/
26 isProfileDMDisabled?: boolean
27 karma?: number
28 /** Kullanıcı rozetleri için isteğe bağlı yapılandırma. **/
29 badgeConfig?: {
30 /** Kullanıcıya atanacak rozet ID'lerinden oluşan dizi. 30 rozet ile sınırlıdır. Sıra korunur. **/
31 badgeIds: string[]
32 /** Eğer true ise, görüntülenen mevcut tüm rozetleri sağlananlarla değiştirir. Eğer false ise mevcut rozetlere ekler. **/
33 override?: boolean
34 /** Eğer true ise, rozet görüntü özelliklerini kiracı yapılandırmasından günceller. **/
35 update?: boolean
36 }
37}
38
Billing for SSO Users
SSO users are billed differently based on their permission flags:
- Regular SSO Users: Users without admin or moderator permissions are billed as regular SSO users
- SSO Admins: Users with
isAccountOwnerorisAdminAdminflags are billed separately as SSO Admins (same rate as regular tenant admins) - SSO Moderators: Users with
isCommentModeratorAdminflag are billed separately as SSO Moderators (same rate as regular moderators)
Important: To prevent double billing, the system automatically deduplicates SSO users against regular tenant users and moderators by email address. If an SSO user has the same email as a regular tenant user or moderator, they will not be billed twice.
Access Control
Users can be broken into groups. This is what the groupIds field is for, and is optional.
@Mentions
By default @mentions will use username to search for other sso users when the @ character is typed. If displayName is used, then results matching
username will be ignored when there is a match for displayName, and the @mention search results will use displayName.
Subscriptions
With FastComments, users can subscribe to a page by clicking the bell icon in the comment widget and clicking Subscribe.
With a regular user, we send them notification emails based on their notification settings.
With SSO Users, we split this up for backwards compatibility. Users will only get sent these additional subscription notification
emails if you set optedInSubscriptionNotifications to true.
Badges
You can assign badges to SSO users using the badgeConfig property. Badges are visual indicators that appear next to a user's name in comments.
badgeIds- An array of badge IDs to assign to the user. These must be valid badge IDs created in your FastComments account. Limited to 30 badges.override- If true, all existing badges displayed on comments will be replaced with the provided ones. If false or omitted, the provided badges will be added to any existing badges.update- If true, badge display properties will be updated from the tenant configuration whenever the user logs in.
GET /api/v1/sso-users
Resource: SSOUser as GET /api/v1/sso-users Credit Cost: 10
Bu rota SSO Kullanıcılarını 100'erlik sayfalarda döndürür. Sayfalandırma skip parametresi ile sağlanır. Kullanıcılar signUpDate ve id alanlarına göre sıralanır.
SSOUsers cURL Örneği
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/sso-users?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
SSOUsers İstek Yapısı
Copy
1
2interface SSOUsersRequestQueryParams {
3 tenantId: string
4 API_KEY: string
5 skip?: number
6}
7
SSOUsers Yanıt Yapısı
Copy
1
2interface SSOUsersResponse {
3 status: 'success' | 'failed'
4 /** Hata durumunda dahil edilir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
6 /** Hata durumunda dahil edilir. **/
7 reason?: string
8 users: SSOUser[]
9}
10
GET /api/v1/sso-users/by-id/:id
Resource: SSOUser as GET /api/v1/sso-users/by-id/:id Credit Cost: 1
Bu rota, bir SSO kullanıcısını id'sine göre döndürür.
SSOUser ID ile cURL Örneği
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/sso-users/by-id/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
SSOUser İstek Yapısı
Copy
1
2interface SSOUserRequestByIdQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
SSOUser Yanıt Yapısı
Copy
1
2interface SSOUserByIdResponse {
3 status: 'success' | 'failed'
4 /** Başarısızlık durumunda dahil edilir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'user-does-not-exist'
6 /** Başarısızlık durumunda dahil edilir. **/
7 reason?: string
8 user: SSOUser
9}
10
GET /api/v1/sso-users/by-email/:email
Resource: SSOUser as GET /api/v1/sso-users/by-email/:email Credit Cost: 1
Bu rota e-posta adresine göre tek bir SSO kullanıcısı döndürür.
E-posta ile SSOUser cURL Örneği
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/sso-users/by-email/someone@somewhere.com?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
SSOUser İstek Yapısı
Copy
1
2interface SSOUserRequestByEmailQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
SSOUser Yanıt Yapısı
Copy
1
2interface SSOUserByEmailResponse {
3 status: 'success' | 'failed'
4 /** Başarısızlık durumunda dahil edilir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-email' | 'user-does-not-exist'
6 /** Başarısızlık durumunda dahil edilir. **/
7 reason?: string
8 user: SSOUser
9}
10
PATCH /api/v1/sso-users/:id
Resource: SSOUser as PATCH /api/v1/sso-users/:id Credit Cost: 1
Bu rota, tek bir SSO kullanıcısını güncelleme olanağı sağlar.
SSOUser Güncelleme cURL Örneği
Copy
1
2curl --request PATCH \
3 --url 'https://fastcomments.com/api/v1/sso-users/my-user-id?tenantId=demo&API_KEY=DEMO_API_SECRET' \
4 --header 'Content-Type: application/json' \
5 --data '{
6 "username": "notfordperfect"
7}'
8
SSOUser Güncelleme İstek Yapısı
Copy
1
2interface SSOUserPatchQueryParams {
3 tenantId: string
4 API_KEY: string
5 /** E-posta veya kullanıcı adı değiştirildiğinde, kullanıcının yorumlarını da güncellemek için bunu true olarak ayarlayabilirsiniz. Bu, kredi maliyetini iki katına çıkarır. **/
6 updateComments: 'true' | 'false'
7}
8
SSOUser Güncelleme Yanıt Yapısı
Copy
1
2interface SSOUserPatchResponse {
3 status: 'success' | 'failed'
4 /** Hata durumunda dahil edilir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'empty-request' | 'invalid-input' | 'missing-id' | 'user-does-not-exist'
6 /** Hata durumunda dahil edilir. **/
7 reason?: string
8 user?: SSOUser; // Başarı durumunda güncellenmiş kullanıcının tamamını döndürürüz.
9}
10
POST /api/v1/sso-users
Resource: SSOUser as POST /api/v1/sso-users Credit Cost: 1
Bu rota tek bir SSO kullanıcısının oluşturulmasını sağlar.
Aynı ID'ye sahip iki kullanıcı oluşturmaya çalışmak hata ile sonuçlanır.
SSOUser Oluşturma cURL Örneği
Copy
1
2curl --request POST \
3 --url 'https://fastcomments.com/api/v1/sso-users?tenantId=demo&API_KEY=DEMO_API_SECRET' \
4 --header 'Content-Type: application/json' \
5 --data '{
6 "id": "my-user-id",
7 "username": "fordperfect",
8 "displayName": "Ford Perfect",
9 "email": "fordperfect@galaxy.com",
10 "groupIds": ["some-optional-group-id"]
11}'
12
Bu örnekte erişim kontrolü için groupIds belirtiyoruz, ancak bu isteğe bağlıdır.
SSOUser Oluşturma İstek Yapısı
Copy
1
2interface SSOUserPostQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
SSOUser Oluşturma Yanıt Yapısı
Copy
1
2interface SSOUserPostResponse {
3 status: 'success' | 'failed'
4 /** Başarısızlık halinde dahil edilir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'empty-request' | 'invalid-input' | 'missing-id' | 'user-exists'
6 /** Başarısızlık halinde dahil edilir. **/
7 reason?: string
8 user?: SSOUser; // Başarı durumunda oluşturulan kullanıcıyı döndürür.
9}
10
Entegrasyon Notu
API tarafından gönderilen veriler, farklı bir SSO User HMAC yükü göndererek kolayca geçersiz kılınabilir. Örneğin, kullanıcı adını API üzerinden ayarlarsanız, ancak sayfa yüklemesi sırasında SSO akışıyla farklı bir kullanıcı adı gönderirseniz, kullanıcı adlarını otomatik olarak güncelleyeceğiz.
Bu akışta kullanıcı parametrelerini, bunları açıkça belirtmediğiniz veya null olarak ayarlamadığınız (undefined değil) sürece güncellemeyeceğiz.
PUT /api/v1/sso-users/:id
Resource: SSOUser as PUT /api/v1/sso-users Credit Cost: 1
Bu rota tek bir SSO kullanıcısını güncelleme yeteneği sağlar.
SSOUser Güncelleme cURL Örneği
Copy
1
2curl --request PUT \
3 --url 'https://fastcomments.com/api/v1/sso-users/my-user-id?tenantId=demo&API_KEY=DEMO_API_SECRET' \
4 --header 'Content-Type: application/json' \
5 --data '{
6 "username": "fordperfect",
7 "displayName": "Ford Perfect",
8 "email": "fordperfect@galaxy.com",
9 "groupIds": ["some-optional-group-id"]
10}'
11
Bu örnekte erişim kontrolü için groupIds belirtiyoruz, ancak bu isteğe bağlıdır.
SSOUser Güncelleme İstek Yapısı
Copy
1
2interface SSOUserPutQueryParams {
3 tenantId: string
4 API_KEY: string
5 /** E-posta veya kullanıcı adı değiştirildiğinde, kullanıcının yorumlarını da güncellemek için bunu 'true' olarak ayarlayabilirsiniz. Bu kredi maliyetini iki katına çıkaracaktır. **/
6 updateComments: 'true' | 'false'
7}
8
SSOUser Güncelleme Yanıt Yapısı
Copy
1
2interface SSOUserPutResponse {
3 status: 'success' | 'failed'
4 /** Başarısızlık durumunda eklenir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'empty-request' | 'invalid-input' | 'missing-id' | 'user-exists'
6 /** Başarısızlık durumunda eklenir. **/
7 reason?: string
8 user?: SSOUser; // Başarı durumunda güncellenen kullanıcıyı döndürürüz.
9}
10
DELETE /api/v1/sso-users/:id
Resource: SSOUser as DELETE /api/v1/sso-users/:id Credit Cost: 1
Bu rota, tek bir SSO kullanıcısını id'si ile kaldırmayı sağlar.
Bu kullanıcının payload'ını içeren yorum bileşenini yeniden yüklemenin kullanıcıyı sorunsuz şekilde yeniden oluşturacağını unutmayın.
Kullanıcının yorumlarını silmek deleteComments sorgu parametresi aracılığıyla mümkündür. Bunun true olması durumunda:
- Kullanıcının tüm yorumları canlı olarak silinecektir.
- Tüm child (şimdi yetim) yorumlar, her bir yorumun ilişkili olduğu sayfa yapılandırmasına göre silinecek veya anonimleştirilecektir. Örneğin thread deletion modu "anonymize" ise yanıtlar kalacak ve kullanıcının yorumları anonimleştirilecektir. Bu yalnızca
commentDeleteModeRemove(varsayılan değer) olduğunda geçerlidir. creditsCostdeğeri2olur.
Anonimleştirilmiş Yorumlar
Kullanıcının yorumlarını koruyabilir ancak commentDeleteMode=1 olarak ayarlayarak bunları anonimleştirebilirsiniz.
Kullanıcının yorumları anonimleştirildiyse aşağıdaki değerler null olarak ayarlanır:
- commenterName
- commenterEmail
- avatarSrc
- userId
- anonUserId
- mentions
- badgesisDeleted ve isDeletedUser true olarak ayarlanır.
Render sırasında yorum bileşeni, kullanıcının adı için DELETED_USER_PLACEHOLDER (varsayılan: "[deleted]") ve yorum için DELETED_CONTENT_PLACEHOLDER kullanır. Bunlar Widget Özelleştirme UI'si aracılığıyla özelleştirilebilir.
Örnekler
SSOUser Kaldırma cURL Örneği
Copy
1
2curl --request DELETE \
3 --url 'https://fastcomments.com/api/v1/sso-users/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
SSOUser Kaldırma İstek Yapısı
Copy
1
2enum SSOUserCommentDeleteMode {
3 Remove = 0, // varsayılan
4 Anonymize = 1
5}
6
7interface SSOUsersDeleteQueryParams {
8 tenantId: string
9 API_KEY: string
10 /** Kullanıcının yorumlarını da silmek için bunu true olarak ayarlayabilirsiniz. Bu kredi maliyetini iki katına çıkarır. **/
11 deleteComments?: 'true' | 'false'
12 /** Kullanıcının yorumlarını nasıl işleyeceğinizi belirlemek için bunu istediğiniz gibi ayarlayabilirsiniz. **/
13 commentDeleteMode?: SSOUserCommentDeleteMode
14}
15
SSOUser Kaldırma Yanıt Yapısı
Copy
1
2interface SSOUsersResponse {
3 status: 'success' | 'failed'
4 /** Başarısızlık durumunda dahil edilir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'user-does-not-exist'
6 /** Başarısızlık durumunda dahil edilir. **/
7 reason?: string
8 user?: SSOUser; // Başarılı olduğunda kaldırılan kullanıcıyı döneriz.
9}
10
Abonelik Yapısı
A Subscription object represents a subscription for a user.
Subscription objects are created when a user clicks the notification bell in the comment widget and clicks "Bu sayfaya abone ol".
Subscriptions can also be created via the API.
Having a Subscription object causes Notification objects to be generated, and emails sent, when new comments are left on the root of the associated page
that the Subscription is for. Sending of emails depends on the type of user. For regular users this depends on optedInNotifications. For SSO Users this depends on optedInSubscriptionNotifications. Note that some applications may not have the concept of a web-accessible page, in which case simply set urlId to
the id of the item you are subscribing to (same value for urlId you would pass to the comment widget).
The structure for the Subscription object is as follows:
Abonelik Yapısı
Copy
1
2interface Subscription {
3 id: string
4 tenantId: string
5 /** SSO ile, kullanıcı kimliği `<tenant id>:<user id>` formatındadır. **/
6 userId: string
7 anonUserId?: string
8 urlId: string
9 url?: string
10 pageTitle?: string
11 createdAt: string // tarih dizesi
12}
13
GET /api/v1/subscriptions/:id
Resource: Subscription as GET /api/v1/subscriptions Credit Cost: 1
Bu rota, createdAt'e göre sıralanmış, en yeni ilk olacak şekilde en fazla 30 Subscription nesnesi döndürür.
userId ile filtreleyebilirsiniz. SSO ile, kullanıcı kimliği <tenant id>:<user id> formatındadır.
Kullanıcı İçin Abonelikler cURL Örneği
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/subscriptions?tenantId=demo&API_KEY=DEMO_API_SECRET&userId=SOME_USER_ID'
4
Abonelikler İstek Yapısı
Copy
1
2interface SubscriptionsGetQueryParams {
3 tenantId: string
4 API_KEY: string
5 /** Kayıtları atlayarak sayfalama. **/
6 skip?: number
7 /** Kullanıcıya göre filtrele. **/
8 userId?: string
9}
10
Abonelikler Yanıt Yapısı
Copy
1
2interface SubscriptionsGetResponse {
3 status: 'success' | 'failed'
4 /** Başarısızlık halinde dahil edilir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'unauthorized' | 'unexpected-param' | 'not-found'
6 /** Başarısızlık halinde dahil edilir. **/
7 reason?: string
8 subscriptions?: Subscription[]
9}
10
POST /api/v1/subscriptions
Resource: Subscription as POST /api/v1/subscriptions Credit Cost: 1
This API endpoint provides the ability to create a Subscription. Note that a user may only have one subscription per page, as more is redundant, and trying
to create more than one subscription for the same user for the same page will result in an error.
Creating a subscription will result in Notification objects being created when a new comment is left on the root of the subscribed urlId (when comment parentId is null).
Abonelik POST cURL Örneği
Copy
1
2curl --request POST \
3 --url 'https://fastcomments.com/api/v1/subscriptions?tenantId=demo&API_KEY=DEMO_API_SECRET' \
4 --header 'Content-Type: application/json' \
5 --data '{
6 "userId": "tenantId:test-user-id",
7 "urlId": "some-page-id-or-url",
8 "url": "https://example.com/page",
9 "pageTitle": "Some Example Page!"
10}'
11
Abonelik POST İstek Yapısı
Copy
1
2interface SubscriptionPostQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
Abonelik POST Yanıt Yapısı
Copy
1
2
3interface SubscriptionPostResponse {
4 status: 'success' | 'failed'
5 /** Hata durumunda dahil edilir. **/
6 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'unexpected-param' | 'unauthorized' | 'not-found';
7 /** Hata durumunda dahil edilir. **/
8 reason?: string
9}
10
DELETE /api/v1/subscriptions/:id
Resource: Subscription as DELETE /api/v1/subscriptions Credit Cost: 1
Bu rota bir Subscription nesnesini id ile siler.
Abonelik Kaldırma cURL Örneği
Copy
1
2curl --request DELETE \
3 --url 'https://fastcomments.com/api/v1/subscriptions/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
Abonelik Kaldırma İstek Yapısı
Copy
1
2interface SubscriptionsDeleteQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
Abonelik Kaldırma Yanıt Yapısı
Copy
1
2interface SubscriptionDeleteResponse {
3 status: 'success' | 'failed'
4 /** Başarısızlık durumunda dahil edilir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'unauthorized' | 'unexpected-param' | 'not-found'
6 /** Başarısızlık durumunda dahil edilir. **/
7 reason?: string
8}
9
Kiracı Günlük Kullanım Yapısı
Bir TenantDailyUsage nesnesi, belirli bir gün için bir kiracının kullanımını temsil eder. Eğer belirli bir kiracı için belirli bir
günde hiçbir etkinlik yoksa, o gün için bir TenantDailyUsage nesnesi olmayacaktır.
The TenantDailyUsage object is not real time and may be minutes behind actual usage.
The structure for the TenantDailyUsage object is as follows:
TenantDailyUsage Yapısı
Copy
1
2export interface TenantDailyUsage {
3 yearNumber: number
4 monthNumber: number
5 dayNumber: number
6 commentFetchCount?: number
7 commentCreateCount?: number
8 conversationCreateCount?: number
9 voteCount?: number
10 accountCreatedCount?: number
11 userMentionSearch?: number
12 hashTagSearch?: number
13 gifSearchTrending?: number
14 gifSearch?: number
15 apiCreditsUsed?: number
16 createdAt: string
17 billed: boolean
18 /** Faturalama için dikkate alınmaz. **/
19 ignored: boolean
20}
21
GET /api/v1/tenant-daily-usage
Resource: TenantDailyUsage as GET /api/v1/tenant-daily-usage Credit Cost: 1
Bu rota, bir tenant'ın kullanımını yıl, ay ve güne göre aramaya olanak tanır. En fazla 365 nesne döndürülebilir ve maliyet 10 nesne için 1 API kredisi.
Yanıt nesneleri oluşturuldukları tarihe göre sıralanır (en eski önce).
TenantDailyUsage Arama cURL Örneği
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/tenant-daily-usage?tenantId=demo&API_KEY=DEMO_API_SECRET&yearNumber=2022&monthNumber=2&dayNumber=10'
4
TenantDailyUsage İstek Yapısı
Copy
1
2interface TenantDailyUsageQueryParams {
3 tenantId: string
4 API_KEY: string
5 /** UTC'ye göre. **/
6 yearNumber?: number
7 /** Sıfır tabanlı. UTC'ye göre. **/
8 monthNumber?: number
9 /** Bir tabanlı. UTC'ye göre. **/
10 dayNumber?: number
11}
12
TenantDailyUsage Yanıt Yapısı
Copy
1
2interface TenantDailyUsageResponse {
3 status: 'success' | 'failed'
4 /** Başarısızlık durumunda dahil edilir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found'
6 /** Başarısızlık durumunda dahil edilir. **/
7 reason?: string
8 tenantDailyUsages: TenantDailyUsage[]
9}
10
Kiracı Yapısı
Tenant, FastComments.com müşterisini tanımlar. Bunlar API aracılığıyla white-label erişimine sahip kiracılar tarafından oluşturulabilir. White-label kiracılar
başka white-label kiracılar oluşturamaz (sadece bir düzey iç içe izin verilir).
Tenant nesnesinin yapısı aşağıdaki gibidir:
Tenant Yapısı
Copy
1
2export enum SiteType {
3 Unknown = 0,
4 WordPress = 1
5}
6
7/** Bu, DomainConfig API aracılığıyla da işlenebilir. **/
8export interface TenantDomainConfig {
9 domain: string
10 emailFromName?: string
11 emailFromEmail?: string
12 createdAt?: string,
13 siteType?: FastCommentsSiteType, // muhtemelen Unknown kullanmak istersiniz
14 logoSrc?: string, // ham resim yolu
15 logoSrc100px?: string, // küçük resimler için yeniden boyutlandırılmış
16 footerUnsubscribeURL?: string,
17 emailHeaders?: Record<string, string>,
18 disableUnsubscribeLinks?: boolean,
19 dkim?: {
20 domainName: string,
21 keySelector: string,
22 privateKey: string
23 }
24}
25
26export interface TenantBillingInfo {
27 name: string
28 address: string
29 city: string
30 state: string
31 zip: string
32 country: string
33}
34
35export enum TenantPaymentFrequency {
36 Monthly = 0,
37 Annually = 1
38}
39
40export interface Tenant {
41 id: string
42 name: string
43 email?: string
44 signUpDate: number; // sayı, "legacy" nedenlerden dolayı
45 packageId?: string | null
46 paymentFrequency?: TenantPaymentFrequency
47 billingInfoValid?: boolean
48 billingHandledExternally?: boolean
49 createdBy?: string
50 isSetup?: boolean
51 domainConfiguration: FastCommentsAPITenantDomainConfig[]
52 billingInfo?: FastCommentsAPITenantBillingInfo
53 stripeCustomerId?: string
54 stripeSubscriptionId?: string
55 stripePlanId?: string
56 enableProfanityFilter?: boolean
57 enableSpamFilter?: boolean
58 lastBillingIssueReminderDate?: string
59 removeUnverifiedComments?: boolean
60 unverifiedCommentsTTLms?: number
61 commentsRequireApproval?: boolean
62 autoApproveCommentOnVerification?: boolean
63 sendProfaneToSpam?: boolean
64 /** @readonly - packageId'ye göre hesaplanır. **/
65 hasFlexPricing?: boolean
66 /** @readonly **/
67 flexLastBilledAmount?: number
68 /** @readonly - packageId'ye göre hesaplanır. **/
69 hasAuditing?: boolean
70 /** Kiracıyla sorgulamada kullanabileceğiniz bir anahtar-değer çifti saklayabilirsiniz. Anahtarlar "." veya "$" içeremez veya 100 karakterden uzun olamaz. Değerler 2k karakterden uzun olamaz. **/
71 meta?: Record<string, string | null>
72}
73
GET /api/v1/tenants/:id
Resource: Tenant as GET /api/v1/tenants/:id Credit Cost: 1
Bu rota id ile tek bir Tenant döndürür.
ID ile Tenant cURL Örneği
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/tenants/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
Tenant İstek Yapısı
Copy
1
2interface TenantByIdQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
Tenant Yanıt Yapısı
Copy
1
2interface TenantByIdResponse {
3 status: 'success' | 'failed'
4 /** Başarısızlık durumunda dahil edilir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found' | 'unauthorized'
6 /** Başarısızlık durumunda dahil edilir. **/
7 reason?: string
8 tenant?: Tenant
9}
10
GET /api/v1/tenants
Resource: Tenant as GET /api/v1/tenants Credit Cost: 1
Bu API, tenant'ınız tarafından yönetilen tenants listesini döndürür.
Sayfalama skip sorgu parametresi ile sağlanır. Tenants, 100 öğelik sayfalar halinde, signUpDate ve id'ye göre sıralanarak döndürülür.
Maliyet, döndürülen tenants sayısına göre belirlenir; döndürülen her 10 tenants için 1 credit per 10 ücretlendirilir.
Tenant cURL Örneği
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/tenants?tenantId=demo&skip=0&API_KEY=DEMO_API_SECRET'
4
Tenant nesneleri üzerinde meta parametreleri tanımlayabilir ve eşleşen tenants için sorgu yapabilirsiniz. Örneğin, someKey anahtarı ve some-value meta değeri için, bu anahtar/değer çiftini içeren bir JSON nesnesi oluşturup filtrelemek için bunu URI kodlayarak sorgu parametresi olarak kullanabiliriz:
Meta ile Tenant Sorgulama cURL Örneği
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/tenants?tenantId=demo&skip=0&API_KEY=DEMO_API_SECRET&meta=%7B%22someKey%22%3A%22some-value%22%7D'
4
Tenant İstek Yapısı
Copy
1
2interface TenantsRequestQueryParams {
3 tenantId: string
4 API_KEY: string
5 /** Sayfalama için atlanacak tenants sayısı. **/
6 skip?: number
7 /** Meta parametrelerine göre filtreleme. **/
8 meta?: string
9}
10
Tenant Yanıt Yapısı
Copy
1
2interface TenantsResponse {
3 status: 'success' | 'failed'
4 /** Hata durumunda eklenir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
6 /** Hata durumunda eklenir. **/
7 reason?: string
8 tenants?: Tenant[]
9}
10
POST /api/v1/tenants
Resource: Tenant as POST /api/v1/tenants Credit Cost: 1
Bu rota tek bir Tenant ekleme yeteneği sağlar.
Bir Tenant oluşturmanın aşağıdaki kısıtlamaları vardır:
- A
nameis required. domainConfigurationis required.- The following values may not be provided when creating a
Tenant:hasFlexPricinglastBillingIssueReminderDateflexLastBilledAmount
- The
signUpDatemay not be in the future. - The
namemay not be longer than200 characters. - The
emailmay not be longer than300 characters. - The
emailmust be unique across all of FastComments.com tenants. - You may not create tenants if the parent tenant does not have a valid
TenantPackagedefined.- If your tenant was created via FastComments.com, this shouldn't be an issue.
- You may not create more tenants than defined under
maxWhiteLabeledTenantsin your package. - You must specify the
tenantIdquery param which is the id of yourparent tenantwith white labeling enabled.
Sadece birkaç parametre ile bir Tenant oluşturabiliriz:
Tenant Oluşturma cURL Örneği
Copy
1
2curl --request POST \
3 --url 'https://fastcomments.com/api/v1/tenants?tenantId=demo&API_KEY=DEMO_API_SECRET' \
4 --header 'Content-Type: application/json' \
5 --data '{
6 "name": "Some Name",
7 "email": "someone@someone.com",
8 "domainConfiguration": [ { "domain": "somedomain.com" } ]
9}'
10
Tenant Oluşturma İstek Yapısı
Copy
1
2interface TenantPostQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
Tenant Oluşturma Yanıt Yapısı
Copy
1
2interface TenantPostResponse {
3 status: 'success' | 'failed'
4 /** Hata durumunda dahil edilir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'unexpected-param' | 'not-found' | 'unexpected-param' | 'sign-up-date-in-future' | 'payment-frequency-invalid' | 'cannot-change-payment-frequency' | 'name-invalid' | 'email-invalid' | 'email-taken' | 'no-package' | 'invalid-package' | 'unauthorized' | 'tenant-limit-reached' | 'cannot-move-tenant' | 'cannot-change-package' | 'invalid-billing-info'
6 /** Hata durumunda dahil edilir. **/
7 reason?: string
8 tenant?: Tenant; // Başarı durumunda oluşturulan tenant'ın tamamını döndürürüz.
9}
10
PATCH /api/v1/tenants/:id
Resource: Tenant as PATCH /api/v1/tenants/:id Credit Cost: 1
This API endpoint provides the ability to update a Tenant by id.
Updating a Tenant has the following restrictions:
- The following values may not be updated:
hasFlexPricinglastBillingIssueReminderDateflexLastBilledAmountmanagedByTenantId
- The
signUpDatemay not be in the future. - The
namemay not be longer than200 characters. - The
emailmay not be longer than300 characters. - The
emailmust be unique across all of FastComments.com tenants. - When setting
billingInfoValidtotrue,billingInfomust be provided in the same request. - You may not update the
packageIdassociated with your own tenant. - You may not update the
paymentFrequencyassociated with your own tenant.
Tenant PATCH cURL Örneği
Copy
1
2curl --request PATCH \
3 --url 'https://fastcomments.com/api/v1/tenants/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET' \
4 --header 'Content-Type: application/json' \
5 --data '{
6 "name": "Some New Name",
7}'
8
Tenant PATCH İstek Yapısı
Copy
1
2interface TenantPatchQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
Tenant PATCH Yanıt Yapısı
Copy
1
2
3interface TenantPatchResponse {
4 status: 'success' | 'failed'
5 /** Başarısızlık durumunda dahil edilir. **/
6 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'unexpected-param' | 'not-found' | 'unexpected-param' | 'sign-up-date-in-future' | 'payment-frequency-invalid' | 'cannot-change-payment-frequency' | 'name-invalid' | 'email-invalid' | 'email-taken' | 'no-package' | 'invalid-package' | 'unauthorized' | 'tenant-limit-reached' | 'cannot-move-tenant' | 'cannot-change-package' | 'invalid-billing-info';
7 /** Başarısızlık durumunda dahil edilir. **/
8 reason?: string
9}
10
DELETE /api/v1/tenants/:id
Resource: Tenant as DELETE /api/v1/tenants/:id Credit Cost: 1,000
Bu rota, bir Tenant ve ilgili tüm verilerin (kullanıcılar, yorumlar, vb.) id ile kaldırılmasını sağlar.
Aşağıdaki kısıtlamalar tenant kaldırma işlemi ile ilgilidir:
- Tenant sizin kendi tenant'ınız olmalı veya sizin yönettiğiniz beyaz etiketli bir tenant olmalıdır.
suresorgu parametresitrueolarak ayarlanmış olmalıdır.
Kiracı Silme cURL Örneği
Copy
1
2curl --request DELETE \
3 --url 'https://fastcomments.com/api/v1/tenants/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
Kiracı Silme İstek Yapısı
Copy
1
2interface TenantDeleteQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
Kiracı Silme Yanıt Yapısı
Copy
1
2interface TenantDeleteResponse {
3 status: 'success' | 'failed'
4 /** Başarısızlık durumunda eklenir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'not-found' | 'unauthorized' | 'unsure'
6 /** Başarısızlık durumunda eklenir. **/
7 reason?: string
8}
9
Kiracı Paketi Yapısı
TenantPackage, bir Tenant için mevcut paket bilgilerini tanımlar. Bir tenant'ın birden çok paketi olabilir, ancak aynı anda yalnızca biri kullanımda olabilir.
Bir Tenant, packageId geçerli bir TenantPackage'ı işaret edene kadar herhangi bir ürün için kullanılamaz.
İki tür TenantPackage nesnesi vardır:
- Sabit fiyatlı paketler -
hasFlexPricingfalse olduğunda. - Esnek fiyatlandırma -
hasFlexPricingtrue olduğunda.
Her iki durumda da paketi kullanan hesap üzerinde limitler tanımlanır, ancak Flex ile tenant'a baz bir ücret artı kullandıkları miktar flex* parametreleri ile tanımlanan şekilde faturalandırılır.
Bir tenant'ın birden fazla tenant paketi olabilir ve paketi kendileri Fatura Bilgileri Sayfası. üzerinden değiştirme yetkisi olabilir.
Faturalamayı tenantlar için kendiniz yönetecekseniz, limitlerini tanımlamak için yine de her tenant için bir paket tanımlamanız gerekir. Tenant üzerinde billingHandledExternally'i true olarak ayarlamanız yeterlidir; böylece kendi fatura bilgilerini veya aktif paketlerini değiştiremeyeceklerdir.
Üst tenant'tan daha yüksek limitlere sahip paketler oluşturamazsınız.
TenantPackage nesnesinin yapısı aşağıdaki gibidir:
TenantPackage Yapısı
Copy
1
2export interface TenantPackage {
3 id: string
4 name: string
5 tenantId: string
6 createdAt: string
7 monthlyCostUSD: number
8 yearlyCostUSD: number
9 monthlyStripePlanId?: string
10 yearlyStripePlanId?: string
11 maxMonthlyPageLoads: number
12 maxMonthlyAPICredits: number
13 maxMonthlyComments: number
14 maxConcurrentUsers: number
15 maxTenantUsers: number
16 maxSSOUsers: number
17 maxModerators: number
18 maxDomains: number
19 maxWhiteLabeledTenants: number
20 hasWhiteLabeling: boolean
21 hasDebranding: boolean
22 forWhoText: string
23 featureTaglines: string[]
24 hasAuditing: boolean
25 hasFlexPricing: boolean
26 flexPageLoadCostCents?: null
27 flexPageLoadUnit?: null
28 flexCommentCostCents?: null
29 flexCommentUnit?: null
30 flexSSOUserCostCents?: null // Normal SSO kullanıcı başına maliyet (yönetici/moderatör izinleri olmadan)
31 flexSSOUserUnit?: null
32 flexAPICreditCostCents?: null
33 flexAPICreditUnit?: null
34 flexModeratorCostCents?: null
35 flexModeratorUnit?: null
36 flexAdminCostCents?: null
37 flexAdminUnit?: null
38 flexDomainCostCents?: null
39 flexDomainUnit?: null
40 flexSSOAdminCostCents?: null // Yönetici izinlerine sahip SSO kullanıcı başına maliyet (isAccountOwner veya isAdminAdmin bayrakları)
41 flexSSOAdminUnit?: null
42 flexSSOModeratorCostCents?: null // Moderatör izinlerine sahip SSO kullanıcı başına maliyet (isCommentModeratorAdmin bayrağı)
43 flexSSOModeratorUnit?: null
44 flexMinimumCostCents?: null
45}
46
GET /api/v1/tenant-packages/:id
Resource: TenantPackage as GET /api/v1/tenant-packages/:id Credit Cost: 1
Bu rota, id ile tek bir Tenant Package döndürür.
TenantPackage ID'ye Göre cURL Örneği
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/tenant-packages/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
TenantPackage İstek Yapısı
Copy
1
2interface TenantPackageByIdQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
TenantPackage Yanıt Yapısı
Copy
1
2interface TenantPackageByIdResponse {
3 status: 'success' | 'failed'
4 /** Başarısızlık durumunda dahil edilir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found'
6 /** Başarısızlık durumunda dahil edilir. **/
7 reason?: string
8 tenantPackage: TenantPackage
9}
10
GET /api/v1/tenant-packages
Resource: TenantPackage as GET /api/v1/tenant-packages Credit Cost: 1
Bu API, skip sorgu parametresiyle sağlanan sayfalandırmayı kullanır. TenantPackages, createdAt ve id'ye göre sıralanmış olarak, 100 öğelik sayfalar halinde döndürülür.
Maliyet, döndürülen tenant paketlerinin sayısına göre hesaplanır; döndürülen tenant paketleri için maliyet 1 credit per 10'dur.
TenantPackage cURL Örneği
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/tenant-packages?tenantId=demo&skip=0&API_KEY=DEMO_API_SECRET'
4
TenantPackage İstek Yapısı
Copy
1
2interface TenantPackagesRequestQueryParams {
3 tenantId: string
4 API_KEY: string
5 /** Sayfalandırma için atlanacak tenant paketlerinin sayısı. **/
6 skip?: number
7}
8
TenantPackage Yanıt Yapısı
Copy
1
2interface TenantPackagesResponse {
3 status: 'success' | 'failed'
4 /** Başarısızlık durumunda eklenir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
6 /** Başarısızlık durumunda eklenir. **/
7 reason?: string
8 tenantPackages?: TenantPackage[]
9}
10
POST /api/v1/tenant-packages
Resource: TenantPackage as POST /api/v1/tenant-packages Credit Cost: 1
Bu rota tek bir TenantPackage ekleme yeteneği sağlar.
Bir TenantPackage oluşturmanın aşağıdaki kısıtlamaları vardır:
- Aşağıdaki parametreler gereklidir:
nametenantIdmonthlyCostUSD- Boş (null) olabilir.yearlyCostUSD- Boş (null) olabilir.maxMonthlyPageLoadsmaxMonthlyAPICreditsmaxMonthlyCommentsmaxConcurrentUsersmaxTenantUsersmaxSSOUsersmaxModeratorsmaxDomainshasDebrandingforWhoTextfeatureTaglineshasFlexPricing- Eğer true ise, tümflex*parametreleri gereklidir.
name50 characters'den daha uzun olamaz.- Her
forWhoTextöğesi200 characters'den daha uzun olamaz. - Her
featureTaglinesöğesi100 characters'den daha uzun olamaz. TenantPackage, üst kiracıdan daha "küçük" olmalıdır. Örneğin, tümmax*parametrelerinin üst kiracıdan daha düşük değerlere sahip olması gerekir.- Bir beyaz etiketli kiracı en fazla beş pakete sahip olabilir.
- Sadece beyaz etiketleme erişimine sahip kiracılar bir
TenantPackageoluşturabilir. - Kendi kiracınıza paket ekleyemezsiniz. :)
Bir TenantPackage şu şekilde oluşturulabilir:
TenantPackage E-posta ile Oluşturma cURL Örneği
Copy
1
2curl --request PATCH \
3 --url 'https://fastcomments.com/api/v1/tenant-packages?tenantId=demo&API_KEY=DEMO_API_SECRET' \
4 --header 'Content-Type: application/json' \
5 --data '{
6 "name": "Default Package",
7 "tenantId": "some-child-tenant-id",
8 "monthlyCostUSD": null,
9 "yearlyCostUSD": null,
10 "maxMonthlyPageLoads": 50000,
11 "maxMonthlyAPICredits": 50000,
12 "maxMonthlyComments": 50000,
13 "maxConcurrentUsers": 50000,
14 "maxTenantUsers": 10,
15 "maxSSOUsers": 50000,
16 "maxModerators": 100,
17 "maxDomains": 3,
18 "hasWhiteLabeling": false,
19 "hasDebranding": true,
20 "forWhoText": "For Everyone",
21 "featureTaglines": [
22 "Some Tag",
23 "Some Other Tag"
24 ],
25 "hasFlexPricing": true,
26 "flexPageLoadCostCents": 100,
27 "flexPageLoadUnit": 100000,
28 "flexCommentCostCents": 100,
29 "flexCommentUnit": 100000,
30 "flexSSOUserCostCents": 100,
31 "flexSSOUserUnit": 1000,
32 "flexAPICreditCostCents": 100,
33 "flexAPICreditUnit": 50000,
34 "flexModeratorCostCents": 500,
35 "flexModeratorUnit": 1,
36 "flexAdminCostCents": 1000,
37 "flexAdminUnit": 1,
38 "flexDomainCostCents": 1000,
39 "flexDomainUnit": 1,
40 "flexMinimumCostCents": 99
41}'
42
TenantPackage Oluşturma İstek Yapısı
Copy
1
2interface TenantPackagePostQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
TenantPackage Oluşturma Yanıt Yapısı
Copy
1
2interface TenantPackagePostResponse {
3 status: 'success' | 'failed'
4 /** Başarısızlık durumunda dahil edilir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'unexpected-param' | 'not-found' 'white-labeling-not-allowed' | 'name-too-long' | 'for-who-text-too-long' | 'feature-tag-lines-too-long' | 'no-package' | 'invalid-package' | 'unauthorized' | 'child-tenant-too-large' | 'flex-param-missing' | 'unexpected-flex-param' | 'package-limit-reached' | 'flex-param-missing' | 'unexpected-flex-param'
6 /** Başarısızlık durumunda dahil edilir. **/
7 reason?: string
8 tenantPackage?: TenantPackage; // Başarı durumunda oluşturulan tenant paketinin tamamını döneriz.
9}
10
PATCH /api/v1/tenant-packages/:id
Resource: TenantPackage as PATCH /api/v1/tenant-packages/:id Credit Cost: 1
This API endpoint provides the ability to update a TenantPackage by id.
Updating a TenantPackage has the following restrictions:
- If you are setting
hasFlexPricingto true, then allflex*parameters are required in that same request. - The
namemay not be longer than50 characters. - Each
forWhoTextitem may not be longer than200 characters. - Each
featureTaglinesitem may not be longer than100 characters. - The
TenantPackagemust be "smaller" than the parent tenant. For example, all of themax*parameters must have lower values than the parent tenant. - You may not change the
tenantIdassociated with aTenantPackage.
TenantPackage PATCH cURL Örneği
Copy
1
2curl --request PATCH \
3 --url 'https://fastcomments.com/api/v1/tenant-packages/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET' \
4 --header 'Content-Type: application/json' \
5 --data '{
6 "name": "Some New Name",
7}'
8
TenantPackage PATCH İstek Yapısı
Copy
1
2interface TenantPackagePatchQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
TenantPackage PATCH Yanıt Yapısı
Copy
1
2
3interface TenantPackagePatchResponse {
4 status: 'success' | 'failed'
5 /** Başarısızlık durumunda eklenir. **/
6 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'unexpected-param' | 'not-found' | 'white-labeling-not-allowed' | 'name-too-long' | 'for-who-text-too-long' | 'feature-tag-lines-too-long' | 'no-package' | 'invalid-package' | 'unauthorized' | 'child-tenant-too-large' | 'flex-param-missing' | 'unexpected-flex-param' | 'package-limit-reached' | 'flex-param-missing' | 'unexpected-flex-param';
7 /** Başarısızlık durumunda eklenir. **/
8 reason?: string
9}
10
DELETE /api/v1/tenant-packages/:id
Resource: TenantPackage as DELETE /api/v1/tenant-packages/:id Credit Cost: 5
Bu rota bir TenantPackage'ı id ile kaldırmayı sağlar.
Kullanımda olan bir TenantPackage'ı kaldıramazsınız (bir tenant'ın packageId pakete işaret ediyor). Önce Tenant'ı güncelleyin.
TenantPackage Kaldırma cURL Örneği
Copy
1
2curl --request DELETE \
3 --url 'https://fastcomments.com/api/v1/tenant-packages/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
TenantPackage Kaldırma İstek Yapısı
Copy
1
2interface TenantPackageDeleteQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
TenantPackage Kaldırma Yanıt Yapısı
Copy
1
2interface TenantPackageDeleteResponse {
3 status: 'success' | 'failed'
4 /** Başarısızlık durumunda dahil edilir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'not-found' | 'unauthorized' | 'package-in-use'
6 /** Başarısızlık durumunda dahil edilir. **/
7 reason?: string
8}
9
Kiracı Kullanıcı Yapısı
The TenantUser defines a User which is managed by a specific tenant. Their account is in complete control of the tenant
they are associated with, and their account can be updated or deleted via the UI or API.
Tenant users can be administrators with all permissions and access to the Tenant, or they can be limited to specific permissions to
moderate comments, access API keys, etc.
The structure for the TenantUser object is as follows:
TenantUser Yapısı
Copy
1
2/** Bu bildirimler içindir. **/
3export enum UserDigestEmailFrequency {
4 Disabled = -1,
5 Daily = 0,
6 Weekly = 1,
7 Monthly = 2
8}
9
10export interface TenantUser {
11 id: string
12 tenantId: string
13 username: string
14 /** Örneğin yorumcunun bloguna bir bağlantı. **/
15 websiteUrl?: string
16 email: string
17 signUpDate: number
18 createdFromUrlId: string
19 createdFromTenantId: string
20 verified: boolean
21 loginCount: number
22 optedInNotifications: boolean
23 optedInTenantNotifications: boolean
24 hideAccountCode: boolean
25 avatarSrc?: string
26 /** Kullanıcı yorumculardan gelen yardım isteklerini alıyor mu? **/
27 isHelpRequestAdmin: boolean
28 isAccountOwner: boolean
29 isAdminAdmin: boolean
30 isBillingAdmin: boolean
31 isAnalyticsAdmin: boolean
32 isCustomizationAdmin: boolean
33 isManageDataAdmin: boolean
34 isCommentModeratorAdmin: boolean
35 isAPIAdmin: boolean
36 moderatorIds: string[]
37 locale: FastCommentsLocale
38 digestEmailFrequency: UserDigestEmailFrequency
39 lastLoginDate: string
40 displayLabel?: string
41 karma?: number
42}
43
GET /api/v1/tenant-users/:id
Resource: TenantUser as GET /api/v1/tenant-users/:id Credit Cost: 1
Bu rota id ile tek bir TenantUser döndürür.
TenantUser ID ile cURL Örneği
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/tenant-users/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
TenantUser İstek Yapısı
Copy
1
2interface TenantUserByIdQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
TenantUser Yanıt Yapısı
Copy
1
2interface TenantUserByIdResponse {
3 status: 'success' | 'failed'
4 /** Başarısızlık durumunda dahil edilir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found' | 'unauthorized'
6 /** Başarısızlık durumunda dahil edilir. **/
7 reason?: string
8 tenantUser?: TenantUser
9}
10
GET /api/v1/tenant-users
Resource: TenantUser as GET /api/v1/tenant-users Credit Cost: 1
Bu API, sayfalama için skip sorgu parametresi ile çalışır. TenantUsers, 100 öğe sayfaları halinde döndürülür; signUpDate, username ve id'ye göre sıralanır.
Maliyet döndürülen tenant users sayısına göre belirlenir; döndürülen her 10 tenant users için 1 credit per 10 ücret alınır.
TenantUser cURL Örneği
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/tenant-users?tenantId=demo&page=0&API_KEY=DEMO_API_SECRET'
4
TenantUser İstek Yapısı
Copy
1
2interface TenantUsersRequestQueryParams {
3 tenantId: string
4 API_KEY: string
5 /** Sayfalama için atlanacak tenant kullanıcı sayısı. **/
6 skip?: number
7}
8
TenantUser Yanıt Yapısı
Copy
1
2interface TenantUsersResponse {
3 status: 'success' | 'failed'
4 /** Hata durumunda dahil edilir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
6 /** Hata durumunda dahil edilir. **/
7 reason?: string
8 tenantUsers?: TenantUser[]
9}
10
POST /api/v1/tenant-users
Resource: TenantUser as POST /api/v1/tenant-users Credit Cost: 1
Bu rota tek bir TenantUser ekleme olanağı sağlar.
Bir TenantUser oluşturmanın aşağıdaki kısıtlamaları vardır:
usernamegereklidir.emailgereklidir.signUpDategelecekte olamaz.localeşu listede olmalıdır: Desteklenen Yereller.usernameFastComments.com genelinde benzersiz olmalıdır. Bu bir sorun ise, bunun yerine SSO kullanmanızı öneririz.emailFastComments.com genelinde benzersiz olmalıdır. Bu bir sorun ise, bunun yerine SSO kullanmanızı öneririz.- Paketinizde
maxTenantUsersaltında tanımlanan sayıda tenant kullanıcıdan daha fazlasını oluşturamazsınız.
TenantUser şu şekilde oluşturabiliriz
TenantUser Oluşturma cURL Örneği
Copy
1
2curl --request POST \
3 --url 'https://fastcomments.com/api/v1/tenants?tenantId=demo&API_KEY=DEMO_API_SECRET' \
4 --header 'Content-Type: application/json' \
5 --data '{
6 "username": "Some Name",
7 "email": "someone@someone.com"
8}'
9
TenantUser Oluşturma İstek Yapısı
Copy
1
2interface TenantUserPostQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
TenantUser Oluşturma Yanıt Yapısı
Copy
1
2interface TenantUserPostResponse {
3 status: 'success' | 'failed'
4 /** Başarısızlık durumunda dahil edilir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'username-required' | 'email-required' | 'sign-up-date-in-future' | 'unsupported-locale' | 'unauthorized' | 'username-taken' | 'email-taken' | 'tenant-user-limit-reached'
6 /** Başarısızlık durumunda dahil edilir. **/
7 reason?: string
8 tenantUser?: TenantUser; // Başarı durumunda oluşturulan tenant kullanıcıyı eksiksiz döneriz.
9}
10
POST /api/v1/tenant-users/:id/send-login-link
Resource: TenantUser as POST /api/v1/tenant-users/:id/send-login-link Credit Cost: 10
Bu rota tek bir TenantUser'a giriş bağlantısı gönderebilme imkanı sağlar.
Kullanıcıları toplu oluştururken ve onlara FastComments.com'a nasıl giriş yapacaklarını anlatmak zorunda olmadığınız durumlarda faydalıdır. Bu, onlara giriş yapmak için süresi dolan bir "sihirli bağlantı" gönderecektir; süresi 30 days sonra sona erer.
Bir TenantUser'a giriş bağlantısı göndermek için aşağıdaki kısıtlamalar geçerlidir:
TenantUserzaten mevcut olmalıdır.TenantUser'ın ait olduğuTenant'ı yönetme erişiminiz olmalıdır.
Bir TenantUser'a giriş bağlantısı şu şekilde gönderilebilir:
TenantUser Giriş Bağlantısı cURL Örneği
Copy
1
2curl --request POST \
3 --url 'https://fastcomments.com/api/v1/tenant-users/xyz/send-login-link?tenantId=demo&API_KEY=DEMO_API_SECRET' \
4 --header 'Content-Type: application/json'
5
Bu, şu şekilde bir e-posta gönderecektir: Bob at TenantName is inviting you to be a moderator...
TenantUser Giriş Bağlantısı İstek Yapısı
Copy
1
2interface TenantUserPostQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
TenantUser Giriş Bağlantısı Yanıt Yapısı
Copy
1
2interface TenantUserPostResponse {
3 status: 'success' | 'failed'
4 /** Başarısızlık durumunda dahil edilir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'unauthorized' | 'not-found'
6 /** Başarısızlık durumunda dahil edilir. **/
7 reason?: string
8}
9
PATCH /api/v1/tenant-users/:id
Resource: TenantUser as PATCH /api/v1/tenant-users/:id Credit Cost: 1
This route provides the ability to update a single TenantUser.
Updating a TenantUser has the following restrictions:
- The
signUpDatemay not be in the future. - The
localemust be in the list of Supported Locales. - The
usernamemust be unique across all of FastComments.com. If this is an issue, we suggest using SSO instead. - The
emailmust be unique across all of FastComments.com. If this is an issue, we suggest using SSO instead. - You cannot update the
tenantIdof a user.
We can create a TenantUser as follows
TenantUser Güncelleme cURL Örneği
Copy
1
2curl --request PATCH \
3 --url 'https://fastcomments.com/api/v1/tenant-users/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET' \
4 --header 'Content-Type: application/json' \
5 --data '{
6 "username": "Some Name",
7 "email": "someone@someone.com"
8}'
9
TenantUser Güncelleme İstek Yapısı
Copy
1
2interface TenantUserPatchQueryParams {
3 tenantId: string
4 API_KEY: string
5 /** E-posta veya kullanıcı adı değiştirildiğinde, kullanıcının yorumlarını da güncellemek için bunu true olarak ayarlayabilirsiniz. Bu kredi maliyetini iki katına çıkarır. **/
6 updateComments: 'true' | 'false'
7}
8
TenantUser Güncelleme Yanıt Yapısı
Copy
1
2interface TenantUserPatchResponse {
3 status: 'success' | 'failed'
4 /** Başarısızlık durumunda dahil edilir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'sign-up-date-in-future' | 'unsupported-locale' | 'unauthorized' | 'username-taken' | 'email-taken' | 'unauthorized' | 'no-package' | 'invalid-package' | 'tenant-user-limit-reached' | 'user-does-not-exist'
6 /** Başarısızlık durumunda dahil edilir. **/
7 reason?: string
8}
9
DELETE /api/v1/tenant-users/:id
Resource: TenantUser as DELETE /api/v1/tenant-users/:id Credit Cost: 5
Bu rota bir TenantUser'ı id ile kaldırmayı sağlar.
Kullanıcının yorumlarının silinmesi deleteComments sorgu parametresi ile mümkündür. Bunun true olması durumunda:
- Kullanıcının tüm yorumları canlı olarak silinecektir.
- Tüm child (şimdi öksüz) yorumlar, her yorumun ilişkili sayfa yapılandırmasına göre silinecek veya anonimleştirilecektir. Örneğin konu silme modu "anonymize" ise yanıtlar kalır ve kullanıcının yorumları anonimleştirilir. Bu yalnızca
commentDeleteModeRemoveolduğunda (varsayılan değer) geçerlidir. creditsCostdeğeri2olur.
Anonymized Comments
Kullanıcının yorumlarını saklayabilir fakat commentDeleteMode=1 ayarlayarak bunları yalnızca anonimleştirebilirsiniz.
Kullanıcının yorumları anonimleştirildiğinde aşağıdaki değerler null olarak ayarlanır:
- commenterName
- commenterEmail
- avatarSrc
- userId
- anonUserId
- mentions
- badgesisDeleted ve isDeletedUser true olarak ayarlanır.
Render edilirken, yorum widget'ı kullanıcının adı için DELETED_USER_PLACEHOLDER (varsayılan: "[deleted]") ve yorum için DELETED_CONTENT_PLACEHOLDER kullanır. Bunlar Widget Özelleştirme UI'sı aracılığıyla özelleştirilebilir.
Examples
TenantUser Kaldırma cURL Örneği
Copy
1
2curl --request DELETE \
3 --url 'https://fastcomments.com/api/v1/tenant-users/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
TenantUser Kaldırma İstek Yapısı
Copy
1
2enum TenantUserCommentDeleteMode {
3 Remove = 0, // varsayılan
4 Anonymize = 1
5}
6
7interface TenantUserDeleteQueryParams {
8 tenantId: string
9 API_KEY: string
10 /** Kullanıcının yorumlarını aynı zamanda silmek için bunu true olarak ayarlayabilirsiniz. Bu kredi maliyetini iki katına çıkarır. **/
11 deleteComments?: 'true' | 'false'
12 /** Kullanıcının yorumlarının nasıl ele alınacağını belirlemek için bunu istediğiniz gibi ayarlayabilirsiniz. **/
13 commentDeleteMode?: TenantUserCommentDeleteMode
14}
15
TenantUser Kaldırma Yanıt Yapısı
Copy
1
2interface TenantUserDeleteResponse {
3 status: 'success' | 'failed'
4 /** Başarısızlık durumunda dahil edilir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'not-found' | 'unauthorized'
6 /** Başarısızlık durumunda dahil edilir. **/
7 reason?: string
8}
9
Kullanıcı Yapısı
User tüm kullanıcı türlerinin en yaygın ortak paydasını temsil eden bir nesnedir.
Unutmayın ki FastComments'ta kullanıcılar için birçok farklı kullanım durumu bulunur:
- Secure SSO
- Simple SSO
- Tenant Users (Örneğin: Yöneticiler)
- Commenters
Bu API Commenters ve Simple SSO aracılığıyla oluşturulan kullanıcılar içindir. Temelde, siteniz üzerinden oluşturulan herhangi bir kullanıcıya bu API aracılığıyla erişilebilir. Tenant Users da bu şekilde alınabilir, ancak /tenant-users/ API'si ile etkileşime girerek daha fazla bilgi edinebilirsiniz.
Secure SSO için lütfen /sso-users/ API'sini kullanın.
Bu tür kullanıcıları güncelleyemezsiniz. Hesaplarını siteniz aracılığıyla oluşturmuşlardır, bu yüzden temel bazı salt okunur erişim sağlıyoruz, ancak değişiklik yapamazsınız. Bu tür bir akışa sahip olmak istiyorsanız - Secure SSO'yu kurmanız gerekir.
User nesnesinin yapısı aşağıdaki gibidir:
Kullanıcı Yapısı
Copy
1
2export interface User {
3 /** Bu, yorum nesnelerindeki userId olarak da kullanılan id'dir. **/
4 id: string
5 username: string
6 /** Örneğin yorumcunun bloguna bir bağlantı. **/
7 websiteUrl?: string
8 email: string
9 signUpDate: number
10 createdFromUrlId: string
11 createdFromTenantId: string
12 avatarSrc?: string
13 locale: FastCommentsLocale
14 displayLabel?: string
15 karma?: number
16}
17
GET /api/v1/users/:id
Resource: User as GET /api/v1/users/:id Credit Cost: 1
Bu rota id ile tek bir Kullanıcı döndürür.
ID ile Kullanıcı cURL Örneği
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/users/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
Kullanıcı İstek Yapısı
Copy
1
2interface UserByIdQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
Kullanıcı Yanıt Yapısı
Copy
1
2interface UserByIdResponse {
3 status: 'success' | 'failed'
4 /** Başarısızlık durumunda dahil edilir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found' | 'unauthorized'
6 /** Başarısızlık durumunda dahil edilir. **/
7 reason?: string
8 user?: User
9}
10
Oy Yapısı
Bir Vote nesnesi, bir kullanıcı tarafından bırakılan bir oyu temsil eder.
Yorumlar ile oy arasındaki ilişki commentId aracılığıyla tanımlanır.
Vote nesnesinin yapısı aşağıdaki gibidir:
Vote Yapısı
Copy
1
2interface Vote {
3 id: string
4 urlId: string
5 commentId: string
6 userId: string
7 direction: 1 | -1
8 createdAt: string
9}
10
GET /api/v1/votes
Resource: Vote as GET /api/v1/votes Credit Cost: 10
Oylar urlId ile alınmalıdır.
Oy Türleri
Üç tür oy vardır:
- Kimliği doğrulanmış oylar, ilgili yoruma uygulanır. Bunları bu API aracılığıyla oluşturabilirsiniz.
- Kimliği doğrulanmış oylar, doğrulama için beklemede olan ve bu nedenle henüz yoruma uygulanmamış olanlar. Bunlar bir kullanıcı FastComments.com oy vermek için giriş yap mekanizmasını kullandığında oluşturulur.
- Anonim oylar, ilgili yoruma uygulanır. Bunlar anonim yorumla birlikte oluşturulur.
Bunlar karışıklığı azaltmak için API'de ayrı listeler halinde döndürülür.
Oylar cURL Örneği
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/votes?tenantId=demo&API_KEY=DEMO_API_SECRET&urlId=test'
4
Oylar İstek Yapısı
Copy
1
2interface VotesRequestQueryParams {
3 tenantId: string
4 API_KEY: string
5 urlId: string
6}
7
Oylar Yanıt Yapısı
Copy
1
2interface VotesResponse {
3 status: 'success' | 'failed'
4 /** Başarısızlık durumunda dahil edilir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-url-id'
6 /** Başarısızlık durumunda dahil edilir. **/
7 reason?: string
8 /** Yetkili, doğrulanmış oylar, ilgili yorumlarına uygulanmış. **/
9 appliedAuthorizedVotes: Vote[]
10 /** Anonim oylar, ilgili yorumlarına uygulanmış. **/
11 appliedAnonymousVotes: Vote[]
12 /** Doğrulama bekleyen oylar, henüz ilgili yorumlarına uygulanmamış. **/
13 pendingVotes: Vote[]
14}
15
Anonim Oylar Notları
Bu API aracılığıyla oluşturulan anonim oyların appliedAuthorizedVotes listesinde görüneceğini unutmayın. API anahtarıyla API aracılığıyla oluşturuldukları için yetkili olarak kabul edilirler.
appliedAnonymousVotes yapısı e-posta, API anahtarı vb. olmadan oluşturulan oylar içindir.
GET /api/v1/votes/for-user
Resource: Vote as GET /api/v1/votes/for-user Credit Cost: 1
Belirli bir urlId üzerinde bir kullanıcı tarafından bırakılan oyları getirmeyi sağlar. Herhangi bir FastComments.com veya SSO User olabilecek bir userId alır.
Bu, bir kullanıcının bir yoruma oy verip vermediğini göstermek istiyorsanız yararlıdır. Yorumları getirirken, aynı urlId ile kullanıcı için aynı anda bu API'yi çağırmanız yeterlidir.
Eğer anonim oy kullanıyorsanız bunun yerine anonUserId göndermek isteyeceksiniz.
Kullanıcı için Oylar cURL Örneği
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/votes/for-user?tenantId=demo&API_KEY=DEMO_API_SECRET&urlId=test&userId=some-user-id'
4
Anonim Kullanıcı için Oylar cURL Örneği
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/votes/for-user?tenantId=demo&API_KEY=DEMO_API_SECRET&urlId=test&anonUserId=some-user-id'
4
Anonim oyların appliedAuthorizedVotes listesinde görüneceğini unutmayın. API anahtarı ile API üzerinden oluşturuldukları için yetkili kabul edilirler.
Kullanıcı için Oylar İstek Yapısı
Copy
1
2interface VotesForUserRequestQueryParams {
3 tenantId: string
4 API_KEY: string
5 urlId: string
6 userId?: string
7 anonUserId?: string
8}
9
Kullanıcı için Oylar Yanıt Yapısı
Copy
1
2interface VotesForUserResponse {
3 status: 'success' | 'failed'
4 /** Başarısızlık durumunda eklenir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-url-id' | 'invalid-user-id'
6 /** Başarısızlık durumunda eklenir. **/
7 reason?: string
8 /** Yetkili ve doğrulanmış oylar; ilgili yorumlara uygulanır. **/
9 appliedAuthorizedVotes: Vote[]
10 /** Doğrulama bekleyen oylar; henüz ilgili yorumlara uygulanmamıştır. **/
11 pendingVotes: Vote[]
12}
13
POST /api/v1/votes
Resource: Vote as POST /api/v1/votes Credit Cost: 1
Bu rota tek bir yetkili Vote ekleme yeteneği sağlar. Oylar up (+1) veya down (-1) olabilir.
Oy Oluşturma cURL Örneği
Copy
1
2curl --request POST \
3 --url 'https://fastcomments.com/api/v1/votes?tenantId=demo&API_KEY=DEMO_API_SECRET&userId=user-id&commentId=comment-id&direction=up' \
4 --header 'Content-Type: application/json'
5
Anonim Oy Oluşturma cURL Örneği
Copy
1
2curl --request POST \
3 --url 'https://fastcomments.com/api/v1/votes?tenantId=demo&API_KEY=DEMO_API_SECRET&anonUserId=some-randomly-generated-identifier&commentId=comment-id&direction=up' \
4 --header 'Content-Type: application/json'
5
Oy Oluşturma İstek Yapısı
Copy
1
2interface VotePostQueryParams {
3 tenantId: string
4 API_KEY: string
5 userId?: string
6 anonUserId?: string
7 commentId: string
8 direction: 'up' | 'down'
9}
10
Oy Oluşturma Yanıt Yapısı
Copy
1
2interface VotePostResponse {
3 status: 'success' | 'failed'
4 /** Başarısızlık durumunda dahil edilir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-user-id' | 'invalid-user-id' | 'invalid-comment-id' | 'invalid-direction' | 'duplicate' | 'voting-disabled'
6 /** Başarısızlık durumunda dahil edilir. **/
7 reason?: string
8 voteId?: string
9}
10
Anonim Oy Oluşturma
Anonim oylar, sorgu parametrelerinde userId yerine anonUserId ayarlanarak oluşturulabilir.
Bu id herhangi bir kullanıcı nesnesiyle eşleşmek zorunda değildir (dolayısıyla anonim). Bu, yalnızca oturum için bir tanımlayıcıdır, böylece aynı oturum içinde oyları tekrar alabilir ve bir yorumun oylandığını kontrol edebilirsiniz.
Eğer FastComments'ın sahip olduğu gibi "anonim oturumlar" gibi bir şeye sahip değilseniz - bunu basitçe rastgele bir ID'ye, örneğin bir UUID'ye ayarlayabilirsiniz (ancak alan tasarrufu için daha küçük tanımlayıcıları tercih ediyoruz).
Diğer Notlar
- Bu API, tenant düzeyindeki ayarlara uyar. Örneğin, belirli bir sayfa için oylamayı devre dışı bırakırsanız ve API aracılığıyla bir oy oluşturmaya çalışırsanız,
voting-disabledhata kodu ile başarısız olur. - Bu API varsayılan olarak canlıdır.
- Bu API, ilgili
Comment'invotesalanını güncelleyecektir.
DELETE /api/v1/votes/:id
Resource: Vote as DELETE /api/v1/votes/:id Credit Cost: 1
Bu rota tek bir Vote'u silme imkanı sağlar.
Vote Silme cURL Örneği
Copy
1
2curl --request DELETE \
3 --url 'https://fastcomments.com/api/v1/votes/some-id?tenantId=demo&API_KEY=DEMO_API_SECRET' \
4 --header 'Content-Type: application/json'
5
Vote Silme İstek Yapısı
Copy
1
2interface VoteDeleteQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
Vote Silme Yanıt Yapısı
Copy
1
2interface VoteDeleteResponse {
3 status: 'success' | 'failed'
4 /** Hata durumunda eklenir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id'
6 /** Hata durumunda eklenir. **/
7 reason?: string
8}
9
Notlar:
- Bu API, kiracı düzeyindeki ayarlara uyar. Örneğin, belirli bir sayfa için oylamayı devre dışı bırakırsanız ve API üzerinden bir oy oluşturmaya çalışırsanız,
voting-disabledhata kodu ile başarısız olur. - Bu API varsayılan olarak canlıdır.
- Bu API, ilgili
Comment'invotesdeğerini güncelleyecektir.
Alan Adı Yapılandırması Yapısı
A DomainConfig object represents configuration for a domain for a tenant.
The structure for the DomainConfig object is as follows:
Domain Yapılandırma Yapısı
Copy
1
2interface DomainConfig {
3 /** Bir alan adı, URL değil, örneğin "fastcomments.com" veya "www.example.com". Alt alan sınırlandırması isteniyorsa alt alan adı dahil edilebilir. En fazla 1000 karakter. **/
4 domain: string
5 /** E-posta gönderiminde kullanılan Gönderici Adı. **/
6 emailFromName?: string
7 /** E-posta gönderiminde kullanılan Gönderen E-posta adresi. Bu öznitelikte kullanılan alan adına mail.fastcomments.com'un e-posta göndermesine izin verecek şekilde SPF ayarlandığından emin olun. **/
8 emailFromEmail?: string
9 /** SADECE OKUNUR. Nesnenin oluşturulma zamanı. **/
10 createdAt: string
11 /** Bu domaine ait logo. E-postalarda kullanılır. HTTPS kullanın. **/
12 logoSrc?: string
13 /** Bu domaine ait daha küçük logo. HTTPS kullanın. **/
14 logoSrc100px?: string
15 /** YALNIZCA SSO. Gönderilen her e-postanın altbilgisinde kullanılan URL. "[userId]" değişkenini destekler. **/
16 footerUnsubscribeURL?: string
17 /** YALNIZCA SSO. Gönderilen her e-postada kullanılan başlıklar. Örneğin teslimatı iyileştirmek için abonelikten çıkma ile ilgili başlıkların ayarlanması için yararlıdır. Bu kayıttaki List-Unsubscribe girdisi, varsa, "[userId]" değişkenini destekler. **/
18 emailHeaders?: Record<string, string>
19 /** Tüm abonelikten çıkma bağlantılarını devre dışı bırakır. Önerilmez, teslimat oranlarını olumsuz etkileyebilir. **/
20 disableUnsubscribeLinks?: boolean
21 /** DKIM Yapılandırması. **/
22 dkim?: DomainConfigDKIM
23}
24
DKIM Yapılandırma Yapısı
Copy
1
2interface DomainConfigDKIM {
3 /** DKIM kaydınızdaki alan adı. **/
4 domainName: string
5 /** Kullanılacak DKIM anahtar seçicisi. **/
6 keySelector: string
7 /** Özel anahtarınız. -----BEGIN PRIVATE KEY----- ile başlamalı ve -----END PRIVATE KEY----- ile bitmelidir **/
8 privateKey: string
9}
10
Kimlik Doğrulama
Alan Yapılandırması, hesabınız için hangi sitelerin FastComments widget'ını barındırabileceğini belirlemek için kullanılır. Bu temel bir kimlik doğrulama biçimidir, yani herhangi bir Alan Yapılandırması eklenmesi veya kaldırılması, FastComments kurulumunuzun üretimdeki kullanılabilirliğini etkileyebilir.
Halihazırda kullanımda olan bir alan için Domain Config içindeki domain özelliğini, o alanı devre dışı bırakmak amaçlanmıyorsa, kaldırmayın veya güncellemeyin.
Bu, /auth/my-account/configure-domains'den bir alanı kaldırma ile aynı davranışı gösterir.
Ayrıca, My Domains UI'dan bir alanı kaldırmanın, bu UI aracılığıyla eklenmiş olabilecek o alana ait ilgili yapılandırmayı da kaldıracağını unutmayın.
E-posta Özelleştirmesi İçin
E-posta altbilgisindeki abonelikten çıkma bağlantısı ve birçok e-posta istemcisinin sunduğu tek tıklamayla abonelikten çıkma özelliği, sırasıyla footerUnsubscribeURL ve emailHeaders tanımlanarak bu API aracılığıyla yapılandırılabilir.
DKIM İçin
DKIM DNS kayıtlarınızı tanımladıktan sonra, tanımlı yapıyı kullanarak DKIM yapılandırmanızı DomainConfig ile güncellemeniz yeterlidir.
GET /api/v1/domain-configs
Resource: Comment as GET /api/v1/domain-configs Credit Cost: 1
Bu API, bir kiracı için tüm DomainConfig nesnelerini getirme yeteneği sağlar.
DomainConfig GET cURL Örneği
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/domain-configs?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
DomainConfig GET İstek Yapısı
Copy
1
2interface GetDomainConfigsRequestQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
DomainConfig GET Yanıt Yapısı
Copy
1
2interface GetDomainConfigsResponse {
3 status: 'success' | 'failed'
4 /** Hata durumunda dahil edilir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
6 /** Hata durumunda dahil edilir. **/
7 reason?: string
8 /** Yapılandırmalar! **/
9 configurations: DomainConfig[] | null
10}
11
GET /api/v1/domain-configs/:domain
Resource: DomainConfig as GET /api/v1/domain-configs/:domain Credit Cost: 1
Bireysel DomainConfig'ler, karşılık gelen domain ile alınabilir.
Alan Bazında Domain Yapılandırması cURL Örneği
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/domain-configs/example.com?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
Alan Bazında Domain Yapılandırması İstek Yapısı
Copy
1
2interface DomainConfigsByDomainRequestQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
Alan Bazında Domain Yapılandırması Yanıt Yapısı
Copy
1
2interface DomainConfigResponse {
3 status: 'success' | 'failed'
4 /** Başarısızlık durumunda dahil edilir. **/
5 code?: 'internal' | 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-url-id' | 'missing-domain' | 'update-would-create-duplicate' | 'domain-does-not-exist'
6 /** Başarısızlık durumunda dahil edilir. **/
7 reason?: string
8 configuration?: DomainConfig | null
9}
10
POST /api/v1/domain-configs
Resource: DomainConfig as POST /api/v1/domain-configs Credit Cost: 1
Bu API uç noktası alan adı yapılandırmaları oluşturma yeteneği sağlar.
Bir alan adı için yapılandırma eklemek, o alan adını FastComments hesabı için yetkilendirir.
Bu API'nin yaygın kullanım durumları başlangıç kurulumu, birçok alan adı eklenmesi gerektiğinde veya e-posta gönderimi için özel yapılandırmadır.
DomainConfig POST cURL Örneği
Copy
1
2curl --request POST \
3 --url 'https://fastcomments.com/api/v1/domain-configs?tenantId=demo&API_KEY=DEMO_API_SECRET' \
4 --header 'Content-Type: application/json' \
5 --data '{
6 "domain": "example.com",
7 "emailFromName": "some from name",
8 "emailFromEmail": "some@test.com",
9 "logoSrc": "https://example.com/my-logo-big.png",
10 "logoSrc100px": "https://example.com/my-logo-100px.png",
11 "footerUnsubscribeURL": "http://example.com/unsubscribe-ui",
12 "emailHeaders": {
13 "List-Unsubscribe-Post": "List-Unsubscribe=One-Click",
14 "List-Unsubscribe": "<https://example.com/opt-out/[userId]>"
15 }
16}'
17
DomainConfig POST İstek Yapısı
Copy
1
2interface DomainConfigPostQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
DomainConfig POST Yanıt Yapısı
Copy
1
2
3interface DomainConfigPostResponse {
4 status: 'success' | 'failed'
5 /** Başarısızlık durumunda dahil edilir. **/
6 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'empty-request' | 'internal' | 'invalid-input' | 'missing-domain' | 'configuration-exists-for-domain' | 'domain-too-long' | 'domain-invalid';
7 /** Başarısızlık durumunda dahil edilir. **/
8 reason?: string
9 /** Oluşturulan yapılandırma. **/
10 configuration?: DomainConfig
11}
12
PATCH /api/v1/domain-configs/:domain
Resource: DomainConfig as PATCH /api/v1/domain-configs/:domain Credit Cost: 1
Bu API uç noktası, yalnızca alan adını ve güncellenecek özniteliği belirterek bir alan yapılandırmasını güncelleme yeteneği sağlar.
DomainConfig PATCH cURL Örneği
Copy
1
2curl --request PATCH \
3 --url 'https://fastcomments.com/api/v1/domain-configs/example.com?tenantId=demo&API_KEY=DEMO_API_SECRET' \
4 --header 'Content-Type: application/json' \
5 --data '{
6 "emailFromName": "Some New From Name",
7}'
8
DomainConfig PATCH İstek Yapısı
Copy
1
2interface DomainConfigPatchQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
DomainConfig PATCH Yanıt Yapısı
Copy
1
2
3interface DomainConfigPatchResponse {
4 status: 'success' | 'failed'
5 /** Başarısızlık durumunda dahil edilir. **/
6 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'empty-request' | 'internal' | 'invalid-input' | 'missing-domain' | 'domain-does-not-exist' | 'update-would-create-duplicate' | 'domain-too-long' | 'domain-invalid';
7 /** Başarısızlık durumunda dahil edilir. **/
8 reason?: string
9 /** Güncellenmiş yapılandırma. **/
10 configuration?: DomainConfig
11}
12
PUT /api/v1/domain-configs/:domain
Resource: DomainConfig as PUT /api/v1/domain-configs/:domain Credit Cost: 1
Bu API uç noktası bir alan yapılandırmasını değiştirme yeteneği sağlar.
DomainConfig PUT cURL Örneği
Copy
1
2curl --request PUT \
3 --url 'https://fastcomments.com/api/v1/domain-configs/example.com?tenantId=demo&API_KEY=DEMO_API_SECRET' \
4 --header 'Content-Type: application/json' \
5 --data '{
6 "domain": "new-domain-example.com",
7 "emailFromName": "some from name",
8 "emailFromEmail": "some@test.com",
9 "logoSrc": "https://example.com/my-logo-big.png",
10 "logoSrc100px": "https://example.com/my-logo-100px.png",
11 "footerUnsubscribeURL": "http://example.com/unsubscribe-ui",
12 "emailHeaders": {
13 "List-Unsubscribe-Post": "List-Unsubscribe=One-Click",
14 "List-Unsubscribe": "<https://example.com/opt-out/[userId]>"
15 }
16}'
17
DomainConfig PUT İstek Yapısı
Copy
1
2interface DomainConfigPutQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
DomainConfig PUT Yanıt Yapısı
Copy
1
2
3interface DomainConfigPutResponse {
4 status: 'success' | 'failed'
5 /** Başarısızlık durumunda dahil edilir. **/
6 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'empty-request' | 'internal' | 'invalid-input' | 'missing-domain' | 'domain-does-not-exist' | 'update-would-create-duplicate' | 'domain-too-long' | 'domain-invalid';
7 /** Başarısızlık durumunda dahil edilir. **/
8 reason?: string
9 /** Güncellenmiş yapılandırma. **/
10 configuration?: DomainConfig
11}
12
DELETE /api/v1/domain-configs/:domain
Resource: DomainConfig as DELETE /api/v1/domain-configs/:domain Credit Cost: 1
Bu rota, tek bir DomainConfig'in id'sine göre kaldırılmasını sağlar.
- Not: Bir
DomainConfig'in kaldırılması, o alan adının FastComments kullanma yetkisini kaldırır. - Not: UI üzerinden bir alan adını yeniden eklemek nesneyi yeniden oluşturur (yalnızca
domainalanı doldurulmuş olarak).
DomainConfig Kaldırma cURL Örneği
Copy
1
2curl --request DELETE \
3 --url 'https://fastcomments.com/api/v1/domain-configs/example.com?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
DomainConfig Kaldırma İstek Yapısı
Copy
1
2interface DomainConfigRequestQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
DomainConfig Kaldırma Yanıt Yapısı
Copy
1
2interface DomainConfigDeleteResponse {
3 status: 'success' | 'failed'
4 /** Başarısızlık halinde dahil edilir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-domain' | 'domain-config-does-not-exist'
6 /** Başarısızlık halinde dahil edilir. **/
7 reason?: string
8}
9
Soru Yapılandırması Yapısı
FastComments, soru oluşturma ve bunların sonuçlarını toplama yolu sağlar. Bir soru örneği (bundan sonra QuestionConfig olarak anılacaktır)
yıldız derecelendirmesi, bir kaydırıcı veya bir NPS sorusu olabilir (type ile belirlenir).
Soru verileri ayrı ayrı, birlikte, zaman içinde, genel olarak, sayfaya göre vb. şekilde toplanabilir.
Bu çerçeve, istemci tarafı widget'ları (bu API'nin önünde sunucunuzla), yönetici panolarını ve raporlama araçlarını oluşturmak için gereken tüm yeteneklere sahiptir.
İlk olarak bir QuestionConfig tanımlamamız gerekiyor. Yapısı şu şekildedir:
QuestionConfig Yapısı
Copy
1
2type QuestionConfigType = 'nps' | 'slider' | 'star' | 'thumbs';
3
4interface QuestionConfig {
5 id: string
6 tenantId: string
7 name: string
8 question: string
9 helpText?: string
10 createdAt: string
11 createdBy: string
12 /** SADECE OKUNUR - her yeni yanıta göre artırılır. **/
13 usedCount: number
14 /** Yapılandırmanın en son ne zaman kullanıldığına (sonucun bırakıldığı) dair bir tarih dizgesi. **/
15 lastUsed?: string
16 type: QuestionConfigType
17 numStars?: number
18 min?: number
19 max?: number
20 defaultValue?: number
21 labelNegative?: string
22 labelPositive?: string
23 subQuestionIds?: string[]
24 alwaysShowSubQuestions?: boolean
25 reportingOrder: number
26}
27
GET /api/v1/question-configs
Resource: QuestionConfig as GET /api/v1/question-configs Credit Cost: 1
Bu rota sayfalandırılmış şekilde tek seferde en fazla 100 QuestionConfig nesnesi döndürür. Maliyet 100 nesne başına 1'dir. Bunlar
soru metnine göre artan sırada sıralanırlar (question alanı).
QuestionConfig Örneği
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/question-configs?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
QuestionConfig İstek Yapısı
Copy
1
2interface QuestionConfigRequestByIdQueryParams {
3 tenantId: string
4 API_KEY: string
5 /** Sayfalama için. 0'dan başlar. **/
6 skip?: number
7}
8
QuestionConfig Yanıt Yapısı
Copy
1
2interface QuestionConfigByIdResponse {
3 status: 'success' | 'failed'
4 /** Başarısızlık durumunda dahil edilir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
6 /** Başarısızlık durumunda dahil edilir. **/
7 reason?: string
8 questionConfigs: QuestionConfig[]
9}
10
GET /api/v1/question-configs/:id
Resource: QuestionConfig as GET /api/v1/question-configs/:id Credit Cost: 1
Bu rota verilen id ile tek bir QuestionConfig döndürür.
QuestionConfig ID'ye Göre cURL Örneği
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/question-configs/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
QuestionConfig İstek Yapısı
Copy
1
2interface QuestionConfigRequestByIdQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
QuestionConfig Yanıt Yapısı
Copy
1
2interface QuestionConfigByIdResponse {
3 status: 'success' | 'failed'
4 /** Başarısızlık durumunda dahil edilir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found'
6 /** Başarısızlık durumunda dahil edilir. **/
7 reason?: string
8 questionConfig?: QuestionConfig
9}
10
POST /api/v1/question-configs
Resource: QuestionConfig as POST /api/v1/question-configs Credit Cost: 1
Bu API uç noktası bir QuestionConfig oluşturma yeteneği sağlar.
QuestionConfig POST cURL Örneği
Copy
1
2curl --request POST \
3 --url 'https://fastcomments.com/api/v1/question-configs?tenantId=demo&API_KEY=DEMO_API_SECRET' \
4 --header 'Content-Type: application/json' \
5 --data '{
6 "name": "Some name that shows on reports.",
7 "question": "how much do you like this api?",
8 "type": 'slider',
9 "reportingOrder": 0,
10 "min": 0,
11 "max": 10
12}'
13
QuestionConfig POST İstek Yapısı
Copy
1
2interface QuestionConfigPostQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
QuestionConfig POST Yanıt Yapısı
Copy
1
2
3interface QuestionConfigPostResponse {
4 status: 'success' | 'failed'
5 /** Başarısızlık durumunda dahil edilir. **/
6 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'empty-request' | 'internal' | 'invalid-input';
7 /** Başarısızlık durumunda dahil edilir. **/
8 reason?: string
9 /** Oluşturulan nesne. **/
10 questionConfig?: QuestionConfig
11}
12
PATCH /api/v1/question-configs/:id
Resource: QuestionConfig as PATCH /api/v1/question-configs/:id Credit Cost: 1
Bu rota tek bir QuestionConfig'i güncelleme olanağı sağlar.
Aşağıdaki yapı değiştirilebilecek tüm değerleri temsil eder:
QuestionConfig Yapısı
Copy
1
2interface QuestionConfigPatchBody {
3 name?: string
4 question?: string
5 helpText?: string
6 /** Dikkat! type değiştirildiğinde raporlama min/max farklıysa etkilenebilir. **/
7 type?: QuestionConfigType
8 numStars?: number
9 min?: number
10 max?: number
11 defaultValue?: number
12 labelNegative?: string
13 labelPositive?: string
14 subQuestionIds?: string[]
15 alwaysShowSubQuestions?: boolean
16 reportingOrder?: number
17}
18
QuestionConfig Güncelleme cURL Örneği
Copy
1
2curl --request PATCH \
3 --url 'https://fastcomments.com/api/v1/question-configs/my-id?tenantId=demo&API_KEY=DEMO_API_SECRET' \
4 --header 'Content-Type: application/json' \
5 --data '{
6 "question": "some new question text"
7}'
8
QuestionConfig Güncelleme İstek Yapısı
Copy
1
2interface QuestionConfigPatchQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
QuestionConfig Güncelleme Yanıt Yapısı
Copy
1
2interface QuestionConfigPatchResponse {
3 status: 'success' | 'failed'
4 /** Hata durumunda dahil edilir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'unauthorized' | 'missing-api-key' | 'missing-id' | 'not-found' | 'empty-request' | 'invalid-input'
6 /** Hata durumunda dahil edilir. **/
7 reason?: string
8}
9
DELETE /api/v1/question-configs/:id
Resource: QuestionConfig as DELETE /api/v1/question-configs/:id Credit Cost: 100
Bu rota, bir QuestionConfig'ı id ile kaldırmayı sağlar.
Bu, ilgili tüm soru sonuçlarını silecektir (ancak yorumları silmez). Bu, yüksek kredi maliyetinin bir parçasıdır.
QuestionConfig Kaldırma cURL Örneği
Copy
1
2curl --request DELETE \
3 --url 'https://fastcomments.com/api/v1/question-configs/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
QuestionConfig Kaldırma İstek Yapısı
Copy
1
2interface QuestionConfigDeleteQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
QuestionConfig Kaldırma Yanıt Yapısı
Copy
1
2interface QuestionConfigResponse {
3 status: 'success' | 'failed'
4 /** Başarısızlık halinde dahil edilir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found'
6 /** Başarısızlık halinde dahil edilir. **/
7 reason?: string
8}
9
Soru Sonucu Yapısı
Sorular için sonuçları kaydetmek amacıyla bir QuestionResult oluşturursunuz. Ardından soru sonuçlarını toplu hâlde işleyebilir ve raporlama amaçları için yorumlara bağlayabilirsiniz.
QuestionResult Yapısı
Copy
1
2interface QuestionResultMeta {
3 name: string
4 values: string[]
5}
6
7interface QuestionResult {
8 id: string
9 tenantId: string
10 urlId: string
11 anonUserId?: string
12 userId?: string
13 createdAt?: string
14 value: number
15 commentId?: string
16 questionId: string
17 meta?: QuestionResultMeta[]
18}
19
GET /api/v1/question-results
Resource: QuestionResults as GET /api/v1/question-results Credit Cost: 1
Bu rota sayfalandırılmış olarak aynı anda en fazla 1000 QuestionResults nesnesi döndürür. Ücret her 100 nesne için 1'dir. Onlar
createdAt'e göre artan sırada sıralanırlar. Çeşitli parametrelere göre filtreleyebilirsiniz.
QuestionResults Örneği
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/question-results?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
QuestionResults İstek Yapısı
Copy
1
2interface QuestionResultsRequestQueryParams {
3 tenantId: string
4 API_KEY: string
5 /** Sayfalandırma için. 0'dan başlar. **/
6 skip?: number
7 /** Sayfalandırma için. **/
8 limit?: number
9 /** Belirli bir sayfadan sonuçları alır. **/
10 urlId?: string
11 /** Belirli bir kullanıcıdan sonuçları alır. **/
12 userId?: string
13 startDate?: string | number
14 questionId?: string | string[]
15}
16
QuestionResults Yanıt Yapısı
Copy
1
2interface QuestionResultsResponse {
3 status: 'success' | 'failed'
4 /** Başarısızlık halinde eklenir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
6 /** Başarısızlık halinde eklenir. **/
7 reason?: string
8 questionResults: QuestionResults[]
9}
10
GET /api/v1/question-results/:id
Resource: QuestionResult as GET /api/v1/question-results/:id Credit Cost: 1
Bu rota, id'sine göre tek bir QuestionResult döndürür.
ID ile QuestionResult cURL Örneği
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/question-results/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
QuestionResult İstek Yapısı
Copy
1
2interface QuestionResultRequestByIdQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
QuestionResult Yanıt Yapısı
Copy
1
2interface QuestionResultByIdResponse {
3 status: 'success' | 'failed'
4 /** Başarısızlık halinde dahil edilir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found'
6 /** Başarısızlık halinde dahil edilir. **/
7 reason?: string
8 questionResult?: QuestionResult
9}
10
POST /api/v1/question-results
Resource: QuestionResult as POST /api/v1/question-results Credit Cost: 1
Bu API uç noktası bir QuestionResult oluşturma yeteneği sağlar.
QuestionResult POST cURL Örneği
Copy
1
2curl --request POST \
3 --url 'https://fastcomments.com/api/v1/question-results?tenantId=demo&API_KEY=DEMO_API_SECRET' \
4 --header 'Content-Type: application/json' \
5 --data '{
6 "urlId": "some-page-id",
7 "anonUserId": 'anon-0',
8 "userId": 'user-0',
9 "value": 10,
10 "questionId": "some-question-id",
11 "meta": [
12 {
13 name: "example",
14 values: ["value-1", "value-2"]
15 }
16 ]
17}'
18
QuestionResult POST İstek Yapısı
Copy
1
2interface QuestionResultPostQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
QuestionResult POST Yanıt Yapısı
Copy
1
2
3interface QuestionResultPostResponse {
4 status: 'success' | 'failed'
5 /** Başarısızlık durumunda dahil edilir. **/
6 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'empty-request' | 'internal' | 'invalid-input';
7 /** Başarısızlık durumunda dahil edilir. **/
8 reason?: string
9 /** Oluşturulan nesne. **/
10 questionResult?: QuestionResult
11}
12
PATCH /api/v1/question-results/:id
Resource: QuestionResult as PATCH /api/v1/question-results/:id Credit Cost: 1
Bu rota tek bir QuestionResult'ı güncelleme yeteneği sağlar.
Aşağıdaki yapı, değiştirilebilecek tüm değerleri temsil eder:
QuestionResult Yapısı
Copy
1
2interface QuestionResultPatchBody {
3 urlId?: string
4 anonUserId?: string
5 userId?: string
6 value?: string
7 commentId?: string
8 questionId?: string
9 meta?: QuestionResultMeta[]
10}
11
QuestionResult Güncelleme cURL Örneği
Copy
1
2curl --request PATCH \
3 --url 'https://fastcomments.com/api/v1/question-results/my-id?tenantId=demo&API_KEY=DEMO_API_SECRET' \
4 --header 'Content-Type: application/json' \
5 --data '{
6 "value": 5
7}'
8
QuestionResult Güncelleme İstek Yapısı
Copy
1
2interface QuestionResultPatchQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
QuestionResult Güncelleme Yanıt Yapısı
Copy
1
2interface QuestionResultPatchResponse {
3 status: 'success' | 'failed'
4 /** Başarısızlık durumunda dahil edilir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'unauthorized' | 'missing-api-key' | 'missing-id' | 'not-found' | 'empty-request' | 'invalid-input'
6 /** Başarısızlık durumunda dahil edilir. **/
7 reason?: string
8}
9
DELETE /api/v1/question-results/:id
Resource: QuestionResult as DELETE /api/v1/question-results/:id Credit Cost: 1
Bu rota, id ile bir QuestionResult'ın kaldırılmasını sağlar.
QuestionResult Kaldırma cURL Örneği
Copy
1
2curl --request DELETE \
3 --url 'https://fastcomments.com/api/v1/question-results/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
QuestionResult Kaldırma İstek Yapısı
Copy
1
2interface QuestionResultDeleteQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
QuestionResult Kaldırma Yanıt Yapısı
Copy
1
2interface QuestionResultResponse {
3 status: 'success' | 'failed'
4 /** Başarısızlık durumunda dahil edilir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found'
6 /** Başarısızlık durumunda dahil edilir. **/
7 reason?: string
8}
9
GET /api/v1/question-results-aggregate
Resource: QuestionResultsAggregate as GET /api/v1/question-results-aggregate Credit Cost: 2
Burası sonuçların toplandığı yerdir.
Agregasyon yanıt yapısı aşağıdaki gibidir:
QuestionResultsAggregationResult Yapısı
Copy
1
2interface QuestionResultDataPoint {
3 /** Geçerli veri noktası (tarih kovası veya sayfa) için değerden kaç tane olduğunu gösteren değer->adet haritası. **/
4 v: Map<ValueAsString, number>
5 total: number
6}
7
8interface QuestionResultsAggregationResult {
9 /** Not - timeBucket belirtilmediğinde null olur. **/
10 dataByDateBucket?: Map<DateString, QuestionResultDataPoint>
11 dataByUrlId?: Map<URLIdString, QuestionResultDataPoint>
12 countsByValue?: Map<ValueAsString, number>
13 /** Toplanan toplam sonuç sayısı. **/
14 total: number
15 /** Ortaya çıkan ağırlıklı ortalama. Ondalık sayıdır, genellikle iki ondalık veya daha az. **/
16 average: number
17 /** Bu verinin hesaplandığı zamanı gösteren tarih dizgisi; çünkü veriler önbellekten gelebilir. **/
18 createdAt: string
19}
20
Here are the query parameters available for aggregation:
QuestionResultsAggregation İstek Yapısı
Copy
1
2interface QuestionResultsAggregateRequestQueryParams {
3 tenantId: string
4 API_KEY: string
5 /** You can aggregate results for one or more questions. **/
6 questionId: string | string[]
7 startDate?: string | number
8 timeBucket?: 'day' | 'month' | 'year'
9 /** Aggregate for a specific page. **/
10 urlId?: string
11 /** Aggregate for a specific user. **/
12 userId?: string
13 /** Force recalculate now and update the cache. **/
14 forceRecalculate?: boolean
15}
16
Here's an example request:
QuestionResultsAggregation Örneği
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/question-results-aggregation?tenantId=demo&API_KEY=DEMO_API_SECRET&questionId=some-question-id'
4
Example response:
QuestionResultsAggregation Yanıt Örneği
Copy
1
2 {
3 "average": 8.33,
4 "countsByValue": {
5 "5": 1,
6 "10": 2
7 },
8 "createdAt": "2023-08-30T00:00:00.000Z",
9 "dataByUrlId": {
10 "some-page": {
11 "total": 3,
12 "v": {
13 "5": 1,
14 "10": 2
15 }
16 }
17 },
18 "total": 3
19 }
20
QuestionResultsAggregation Yanıt Yapısı
Copy
1
2interface QuestionResultsAggregationResponse {
3 status: 'success' | 'failed'
4 /** Included on failure. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
6 /** Included on failure. **/
7 reason?: string
8 data: QuestionResultsAggregationResult
9}
10
Performans Notları
- Önbellek bulunamadığında, agregasyonlar genellikle her milyon sonuç için beş saniye sürer.
- Aksi takdirde, istekler sabit zamanlıdır.
Önbellekleme ve Maliyet Notları
forceRecalculatebelirtildiğinde maliyet her zaman10olur, normal2yerine.- Önbellek süresi dolup veriler yeniden hesaplanırsa,
forceRecalculatebelirtilmemişse maliyet yine sabit2'dir. Önbellek, toplanan veri kümesinin boyutuna göre sona erer (30 saniye ile 5 dakika arasında değişebilir). - Bu, önbelleğin kullanılmasını teşvik etmek içindir.
GET /api/v1/question-results-aggregate/combine/comments
Resource: QuestionResultsCombinedWithComments as GET /api/v1/question-results-aggregate/combine/comments Credit Cost: 2
Bu, sonuçların yorumlarla birleştirildiği yerdir. Örneğin bir ürün için "son olumlu ve olumsuz yorumlar" grafiği oluşturmak için faydalıdır.
Değer aralığı (dahil), bir veya daha fazla soru ve bir başlangıç tarihi (dahil) ile arama yapabilirsiniz.
Yanıt yapısı şu şekildedir:
QuestionResultsCombinedWithCommentsResponse Yapısı
Copy
1
2interface SimpleComment {
3 id: string
4 commenterName: string
5 userId?: string
6 date: string
7 commentHTML: string
8}
9
10interface SimpleQuestionResult {
11 id: string
12 value: number
13}
14
15interface CommentAndResult {
16 comment: SimpleComment
17 result: SimpleQuestionResult
18}
19
20interface QuestionResultsCombinedWithCommentsResponse {
21 /** Bu verinin hesaplandığı zamanı temsil eden bir tarih dizesi; önbellekten gelmiş olabilir. **/
22 createdAt: string
23 results: CommentAndResult[]
24}
25
Toplama için kullanılabilen sorgu parametreleri şunlardır:
QuestionResultsCombineComments İstek Yapısı
Copy
1
2interface QuestionResultsAggregateRequestQueryParams {
3 tenantId: string
4 API_KEY: string
5 /** Bir veya daha fazla soru için sonuçları birleştirebilirsiniz. **/
6 questionId: string | string[]
7 startDate?: string | number
8 urlId?: string
9 minValue: number
10 maxValue: number
11 limit?: number
12 forceRecalculate?: boolean
13}
14
İşte bir örnek istek:
QuestionResultsCombineComments Örneği
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/question-results-aggregation/combine/comments?tenantId=demo&API_KEY=DEMO_API_SECRET&questionId=some-question-id&minValue=5&maxValue=10'
4
Örnek yanıt:
QuestionResultsCombineComments Yanıt Örneği
Copy
1
2{
3 "createdAt": "2023-08-30T00:00:00.000Z",
4 "results": [
5 {
6 "comment": {
7 "id": "some-id",
8 "commentHTML": "test-2",
9 "commenterName": "Test",
10 "date": "2023-08-30T00:00:00.000Z",
11 "userId": "some-user-id"
12 },
13 "result": {
14 "id": "some-id",
15 "value": 10
16 }
17 },
18 {
19 "comment": {
20 "id": "some-id",
21 "commentHTML": "test-0",
22 "commenterName": "Some Name",
23 "date": "2023-08-30T00:00:00.000Z",
24 "userId": "some-user-id"
25 },
26 "result": {
27 "id": "some-id",
28 "value": 5
29 }
30 }
31 ]
32}
33
QuestionResultsCombineComments Yanıt Yapısı
Copy
1
2interface QuestionResultsCombineCommentsResponse {
3 status: 'success' | 'failed'
4 /** Başarısızlık durumunda dahil edilir. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
6 /** Başarısızlık durumunda dahil edilir. **/
7 reason?: string
8 data: QuestionResultsCombinedWithCommentsResponse
9}
10
Önbellekleme ve Maliyet Notları
forceRecalculatebelirtildiğinde maliyet normal2yerine her zaman10olur.- Önbellek süresi dolup veriler yeniden hesaplanırsa,
forceRecalculatebelirtilmemişse maliyet yine sabit2olur. - Bu, önbelleğin kullanılmasını teşvik etmek içindir.
Kullanıcı Rozeti Yapısı
UserBadge FastComments sisteminde bir kullanıcıya atanan bir rozeti temsil eden bir nesnedir.
Rozetler, kullanıcı etkinliğine (such as comment count, reply time, veteran status) göre otomatik olarak veya site yöneticileri tarafından elle atanabilir.
The structure for theUserBadgeobject is as follows: -> UserBadge nesnesinin yapısı aşağıdaki gibidir:
UserBadge Yapısı
Copy
1
2export interface UserBadge {
3 /** Bu kullanıcı rozet atamasının benzersiz tanımlayıcı */
4 id: string
5 /** Bu rozetin atandığı kullanıcının ID'si */
6 userId: string
7 /** Kiracının rozet kataloğundan rozet tanımının ID'si */
8 badgeId: string
9 /** Bu rozeti oluşturan/atan kiracının ID'si */
10 fromTenantId: string
11 /** Bu rozetin oluşturulduğu zaman (epoch'tan bu yana milisaniye) */
12 createdAt?: number
13 /** Bu rozetin kullanıcı tarafından alındığı zaman (epoch'tan bu yana milisaniye) */
14 receivedAt?: number
15 /**
16 * Rozet türü:
17 * 0=CommentCount, 1=CommentUpVotes, 2=CommentReplies, 3=CommentsPinned,
18 * 4=Veteran, 5=NightOwl, 6=FastReplyTime, 7=ModeratorCommentsDeleted,
19 * 8=ModeratorCommentsApproved, 9=ModeratorCommentsUnapproved, 10=ModeratorCommentsReviewed,
20 * 11=ModeratorCommentsMarkedSpam, 12=ModeratorCommentsMarkedNotSpam, 13=RepliedToSpecificPage,
21 * 14=Manual
22 */
23 type: number
24 /** Eşiğe dayalı rozetler için eşik değeri */
25 threshold?: number
26 /** Rozetin adı/etiketi */
27 name?: string
28 /** Rozetin ayrıntılı açıklaması */
29 description?: string
30 /** Rozette gösterilen metin */
31 displayLabel?: string
32 /** Rozette gösterilen resmin URL'si */
33 displaySrc?: string
34 /** Rozet için arka plan rengi (hex kodu) */
35 backgroundColor?: string
36 /** Rozet için kenarlık rengi (hex kodu) */
37 borderColor?: string
38 /** Rozet için metin rengi (hex kodu) */
39 textColor?: string
40 /** Stil için ek CSS sınıfı */
41 cssClass?: string
42 /** Veteran rozetleri için zaman eşiği (milisaniye) */
43 veteranUserThresholdMillis?: number
44 /** Bu rozetin kullanıcının yorumlarında görüntülenip görüntülenmediği */
45 displayedOnComments: boolean
46 /** Rozetin gösterim sırası */
47 order?: number
48}
49
GET /api/v1/user-badges
Bu uç nokta, çeşitli kriterlere göre kullanıcı rozetlerini almanıza olanak tanır.
Example Request:
GET İstek Örneği
Copy Run
Run 1
2curl -X GET "https://fastcomments.com/api/v1/user-badges?tenantId=demo&API_KEY=DEMO_API_SECRET"
3
You can add various query parameters to filter the results:
userId- Belirli bir kullanıcıya ait rozetleri albadgeId- Belirli bir rozete ait örnekleri altype- Rozet türüne göre filtrele (0=CommentCount, 1=CommentUpVotes, 2=CommentReplies, vb. Tam liste için UserBadge yapısına bakın)displayedOnComments- Rozetin yorumlarda gösterilip gösterilmediğine göre filtrele (true/false)limit- Döndürülecek maksimum rozet sayısı (varsayılan 30, maksimum 200)skip- Atlanacak rozet sayısı (sayfalandırma için)
Example Response:
Yanıt
Copy
1
2{
3 "status": "success",
4 "userBadges": [
5 {
6 "id": "badge123",
7 "userId": "user456",
8 "badgeId": "badgeDef789",
9 "fromTenantId": "tenant001",
10 "createdAt": 1650532511000,
11 "receivedAt": 1650532511000,
12 "type": 14,
13 "name": "Special Contributor",
14 "description": "Awarded to special contributors to our community",
15 "displayLabel": "Special",
16 "backgroundColor": "#4a5568",
17 "textColor": "#ffffff",
18 "displayedOnComments": true,
19 "order": 1
20 },
21 {
22 "id": "badge124",
23 "userId": "user456",
24 "badgeId": "badgeDef790",
25 "fromTenantId": "tenant001",
26 "createdAt": 1650532598000,
27 "receivedAt": 1650532598000,
28 "type": 0,
29 "threshold": 100,
30 "name": "Centurion",
31 "description": "Made 100 comments",
32 "displayLabel": "100",
33 "backgroundColor": "#2b6cb0",
34 "textColor": "#ffffff",
35 "displayedOnComments": true,
36 "order": 2
37 }
38 ]
39}
40
Possible Error Responses:
Hata: Eksik Tenant ID
Copy
1
2{
3 "status": "failed",
4 "code": "missing-tenant-id",
5 "reason": "Tenant ID (query param: tenantId) is missing."
6}
7
Hata: Geçersiz Limit
Copy
1
2{
3 "status": "failed",
4 "code": "invalid-limit",
5 "reason": "The limit (query param: limit) is too large (> 200)."
6}
7
GET /api/v1/user-badges/:id
Bu uç nokta, benzersiz bir ID ile belirli bir kullanıcı rozetini getirmenize olanak tanır.
Örnek İstek:
GET İstek Örneği
Copy Run
Run 1
2curl -X GET "https://fastcomments.com/api/v1/user-badges/badge123?tenantId=demo&API_KEY=DEMO_API_SECRET"
3
Örnek Yanıt:
Yanıt
Copy
1
2{
3 "status": "success",
4 "userBadge": {
5 "id": "badge123",
6 "userId": "user456",
7 "badgeId": "badgeDef789",
8 "fromTenantId": "tenant001",
9 "createdAt": 1650532511000,
10 "receivedAt": 1650532511000,
11 "type": 14,
12 "name": "Special Contributor",
13 "description": "Awarded to special contributors to our community",
14 "displayLabel": "Special",
15 "backgroundColor": "#4a5568",
16 "textColor": "#ffffff",
17 "displayedOnComments": true,
18 "order": 1
19 }
20}
21
Olası Hata Yanıtları:
Hata: Eksik Tenant ID
Copy
1
2{
3 "status": "failed",
4 "code": "missing-tenant-id",
5 "reason": "Tenant ID (query param: tenantId) is missing."
6}
7
Hata: Bulunamadı
Copy
1
2{
3 "status": "failed",
4 "code": "not-found",
5 "reason": "The user badge badge123 was not found."
6}
7
POST /api/v1/user-badges
Bu uç nokta, yeni bir kullanıcı rozet ataması oluşturmanıza olanak tanır.
Örnek İstek:
POST İsteği Örneği
Copy Run
Run 1
2curl -X POST "https://fastcomments.com/api/v1/user-badges?tenantId=demo&API_KEY=DEMO_API_SECRET" \
3-H "Content-Type: application/json" \
4-d '{
5 "userId": "user456",
6 "badgeId": "badgeDef789",
7 "displayedOnComments": true
8}'
9
İstek gövdesi aşağıdaki parametreleri içermelidir:
userId(required) - Rozeti atayacağınız kullanıcının kimliğibadgeId(required) - Atanacak rozetin kimliğidisplayedOnComments(optional) - Rozetin kullanıcının yorumlarında gösterilip gösterilmeyeceği (varsayılan true)
Önemli Notlar:
- Rozet, tenant'ınızın rozet kataloğunda mevcut olmalı ve etkinleştirilmiş olmalıdır
- Rozetleri yalnızca tenant'ınıza ait olan veya sitenizde yorum yapmış kullanıcılara atayabilirsiniz
Örnek Yanıt:
Yanıt
Copy
1
2{
3 "status": "success",
4 "userBadge": {
5 "id": "badge123",
6 "userId": "user456",
7 "badgeId": "badgeDef789",
8 "fromTenantId": "tenant001",
9 "createdAt": 1650532511000,
10 "receivedAt": 1650532511000,
11 "type": 14,
12 "name": "Special Contributor",
13 "description": "Awarded to special contributors to our community",
14 "displayLabel": "Special",
15 "backgroundColor": "#4a5568",
16 "textColor": "#ffffff",
17 "displayedOnComments": true,
18 "order": 1
19 }
20}
21
Olası Hata Yanıtları:
Hata: Tenant ID Eksik
Copy
1
2{
3 "status": "failed",
4 "code": "missing-tenant-id",
5 "reason": "Tenant ID (query param: tenantId) is missing."
6}
7
Hata: Eksik Kullanıcı ID
Copy
1
2{
3 "status": "failed",
4 "code": "missing-user-id",
5 "reason": "User ID (body param: userId) is required."
6}
7
Hata: Rozet ID Eksik
Copy
1
2{
3 "status": "failed",
4 "code": "missing-badge-id",
5 "reason": "Badge ID (body param: badgeId) is required."
6}
7
Hata: Rozet Bulunamadı
Copy
1
2{
3 "status": "failed",
4 "code": "badge-not-found",
5 "reason": "The badge badgeDef789 was not found or is not enabled."
6}
7
Hata: Yetkisiz Kullanıcı
Copy
1
2{
3 "status": "failed",
4 "code": "unauthorized-user",
5 "reason": "You can only add badges to users who belong to your tenant or have commented on your site."
6}
7
PUT /api/v1/user-badges/:id
Bu uç nokta, bir kullanıcı rozeti atamasını güncellemenize olanak tanır.
Şu anda yalnızca güncellenebilen özellik displayedOnComments'tir; bu özellik rozetin kullanıcının yorumlarında gösterilip gösterilmeyeceğini kontrol eder.
Örnek İstek:
PUT İsteği Örneği
Copy Run
Run 1
2curl -X PUT "https://fastcomments.com/api/v1/user-badges/badge123?tenantId=demo&API_KEY=DEMO_API_SECRET" \
3-H "Content-Type: application/json" \
4-d '{
5 "displayedOnComments": false
6}'
7
Örnek Yanıt:
Yanıt
Copy
1
2{
3 "status": "success"
4}
5
Olası Hata Yanıtları:
Hata: Tenant ID Eksik
Copy
1
2{
3 "status": "failed",
4 "code": "missing-tenant-id",
5 "reason": "Tenant ID (query param: tenantId) is missing."
6}
7
Hata: ID Eksik
Copy
1
2{
3 "status": "failed",
4 "code": "missing-id",
5 "reason": "The User Badge ID (url param: id) is missing."
6}
7
Hata: Bulunamadı
Copy
1
2{
3 "status": "failed",
4 "code": "not-found",
5 "reason": "The user badge badge123 was not found."
6}
7
DELETE /api/v1/user-badges/:id
Bu uç nokta bir kullanıcı rozet atamasını silmenize olanak tanır.
Örnek İstek:
DELETE İsteği Örneği
Copy Run
Run 1
2curl -X DELETE "https://fastcomments.com/api/v1/user-badges/badge123?tenantId=demo&API_KEY=DEMO_API_SECRET"
3
Örnek Yanıt:
Yanıt
Copy
1
2{
3 "status": "success"
4}
5
Olası Hata Yanıtları:
Hata: Eksik Tenant ID
Copy
1
2{
3 "status": "failed",
4 "code": "missing-tenant-id",
5 "reason": "Tenant ID (query param: tenantId) is missing."
6}
7
Hata: Eksik ID
Copy
1
2{
3 "status": "failed",
4 "code": "missing-id",
5 "reason": "The User Badge ID (url param: id) is missing."
6}
7
Hata: Bulunamadı
Copy
1
2{
3 "status": "failed",
4 "code": "not-found",
5 "reason": "The user badge badge123 was not found."
6}
7
Kullanıcı Rozet İlerleme Yapısı
UserBadgeProgress is an object that represents a user's progress toward earning various badges in the FastComments system.
This tracking helps determine when users should receive automatic badges based on their activity and participation in your community.
The structure for the UserBadgeProgress object is as follows:
UserBadgeProgress Yapısı
Copy
1
2export interface UserBadgeProgress {
3 /** Bu ilerleme kaydı için benzersiz tanımlayıcı */
4 id: string
5 /** Bu ilerleme kaydının ait olduğu tenant ID'si */
6 tenantId: string
7 /** Bu ilerleme kaydının izlediği kullanıcının ID'si */
8 userId: string
9 /** Kullanıcının sistemdeki ilk yorumunun ID'si */
10 firstCommentId?: string
11 /** Kullanıcının ilk yorumunun tarihi (epoch'ten itibaren milisaniye cinsinden) */
12 firstCommentDate?: number
13 /** Kullanıcı etkinliğine göre otomatik hesaplanan güven faktörü */
14 autoTrustFactor?: number
15 /** Yöneticiler tarafından manuel olarak ayarlanan güven faktörü */
16 manualTrustFactor?: number
17 /** Çeşitli metrikler içeren ayrıntılı ilerleme nesnesi, anahtarlar BadgeType enum ile eşleşir */
18 progress: {
19 /** 0: CommentCount - Kullanıcının yaptığı yorum sayısı */
20 '0'?: number
21 /** 1: CommentUpVotes - Kullanıcının aldığı beğeni (upvote) sayısı */
22 '1'?: number
23 /** 2: CommentReplies - Kullanıcının yaptığı yanıt sayısı */
24 '2'?: number
25 /** 3: CommentsPinned - Kullanıcının sabitlenen yorum sayısı */
26 '3'?: number
27 /** 4: Veteran - Kullanıcının hesap yaşı */
28 '4'?: number
29 /** 5: NightOwl - Kullanıcının gece saatlerinde yorum yaptığı kez sayısı */
30 '5'?: number
31 /** 6: FastReplyTime - Ortalama yanıt süresi (milisaniye) */
32 '6'?: number
33 /** 7: ModeratorCommentsDeleted - Moderatör rozetleri için, silinen yorum sayısı */
34 '7'?: number
35 /** 8: ModeratorCommentsApproved - Moderatör rozetleri için, onaylanan yorum sayısı */
36 '8'?: number
37 /** 9: ModeratorCommentsUnapproved - Moderatör rozetleri için, onaydan çıkarılan yorum sayısı */
38 '9'?: number
39 /** 10: ModeratorCommentsReviewed - Moderatör rozetleri için, incelenen yorum sayısı */
40 '10'?: number
41 /** 11: ModeratorCommentsMarkedSpam - Moderatör rozetleri için, spam olarak işaretlenen yorum sayısı */
42 '11'?: number
43 /** 12: ModeratorCommentsMarkedNotSpam - Moderatör rozetleri için, spam olmayan olarak işaretlenen yorum sayısı */
44 '12'?: number
45 /** 13: RepliedToSpecificPage - Her sayfa için, yanıt sayıları */
46 '13'?: Record<string, number>
47 }
48}
49
GET /api/v1/user-badge-progress
Bu uç nokta, çeşitli kriterlere göre kullanıcı rozet ilerleme kayıtlarını almanıza olanak tanır.
Örnek İstek:
GET İstek Örneği
Copy Run
Run 1
2curl -X GET "https://fastcomments.com/api/v1/user-badge-progress?tenantId=demo&API_KEY=DEMO_API_SECRET"
3
Sonuçları filtrelemek için çeşitli sorgu parametreleri ekleyebilirsiniz:
userId- Belirli bir kullanıcı için ilerlemeyi alınlimit- Döndürülecek maksimum kayıt sayısı (varsayılan 30, maksimum 200)skip- Atlanacak kayıt sayısı (sayfalama için)
Örnek Yanıt:
Yanıt
Copy
1
2{
3 "status": "success",
4 "userBadgeProgresses": [
5 {
6 "id": "progress123",
7 "tenantId": "tenant001",
8 "userId": "user456",
9 "firstCommentId": "comment789",
10 "firstCommentDate": 1650532511000,
11 "autoTrustFactor": 0.75,
12 "progress": {
13 "0": 42,
14 "1": 120,
15 "2": 15,
16 "3": 3,
17 "5": 5,
18 "6": 1800000,
19 "8": 0,
20 "7": 0
21 }
22 },
23 {
24 "id": "progress124",
25 "tenantId": "tenant001",
26 "userId": "user789",
27 "firstCommentId": "comment790",
28 "firstCommentDate": 1650532598000,
29 "autoTrustFactor": 0.5,
30 "progress": {
31 "0": 12,
32 "1": 15,
33 "2": 4
34 }
35 }
36 ]
37}
38
Olası Hata Yanıtları:
Hata: Eksik Tenant ID
Copy
1
2{
3 "status": "failed",
4 "code": "missing-tenant-id",
5 "reason": "Tenant ID (query param: tenantId) is missing."
6}
7
Hata: Geçersiz Limit
Copy
1
2{
3 "status": "failed",
4 "code": "invalid-limit",
5 "reason": "The limit (query param: limit) is too large (> 200)."
6}
7
GET /api/v1/user-badge-progress/:id
Bu uç nokta, benzersiz kimliğiyle belirli bir kullanıcı rozet ilerleme kaydını almanıza olanak tanır.
Example Request:
GET İsteği Örneği
Copy Run
Run 1
2curl -X GET "https://fastcomments.com/api/v1/user-badge-progress/progress123?tenantId=demo&API_KEY=DEMO_API_SECRET"
3
Example Response:
Yanıt
Copy
1
2{
3 "status": "success",
4 "userBadgeProgress": {
5 "id": "progress123",
6 "tenantId": "tenant001",
7 "userId": "user456",
8 "firstCommentId": "comment789",
9 "firstCommentDate": 1650532511000,
10 "autoTrustFactor": 0.75,
11 "progress": {
12 "0": 42,
13 "1": 120,
14 "2": 15,
15 "3": 3,
16 "5": 5,
17 "6": 1800000,
18 "8": 0,
19 "7": 0
20 }
21 }
22}
23
Possible Error Responses:
Hata: Tenant ID Eksik
Copy
1
2{
3 "status": "failed",
4 "code": "missing-tenant-id",
5 "reason": "Tenant ID (query param: tenantId) is missing."
6}
7
Hata: Bulunamadı
Copy
1
2{
3 "status": "failed",
4 "code": "not-found",
5 "reason": "The user badge progress progress123 was not found."
6}
7
GET /api/v1/user-badge-progress/user/:userId
Bu uç nokta, bir kullanıcının user ID'sine göre rozet ilerleme kaydını almanıza olanak tanır.
Example Request:
GET İsteği Örneği
Copy Run
Run 1
2curl -X GET "https://fastcomments.com/api/v1/user-badge-progress/user/user456?tenantId=demo&API_KEY=DEMO_API_SECRET"
3
Example Response:
Yanıt
Copy
1
2{
3 "status": "success",
4 "userBadgeProgress": {
5 "id": "progress123",
6 "tenantId": "tenant001",
7 "userId": "user456",
8 "firstCommentId": "comment789",
9 "firstCommentDate": 1650532511000,
10 "autoTrustFactor": 0.75,
11 "progress": {
12 "0": 42,
13 "1": 120,
14 "2": 15,
15 "3": 3,
16 "5": 5,
17 "6": 1800000,
18 "8": 0,
19 "7": 0
20 }
21 }
22}
23
Possible Error Responses:
Hata: Tenant ID Eksik
Copy
1
2{
3 "status": "failed",
4 "code": "missing-tenant-id",
5 "reason": "Tenant ID (query param: tenantId) is missing."
6}
7
Hata: User ID Eksik
Copy
1
2{
3 "status": "failed",
4 "code": "missing-user-id",
5 "reason": "The User ID (path param: userId) is missing."
6}
7
Hata: Bulunamadı
Copy
1
2{
3 "status": "failed",
4 "code": "not-found",
5 "reason": "No badge progress found for user user456 in tenant tenant001."
6}
7
Sonuç olarak
API belgelerimizin kapsamlı ve anlaşılması kolay olduğunu umuyoruz. Herhangi bir eksiklik bulursanız, lütfen aşağıdan bize bildirin.