API-ji za live komentiranje

Korištenje resursa

Treba napomenuti da se dohvaćanje podataka s API-ja računa kao korištenje na vašem računu.

Svaki resurs će navesti to korištenje u svojoj sekciji.

Neki resursi koštaju više za posluživanje od drugih. Svaki endpoint ima fiksnu cijenu kredita po API pozivu. Za neke endpointove, broj kredita varira ovisno o opcijama i veličinama odgovora.

Korištenje API-ja možete provjeriti na stranici Billing Analytics i ažurira se svakih nekoliko minuta.

Napomena!

Preporučujemo da najprije pročitate dokumentaciju za Pages, kako biste smanjili zabunu pri određivanju koje vrijednosti proslijediti za urlId u Comment API-ju.

Webhookovi

Pretplate na webhookove imaju svoj vodič. POST, GET i DELETE /api/v1/webhooks, te GET /api/v1/webhooks/sample-payloads, dokumentirani su pod Managing Subscriptions via API, a strukture događaja pod Webhook Structures.

FastComments je OAuth 2.1 poslužitelj autorizacije. Aplikacija može dobiti token koji je vezan uz jedan FastComments račun i koristiti ga na svakom krajnjem točku u ovom vodiču umjesto API ključa. Tako se Zapier aplikacija, MCP poslužitelj i druge integracije trećih strana povezuju.

Tokeni se izdaju putem toka autorizacijskog koda s PKCE-om. Ne postoji odobrenje klijentskih vjerodajnica niti implicitno odobrenje.

Discovery

Lokacije krajnjih točaka, podržana odobrenja i metode autentifikacije objavljuju se na standardnoj URL adresi metapodataka:

Metapodaci poslužitelja autorizacije

Copy

1

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

3

Endpointi koje opisuje:

OAuth krajnje točke

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

Računi u EU regiji koriste https://eu.fastcomments.com kao izdavatelja, s istim putanjama.

Registracija klijenta

Klijent treba client_id i registriranu redirect_uri prije nego što može započeti tok. Postoje dva načina za dobivanje:

• Dinamička registracija klijenta. POST /oauth/register s JSON tijelom prema RFC 7591 (redirect_uris, client_name, client_uri, logo_uri, token_endpoint_auth_method). Odgovor nosi client_id i, za povjerljive klijente, client_secret. Registracija je neautentificirana i ograničena po brzini po IP-u.
• Dokument metapodataka ID klijenta. Klijent koristi https URL koji kontrolira kao svoj client_id. FastComments dohvaća taj URL i čita iste metapodatke iz njega. Nije potreban poziv za registraciju.

Partner aplikacije navedene u FastComments nadzornoj ploči, poput Zapiera, registrira izravno FastComments. Kontaktirajte podršku ako izgradite popis na tržištu i trebate klijenta prve strane.

Opsezi

Opsezi

Copy

1

2read GET and HEAD requests

3write every other method

4

Zahtjev koji ne traži opseg odobrava oba. Korisnik vidi tražene opsege na stranici pristanka. Zahtjev za opsegom koji nije jedan od ova dva ne uspijeva s invalid_scope.

Korak 1 - Zahtjev za autorizaciju

Pošaljite preglednik korisnika na krajnju točku autorizacije. PKCE s metodom S256 je obavezan za svakog klijenta.

Zahtjev za autorizaciju

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

Parametri zahtjeva za autorizaciju

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

Korisnik se prijavljuje u FastComments ako je potrebno i vidi stranicu pristanka koja navodi vašu aplikaciju, račun na koji će biti povezana i tražene opsege. Korisnik mora imati API Admin dozvolu na tom računu; bilo tko drugi vidi pogrešku dozvole umjesto obrasca pristanka. Odobrenje preusmjerava preglednik na vaš redirect_uri s code i state. Odbijanje preusmjerava s error=access_denied.

Autorizacijski kod je valjan 10 minuta i može se razmijeniti jednom. Druga razmjena istog koda opoziva svaki token koji je prva razmjena proizvela.

Korak 2 - Zahtjev za token

Razmijenite kod za tokene. Tijelo je kodirano kao obrazac. Povjerljivi klijenti autentificiraju se s client_secret_basic (HTTP Basic) ili client_secret_post (tajna u tijelu). Javni klijenti šalju samo client_id.

Primjer cURL zahtjeva za token

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

Tijelo zahtjeva za token (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

Struktura odgovora na token

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

Pogreške slijede RFC 6749: JSON tijelo s error i error_description, HTTP 400 za invalid_request, invalid_grant, invalid_scope, invalid_target i unsupported_grant_type, HTTP 401 za invalid_client, HTTP 429 kada je ograničena brzina.

Korak 3 - Pozivanje API-ja

Pošaljite pristupni token kao token nositelja. Najamnik je impliciran tokenom, pa je tenantId opcionalan. Kada je naveden, mora se podudarati s tokenom ili zahtjev ne uspijeva.

Primjer cURL za token nositelja

Copy

1

2curl --request GET \

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

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

5

GET /api/v1/me vraća najamnika, ovlaštenog korisnika i odobrene opsege, što ga čini pravim pozivom za testiranje veze. Zahtjev s isteklim ili opozvanim tokenom dobiva HTTP 401. Zahtjev čija metoda zahtijeva opseg koji token ne posjeduje dobiva HTTP 403.

Korak 4 - Osvježavanje

Primjer cURL zahtjeva za osvježavanje

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

Tijelo zahtjeva za token (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

Odgovor ima isti oblik kao razmjena koda. Osvježavajući tokeni rotiraju: svako osvježenje vraća novi refresh_token i opoziva stari nakon 30 sekundi grace perioda za istovremene zahtjeve. Predstavljanje osvježavajućeg tokena koji je rotiran prije više od 30 sekundi smatra se ponovnim korištenjem i opoziva cijelo odobrenje. Partner aplikacije registrirane od strane FastComments su izuzete od rotacije i vraćaju isti osvježavajući token s produženim rokom valjanosti za još 30 dana.

Osvježenje također provjerava da li ovlašteni korisnik i dalje ima API Admin na računu. Ako ne, odobrenje se opoziva i odgovor je invalid_grant.

Opoziv

Primjer cURL zahtjeva za opoziv

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

Opoziv osvježavajućeg tokena opoziva svaki pristupni token izdan iz istog odobrenja. Opoziv pristupnog tokena opoziva samo taj token. Krajnja točka vraća HTTP 200 s praznim JSON objektom, bez obzira je li token pronađen, prema RFC 7009.

Korisnici također mogu opozvati vezu iz Povezanih aplikacija u FastComments nadzornoj ploči. Svaki token za tu aplikaciju prestaje odmah raditi.

Ovaj API agregira dokumente grupiranjem (ako je naveden groupBy) i primjenom više operacija. Podržane su različite operacije (npr. sum, countDistinct, avg, itd.).

Trošak je varijabilan. Svakih 500 pregledanih objekata košta 1 API kredit.

Maksimalna dopuštena upotreba memorije po API pozivu po zadanim postavkama iznosi 64MB, a po zadanim postavkama možete imati samo jednu agregaciju koja se izvršava u jednom trenutku. Ako istodobno pošaljete više agregacija, bit će stavljenje u red i izvršene redoslijedom podnošenja. Neobrađene agregacije čekat će najviše 60 sekundi, nakon čega će zahtjev isteći. Pojedinačne agregacije mogu se izvršavati do 5 minuta.

Ako imate upravljane tenante, možete agregirati sve resurse podređenih tenant-a u jednom pozivu prosljeđivanjem query parametra parentTenantId.

Primjeri

Primjer: Brojanje jedinstvenih

Primjer cURL zahtjeva: broj jedinstvenih vrijednosti

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

Odgovor: broj jedinstvenih vrijednosti

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

Primjer: Brojanje različitih vrijednosti

Primjer cURL zahtjeva: broj različitih vrijednosti

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

Odgovor:

Odgovor: broj različitih vrijednosti

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

Primjer: Zbroj vrijednosti više polja

Primjer cURL zahtjeva: zbroj vrijednosti

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

Odgovor:

Odgovor: zbroj vrijednosti

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

Primjer: Prosjek vrijednosti više polja

Primjer cURL zahtjeva: prosjek vrijednosti

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

Odgovor:

Odgovor: prosjek vrijednosti

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

Primjer: Min/Max vrijednosti više polja

Primjer cURL zahtjeva: min/max vrijednosti

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

Odgovor:

Odgovor: min/max vrijednosti

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

Primjer: Brojanje jedinstvenih vrijednosti više polja

Primjer cURL zahtjeva: broj jedinstvenih vrijednosti

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

Odgovor:

Odgovor: broj jedinstvenih vrijednosti

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

Primjer: Kreiranje upita

Primjer cURL zahtjeva: kreiranje upita

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

Odgovor:

Odgovor: kreiranje upita

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

Primjer: Brojanje komentara na čekanju pregleda

Primjer cURL zahtjeva: broj komentara na čekanju pregleda

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

Odgovor:

Odgovor: broj komentara na čekanju pregleda

Copy

1

2{

3 "status": "success",

4 "data": [

5 { "count": { "numericValue": 2 } }

6 ],

7 "stats": { "scanned": 2 }

8}

9

Primjer: Pregled raspodjele odobrenih, pregledanih i spam komentara

Primjer cURL zahtjeva: pregled raspodjele komentara

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

Odgovor:

Odgovor: pregled raspodjele komentara

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

Strukture

Struktura zahtjeva za agregaciju

Copy

1

2export type AggregationOpType = 'sum' | 'countDistinct' | 'distinct' | 'avg' | 'min' | 'max' | 'count';

3

4/** Operacija koja će se primijeniti na polje */

5export interface AggregationOperation {

6 /** Polje na kojem će se izvršiti operacija */

7 field: string;

8 /** Tip operacije */

9 op: AggregationOpType;

10 /** Opcionalni alias za izlaz; ako nije naveden, koristi se izračunati zadani alias */

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

Struktura odgovora za agregaciju

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

Sljedeći resursi mogu se agregirati:

• 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

Ovaj API koristi paginaciju, koju pružaju parametri skip, limit, before i after. AuditLog zapisi se vraćaju u stranicama od 1000 po zadanim postavkama, do maksimalnog limit od 10000, poredani po when i id. Stranice su velike jer se ovaj krajnji punkt obično koristi za izvoz povijesti, a ne za interaktivno listanje.

Svaki 100 vraćenih zapisa košta 1 kredit.

Prema zadanim postavkama, dobit ćete popis s najnovijim stavkama prvo. Na ovaj način možete povlačiti podatke počevši od skip=0, paginirajući sve dok ne pronađete posljednji zapis koji ste obradili.

Alternativno, možete sortirati najstarije prvo i paginirati sve dok ne ostane više zapisa.

Sortiranje se može izvršiti postavljanjem order na ASC ili DESC. Zadano je DESC.

Upiti po datumu mogu se izvršiti putem before i after kao vremenskih oznaka u milisekundama. before i after NISU inkluzivni i svaki se može koristiti samostalno.

Pronalaženje što se dogodilo osobi

Svaki događaj bilježi tko ga je izvršio (username, userId, ip) i, odvojeno, na čemu je izvršen. targetLabel je čitljiva oznaka za taj objekt, na primjer jsmith (jsmith@example.com), a targetId je njegov ID. Koristite target za podudaranje podstringa neosjetljivo na veličinu slova na oznaci kada znate ime ili e‑mail osobe, ali ne i njen ID.

Brisanja bilježe oznaku u trenutku događaja, tako da se uklonjeni korisnik ili moderator i dalje može identificirati nakon što je osnovni zapis izbrisan.

Upravljani najmodavci

Ako vaš najmodavac upravlja drugim najmodavcima, postavite includeManagedTenants=true kako biste vratili događaje iz vašeg najmodavca i svih najmodavaca koje on upravlja u jednom odgovoru. Svaki vraćeni zapis ima tenantId koji vam govori iz kojeg najmodavca potječe.

AuditLog cURL primjer

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

Struktura zahtjeva za AuditLog

Copy

1

2interface AuditLogsRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5 order?: 'ASC' | 'DESC'

6 /** Max 10000. Defaults to 1000. **/

7 limit?: number

8 skip?: number

9 before?: number

10 after?: number

11 /** Only events performed by this username. **/

12 username?: string

13 /** Only events from this IP address. **/

14 ip?: string

15 /** Only events of this type. **/

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

17 /** Only events for this resource, e.g. User or Moderator. **/

18 resourceName?: string

19 /** Only events whose affected object has this id. **/

20 targetId?: string

21 /** Case-insensitive substring match on the affected object's label. **/

22 target?: string

23 /** Also return events from tenants this tenant manages. **/

24 includeManagedTenants?: boolean

25}

26

Struktura odgovora za AuditLog

Copy

1

2interface AuditLogsResponse {

3 status: 'success' | 'failed'

4 /** Included on failure. **/

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

6 /** Included on failure. **/

7 reason?: string

8 /** The logs! **/

9 auditLogs: AuditLog[]

10}

11

Ova ruta vraća batch poslove najmodera svih tipova, najnovije prvo, 100 po stranici. Upotrijebite type i status za sužavanje popisa, i skip za paginaciju.

Primjer cURL zahtjeva za popis BatchJobova

Copy

1

2curl --request GET \

3 --url 'https://fastcomments.com/api/v1/batch-jobs?tenantId=demo&API_KEY=DEMO_API_SECRET&type=migrate-pages&status=running'

4

Struktura zahtjeva za popis BatchJobova

Copy

1

2interface BatchJobsQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** Samo poslovi ovog tipa, na primjer migrate-pages. **/

6 type?: string

7 status?: 'requested' | 'running' | 'success' | 'failed'

8 /** Koliko poslova preskočiti, za paginaciju. Nenegativni cijeli broj. **/

9 skip?: number

10}

11

Struktura odgovora za popis BatchJobova

Copy

1

2interface BatchJobsResponse {

3 status: 'success' | 'failed'

4 /** Uključeno u slučaju neuspjeha. **/

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

6 /** Uključeno u slučaju neuspjeha. **/

7 reason?: string

8 /** Najnovije prvo, najviše 100. **/

9 batchJobs?: BatchJob[]

10}

11

Ova ruta vraća status, napredak i, nakon što je završila, rezultat jednog batch posla. Koristite je za praćenje posla pokrenutog putem POST /api/v1/pages/migrations ili POST /api/v1/pages/migrations/:undoId/undo.

Posao je završen kada je njegov status success ili failed. Svaki poziv košta 1 kredit, pa zato vršite upit svakih nekoliko sekundi umjesto kontinuirano.

BatchJob po ID cURL primjer

Copy

1

2curl --request GET \

3 --url 'https://fastcomments.com/api/v1/batch-jobs/my-batch-job-id?tenantId=demo&API_KEY=DEMO_API_SECRET'

4

BatchJob po ID struktura zahtjeva

Copy

1

2interface BatchJobQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

BatchJob po ID struktura odgovora

Copy

1

2interface BatchJobResponse {

3 status: 'success' | 'failed'

4 /** Uključeno pri neuspjehu. **/

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

6 /** Uključeno pri neuspjehu. **/

7 reason?: string

8 batchJob?: BatchJob

9}

10

Primjer dovršenog posla migracije stranice

Copy

1

2{

3 "status": "success",

4 "batchJob": {

5 "id": "my-batch-job-id",

6 "type": "migrate-pages",

7 "status": "success",

8 "createdAt": "2026-10-19T16:00:00.000Z",

9 "completedAt": "2026-10-19T16:00:12.000Z",

10 "processedCount": 2,

11 "totalCount": 2,

12 "pageMigrationResults": [

13 {"from": "old-post-id", "to": "new-post-id", "type": "urlId", "status": "success", "commentsMigrated": 42},

14 {"from": "old.example.com", "to": "new.example.com", "type": "domain", "status": "success", "commentsMigrated": 1250}

15 ],

16 "undoId": "my-undo-id"

17 }

18}

19

Ovaj API se koristi za dohvaćanje komentara za prikaz korisniku. Na primjer, automatski filtrira neodobrene ili spam komentare.

Pagiranje

Pagiranje se može izvesti na jedan od dva načina, ovisno o zahtjevima za performansama i slučaju upotrebe:

1. Najbrže: Precalculated Pagination:
   1. Ovo je način na koji FastComments radi kada koristite naše unaprijed izgrađene widgete i klijente.
   2. Klikom na „next“ jednostavno se povećava broj stranice.
   3. Možete to zamisliti kao dohvaćanje iz key-value pohrane.
   4. Na ovaj način, jednostavno definirajte parametar page koji počinje od 0 i smjer sortiranja kao direction.
   5. Veličine stranica mogu se prilagoditi putem pravila prilagodbe.
2. Najfleksibilnije: Flexible Pagination:
   1. Na ovaj način možete definirati prilagođene parametre limit i skip. Nemojte proslijediti page.
   2. Sortiranje direction također je podržano.
   3. limit je ukupni broj koji se vraća nakon primjene skip.
      • Primjer: postavite skip = 200, limit = 100 kada je page size = 100 i page = 2.
   4. Podređeni komentari i dalje se računaju u paginaciji. Možete to zaobići korištenjem opcije asTree.
      • Možete paginirati podređene putem limitChildren i skipChildren.
      • Možete ograničiti dubinu vraćenih niti putem maxTreeDepth.

Niti

1. Pri korištenju Precalculated Pagination, komentari su grupirani po page i komentari u nitima utječu na cijelu stranicu.
   1. Na ovaj način, niti se mogu odrediti na klijentu na temelju parentId.
   2. Na primjer, s stranicom koja ima jedan komentar na najvišoj razini i 29 odgovora, i postavljanjem page=0 u API - dobit ćete samo komentar na najvišoj razini i 29 podređenih.
2. Pri korištenju Flexible Pagination, možete definirati parametar parentId.
   1. Postavite ga na null da biste dobili samo komentare na najvišoj razini.
   2. Zatim, za pregled niti, ponovno pozovite API i proslijedite parentId.
   3. Uobičajeno rješenje je napraviti API poziv za komentare na najvišoj razini, a zatim paralelne API pozive za dobivanje komentara za podređene svakog komentara.
3. NOVO Od veljače 2023! Dohvatite kao stablo koristeći &asTree=true.
   1. Možete to zamisliti kao Flexible Pagination as a Tree.
   2. Samo komentari na najvišoj razini se računaju u paginaciji.
   3. Postavite parentId=null da započnete stablo na korijenu (morate postaviti parentId).
   4. Postavite skip i limit za paginaciju.
   5. Postavite asTree na true.
   6. Cijena u kreditima povećava se za 2x, jer naš backend mora obaviti puno više posla u ovom scenariju.
   7. Postavite maxTreeDepth, limitChildren i skipChildren prema želji.

Objašnjenje stabala

Kada se koristi asTree, može biti teško razmišljati o paginaciji. Evo praktičnog grafikona:

Dijagram paginacije stabla

Dohvaćanje komentara u kontekstu korisnika

API /comments može se koristiti u dva konteksta, za različite slučajeve upotrebe:

• Za vraćanje komentara sortiranih i označenih informacijama za izgradnju vlastitog klijenta.
  • U tom slučaju, definirajte upitni parametar contextUserId.
• Za dohvaćanje komentara iz vašeg backend-a za prilagođene integracije.
  • Platforma će prema zadanim postavkama koristiti ovo bez contextUserId.

Komentari Precalculated Pagination

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

Komentari Flexible Pagination

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

Komentari Flexible Pagination u kontekstu korisnika

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

Komentari Flexible Pagination u kontekstu korisnika samo za komentare najviše razine

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

Dohvaćanje komentara kao stablo

Moguće je dobiti komentare vraćene kao stablo, s paginacijom koja broji samo komentare najviše razine.

Komentari As-A-Tree u kontekstu korisnika

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

Želite li dobiti samo komentare najviše razine i neposredne podređene? Evo jednog načina:

Komentari As-A-Tree s maksimalnom dubinom

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

Međutim, u vašem UI-ju možda ćete trebati znati treba li prikazati gumb „prikaži odgovore“ na svakom komentaru. Kada dohvaćate komentare putem stabla, postoji svojstvo hasChildren koje je označeno na komentarima kada je primjenjivo.

Dohvaćanje komentara kao stablo, pretraživanje po hashtag-u

Moguće je pretraživati po hashtag-u koristeći API, kroz cijeli vaš tenant (nije ograničeno na jednu stranicu ili urlId).

U ovom primjeru izostavljamo urlId i pretražujemo po više hashtagova. API će vratiti samo komentare koji imaju sve tražene hashtagove.

Komentari As-A-Tree u kontekstu korisnika, po hashtag-u

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

Svi parametri zahtjeva

Struktura zahtjeva za komentare

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

Odgovor

Struktura odgovora za komentare

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

Korisni savjeti

URL ID

Vjerojatno želite koristiti API Comment s parametrom urlId. Možete najprije pozvati API Pages da vidite kako izgledaju dostupne vrijednosti urlId.

Anonimne radnje

Za anonimno komentiranje vjerojatno želite proslijediti anonUserId prilikom dohvaćanja komentara i prilikom označavanja i blokiranja.

(!) Ovo je potrebno za mnoge trgovine aplikacija jer korisnici moraju moći označiti sadržaj koji su kreirali drugi korisnici, čak i ako nisu prijavljeni. Nepoštivanje može uzrokovati uklanjanje vaše aplikacije iz te trgovine.

Komentari se ne vraćaju

Provjerite da su vaši komentari odobreni i da nisu spam.

Ovaj API omogućuje dohvat jednog komentara prema ID-u.

Primjer cURL zahtjeva za dohvat komentara po ID-u

Copy

1

2curl --request GET \

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

4

Struktura zahtjeva za dohvat komentara po ID-u

Copy

1

2interface CommentsGetByIdQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Struktura odgovora za dohvat komentara po ID-u

Copy

1

2interface CommentGetByIdResponse {

3 status: 'success' | 'failed'

4 /** Uključeno u slučaju neuspjeha. **/

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

6 /** Uključeno u slučaju neuspjeha. **/

7 reason?: string

8 /** Komentar! **/

9 comment?: Comment

10}

11

Ovaj API endpoint omogućava stvaranje komentara.

Uobičajeni slučajevi upotrebe su prilagođena korisnička sučelja, integracije ili uvozi.

Napomene:

• Ovaj API može po želji ažurirati widget za komentare "uživo" (to povećava creditsCost s 1 na 2).
• Ovaj API će automatski stvoriti korisničke objekte u našem sustavu ako je naveden email.
• Pokušaj spremanja dva komentara s različitim emailovima, ali istim korisničkim imenom, rezultirat će greškom za drugi komentar.
• Ako navodite parentId, a podređeni komentar ima notificationSentForParent postavljeno na false, poslat ćemo obavijesti za nadređeni komentar. To se radi svaki sat (obavijesti grupiramo kako bismo smanjili broj poslanih emailova).
• Ako želite slati dobrodošlice prilikom stvaranja korisnika, ili emailove za potvrdu komentara, postavite sendEmails na true u query parametrima.
• Komentari stvoreni putem ovog API-ja prikazat će se na stranicama Analytics i Moderation u admin aplikaciji.
• "loše riječi" i dalje se maskiraju u imenima komentatora i tekstu komentara ako je ta postavka uključena.
• Komentari stvoreni putem ovog API-ja mogu se po želji i dalje provjeravati na spam.
• Konfiguracija poput maksimalne duljine komentara, ako je postavljena putem admin stranice Customization Rule, primjenjuje se i ovdje.

Minimalni podaci potrebni za slanje koji će se prikazati u widgetu za komentare su sljedeći:

Primjer minimalnog POST cURL zahtjeva za komentar

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

Realističniji zahtjev može izgledati ovako:

Primjer POST cURL zahtjeva za komentar

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

Struktura POST zahtjeva za komentar

Copy

1

2interface CommentPostQueryParams {

3 tenantId: string

4 API_KEY: string

5 doSpamCheck?: 'true' | 'false'

6 /** Treba li se komentar prikazati "uživo" korisnicima koji gledaju instance widgeta za komentare s istim urlId. NAPOMENA: Udvostručuje cijenu kredita s 1 na 2. **/

7 isLive?: 'true' | 'false'

8 sendEmails?: 'true' | 'false'

9 populateNotifications?: 'true' | 'false'

10}

11

Struktura POST odgovora za komentar

Copy

1

2

3interface CommentPostResponse {

4 status: 'success' | 'failed'

5 /** Uključeno u slučaju neuspjeha. **/

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 /** Uključeno u slučaju neuspjeha. **/

8 reason?: string

9 /** Stvoreni komentar. **/

10 comment?: Comment

11 /** Pridruženi korisnik, koji možda već postoji ili ne. **/

12 user?: User

13}

14

Ovaj API endpoint omogućuje ažuriranje pojedinačnog komentara.

Napomene:

• Ovaj API može ažurirati widget komentara "uživo" ako se želi (ovo povećava osnovni creditsCost s 1 na 2).
  • Ovo može učiniti migracije komentara između stranica "uživo" (promjena urlId).
  • Migracije koštaju dodatna 2 kredita jer se stranice prethodno izračunavaju i to je CPU-intenzivno.
• Za razliku od API-ja za kreiranje, ovaj API NEće automatski stvoriti korisničke objekte u našem sustavu ako je e-mail naveden.
• Komentari ažurirani putem ovog API-ja i dalje se mogu provjeriti na spam ako je potrebno.
• Konfiguracije poput maksimalne duljine komentara, ako su podešene putem administratorske stranice pravila prilagodbe, primjenjivat će se ovdje.
• Da biste korisnicima omogućili ažuriranje teksta komentara, možete jednostavno navesti comment u tijelu zahtjeva. Mi ćemo generirati odgovarajući commentHTML.
  • Ako definirate i comment i commentHTML, nećemo automatski generirati HTML.
  • Ako korisnik doda spominjanja ili hashtagove u svom novom tekstu, oni će i dalje biti obrađeni poput POST API-ja.
• Prilikom ažuriranja commenterEmail na komentaru, najbolje je također navesti userId. Inače morate osigurati da korisnik s tom e-mail adresom pripada vašem tenantu, inače će zahtjev propasti.
• Ako je ciljani komentar zaključan (isLocked: true), zahtjev se odbija s code: 'locked'. Prvo otključajte komentar, ažurirajte ga, a zatim ga ponovno zaključajte ako želite.

Minimalni primjer PATCH zahtjeva za komentar (cURL)

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

Struktura PATCH zahtjeva za komentar

Copy

1

2interface CommentPatchQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** Korisnik koji obavlja ažuriranje. Po želji se može koristiti za provjeru mogu li uređivati komentar. **/

6 contextUserId?: string

7 /** Trebamo li provjeriti izgleda li novi komentar kao spam? **/

8 doSpamCheck?: 'true' | 'false'

9 /** Treba li komentar biti prikazan "uživo" korisnicima koji gledaju instance widgeta komentara s istim urlId-om. NAPOMENA: Udvostručuje trošak kredita s 1 na 2. **/

10 isLive?: 'true' | 'false'

11}

12

Struktura odgovora PATCH zahtjeva za komentar

Copy

1

2

3interface CommentPatchResponse {

4 status: 'success' | 'failed'

5 /** Uključeno u slučaju pogreške. **/

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 /** Uključeno u slučaju pogreške. **/

8 reason?: string

9}

10

Ovaj API endpoint omogućuje brisanje komentara.

Napomene:

• Ovaj API može ažurirati widget komentara "uživo" ako se želi (ovo povećava creditsCost s 1 na 2).
• Ovaj API će obrisati sve podkomentare.
• Ako je ciljani komentar zaključan (isLocked: true), zahtjev se odbija s code: 'locked'. Prvo otključajte komentar, zatim ga obrišite.

Primjer cURL zahtjeva za brisanje komentara

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

Struktura zahtjeva za brisanje komentara

Copy

1

2interface CommentDeleteQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** Korisnik koji izvodi ažuriranje. Po potrebi se može koristiti za provjeru ima li pravo obrisati komentar. **/

6 contextUserId?: string

7 /** Treba li se komentar obrisati "uživo" korisnicima koji pregledavaju instance widgeta komentara s istim urlId. NAPOMENA: Udvostručuje trošak kredita s 1 na 2. **/

8 isLive?: 'true' | 'false'

9}

10

Struktura odgovora za brisanje komentara

Copy

1

2

3interface CommentDeleteResponse {

4 status: 'success' | 'failed'

5 /** Uključeno u slučaju neuspjeha. **/

6 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found' | 'locked'

7 /** Uključeno u slučaju neuspjeha. **/

8 reason?: string

9}

10

Ova API krajnja točka pruža mogućnost označavanja komentara za određenog korisnika.

Napomene:

• Ovaj poziv se uvijek mora izvršiti u kontekstu korisnika. Korisnik može biti FastComments.com korisnik, SSO korisnik ili korisnik stanara.
• Ako je postavljen prag za skrivanje označavanjem, komentar će automatski biti skriven uživo nakon što je označen definirani broj puta.
• Nakon što je automatski skriven (neodobren) - komentar može ponovno odobriti samo administrator ili moderator. Uklanjanje oznake neće ponovno odobriti komentar.

Primjer cURL za označavanje komentara

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

Za anonimno označavanje, moramo navesti anonUserId. Ovo može biti ID koji predstavlja anonimnu sesiju ili nasumični UUID. Ovo nam omogućuje podršku za označavanje i uklanjanje oznake s komentara čak i ako korisnik nije prijavljen. Na taj način, komentar može biti označen kao označen kada se komentari dohvaćaju s istim anonUserId.

Primjer cURL za anonimno označavanje komentara

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

Struktura zahtjeva za označavanje komentara

Copy

1

2interface CommentFlagQueryParams {

3 tenantId: string

4 API_KEY: string

5 userId?: string

6 anonUserId?: string

7}

8

Struktura odgovora za označavanje komentara

Copy

1

2

3interface CommentFlagResponse {

4 status: 'success' | 'failed'

5 /** Included on failure. **/

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 /** Included on failure. **/

8 reason?: string

9 /** Was the comment un-approved (hidden) due to being flagged too many times? **/

10 wasUnapproved?: boolean;

11}

12

Ovaj API endpoint pruža mogućnost uklanjanja označavanja (un-flag) komentara za određenog korisnika.

Napomene:

• Ovaj poziv uvijek se mora izvršiti u kontekstu korisnika. Korisnik može biti FastComments.com User, SSO User, ili Tenant User.
• Nakon što je komentar automatski odbijen (sakriven) - komentar može ponovno odobriti samo administrator ili moderator. Uklanjanje oznake (un-flagging) neće ponovno odobriti komentar.

Primjer cURL zahtjeva za uklanjanje oznake komentara

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

Za anonimno označavanje, moramo navesti anonUserId. To može biti ID koji predstavlja anonimnu sesiju, ili nasumični UUID.

Primjer cURL zahtjeva za anonimno uklanjanje oznake komentara

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

Struktura zahtjeva za uklanjanje oznake komentara

Copy

1

2interface CommentFlagQueryParams {

3 tenantId: string

4 API_KEY: string

5 userId?: string

6 anonUserId?: string

7}

8

Struktura odgovora za uklanjanje oznake komentara

Copy

1

2

3interface CommentUnFlagResponse {

4 status: 'success' | 'failed'

5 /** Uključeno u slučaju neuspjeha. **/

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 /** Uključeno u slučaju neuspjeha. **/

8 reason?: string

9}

10

Ova API krajnja točka pruža mogućnost blokiranja korisnika koji je napisao dani komentar. Podržava blokiranje iz komentara koje su napisali FastComments.com korisnici, SSO korisnici i korisnici stanara.

Podržava parametar tijela commentIdsToCheck za provjeru treba li bilo koji drugi potencijalno vidljivi komentari na klijentu biti blokirani/odblokirani nakon izvršenja ove radnje.

Napomene:

• Ovaj poziv se uvijek mora izvršiti u kontekstu korisnika. Korisnik može biti FastComments.com korisnik, SSO korisnik ili korisnik stanara.
• userId u zahtjevu je korisnik koji vrši blokiranje. Na primjer: Korisnik A želi blokirati Korisnika B. Proslijedite userId=Korisnik A i ID komentara koji je napisao Korisnik B.
• Potpuno anonimni komentari (bez ID-a korisnika, bez e-pošte) ne mogu se blokirati i bit će vraćena pogreška.

Primjer cURL za blokiranje komentara

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

Za anonimno blokiranje, moramo navesti anonUserId. Ovo može biti ID koji predstavlja anonimnu sesiju ili nasumični UUID. Ovo nam omogućuje podršku za blokiranje komentara čak i ako korisnik nije prijavljen dohvaćanjem komentara s istim anonUserId.

Primjer cURL za anonimno blokiranje komentara

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

Struktura zahtjeva za blokiranje komentara

Copy

1

2interface CommentBlockQueryParams {

3 tenantId: string

4 API_KEY: string

5 userId?: string

6 anonUserId?: string

7 commentIdsToCheck?: string[]

8}

9

Struktura odgovora za blokiranje komentara

Copy

1

2

3interface CommentBlockResponse {

4 status: 'success' | 'failed'

5 /** Included on failure. **/

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 /** Included on failure. **/

8 reason?: string

9 /** If commentIdsToCheck is defined, entries in this map with true are also blocked. **/

10 commentStatuses?: Record<string, boolean>;

11}

12

Ovaj API endpoint omogućava deblokiranje korisnika koji je napisao određeni komentar. Podržava deblokiranje komentara koje su napisali FastComments.com korisnici, SSO korisnici i Tenant korisnici.

Podržava commentIdsToCheck body parametar za provjeru trebaju li se drugi potencijalno vidljivi komentari na klijentu blokirati/deblokirati nakon izvođenja ove radnje.

Napomene:

• Ovaj poziv uvijek se mora izvršiti u kontekstu korisnika. Korisnik može biti FastComments.com korisnik, SSO korisnik ili Tenant korisnik.
• userId u zahtjevu je korisnik koji vrši deblokiranje. Na primjer: User A želi deblokirati User B. Proslijedite userId=User A i ID komentara koji je User B napisao.
• Potpuno anonimni komentari (bez korisničkog ID-a, bez e-pošte) ne mogu se blokirati i vratit će se pogreška.

Primjer cURL zahtjeva za deblokiranje komentara

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

Primjer cURL zahtjeva za deblokiranje anonimnog komentara

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

Struktura zahtjeva za deblokiranje komentara

Copy

1

2interface CommentUnBlockQueryParams {

3 tenantId: string

4 API_KEY: string

5 userId?: string

6 anonUserId?: string

7 commentIdsToCheck?: string[]

8}

9

Struktura odgovora na deblokiranje komentara

Copy

1

2

3interface CommentUnBlockResponse {

4 status: 'success' | 'failed'

5 /** Included on failure. **/

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 /** Included on failure. **/

8 reason?: string

9 /** If commentIdsToCheck is defined, entries in this map with true are still blocked. If false, you might want to un-hide the comments from the user so they don't have to refresh. **/

10 commentStatuses?: Record<string, boolean>;

11}

12

Pojedinačne EmailTemplates mogu se dohvatiti prema njihovom odgovarajućem id-u (NE emailTemplateId).

Primjer cURL zahtjeva za EmailTemplate prema ID-u

Copy

1

2curl --request GET \

3 --url 'https://fastcomments.com/api/v1/email-templates/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'

4

Struktura zahtjeva za EmailTemplate prema ID-u

Copy

1

2interface EmailTemplatesByIdRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Struktura odgovora za EmailTemplate prema ID-u

Copy

1

2interface EmailTemplateResponse {

3 status: 'success' | 'failed'

4 /** Uključeno u slučaju neuspjeha. **/

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

6 /** Uključeno u slučaju neuspjeha. **/

7 reason?: string

8 emailTemplate?: EmailTemplate | null

9}

10

Ovaj API koristi paginaciju, zadanu parametrom upita page. EmailTemplates se vraćaju u stranicama po 100, poredane prema createdAt, a zatim prema id.

Primjer cURL zahtjeva za EmailTemplate

Copy

1

2curl --request GET \

3 --url 'https://fastcomments.com/api/v1/email-templates?tenantId=demo&page=0&API_KEY=DEMO_API_SECRET'

4

Struktura zahtjeva za EmailTemplate

Copy

1

2interface EmailTemplatesRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** Stranica za dohvat, počinje s 0. **/

6 page: number

7}

8

Struktura odgovora za EmailTemplate

Copy

1

2interface EmailTemplatesResponse {

3 status: 'success' | 'failed'

4 /** Uključeno u slučaju neuspjeha. **/

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

6 /** Uključeno u slučaju neuspjeha. **/

7 reason?: string

8 emailTemplates: EmailTemplate[]

9}

10

Ovaj API endpoint omogućuje ažuriranje predloška e-pošte tako da se navede samo id i atributi koje treba ažurirati.

Imajte na umu da vrijede ista pravila validacije kao i pri stvaranju predloška, na primjer:

• Predložak se mora renderirati. To se provjerava pri svakom ažuriranju.
• Ne možete imati duplicirane predloške za istu domenu (inače bi jedan bio tiho ignoriran).

EmailTemplate PATCH primjer cURL-a

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 Struktura zahtjeva

Copy

1

2interface EmailTemplatePatchQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

EmailTemplate PATCH Struktura odgovora

Copy

1

2

3interface EmailTemplatePatchResponse {

4 status: 'success' | 'failed'

5 /** Uključeno pri neuspjehu. **/

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 /** Uključeno pri neuspjehu. **/

8 reason?: string

9 /** Ažurirani predložak e-pošte. **/

10 emailTemplate?: EmailTemplate

11}

12

Ovaj API endpoint omogućuje kreiranje predložaka e-pošte.

Bilješke:

• Ne možete imati više predložaka s istim emailTemplateId za istu domenu.
• Međutim, možete imati univerzalni predložak (domain = *) i predložak specifičan za domenu za isti emailTemplateId.
• Navođenje domain ima smisla samo ako imate različite domene ili želite koristiti specifične predloške za testiranje (domain postavljen na localhost itd.).
• Ako navedete domain, mora odgovarati DomainConfig. U slučaju greške daje se popis valjanih domena.
• Sintaksa predloška je EJS i renderira se s timeoutom od 500 ms. P99 za renderiranje je <5 ms, tako da ako dosegnete 500 ms nešto nije u redu.
• Vaš predložak mora renderirati s danim testData da bi se spremio. Greške pri renderiranju se agregiraju i prikazuju u nadzornoj ploči (uskoro dostupno putem API-ja).

Minimalni podaci potrebni za dodavanje predloška su sljedeći:

Minimalni EmailTemplate POST cURL primjer

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

Možda ćete htjeti imati predloške po web-mjestu, u kojem slučaju definirate domain:

EmailTemplate POST cURL primjer

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

Struktura EmailTemplate POST zahtjeva

Copy

1

2interface EmailTemplatePostQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Struktura EmailTemplate POST odgovora

Copy

1

2

3interface EmailTemplatePostResponse {

4 status: 'success' | 'failed'

5 /** Uključeno u slučaju neuspjeha. **/

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 /** Uključeno u slučaju neuspjeha. **/

8 reason?: string

9 /** Kreirani predložak. **/

10 emailTemplate?: EmailTemplate

11}

12

Ovaj API endpoint omogućuje pregled predložaka e-pošte.

Minimalni cURL primjer za POST pregled EmailTemplate

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

Struktura POST zahtjeva za EmailTemplate

Copy

1

2interface EmailTemplatePostQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Struktura POST odgovora za EmailTemplate

Copy

1

2

3interface EmailTemplatePostResponse {

4 status: 'success' | 'failed'

5 /** Uključeno u slučaju neuspjeha. **/

6 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'unauthorized' | 'unexpected-param' | 'does-not-render';

7 /** Uključeno u slučaju neuspjeha. **/

8 reason?: string

9 /** Renderirani HTML u slučaju uspjeha. **/

10 html?: string

11}

12

Ova ruta omogućuje uklanjanje jednog EmailTemplate po id-u.

Primjer cURL zahtjeva za uklanjanje EmailTemplate

Copy

1

2curl --request DELETE \

3 --url 'https://fastcomments.com/api/v1/email-templates/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'

4

Struktura zahtjeva za uklanjanje EmailTemplate

Copy

1

2interface EmailTemplateRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Struktura odgovora za uklanjanje EmailTemplate

Copy

1

2interface EmailTemplateDeleteResponse {

3 status: 'success' | 'failed'

4 /** Uključeno u slučaju neuspjeha. **/

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

6 /** Uključeno u slučaju neuspjeha. **/

7 reason?: string

8}

9

Dohvaća objave u feedu, najnovije prve. Paginiranje je temeljeno na kursoru: proslijedite _id posljednje objave koju ste primili kao afterId da biste dobili sljedeću stranicu.

Košta jedan kredit po deset vraćenih objava, s minimalno jednim kreditom.

FeedPost cURL primjer

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 struktura zahtjeva

Copy

1

2interface FeedPostsRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** Return posts after this post id. Omit for the first page. **/

6 afterId?: string

7 /** Defaults to 10. Maximum 1000. **/

8 limit?: number

9 /** Only return posts with these tags. Repeat the parameter for more than one tag. **/

10 tags?: string[]

11}

12

FeedPost struktura odgovora

Copy

1

2interface FeedPostsResponse {

3 status: 'success' | 'failed'

4 /** Included on failure. **/

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

6 /** Included on failure. **/

7 reason?: string

8 feedPosts: FeedPost[]

9}

10

Ova ruta stvara jedan FeedPost. Svaki post ima autora, pa je fromUserId obavezan i mora biti ID postojećeg FastComments ili SSO korisnika na računu.

Primjer cURL zahtjeva za FeedPost

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

Struktura zahtjeva za stvaranje FeedPosta

Copy

1

2interface FeedPostPostQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** Pošalji post na feedove koji su trenutno otvoreni u pregledniku. Zadano je false. **/

6 isLive?: boolean

7 /** Provedi post kroz anti-spam mehanizam prije spremanja. Zadano je false. **/

8 doSpamCheck?: boolean

9 /** Preskoči provjeru ponovljenog sadržaja koja se izvršava kao dio doSpamCheck. Zadano je false. **/

10 skipDupCheck?: boolean

11 /** Do 256 znakova. Emitira se živim slušateljima kako bi klijent mogao ignorirati vlastitu emisiju. **/

12 broadcastId?: string

13}

14

15interface FeedPostPostBody {

16 /** Obavezno. ID FastComments ili SSO korisnika. **/

17 fromUserId: string

18 title?: string

19 /** HTML. Sanira se pri spremanju. **/

20 contentHTML?: string

21 /** Zamjenjuje prikazano ime uzeto od korisnika. **/

22 fromUserDisplayName?: string

23 tags?: string[]

24 media?: FeedPostMediaItem[]

25 links?: FeedPostLink[]

26 meta?: Record<string, string>

27}

28

Struktura odgovora za stvaranje FeedPosta

Copy

1

2interface FeedPostPostResponse {

3 status: 'success' | 'failed'

4 /** Uključeno u slučaju neuspjeha. **/

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 /** Uključeno u slučaju neuspjeha. **/

7 reason?: string

8 feedPost?: FeedPost; // Vraćamo cijeli kreirani post pri uspjehu.

9}

10

Ova ruta ažurira jedan FeedPost. Pošaljite samo polja koja želite promijeniti.

Primjer cURL zahtjeva za ažuriranje FeedPosta

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