API-ji za živo komentiranje

Uporaba virov

Upoštevati je treba, da se pridobivanje podatkov iz API-ja šteje kot uporaba na vašem računu.

Vsak vir bo v svojem odseku navedel, kakšna je ta uporaba.

Nekateri viri stanejo več za strežbo kot drugi. Vsaka končna točka ima določeno ceno v kreditih na klic API-ja. Za nekatere končne točke se število kreditov razlikuje glede na možnosti in velikosti odgovorov.

Uporabo API-ja lahko preverite na strani Billing Analytics in se posodablja vsake nekaj minut.

Opomba!

Priporočamo, da najprej preberete dokumentacijo strani, da zmanjšate zmedo pri določanju, katere vrednosti posredovati za urlId v API-ju za komentarje.

Webhooki

Naročnine na webhooke imajo svoj vodnik. POST, GET in DELETE /api/v1/webhooks, ter GET /api/v1/webhooks/sample-payloads, so dokumentirani pod Managing Subscriptions via API, medtem ko so dogodkovni payloadi pod Webhook Structures.

FastComments je avtorizacijski strežnik OAuth 2.1. Aplikacija lahko pridobi žeton, ki je vezan na en FastComments račun, in ga uporablja na vseh končnih točkah v tem priročniku namesto API ključa. Na ta način se povezujejo Zapier aplikacija, strežnik MCP in druge integracije tretjih oseb.

Žetoni se izdajajo prek avtorizacijskega toka s PKCE. Podpore za client credentials ali implicit grant ni.

Odkrivanje

Lokacije končnih točk, podprti granti in avtentikacijske metode so objavljeni na standardnem URL-ju metapodatkov:

Metapodatki avtorizacijskega strežnika

Copy

1

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

3

Končne točke, ki jih opisuje:

Končne točke OAuth

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 v regiji EU uporabljajo https://eu.fastcomments.com kot issuer, z istimi potmi.

Registracija odjemalca

Odjemalec potrebuje client_id in registriran redirect_uri, preden lahko začne tok. Na voljo sta dva načina:

• Dinamična registracija odjemalca. POST /oauth/register z JSON telesom v skladu z RFC 7591 (redirect_uris, client_name, client_uri, logo_uri, token_endpoint_auth_method). Odgovor vsebuje client_id in, pri zaupnih odjemalcih, client_secret. Registracija je neavtenticirana in omejena s hitrostjo na IP.
• Metadatni dokument ID odjemalca. Odjemalec kot svoj client_id uporabi https URL, ki ga sam nadzoruje. FastComments pridobi ta URL in iz njega prebere ista metadatna polja. Klic za registracijo ni potreben.

Partnerske aplikacije, navedene v nadzorni plošči FastComments, kot je Zapier, registrira FastComments neposredno. Če gradite trgovinsko objavo in potrebujete odjemalca prve strani, se obrnite na podporo.

Obsegi (scopes)

Obsegi

Copy

1

2read zahtevki GET in HEAD

3write vse ostale metode

4

Zahtevek, ki ne zahteva obsega, dobi oba. Uporabnik na strani za soglasje vidi zahtevane obsege. Zahtevek za obseg, ki ni eden od teh dveh, ne uspe z invalid_scope.

Korak 1 - Avtorizacijski zahtevek

Brskalnik uporabnika pošljite na končno točko authorize. PKCE z metodo S256 je obvezen za vsakega odjemalca.

Avtorizacijski zahtevek

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 avtorizacijskega zahtevka

Copy

1

2interface OAuthAuthorizeQueryParams {

3 response_type: 'code'

4 client_id: string

5 /** Se mora točno ujemati z enim od registriranih preusmeritvenih URI odjemalca. **/

6 redirect_uri: string

7 /** Ločeni s presledkom. Izpustite za zahtevo obeh obsegov. **/

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

9 /** Vrnjen nespremenjen ob preusmeritvi. Uporabite ga za vezavo povratnega klica na sejo, ki je začela tok. **/

10 state?: string

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

12 code_challenge: string

13 code_challenge_method: 'S256'

14 /** Neobvezen indikator vira po RFC 8707. Če je poslan, mora biti ista vrednost poslana tudi na končno točko token. **/

15 resource?: string

16}

17

Uporabnik se po potrebi prijavi v FastComments in vidi stran za soglasje, ki navaja vašo aplikacijo, račun, na katerega bo povezana, in zahtevane obsege. Uporabnik mora imeti dovoljenje API Admin na tem računu; vsi drugi namesto obrazca za soglasje vidijo napako dovoljenja. Potrditev preusmeri brskalnik na vaš redirect_uri s code in state. Zavrnitev preusmeri z error=access_denied.

Avtorizacijska koda je veljavna 10 minut in jo je mogoče zamenjati enkrat. Druga zamenjava iste kode prekliče vse žetone, ki jih je ustvarila prva zamenjava.

Korak 2 - Zahtevek za žeton

Zamenjajte kodo za žetone. Telo je kodirano kot obrazec. Zaupni odjemalci se avtenticirajo z client_secret_basic (HTTP Basic) ali client_secret_post (skrivnost v telesu). Javni odjemalci pošljejo samo client_id.

Primer cURL zahtevka za žeton

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

Telo zahtevka za žeton (authorization_code)

Copy

1

2interface OAuthTokenRequestAuthorizationCode {

3 grant_type: 'authorization_code'

4 client_id: string

5 /** Samo zaupni odjemalci. Lahko je poslano namesto tega kot HTTP Basic avtentikacija. **/

6 client_secret?: string

7 code: string

8 code_verifier: string

9 /** Če je poslano, se mora ujemati z avtorizacijskim zahtevkom. **/

10 redirect_uri?: string

11 resource?: string

12}

13

Struktura odgovora z žetonom

Copy

1

2interface OAuthTokenResponse {

3 /** Predpona fcat_. Veljaven eno uro. **/

4 access_token: string

5 token_type: 'bearer'

6 /** Sekunde do poteka dostopnega žetona. 3600. **/

7 expires_in: number

8 /** Predpona fcrt_. Veljaven 30 dni od izdaje. **/

9 refresh_token: string

10 /** Dodeljeni obsegi, ločeni s presledkom. **/

11 scope: string

12}

13

Napake sledijo RFC 6749: JSON telo s error in error_description, HTTP 400 za invalid_request, invalid_grant, invalid_scope, invalid_target in unsupported_grant_type, HTTP 401 za invalid_client, HTTP 429 pri omejitvi hitrosti.

Korak 3 - Klicanje API-ja

Dostopni žeton pošljite kot bearer žeton. Najemnik je implicitno določen z žetonom, zato je tenantId neobvezen. Če je podan, se mora ujemati z žetonom, sicer zahtevek ne uspe.

Primer cURL z bearer žetonom

Copy

1

2curl --request GET \

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

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

5

GET /api/v1/me vrne najemnika, avtorizirajočega uporabnika in dodeljene obsege, zato je prava izbira za test povezave. Zahtevek s poteklim ali preklicanim žetonom dobi HTTP 401. Zahtevek, katerega metoda potrebuje obseg, ki ga žeton nima, dobi HTTP 403.

Korak 4 - Osveževanje

Primer cURL zahtevka za osvežitev

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

Telo zahtevka za žeton (refresh_token)

Copy

1

2interface OAuthTokenRequestRefreshToken {

3 grant_type: 'refresh_token'

4 client_id: string

5 client_secret?: string

6 refresh_token: string

7 /** Neobvezno. Zoži na podmnožico prvotno dodeljenih obsegov. **/

8 scope?: string

9 resource?: string

10}

11

Odgovor ima isto obliko kot zamenjava kode. Osvežitveni žetoni se rotirajo: vsaka osvežitev vrne nov refresh_token in prekliče starega po 30-sekundnem obdobju milosti za sočasne zahtevke. Predstavitev osvežitvenega žetona, rotiranega pred več kot 30 sekundami, se obravnava kot ponovitev (replay) in prekliče celoten grant. Partnerske aplikacije, registrirane s strani FastComments, so izvzete iz rotacije in dobijo nazaj isti osvežitveni žeton z veljavnostjo, podaljšano za dodatnih 30 dni.

Osvežitev ponovno preveri, ali avtorizirajoči uporabnik še vedno ima API Admin na računu. Če ne, se grant prekliče in odgovor je invalid_grant.

Preklic

Primer cURL zahtevka za preklic

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

Preklic osvežitvenega žetona prekliče vse dostopne žetone, izdane iz istega granta. Preklic dostopnega žetona prekliče samo ta žeton. Končna točka vrne HTTP 200 s praznim JSON objektom, ne glede na to, ali je bil žeton najden, v skladu z RFC 7009.

Uporabniki lahko povezavo prekličejo tudi v razdelku Povezane aplikacije v nadzorni plošči FastComments. Vsi žetoni za to aplikacijo takoj prenehajo delovati.

Ta API agregira dokumente tako, da jih združi (če je podan groupBy) in uporabi več operacij. Podprte so različne operacije (npr. sum, countDistinct, avg itd.).

Strošek je spremenljiv. Vsakih 500 pregledanih objektov stane 1 API kredit.

Privzeto je največja dovoljena poraba pomnilnika na klic API 64 MB, privzeto pa lahko hkrati teče samo ena agregacija. Če pošljete več agregacij hkrati, bodo postavljene v čakalno vrsto in izvršene v vrstnem redu pošiljanja. Čakanje na obdelavo v čakalni vrsti traja največ 60 sekund, po tem poizvedba poteče. Posamezne agregacije se lahko izvršujejo do 5 minut.

Če imate upravljane najemnike (managed tenants), lahko v enem klicu agregirate vire vseh otroških najemnikov tako, da pošljete query parameter parentTenantId.

Primeri

Primer: Štetje edinstvenih vrednosti

Primer cURL: Štetje edinstvenih vrednosti

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: Štetje edinstvenih vrednosti

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

Primer: Štetje različnih

Primer cURL: Štetje različnih vrednosti

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: Štetje različnih vrednosti

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

Primer: Seštevek vrednosti več polj

Primer cURL: Seštevek vrednosti

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: Seštevek vrednosti

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

Primer: Povprečne vrednosti več polj

Primer cURL: Povprečne vrednosti

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: Povprečne vrednosti

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

Primer: Minimalne/maksimalne vrednosti več polj

Primer cURL: Minimalne/maksimalne vrednosti

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: Minimalne/maksimalne vrednosti

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

Primer: Štetje unikatnih vrednosti več polj

Primer cURL: Štetje edinstvenih vrednosti

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: Štetje edinstvenih vrednosti

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

Primer: Primer ustvarjanja poizvedbe

Primer cURL: Ustvarjanje poizvedbe

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: Ustvarjanje poizvedbe

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

Primer: Štetje komentarjev, ki čakajo na pregled

Primer cURL: Štetje komentarjev, ki čakajo na pregled

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: Štetje komentarjev, ki čakajo na pregled

Copy

1

2{

3 "status": "success",

4 "data": [

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

6 ],

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

8}

9

Primer: Razčlenitev odobrenih, pregledanih in spam komentarjev

Primer cURL: Razčlenitev komentarjev

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: Razčlenitev komentarjev

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 zahteve za agregacijo

Copy

1

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

3

4/** Operacija, ki bo uporabljena na polju */

5export interface AggregationOperation {

6 /** Polje, na katerem se bo izvajala operacija */

7 field: string;

8 /** Vrsta operacije */

9 op: AggregationOpType;

10 /** Izbiren vzdevek (alias) za izhod; če ni naveden, se izračuna privzeti vzdevek */

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 agregacijo

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

Naslednje vire je mogoče 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

Ta API uporablja paginacijo, ki jo zagotavljajo parametri skip, limit, before in after. AuditLogi se privzeto vrnejo v straneh po 1000 zapisov, do največjega limita 10000, urejeni po when in id. Strani so velike, ker se ta končna točka običajno uporablja za izpis zgodovine, namesto da bi se po njej interaktivno pomikal.

Vsakih 100 vrnjenih zapisov ima strošek kredita 1.

Privzeto boste prejeli seznam z najnovejšimi elementi na začetku. Na ta način lahko poizvedujete z začetkom skip=0 in paginirate, dokler ne najdete zadnjega zapisa, ki ste ga porabili.

Alternativno lahko razvrstite po najstarejših najprej in paginirate, dokler ne ostane več zapisov.

Razvrščanje lahko izvedete z nastavitvijo order na ASC ali DESC. Privzeto je DESC.

Poizvedovanje po datumu je mogoče prek before in after kot časovnih žigov v milisekundah. before in after NISTA vključena, in katerikoli se lahko uporabi samostojno.

Iskanje, kaj se je zgodilo osebi

Vsak dogodek zabeleži, kdo ga je izvedel (username, userId, ip) in ločeno, na čem je bil izveden. targetLabel je človeško berljiva oznaka za ta objekt, na primer jsmith (jsmith@example.com), targetId pa je njegov ID. Uporabite target za neobčutljivo na velikost črk delno ujemanje podniza v oznaki, ko poznate ime ali e‑naslov osebe, vendar ne njen ID.

Brisanja zajamejo oznako v času dogodka, zato je odstranjenega uporabnika ali moderatorja še vedno mogoče identificirati, ko je osnovni zapis izginil.

Upravljani najemniki

Če vaš najemnik upravlja druge najemnike, nastavite includeManagedTenants=true, da v enem odgovoru vrnete dogodke iz vašega najemnika in vseh najemnikov, ki jih upravlja. Vsak vrnjeni zapis ima tenantId, ki pove, iz katerega najemnika je.

Primer cURL za AuditLog

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 zahteve 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 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

Ta pot vrne paketna opravila najemnika vseh vrst, najprej najnovejša, 100 na stran. Uporabite type in status, da zožita seznam, ter skip za straničenje.

Primer cURL zahteve za seznam BatchJob

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 zahteve za seznam BatchJob

Copy

1

2interface BatchJobsQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** Samo opravila tega tipa, na primer migrate-pages. **/

6 type?: string

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

8 /** Koliko opravil naj se preskoči, za straničenje. Ne-negativno celo število. **/

9 skip?: number

10}

11

Struktura odgovora za seznam BatchJob

Copy

1

2interface BatchJobsResponse {

3 status: 'success' | 'failed'

4 /** Vključeno v primeru napake. **/

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

6 /** Vključeno v primeru napake. **/

7 reason?: string

8 /** Najnovejše najprej, največ 100. **/

9 batchJobs?: BatchJob[]

10}

11

Ta poteka vrne stanje, napredek in, ko je končana, rezultat enega paketnega opravila. Uporabite jo za spremljanje opravila, ki je bilo zagnano z POST /api/v1/pages/migrations ali POST /api/v1/pages/migrations/:undoId/undo.

Opravilo je končano, ko je njegovo status success ali failed. Vsak klic stane 1 kredit, zato poizvedujte vsakih nekaj sekund namesto neprekinjeno.

Primer cURL za BatchJob po ID-ju

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

Struktura zahteve za BatchJob po ID-ju

Copy

1

2interface BatchJobQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Struktura odgovora za BatchJob po ID-ju

Copy

1

2interface BatchJobResponse {

3 status: 'success' | 'failed'

4 /** Vključeno ob napaki. **/

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

6 /** Vključeno ob napaki. **/

7 reason?: string

8 batchJob?: BatchJob

9}

10

Primer končanega posla migracije strani

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

Ta API se uporablja za pridobivanje komentarjev za prikaz uporabniku. Na primer, samodejno filtrira neodobrene ali neželene komentarje.

Paginacija

Pagiranje je mogoče izvesti na enega od dveh načinov, odvisno od zahtev po zmogljivosti in primera uporabe:

1. Najhitrejše: Precalculated Pagination:
   1. Tako FastComments deluje, ko uporabljate naše vnaprej izdelane gradnike in odjemalce.
   2. Klik na "next" preprosto poveča število strani.
   3. To si lahko predstavljate kot pridobivanje iz shrambe ključ‑vrednost.
   4. Na ta način preprosto definirajte parameter page, ki se začne z 0, in smer razvrščanja kot direction.
   5. Velikosti strani je mogoče prilagoditi prek pravil prilagajanja.
2. Najbolj prilagodljivo: Flexible Pagination:
   1. Na ta način lahko definirate lastne parametre limit in skip. Ne posredujte page.
   2. Smer direction je prav tako podprta.
   3. limit je skupno število, ki se vrne po uporabi skip.
      • Primer: nastavite skip = 200, limit = 100, ko je page size = 100 in page = 2.
   4. Podkomentarji se še vedno štejejo v paginaciji. To lahko zaobidete z uporabo možnosti asTree.
      • Podkomentarje lahko paginirate z limitChildren in skipChildren.
      • Globino vrnjenih niti lahko omejite z maxTreeDepth.

Niti

1. Ko uporabljate Precalculated Pagination, so komentarji združeni po page in komentarji v nitih vplivajo na celotno stran.
   1. Na ta način je mogoče niti določiti na odjemalcu na podlagi parentId.
   2. Na primer, pri strani z enim komentarjem najvišje ravni in 29 odgovori, ter nastavitvijo page=0 v API-ju - dobili boste samo komentar najvišje ravni in 29 podkomentarjev.
2. Ko uporabljate Flexible Pagination, lahko definirate parameter parentId.
   1. Nastavite ga na null, da dobite le komentarje najvišje ravni.
   2. Nato za ogled niti ponovno pokličite API in posredujte parentId.
   3. Pogosta rešitev je, da najprej izvedete klic API-ja za komentarje najvišje ravni, nato pa vzporedne klice API-ja za pridobitev komentarjev za podkomentarje vsakega komentarja.
3. NOVO od 2023-02! Fetch as a tree using &asTree=true.
   1. To si lahko predstavljate kot Flexible Pagination as a Tree.
   2. V paginaciji se štejejo le komentarji najvišje ravni.
   3. Nastavite parentId=null, da začnete drevo pri korenu (morate nastaviti parentId).
   4. Nastavite skip in limit za paginacijo.
   5. Nastavite asTree na true.
   6. Strošek kreditov se poveča za 2x, saj mora naš strežnik v tem scenariju opraviti veliko več dela.
   7. Nastavite maxTreeDepth, limitChildren in skipChildren po želji.

Razlaga dreves

Ko uporabljate asTree, je lahko težko razumeti paginacijo. Tukaj je priročna grafika:

Diagram paginacije dreves

Pridobivanje komentarjev v kontekstu uporabnika

/comments API se lahko uporablja v dveh kontekstih, za različne primere uporabe:

• Za vračanje komentarjev, razvrščenih in označenih z informacijami za izgradnjo lastnega odjemalca.
  • V tem primeru definirajte poizvedbeni parameter contextUserId.
• Za pridobivanje komentarjev iz vašega strežnika za prilagojene integracije.
  • Platforma bo to privzeto uporabila brez contextUserId.

Komentarji vnaprej izračunana paginacija

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

Komentarji prilagodljiva paginacija

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

Komentarji prilagodljiva paginacija v kontekstu uporabnika

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

Komentarji prilagodljiva paginacija v kontekstu uporabnika samo za komentarje najvišje ravni

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

Pridobivanje komentarjev kot drevo

Možno je dobiti komentarje vrnjene kot drevo, pri čemer paginacija šteje le komentarje najvišje ravni.

Komentarji kot drevo v kontekstu uporabnika

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 dobiti le komentarje najvišje ravni in takojšnje podkomentarje? Tukaj je en način:

Komentarji kot drevo z največjo globino

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

Vendar pa boste v vašem UI morda morali vedeti, ali naj se prikaže gumb "prikaži odgovore" na vsakem komentarju. Ko pridobivate komentarje prek drevesa, je na komentarje označena lastnost hasChildren, kadar je to primerno.

Pridobivanje komentarjev kot drevo, iskanje po hashtag-u

Možno je iskati po hashtag-u z uporabo API-ja, po celotnem najemniku (ni omejeno na eno stran ali urlId).

V tem primeru izpustimo urlId in iščemo po več hashtag-ih. API bo vrnil le komentarje, ki imajo vse zahtevane hashtag-e.

Komentarji kot drevo v kontekstu uporabnika, 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

Vsi parametri zahteve

Struktura zahteve za komentarje

Copy

1

2interface CommentsRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** urlId (URL strani ali ID članka), s katerim so komentarji povezani. **/

6 urlId?: string

7 /** Omeji komentarje, ki jih vrne ta uporabnik. **/

8 userId?: string

9 /** Uporabite to za iskanje po hashtag-u. Za iskanje preseka več hashtag-ov uporabite &hashTag=a&hashTag=b. **/

10 hashTag?: string

11 /** Smer razvrščanja. Privzeto je MR (najbolj relevantno). Drugi možnosti so OF (najstarejše najprej) in NF (najnovejše najprej). **/

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

13 /** Precalculated Pagination: Stran, ki jo želite pridobiti, začne z 0. Za vse komentarje (do 250) podajte -1. **/

14 page?: number

15 /** Flexible Pagination: Koliko komentarjev naj vrnemo? **/

16 limit?: number

17 /** Flexible Pagination: Koliko podkomentarjev naj vrnemo za vsakega starša? **/

18 limitChildren?: number

19 /** Flexible Pagination: Koliko komentarjev naj preskočimo? **/

20 skip?: number

21 /** Flexible Pagination: Koliko podkomentarjev naj preskočimo za vsakega starša? **/

22 skipChildren?: number

23 /** Za določanje blokiranih in označenih komentarjev. **/

24 contextUserId?: string

25 /** Za določanje blokiranih in označenih komentarjev. **/

26 anonUserId?: string

27 /** Za pridobivanje podkomentarjev. **/

28 parentId?: string

29 /** Za pridobivanje kot drevo. **/

30 asTree?: boolean

31 /** Kako globoko v drevo naj vrnemo podatke? 0 ne vrne podkomentarjev. 1 vrne takojšnje podkomentarje, itd. **/

32 maxTreeDepth?: number

33}

34

Odgovor

Struktura odgovora za komentarje

Copy

1

2interface CommentsResponse {

3 status: 'success' | 'failed'

4 /** Vključeno ob napaki. **/

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 /** Vključeno ob napaki. **/

7 reason?: string

8 /** Komentarji! **/

9 comments: Comment[]

10}

11

Koristni nasveti

URL ID

Verjetno želite uporabiti API Comment s parametrom urlId. Najprej lahko pokličete API Pages, da vidite, kako izgledajo vrednosti urlId, ki so vam na voljo.

Anonimna dejanja

Za anonimno komentiranje verjetno želite posredovati anonUserId pri pridobivanju komentarjev ter pri označevanju in blokiranju.

(!) To je zahtevano v mnogih trgovinah z aplikacijami, saj morajo uporabniki imeti možnost označiti vsebino, ki jo ustvarijo drugi uporabniki, tudi če niso prijavljeni. Če tega ne storite, lahko vaša aplikacija odstrani iz omenjene trgovine.

Komentarji se ne vračajo

Preverite, da so vaši komentarji odobreni in niso neželeni.

Ta API omogoča pridobitev posameznega komentarja po ID-ju.

Primer cURL zahteve za pridobitev komentarja po ID-ju

Copy

1

2curl --request GET \

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

4

Struktura zahteve za pridobitev komentarja po ID-ju

Copy

1

2interface CommentsGetByIdQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Struktura odgovora za pridobitev komentarja po ID-ju

Copy

1

2interface CommentGetByIdResponse {

3 status: 'success' | 'failed'

4 /** Vključeno v primeru napake. **/

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

6 /** Vključeno v primeru napake. **/

7 reason?: string

8 /** Komentar! **/

9 comment?: Comment

10}

11

Ta končna točka API omogoča ustvarjanje komentarjev.

Pogoste uporabe so prilagojeni uporabniški vmesniki, integracije ali uvozi.

Opombe:

• Ta API lahko po želji posodobi prikazovalnik komentarjev "v živo" (to poveča creditsCost z 1 na 2).
• Ta API bo samodejno ustvaril objekte uporabnikov v našem sistemu, če je podan e-poštni naslov.
• Poskus shranjevanja dveh komentarjev z različnimi e-poštnimi naslovi, vendar istim uporabniškim imenom, bo pri drugem komentarju povzročil napako.
• Če določite parentId, in ima otroški komentar notificationSentForParent nastavljen na false, bomo poslali obvestila za starševski komentar. To se izvaja vsako uro (obvestila zbiramo skupaj, da zmanjšamo število poslanih e-poštnih sporočil).
• Če želite poslati dobrodošla e-poštna sporočila ob ustvarjanju uporabnikov ali e-poštna sporočila za preverjanje komentarjev, v poizvedbenih parametrih nastavite sendEmails na true.
• Komentarji ustvarjeni preko tega API se bodo prikazali na straneh Analitike in Moderacije v administrativni aplikaciji.
• "bad words" so še vedno zastrti v imenih komentatorjev in besedilu komentarjev, če je nastavitev vklopljena.
• Komentarje ustvarjene preko tega API-ja je mogoče še vedno preveriti za neželeno pošto, če želite.
• Konfiguracija, kot je največja dolžina komentarja, če je nastavljena preko strani pravil za prilagoditev (Customization Rule) v administraciji, se uporabi tukaj.

Najmanjši podatki, potrebni za oddajo in prikaz v pripomočku za komentarje, so naslednji:

Minimalni primer POST cURL 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

Bolj realističen primer zahteve je:

Primer POST cURL 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 zahtevka za komentar

Copy

1

2interface CommentPostQueryParams {

3 tenantId: string

4 API_KEY: string

5 doSpamCheck?: 'true' | 'false'

6 /** Ali naj se komentar prikaže "v živo" uporabnikom, ki si ogledajo primere pripomočka za komentarje z istim urlId. OPOZORILO: Podvoji strošek kreditov s 1 na 2. **/

7 isLive?: 'true' | 'false'

8 sendEmails?: 'true' | 'false'

9 populateNotifications?: 'true' | 'false'

10}

11

Struktura odgovora POST za komentar

Copy

1

2

3interface CommentPostResponse {

4 status: 'success' | 'failed'

5 /** Vključeno ob napaki. **/

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 /** Vključeno ob napaki. **/

8 reason?: string

9 /** Ustvarjeni komentar. **/

10 comment?: Comment

11 /** Povezani uporabnik, ki je morda že obstajal ali pa še ne. **/

12 user?: User

13}

14

Ta API vmesnik omogoča posodobitev enega komentarja.

Notes:

• Ta API lahko po želji posodobi widget za komentarje "v živo" (to poveča osnovni creditsCost s 1 na 2).
  • To lahko omogoči, da so migracije komentarjev med stranmi "v živo" (spreminjanje urlId).
  • Migracije stanejo dodatne 2 kredite, saj so strani predizračunane in je to CPU-intenzivno.
• V nasprotju z API-jem za ustvarjanje ta API NE bo samodejno ustvaril uporabniških objektov v našem sistemu, če je podan e-poštni naslov.
• Komentarje, posodobljene prek tega API-ja, je mogoče po želji še vedno preveriti za neželeno pošto.
• Konfiguracije, kot je največja dolžina komentarja, če so nastavljene prek administratorske strani Customization Rule, bodo veljale tukaj.
• Če želite uporabnikom omogočiti posodobitev besedila komentarja, lahko v telesu zahteve preprosto določite comment. Samodejno bomo ustvarili ustrezni commentHTML.
  • Če določite oba, comment in commentHTML, HTML ne bomo samodejno ustvarili.
  • Če uporabnik v novo besedilo doda omembe ali hashtage, bo to še vedno obdelano kot pri POST API-ju.
• Pri posodabljanju commenterEmail na komentarju je najbolje tudi navesti userId. V nasprotnem primeru morate zagotoviti, da uporabnik s tem e-poštnim naslovom pripada vašemu tenant, sicer bo zahteva zavrnjena.
• Če je ciljni komentar zaklenjen (isLocked: true), je zahteva zavrnjena s code: 'locked'. Najprej odklenejte komentar, ga posodobite, nato ga po potrebi ponovno zaklenite.

Minimalen primer PATCH cURL za komentar

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 zahteve za komentar

Copy

1

2interface CommentPatchQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** Uporabnik, ki izvaja posodobitev. Po želji se lahko uporabi za preverjanje, ali lahko ureja komentar. **/

6 contextUserId?: string

7 /** Ali naj preverimo, ali nov komentar izgleda kot neželena pošta? **/

8 doSpamCheck?: 'true' | 'false'

9 /** Ali naj se komentar prikaže "v živo" uporabnikom, ki si ogledujejo primere widgeta za komentarje z istim urlId. OPOMBA: Podvoji strošek kreditov s 1 na 2. **/

10 isLive?: 'true' | 'false'

11}

12

Struktura odgovora PATCH za komentar

Copy

1

2

3interface CommentPatchResponse {

4 status: 'success' | 'failed'

5 /** Vključeno ob neuspehu. **/

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 /** Vključeno ob neuspehu. **/

8 reason?: string

9}

10

Ta končna točka API-ja omogoča brisanje komentarja.

Opombe:

• Ta API lahko po želji posodobi widget komentarjev "v živo" (to poveča creditsCost s 1 na 2).
• Ta API bo izbrisal vse otroške komentarje.
• Če je ciljni komentar zaklenjen (isLocked: true), je zahteva zavrnjena z code: 'locked'. Najprej odklenite komentar, nato ga izbrišite.

Primer cURL zahteve za brisanje komentarja

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 zahteve za brisanje komentarja

Copy

1

2interface CommentDeleteQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** Uporabnik, ki izvaja posodobitev. Po želji se lahko uporabi za preverjanje, ali lahko izbriše komentar. **/

6 contextUserId?: string

7 /** Ali naj bo komentar izbrisan "v živo" za uporabnike, ki gledajo primere widgeta komentarjev z istim urlId. OPOMBA: Podvoji strošek kreditov s 1 na 2. **/

8 isLive?: 'true' | 'false'

9}

10

Struktura odgovora za brisanje komentarja

Copy

1

2

3interface CommentDeleteResponse {

4 status: 'success' | 'failed'

5 /** Vključeno v primeru neuspeha. **/

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

7 /** Vključeno v primeru neuspeha. **/

8 reason?: string

9}

10

Ta API endpoint omogoča prijavo (flag) komentarja za določenega uporabnika.

Opombe:

• Ta klic mora biti vedno izveden v kontekstu uporabnika. Uporabnik je lahko FastComments.com uporabnik, SSO uporabnik ali uporabnik najemnika.
• Če je nastavljen flag-to-hide threshold, bo komentar samodejno skrit v živo, potem ko je bil prijavljen tolikokrat, kot je določeno.
• Ko je samodejno preklican (skrit) — komentar lahko ponovno potrdi le skrbnik ali moderator. Odstranitev oznake (un-flagging) komentarja ga ne bo ponovno potrdila.

Primer cURL zahteve za označitev komentarja

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 prijavo moramo določiti anonUserId. To je lahko ID, ki predstavlja anonimno sejo, ali naključni UUID. To nam omogoča podporo prijavljanja in odstranjevanja prijav komentarjev tudi, če uporabnik ni prijavljen. Tako je lahko komentar označen kot prijavljen, ko se komentarji pridobijo z istim anonUserId.

Primer cURL zahteve za anonimno označitev komentarja

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 zahteve za označitev komentarja

Copy

1

2interface CommentFlagQueryParams {

3 tenantId: string

4 API_KEY: string

5 userId?: string

6 anonUserId?: string

7}

8

Struktura odgovora za označitev komentarja

Copy

1

2

3interface CommentFlagResponse {

4 status: 'success' | 'failed'

5 /** Vključeno ob napaki. **/

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 /** Vključeno ob napaki. **/

8 reason?: string

9 /** Ali je bil komentar samodejno preklican (skrit) zaradi prevelikega števila prijav? **/

10 wasUnapproved?: boolean;

11}

12

Ta končna točka API-ja omogoča odstranitev zastavice (un-flag) iz komentarja za določenega uporabnika.

Opombe:

• Klic mora biti vedno izveden v kontekstu uporabnika. Uporabnik je lahko FastComments.com User, SSO User, ali Tenant User.
• Ko je komentar samodejno zavrnjen (skrit) - komentar lahko ponovno odobri le administrator ali moderator. Odznačitev zastavice ne bo ponovno odobrila komentarja.

Primer cURL za odznačitev komentarja

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čevanje z zastavico moramo navesti anonUserId. To je lahko ID, ki predstavlja anonimno sejo, ali naključni UUID.

Primer cURL za anonimno odznačitev komentarja

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 zahtevka za odznačitev komentarja

Copy

1

2interface CommentFlagQueryParams {

3 tenantId: string

4 API_KEY: string

5 userId?: string

6 anonUserId?: string

7}

8

Struktura odgovora za odznačitev komentarja

Copy

1

2

3interface CommentUnFlagResponse {

4 status: 'success' | 'failed'

5 /** Vključeno ob neuspehu. **/

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 /** Vključeno ob neuspehu. **/

8 reason?: string

9}

10

Ta API endpoint omogoča blokiranje uporabnika, ki je napisal določen komentar. Podpira blokiranje komentarjev, napisanih s strani FastComments.com uporabnikov, SSO uporabnikov in najemniških uporabnikov.

Podpira telo parameter commentIdsToCheck, s katerim se preveri, ali je treba po tej akciji kateri koli drug potencialno viden komentar na odjemalcu blokirati/odblokirati.

Opombe:

• Ta klic mora biti vedno izveden v kontekstu uporabnika. Uporabnik je lahko FastComments.com uporabnik, SSO uporabnik ali najemniški uporabnik.
• V zahtevi userId označuje uporabnika, ki izvaja blokiranje. Na primer: User A želi blokirati User B. Posredujte userId=User A in ID komentarja, ki ga je napisal User B.
• Popolnoma anonimnih komentarjev (brez ID uporabnika, brez e-pošte) ni mogoče blokirati in bo vrnjena napaka.

Primer cURL zahteve za blokiranje komentarja

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 en anonUserId. To je lahko ID, ki predstavlja anonimno sejo, ali naključen UUID. To nam omogoča podporo blokiranja komentarjev tudi, če uporabnik ni prijavljen, saj se komentarji pridobijo z istim anonUserId.

Primer cURL za blokiranje anonimnega komentarja

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 zahteve za blokiranje komentarja

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 komentarja

Copy

1

2

3interface CommentBlockResponse {

4 status: 'success' | 'failed'

5 /** Vključeno ob neuspehu. **/

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 /** Vključeno ob neuspehu. **/

8 reason?: string

9 /** Če je commentIdsToCheck definirano, so vnosi v tem zemljevidu z vrednostjo true prav tako blokirani. **/

10 commentStatuses?: Record<string, boolean>;

11}

12

Ta API konecna točka omogoča odblokiranje uporabnika, ki je napisal določen komentar. Podpira odblokiranje komentarjev, napisanih s strani uporabnikov FastComments.com, SSO uporabnikov in najemniških uporabnikov.

Podpira parametru v telesu zahteve commentIdsToCheck, s katerim se preveri, ali je treba tudi druge morebitno vidne komentarje na odjemalcu po tej akciji blokirati/odblokirati.

Opombe:

• Ta klic mora biti vedno izveden v kontekstu uporabnika. Uporabnik je lahko uporabnik FastComments.com, SSO uporabnik ali najemniški uporabnik.
• V zahtevku userId označuje uporabnika, ki izvaja odblokiranje. Na primer: User A želi odblokirati User B. Posredujte userId=User A in ID komentarja, ki ga je napisal User B.
• Popolnoma anonimnih komentarjev (brez ID uporabnika, brez e-pošte) ni mogoče blokirati in bo vrnjena napaka.

Primer cURL zahteve za odblokiranje komentarja

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

Primer cURL zahteve za odblokiranje anonimnega komentarja

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 zahteve za odblokiranje komentarja

Copy

1

2interface CommentUnBlockQueryParams {

3 tenantId: string

4 API_KEY: string

5 userId?: string

6 anonUserId?: string

7 commentIdsToCheck?: string[]

8}

9

Struktura odgovora za odblokiranje komentarja

Copy

1

2

3interface CommentUnBlockResponse {

4 status: 'success' | 'failed'

5 /** Vključeno ob napaki. **/

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 /** Vključeno ob napaki. **/

8 reason?: string

9 /** Če je `commentIdsToCheck` določen, so vnosi v tem zemljevidu z vrednostjo true še vedno blokirani. Če false, boste morda želeli komentare ponovno prikazati uporabniku, da se mu ni treba osveževati. **/

10 commentStatuses?: Record<string, boolean>;

11}

12

Posamezne EmailTemplate lahko pridobite z njihovim ustreznim id (NE emailTemplateId).

Primer cURL za EmailTemplate po ID-ju

Copy

1

2curl --request GET \

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

4

Struktura zahteve za EmailTemplate po ID-ju

Copy

1

2interface EmailTemplatesByIdRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Struktura odgovora za EmailTemplate po ID-ju

Copy

1

2interface EmailTemplateResponse {

3 status: 'success' | 'failed'

4 /** Vključeno ob napaki. **/

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

6 /** Vključeno ob napaki. **/

7 reason?: string

8 emailTemplate?: EmailTemplate | null

9}

10

Ta API uporablja straničenje, ki ga zagotavlja poizvedni parameter page. EmailTemplates so vrnjeni po straneh po 100, urejeni po createdAt in nato id.

Primer cURL 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 zahteve za EmailTemplate

Copy

1

2interface EmailTemplatesRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** Stran za pridobitev, začne se z 0. **/

6 page: number

7}

8

Struktura odgovora za EmailTemplate

Copy

1

2interface EmailTemplatesResponse {

3 status: 'success' | 'failed'

4 /** Vključeno ob napaki. **/

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

6 /** Vključeno ob napaki. **/

7 reason?: string

8 emailTemplates: EmailTemplate[]

9}

10

Ta API endpoint omogoča posodobitev e-poštne predloge z navedbo samo id in atributov, ki jih želite posodobiti.

Upoštevajte, da veljajo enake preveritve kot pri ustvarjanju predloge, na primer:

• Predloga se mora pravilno upodobiti. To se preveri pri vsaki posodobitvi.
• Ne morete imeti podvojenih predlog za isto domeno (v nasprotnem primeru bi bila ena prezreta brez obvestila).

Primer cURL zahteve za EmailTemplate PATCH

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

Struktura zahteve za EmailTemplate PATCH

Copy

1

2interface EmailTemplatePatchQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Struktura odgovora za EmailTemplate PATCH

Copy

1

2

3interface EmailTemplatePatchResponse {

4 status: 'success' | 'failed'

5 /** Vključeno ob neuspehu. **/

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 /** Vključeno ob neuspehu. **/

8 reason?: string

9 /** Posodobljena e-poštna predloga. **/

10 emailTemplate?: EmailTemplate

11}

12

Ta API vmesnik omogoča ustvarjanje predlog e-pošte.

Opombe:

• Ne morete imeti več predlog z istim emailTemplateId za isto domeno.
• Vendar pa lahko imate univerzalno (wildcard) predlogo (domain = *) in domensko specifično predlogo za isti emailTemplateId.
• Določitev domain je pomembna le, če imate različne domene ali želite uporabiti specifične predloge za testiranje (npr. domain nastavljena na localhost).
• Če določite domain, mora ta ustrezati DomainConfig. V primeru napake je na voljo seznam veljavnih domen.
• Sintaksa predloge je EJS in se upodablja z omejitvijo 500ms. P99 za upodabljanje je <5ms, zato, če dosežete 500ms, je nekaj narobe.
• Vaša predloga se mora upodabljati z danimi testData, da se shrani. Napake pri upodabljanju se združujejo in poročajo na nadzorni plošči (kmalu na voljo tudi prek API).

Najmanj podatkov, potrebnih za dodajanje predloge, je naslednjih:

Minimalni primer cURL POST za EmailTemplate

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

Morda boste želeli imeti predloge za vsako spletno mesto posebej; v tem primeru določite domain:

Primer cURL POST za EmailTemplate

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 POST zahteve 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 /** Vključeno ob neuspehu. **/

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 /** Vključeno ob neuspehu. **/

8 reason?: string

9 /** Ustvarjena predloga. **/

10 emailTemplate?: EmailTemplate

11}

12

Ta API končna točka omogoča predogled e-poštnih predlog.

Minimalni cURL primer POST za predogled 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 zahteve 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 /** Vključeno ob napaki. **/

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

7 /** Vključeno ob napaki. **/

8 reason?: string

9 /** Upodobljen HTML ob uspehu. **/

10 html?: string

11}

12

Ta končna točka omogoča odstranitev posameznega EmailTemplate po id.

Primer cURL za odstranitev 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 zahtevka za odstranitev EmailTemplate

Copy

1

2interface EmailTemplateRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Struktura odgovora za odstranitev EmailTemplate

Copy

1

2interface EmailTemplateDeleteResponse {

3 status: 'success' | 'failed'

4 /** Vključeno v primeru napake. **/

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

6 /** Vključeno v primeru napake. **/

7 reason?: string

8}

9

Pridobi objave v viru, najnovejše najprej. Straničenje je zasnovano na kazalcu: posredujte _id zadnje prejete objave kot afterId, da dobite naslednjo stran.

Strošek je en kredit na deset vrnjenih objav, z minimalnim stroškom enega kredita.

Primer cURL za FeedPost

Copy

1

2curl --request GET \

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

4

Struktura zahteve FeedPost

Copy

1

2interface FeedPostsRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** Vrni objave po tem ID-ju objave. Izpusti za prvo stran. **/

6 afterId?: string

7 /** Privzeto 10. Največ 1000. **/

8 limit?: number

9 /** Vrni samo objave s temi oznakami. Parameter ponovite za več kot eno oznako. **/

10 tags?: string[]

11}

12

Struktura odgovora FeedPost

Copy

1

2interface FeedPostsResponse {

3 status: 'success' | 'failed'

4 /** Vključeno ob napaki. **/

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

6 /** Vključeno ob napaki. **/

7 reason?: string

8 feedPosts: FeedPost[]

9}

10

Ta končna točka ustvari en sam FeedPost. Vsaka objava ima avtorja, zato je fromUserId obvezen in mora biti ID obstoječega FastComments ali SSO uporabnika v računu.

Primer cURL za ustvarjanje 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 zahteve za ustvarjanje FeedPost

Copy

1

2interface FeedPostPostQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** Pošlji objavo v vire, ki so trenutno odprti v brskalniku. Privzeto je false. **/

6 isLive?: boolean

7 /** Izvedi objavo skozi sistem za zaznavanje spama pred shranjevanjem. Privzeto je false. **/

8 doSpamCheck?: boolean

9 /** Preskoči preverjanje podvojenega vsebine, ki se izvaja kot del doSpamCheck. Privzeto je false. **/

10 skipDupCheck?: boolean

11 /** Do 256 znakov. Poslano poslušalcem v živo, da lahko odjemalec ignorira svoj lasten prenos. **/

12 broadcastId?: string

13}

14

15interface FeedPostPostBody {

16 /** Obvezno. ID FastComments ali SSO uporabnika. **/

17 fromUserId: string

18 title?: string

19 /** HTML. Očiščen ob shranjevanju. **/

20 contentHTML?: string

21 /** Prepisuje prikazno ime, ki je vzeto od uporabnika. **/

22 fromUserDisplayName?: string

23 tags?: string[]

24 media?: FeedPostMediaItem[]

25 links?: FeedPostLink[]

26 meta?: Record<string, string>

27}

28

Struktura odgovora pri ustvarjanju FeedPost

Copy

1

2interface FeedPostPostResponse {

3 status: 'success' | 'failed'

4 /** Vključeno ob napaki. **/

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 /** Vključeno ob napaki. **/

7 reason?: string

8 feedPost?: FeedPost; // Vrnjemo celotno ustvarjeno objavo ob uspehu.

9}

10

Ta pot posodablja en sam FeedPost. Pošljite le polja, ki jih želite spremeniti.

Primer cURL zahteve za posodobitev FeedPost

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