Canlı Yorum API'leri

Kaynak Kullanımı

API'den veri çekmenin hesabınızdaki kullanım olarak sayıldığını belirtmek gerekir.

Her kaynak, bu kullanımın ne olduğunu kendi bölümünde listeleyecektir.

Bazı kaynakların hizmet maliyeti diğerlerinden daha fazladır. Her uç nokta, API çağrısı başına belirli bir kredi maliyetine sahiptir. Bazı uç noktalar için kredi sayısı, seçenekler ve yanıt boyutlarına göre değişir.

API kullanımı, Billing Analytics sayfasında kontrol edilebilir ve her birkaç dakikada bir güncellenir.

Not!

urlId değerlerini Comment API'sine geçirirken oluşabilecek karışıklığı azaltmak için önce Pages belgelerini okumanızı öneririz.

Webhook'lar

Webhook aboneliklerinin kendi rehberi vardır. POST, GET ve DELETE /api/v1/webhooks, ve GET /api/v1/webhooks/sample-payloads, Managing Subscriptions via API altında belgelenmiştir, ve olay yükleri Webhook Structures altında açıklanmıştır.

FastComments bir OAuth 2.1 yetkilendirme sunucusudur. Bir uygulama, bir FastComments hesabına bağlı bir token alabilir ve bu kılavuzdaki her uç noktada API anahtarı yerine kullanabilir. Bu, Zapier uygulaması, MCP sunucusu ve diğer üçüncü taraf entegrasyonların bağlanma şeklidir.

Tokenlar, PKCE ile yetkilendirme kodu akışı üzerinden verilir. İstemci kimlik bilgileri veya örtük izin yoktur.

Keşif

Uç nokta konumları, desteklenen izinler ve kimlik doğrulama yöntemleri standart metaveri URL'sinde yayınlanır:

Yetkilendirme Sunucusu Metaverisi

Copy

1

2https://fastcomments.com/.well-known/oauth-authorization-server

3

Açıklanan uç noktalar:

OAuth Uç Noktaları

Copy

1

2GET https://fastcomments.com/oauth/authorize

3POST https://fastcomments.com/oauth/token

4POST https://fastcomments.com/oauth/revoke

5POST https://fastcomments.com/oauth/register

6

AB bölgesindeki hesaplar, aynı yollarla, https://eu.fastcomments.com adresini sağlayıcı olarak kullanır.

Bir istemci kaydetme

Bir istemcinin akışı başlatmadan önce bir client_id ve kayıtlı bir redirect_uri'ye ihtiyacı vardır. Bunu elde etmenin iki yolu vardır:

• Dinamik İstemci Kaydı. RFC 7591'e göre bir JSON gövdesiyle POST /oauth/register (redirect_uris, client_name, client_uri, logo_uri, token_endpoint_auth_method). Yanıt client_id ve gizli istemciler için client_secret içerir. Kayıt kimlik doğrulaması gerektirmez ve IP başına oran sınırlıdır.
• İstemci ID Metaveri Belgesi. İstemci, kontrol ettiği bir https URL'sini client_id olarak kullanır. FastComments bu URL'yi alır ve aynı metaveri alanlarını okur. Kayıt çağrısına gerek yoktur.

FastComments kontrol panelinde listelenen ortak uygulamalar, örneğin Zapier, doğrudan FastComments tarafından kaydedilir. Bir pazar yeri listesi oluşturuyorsanız ve bir birinci taraf istemciye ihtiyacınız varsa destek ile iletişime geçin.

Kapsamlar

Kapsamlar

Copy

1

2read GET and HEAD requests

3write every other method

4

Hiçbir kapsam talep etmeyen bir istek her iki kapsamı da alır. Kullanıcı, istenen kapsamları onay sayfasında görür. Bu iki kapsam dışındaki bir kapsam talebi invalid_scope hatasıyla başarısız olur.

Adım 1 - Yetkilendirme isteği

Kullanıcının tarayıcısını yetkilendirme uç noktasına yönlendirin. PKCE, S256 yöntemiyle her istemci için gereklidir.

Yetkilendirme İsteği

Copy

1

2GET https://fastcomments.com/oauth/authorize

3 ?response_type=code

4 &client_id=YOUR_CLIENT_ID

5 &redirect_uri=https://example.com/oauth/callback

6 &scope=read%20write

7 &state=RANDOM_STATE

8 &code_challenge=BASE64URL_SHA256_OF_VERIFIER

9 &code_challenge_method=S256

10

Yetkilendirme İsteği Parametreleri

Copy

1

2interface OAuthAuthorizeQueryParams {

3 response_type: 'code'

4 client_id: string

5 /** Must exactly match one of the client's registered redirect URIs. **/

6 redirect_uri: string

7 /** Space separated. Omit to request both scopes. **/

8 scope?: 'read' | 'write' | 'read write'

9 /** Returned unchanged on the redirect. Use it to bind the callback to the session that started the flow. **/

10 state?: string

11 /** base64url(sha256(code_verifier)). **/

12 code_challenge: string

13 code_challenge_method: 'S256'

14 /** Optional RFC 8707 resource indicator. If sent, the same value must be sent to the token endpoint. **/

15 resource?: string

16}

17

Kullanıcı gerektiğinde FastComments'a giriş yapar ve uygulamanızın adını, bağlanacağı hesabı ve istenen kapsamları gösteren bir onay sayfası görür. Kullanıcının o hesapta API Admin iznine sahip olması gerekir; başka birisi onay formu yerine izin hatası alır. Onaylamak, tarayıcıyı code ve state ile redirect_uri'nize yönlendirir. Reddetmek, error=access_denied ile yönlendirir.

Yetkilendirme kodu 10 dakika geçerlidir ve bir kez takas edilebilir. Aynı kodun ikinci takası, ilk takasın ürettiği tüm tokenları iptal eder.

Adım 2 - Token isteği

Kodu tokenlar için takas edin. Gövde form-encoded'dir. Gizli istemciler client_secret_basic (HTTP Basic) veya client_secret_post (gövdede gizli) ile kimlik doğrular. Genel istemciler sadece client_id gönderir.

Token İsteği cURL Örneği

Copy

1

2curl --request POST \

3 --url 'https://fastcomments.com/oauth/token' \

4 --header 'Content-Type: application/x-www-form-urlencoded' \

5 --data 'grant_type=authorization_code' \

6 --data 'client_id=YOUR_CLIENT_ID' \

7 --data 'client_secret=YOUR_CLIENT_SECRET' \

8 --data 'code=fcac_...' \

9 --data 'code_verifier=YOUR_PKCE_VERIFIER' \

10 --data 'redirect_uri=https://example.com/oauth/callback'

11

Token İsteği Gövdesi (authorization_code)

Copy

1

2interface OAuthTokenRequestAuthorizationCode {

3 grant_type: 'authorization_code'

4 client_id: string

5 /** Confidential clients only. May be sent as HTTP Basic auth instead. **/

6 client_secret?: string

7 code: string

8 code_verifier: string

9 /** Must match the authorization request when sent. **/

10 redirect_uri?: string

11 resource?: string

12}

13

Token Yanıtı Yapısı

Copy

1

2interface OAuthTokenResponse {

3 /** Prefixed fcat_. Valid for one hour. **/

4 access_token: string

5 token_type: 'bearer'

6 /** Seconds until the access token expires. 3600. **/

7 expires_in: number

8 /** Prefixed fcrt_. Valid for 30 days from issue. **/

9 refresh_token: string

10 /** Space separated scopes granted. **/

11 scope: string

12}

13

Hatalar RFC 6749'e uyar: error ve error_description içeren bir JSON gövdesi, invalid_request, invalid_grant, invalid_scope, invalid_target ve unsupported_grant_type için HTTP 400, invalid_client için HTTP 401, oran sınırlaması olduğunda HTTP 429.

Adım 3 - API'yi Çağırma

Erişim tokenını bir bearer token olarak gönderin. Kiracı token tarafından ima edilir, bu yüzden tenantId isteğe bağlıdır. Verildiğinde tokenla eşleşmelidir, aksi takdirde istek başarısız olur.

Bearer Token cURL Örneği

Copy

1

2curl --request GET \

3 --url 'https://fastcomments.com/api/v1/me' \

4 --header 'Authorization: Bearer fcat_...'

5

GET /api/v1/me kiracıyı, yetkilendiren kullanıcıyı ve verilen kapsamları döndürür; bu, bağlantı testi için doğru çağrıdır. Süresi dolmuş veya iptal edilmiş bir tokenla yapılan istek HTTP 401 alır. Yöntemi, tokenın sahip olmadığı bir kapsam gerektiren bir istek HTTP 403 alır.

Adım 4 - Yenileme

Yenileme İsteği cURL Örneği

Copy

1

2curl --request POST \

3 --url 'https://fastcomments.com/oauth/token' \

4 --header 'Content-Type: application/x-www-form-urlencoded' \

5 --data 'grant_type=refresh_token' \

6 --data 'client_id=YOUR_CLIENT_ID' \

7 --data 'client_secret=YOUR_CLIENT_SECRET' \

8 --data 'refresh_token=fcrt_...'

9

Token İsteği Gövdesi (refresh_token)

Copy

1

2interface OAuthTokenRequestRefreshToken {

3 grant_type: 'refresh_token'

4 client_id: string

5 client_secret?: string

6 refresh_token: string

7 /** Optional. Narrows to a subset of the scopes originally granted. **/

8 scope?: string

9 resource?: string

10}

11

Yanıt, kod takasıyla aynı yapıya sahiptir. Yenileme tokenları döner: her yenileme yeni bir refresh_token döndürür ve eşzamanlı istekler için 30 saniyelik bir gecikme penceresinden sonra eski tokenı iptal eder. 30 saniyeden daha uzun bir sürede dönen bir yenileme tokenı sunulursa bu tekrar olarak değerlendirilir ve tüm izin iptal edilir. FastComments tarafından kaydedilen ortak uygulamalar döndürmeden muaf tutulur ve aynı yenileme tokenını alır; süresi başka 30 gün uzatılır.

Yenileme ayrıca yetkilendiren kullanıcının hâlâ hesapta API Admin iznine sahip olup olmadığını kontrol eder. Eğer yoksa, izin iptal edilir ve yanıt invalid_grant olur.

İptal

İptal İsteği cURL Örneği

Copy

1

2curl --request POST \

3 --url 'https://fastcomments.com/oauth/revoke' \

4 --header 'Content-Type: application/x-www-form-urlencoded' \

5 --data 'client_id=YOUR_CLIENT_ID' \

6 --data 'client_secret=YOUR_CLIENT_SECRET' \

7 --data 'token=fcrt_...' \

8 --data 'token_type_hint=refresh_token'

9

Bir yenileme tokenını iptal etmek, aynı izinden verilen tüm erişim tokenlarını iptal eder. Bir erişim tokenını iptal etmek sadece o tokenı iptal eder. Uç nokta, token bulunup bulunmadığına bakılmaksızın boş bir JSON nesnesiyle HTTP 200 döner, RFC 7009'e göre.

Kullanıcılar ayrıca FastComments kontrol panelindeki Bağlı Uygulamalar üzerinden bir bağlantıyı iptal edebilir. O uygulama için tüm tokenlar hemen çalışmaz.

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

Bu API, skip, limit, before ve after parametreleriyle sağlanan sayfalama kullanır. AuditLog'lar varsayılan olarak 1000 kayıtlık sayfalarda döndürülür, maksimum limit 10000'e kadar, when ve id'ye göre sıralanır. Sayfalar büyüktür çünkü bu uç nokta genellikle geçmişi dökmek için kullanılır, etkileşimli olarak sayfalama yapmak yerine.

Dönen her 100 log için kredi maliyeti 1'dir.

Varsayılan olarak, en yeni öğeler önce olacak bir liste alırsınız. Bu şekilde, skip=0 ile başlayarak sorgulayabilir, tükettiğiniz son kaydı bulana kadar sayfalayabilirsiniz.

Alternatif olarak, en eskiyi önce sıralayabilir ve kayıt kalmayana kadar sayfalayabilirsiniz.

Sıralama, order parametresini ASC veya DESC olarak ayarlayarak yapılabilir. Varsayılan DESC'tir.

Tarih sorgulama, milisaniye cinsinden zaman damgaları olarak before ve after ile mümkündür. before ve after KAPSAMLI DEĞİLDİR ve her biri tek başına kullanılabilir.

Bir kişinin başına ne geldiğini bulma

Her olay, kim tarafından gerçekleştirildiğini (username, userId, ip) ve ayrıca ne üzerinde gerçekleştirildiğini kaydeder. targetLabel, o nesne için insan tarafından okunabilir bir etikettir, örneğin jsmith (jsmith@example.com), ve targetId onun kimliğidir. Bir kişinin adını veya e-posta adresini biliyor ancak kimliğini bilmiyorsanız, etiketteki alt dizeyi büyük/küçük harfe duyarsız eşleştirmek için target kullanın.

Silme işlemleri, olay anındaki etiketi yakalar, böylece temel kayıt silinmiş olsa bile kaldırılan bir kullanıcı veya moderatör hâlâ tanımlanabilir.

Yönetilen kiracılar

Kiracınız diğer kiracıları yönetiyorsa, includeManagedTenants=true ayarlayarak bir yanıt içinde kendi kiracınız ve yönettiği tüm kiracılardan gelen olayları döndürün. Dönen her log'un tenantId değeri, kaynağın hangi kiracıdan geldiğini gösterir.

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 AuditLogsRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5 order?: 'ASC' | 'DESC'

6 /** Maksimum 10000. Varsayılan 1000. **/

7 limit?: number

8 skip?: number

9 before?: number

10 after?: number

11 /** Yalnızca bu kullanıcı adıyla gerçekleştirilen olaylar. **/

12 username?: string

13 /** Yalnızca bu IP adresinden gelen olaylar. **/

14 ip?: string

15 /** Yalnızca bu tipteki olaylar. **/

16 crudType?: 'c' | 'r' | 'u' | 'd' | 'login'

17 /** Yalnızca bu kaynak için olaylar, örn. Kullanıcı veya Moderatör. **/

18 resourceName?: string

19 /** Etkilenen nesnenin bu kimliğe sahip olduğu yalnızca olaylar. **/

20 targetId?: string

21 /** Etkilenen nesnenin etiketinde büyük/küçük harfe duyarsız alt dize eşleşmesi. **/

22 target?: string

23 /** Ayrıca bu kiracının yönettiği kiracılardan gelen olayları da döndür. **/

24 includeManagedTenants?: boolean

25}

26

AuditLog Yanıt Yapısı

Copy

1

2interface AuditLogsResponse {

3 status: 'success' | 'failed'

4 /** Başarısızlıkta dahil edilir. **/

5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'invalid-limit' | 'invalid-skip'

6 /** Başarısızlıkta dahil edilir. **/

7 reason?: string

8 /** Loglar! **/

9 auditLogs: AuditLog[]

10}

11

Bu API, bir kullanıcıya göstermek üzere yorumları almak için kullanılır. Örneğin, otomatik olarak onaylanmamış veya istenmeyen (spam) yorumları filtreler.

Pagination

Sayfalama, performans gereksinimlerine ve kullanım durumuna bağlı olarak iki yoldan biriyle yapılabilir:

1. En hızlı: Precalculated Pagination:
   1. Bu, önceden oluşturulmuş widget ve istemcilerimizi kullandığınızda FastComments'ın nasıl çalıştığıdır.
   2. “next”e tıklamak yalnızca sayfa sayacını artırır.
   3. Bunu bir anahtar-değer deposundan alınmış gibi düşünebilirsiniz.
   4. Bu şekilde, 0'dan başlayan bir page parametresi ve direction olarak bir sıralama yönü tanımlamanız yeterlidir.
   5. Sayfa boyutları özelleştirme kurallarıyla ayarlanabilir.
2. En esnek: Flexible Pagination:
   1. Bu şekilde özel limit ve skip parametreleri tanımlayabilirsiniz. page göndermeyin.
   2. direction sıralaması da desteklenir.
   3. limit, skip uygulandıktan sonra döndürülecek toplam sayıyı belirtir.
      • Örnek: page size = 100 ve page = 2 iken skip = 200, limit = 100 ayarlayın.
   4. Alt yorumlar hâlâ sayfalamada sayılır. Bunu asTree seçeneğiyle aşabilirsiniz.
      • limitChildren ve skipChildren ile alt yorumları sayfalayabilirsiniz.
      • maxTreeDepth ile döndürülen konu derinliğini sınırlayabilirsiniz.

Threads

1. Precalculated Pagination kullanıldığında, yorumlar sayfa bazında gruplanır ve konu içindeki yorumlar genel sayfayı etkiler.
   1. Bu şekilde, konular istemci tarafında parentId temel alınarak belirlenebilir.
   2. Örneğin, bir üst düzey yorum ve 29 yanıt içeren bir sayfada API'de page=0 ayarlandığında yalnızca üst düzey yorum ve 29 alt yorum alınır.
2. Flexible Pagination kullanıldığında bir parentId parametresi tanımlayabilirsiniz.
   1. Bunu null olarak ayarlarsanız yalnızca üst düzey yorumları alırsınız.
   2. Ardından konuları görüntülemek için API'yi tekrar çağırıp parentId gönderin.
   3. Yaygın bir çözüm, üst düzey yorumlar için bir API çağrısı yapıp ardından her yorumun alt yorumları için paralel API çağrıları yapmaktır.
3. NEW As of Feb 2023! &asTree=true kullanarak ağaç olarak alın.
   1. Bunu Flexible Pagination as a Tree olarak düşünebilirsiniz.
   2. Yalnızca üst düzey yorumlar sayfalamada sayılır.
   3. parentId=null ayarlayarak ağacı kökten başlatın (parentId ayarlamanız gerekir).
   4. Sayfalama için skip ve limit ayarlayın.
   5. asTree değerini true yapın.
   6. Krediler maliyeti 2x artar, çünkü bu senaryoda arka uç çok daha fazla iş yapmalıdır.
   7. maxTreeDepth, limitChildren ve skipChildren değerlerini istediğiniz gibi ayarlayın.

Trees Explained

asTree kullanıldığında, sayfalama hakkında mantık yürütmek zor olabilir. İşte kullanışlı bir grafik:

Ağaç Sayfalama Diyagramı

Fetching Comments in The Context of a User

/comments API'si iki bağlamda, farklı kullanım durumları için kullanılabilir:

• Kendi istemcinizi oluşturmak için sıralanmış ve etiketlenmiş yorumları döndürmek.
  • Bu durumda bir contextUserId sorgu parametresi tanımlayın.
• Özel entegrasyonlar için yorumları arka uçtan almak.
  • Platform, contextUserId olmadan buna varsayılan olarak geçer.

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

Yorumlar Kullanıcı Bağlamında 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

Yorumlar Kullanıcı Bağlamında Yalnızca Üst Düzey Yorumlar İç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

Get Comments as a Tree

Yorumları bir ağaç olarak alabilir ve sayfalama yalnızca üst düzey yorumları sayar.

Yorumlar Ağaç Şeklinde Kullanıcı Bağlamında

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

Yalnızca üst düzey yorumları ve doğrudan alt yorumları almak ister misiniz? İşte bir yol:

Yorumlar Ağaç Şeklinde Maksimum Derinlik ile

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 yorumun yanıtları göster düğmesini gösterip göstermeyeceğinizi bilmeniz gerekebilir. Ağaç üzerinden yorum alırken, uygulanabilir olduğunda yorumlara hasChildren özelliği eklenir.

Get Comments as a Tree, Searching by Hash Tag

API'yi kullanarak tüm tenantınızda (tek bir sayfaya veya urlId'ye sınırlı olmadan) hashtag ile arama yapabilirsiniz.

Bu örnekte urlId'yi atlıyoruz ve birden fazla hashtag ile arama yapıyoruz. API yalnızca istenen tüm hashtag'lere sahip yorumları döndürür.

Yorumlar Ağaç Şeklinde Kullanıcı Bağlamında, Hashtag ile

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

All Request Params

Yorumlar İstek Yapısı

Copy

1

2interface CommentsRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** Yorumların ilişkilendirildiği urlId (sayfa URL'si veya makale kimliği). **/

6 urlId?: string

7 /** Bu kullanıcı tarafından döndürülen yorumları sınırlayın. **/

8 userId?: string

9 /** Hashtag ile arama yapmak için bunu kullanın. Birden fazla hashtag'in kesişimini bulmak için &hashTag=a&hashTag=b şeklinde kullanın. **/

10 hashTag?: string

11 /** Sıralama yönü. Varsayılan MR (En İlgili). Diğer seçenekler OF (En Eskisi İlk) ve NF (En Yeni İlk). **/

12 direction?: 'MR' | 'OF' | 'NF'

13 /** Önceden Hesaplanmış Sayfalama: Alınacak sayfa, 0'dan başlar. Tüm yorumlar için -1 gönderin (250'ye kadar). **/

14 page?: number

15 /** Esnek Sayfalama: Kaç yorum döndürmeliyiz? **/

16 limit?: number

17 /** Esnek Sayfalama: Her ebeveyn için kaç alt yorum döndürmeliyiz? **/

18 limitChildren?: number

19 /** Esnek Sayfalama: Kaç yorumu atlamalıyız? **/

20 skip?: number

21 /** Esnek Sayfalama: Her ebeveyn için kaç alt yorumu atlamalıyız? **/

22 skipChildren?: number

23 /** Engellenen ve işaretlenmiş yorumları belirlemek için. **/

24 contextUserId?: string

25 /** Engellenen ve işaretlenmiş yorumları belirlemek için. **/

26 anonUserId?: string

27 /** Alt yorumları almak için. **/

28 parentId?: string

29 /** Ağaç olarak almak için. **/

30 asTree?: boolean

31 /** Ağaçta ne kadar derine veri döndürmeliyiz? 0 hiçbir alt yorum döndürmez. 1 doğrudan alt yorumları döndürür, vb. **/

32 maxTreeDepth?: number

33}

34

The Response

Yorumlar Yanıt Yapısı

Copy

1

2interface CommentsResponse {

3 status: 'success' | 'failed'

4 /** Başarısızlıkta dahil edilir. **/

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 /** Başarısızlıkta dahil edilir. **/

7 reason?: string

8 /** Yorumlar! **/

9 comments: Comment[]

10}

11

Helpful Tips

URL ID

Comment API'sini urlId parametresiyle kullanmak isteyebilirsiniz. Önce Pages API'sini çağırarak size mevcut olan urlId değerlerinin nasıl göründüğünü görebilirsiniz.

Anonymous Actions

Anonim yorumlama için yorumları alırken ve işaretleme ve engelleme işlemleri yaparken anonUserId göndermeniz muhtemeldir.

(!) Bu, birçok uygulama mağazası için gereklidir; kullanıcılar oturum açmasalar bile görebildikleri kullanıcı tarafından oluşturulan içeriği işaretleyebilmelidir. Bunu yapmazsanız uygulamanız ilgili mağazadan kaldırılabilir.

Comments Not Being Returned

Yorumlarınızın onaylandığını ve istenmeyen (spam) olmadığını kontrol edin.

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

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'u 1'den 2'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 parentId belirtiyorsanız ve bir alt yorumun notificationSentForParent değ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 sendEmails değerini true olarak 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

Bu API uç noktası tek bir yorumu güncelleme olanağı sağlar.

Notlar:

• İstenirse bu API, yorum widget'ını "live" olarak güncelleyebilir (bu, temel creditsCostu 1'den 2'ye yükseltir).
  • Bu, sayfalar arasında yorumları "live" olarak taşımayı sağlayabilir (urlId değiştirerek).
  • Sayfalar önceden hesaplandığı ve bunun CPU açısından maliyetli olduğu için taşımalar ek 2 kredi ücreti gerektirir.
• Oluşturma API'sinin aksine, bu API e-posta sağlansa bile sistemimizde otomatik olarak kullanıcı nesneleri oluşturmaz.
• Bu API ile güncellenen yorumlar istenirse hala spam için kontrol edilebilir.
• Maksimum yorum uzunluğu gibi yapılandırmalar, eğer Customization Rule yönetim sayfası üzerinden yapılandırıldıysa burada uygulanır.
• Kullanıcıların yorum metinlerini güncellemelerine izin vermek için istek gövdesinde yalnızca comment'i belirtebilirsiniz. Oluşan commentHTML'i biz oluşturacağız.
  • Hem comment hem de commentHTML tanımlarsanız HTML otomatik olarak oluşturulmaz.
  • Kullanıcı yeni metnine mentions veya hashtags eklerse, bu yine POST API'si gibi işlenecektir.
• Bir yorumda commenterEmail'i güncellerken, ayrıca userId'yi belirtmek en iyisidir. Aksi takdirde, bu e-postaya sahip kullanıcının kiracınıza ait olduğundan emin olmalısınız; aksi halde istek başarısız olur.
• Hedef yorum kilitliyse (isLocked: true), istek code: 'locked' ile reddedilir. Önce yorumu kilidini açın, güncelleyin, ardından isterseniz tekrar kilitleyin.

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üncelleme yapan kullanıcı. İstenirse yorumı düzenleme yetkisini 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 /** Aynı urlId'ye sahip yorum widget örneklerini görüntüleyen kullanıcılara yorumun "live" olarak görünüp görünmeyeceği. NOT: Kredi maliyetini 1'den 2'ye iki katına çıkarır. **/

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' | 'locked'

7 /** Başarısızlık durumunda dahil edilir. **/

8 reason?: string

9}

10

Bu API uç noktası bir yorumu silme yeteneği sağlar.

Notlar:

• Bu API istenirse yorum bileşenini "canlı" olarak güncelleyebilir (bu creditsCost'u 1'den 2'ye çıkarır).
• Bu API tüm alt yorumları silecektir.
• Hedef yorum kilitliyse (isLocked: true), istek code: 'locked' ile reddedilir. Önce yorumu kilidini açın, sonra silin.

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, yorumı silme yetkisine sahip olup olmadığını kontrol etmek için kullanılabilir. **/

6 contextUserId?: string

7 /** Yorumun aynı urlId ile yorum bileşeninin örneklerini görüntüleyen kullanıcılara "canlı" olarak silinip silinmeyeceği. NOT: Kredi maliyetini `1`'den `2`'ye katlar. **/

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' | 'locked'

7 /** Başarısızlık durumunda dahil edilir. **/

8 reason?: string

9}

10

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

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

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 A ve User 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

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 A User B'nin engellemesini kaldırmak istiyor. userId=User A ve User B tarafı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

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

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

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

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ı emailTemplateId için alan adı özel bir şablon birlikte bulunabilir.
• domain belirtmek yalnızca farklı alan adlarınız varsa veya test için belirli şablonlar kullanmak istiyorsanız önemlidir (domain set to localhost etc).
• domain belirtirseniz, bunun bir DomainConfig ile 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 testData ile 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

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

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

Bir akıştaki gönderileri, en yenilerden başlayarak alır. Sayfalama imleç tabanlıdır: bir sonraki sayfayı almak için aldığınız son gönderinin _id değerini afterId olarak gönderin.

Dönen her on gönderi için bir kredi, minimum bir kredi olmak üzere maliyetlidir.

FeedPost cURL Örneği

Copy

1

2curl --request GET \

3 --url 'https://fastcomments.com/api/v1/feed-posts?tenantId=demo&limit=10&API_KEY=DEMO_API_SECRET'

4

FeedPost İstek Yapısı

Copy

1

2interface FeedPostsRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** Bu gönderi kimliğinden sonraki gönderileri döndür. İlk sayfa için atlayın. **/

6 afterId?: string

7 /** Varsayılan 10'dur. Maksimum 1000. **/

8 limit?: number

9 /** Yalnızca bu etiketlere sahip gönderileri döndür. Birden fazla etiket için parametreyi tekrarlayın. **/

10 tags?: string[]

11}

12

FeedPost Yanıt Yapısı

Copy

1

2interface FeedPostsResponse {

3 status: 'success' | 'failed'

4 /** Başarısızlıkta dahil edilir. **/

5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'limit-invalid' | 'internal'

6 /** Başarısızlıkta dahil edilir. **/

7 reason?: string

8 feedPosts: FeedPost[]

9}

10

Bu yol tek bir FeedPost oluşturur. Her gönderinin bir yazarı vardır, bu yüzden fromUserId gereklidir ve hesabınızdaki mevcut bir FastComments veya SSO kullanıcısının kimliği olmalıdır.

FeedPost Oluşturma cURL Örneği

Copy

1

2curl --request POST \

3 --url 'https://fastcomments.com/api/v1/feed-posts?tenantId=demo&isLive=true&API_KEY=DEMO_API_SECRET' \

4 --header 'Content-Type: application/json' \

5 --data '{

6 "fromUserId": "some-user-id",

7 "title": "Release 2.0 is out",

8 "contentHTML": "<p>Read the notes and tell us what you think.</p>",

9 "tags": ["releases"],

10 "links": [

11 {

12 "url": "https://example.com/releases/2.0",

13 "title": "Release notes",

14 "description": "Everything that changed in 2.0."

15 }

16 ]

17}'

18

FeedPost Oluşturma İstek Yapısı

Copy

1

2interface FeedPostPostQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** Gönderiyi şu anda bir tarayıcıda açık olan beslemelere gönder. Varsayılan değer false. **/

6 isLive?: boolean

7 /** Gönderiyi kaydetmeden önce spam motorundan geçir. Varsayılan değer false. **/

8 doSpamCheck?: boolean

9 /** doSpamCheck'in bir parçası olarak çalışan yinelenen içerik kontrolünü atla. Varsayılan değer false. **/

10 skipDupCheck?: boolean

11 /** En fazla 256 karakter. Canlı dinleyicilere yankılanır, böylece bir istemci kendi yayınına göz ardı edebilir. **/

12 broadcastId?: string

13}

14

15interface FeedPostPostBody {

16 /** Gerekli. Bir FastComments veya SSO kullanıcı kimliği. **/

17 fromUserId: string

18 title?: string

19 /** HTML. Kaydedilirken temizlenir. **/

20 contentHTML?: string

21 /** Kullanıcıdan alınan görüntüleme adını geçersiz kılar. **/

22 fromUserDisplayName?: string

23 tags?: string[]

24 media?: FeedPostMediaItem[]

25 links?: FeedPostLink[]

26 meta?: Record<string, string>

27}

28

FeedPost Oluşturma Yanıt Yapısı

Copy

1

2interface FeedPostPostResponse {

3 status: 'success' | 'failed'

4 /** Başarısızlıkta dahil edilir. **/

5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-from-user-id' | 'invalid-user' | 'broadcast-id-too-long' | 'spam-blocked' | 'user-rate-limited' | 'internal'

6 /** Başarısızlıkta dahil edilir. **/

7 reason?: string

8 feedPost?: FeedPost; // Başarı durumunda oluşturulan tam gönderiyi döneriz.

9}

10

Bu rota tek bir FeedPost günceller. Değiştirmek istediğiniz alanları yalnızca gönderin.

FeedPost Güncelleme cURL Örneği

Copy

1

2curl --request PATCH \

3 --url 'https://fastcomments.com/api/v1/feed-posts/some-post-id?tenantId=demo&API_KEY=DEMO_API_SECRET' \

4 --header 'Content-Type: application/json' \

5 --data '{

6 "title": "Release 2.0.1 is out",

7 "tags": ["releases", "hotfix"]

8}'

9

FeedPost Güncelleme İstek Yapısı

Copy

1

2interface FeedPostPatchQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

7/** FeedPost yapısından yazılabilir herhangi bir alan. **/

8type FeedPostPatchBody = Partial<Pick<FeedPost, 'title' | 'contentHTML' | 'fromUserDisplayName' | 'tags' | 'weight' | 'meta' | 'media' | 'links'>>

9

FeedPost Güncelleme Yanıt Yapısı

Copy

1

2interface FeedPostPatchResponse {

3 status: 'success' | 'failed'

4 /** Başarısızlıkta dahil edilir. **/

5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found' | 'internal'

6 /** Başarısızlıkta dahil edilir. **/

7 reason?: string

8}

9

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

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

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

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