Live Kommentar-API'er

Ressourceforbrug

Det skal bemærkes, at hentning af data fra API'et tælles som forbrug på din konto.

Hver ressource vil angive, hvad dette forbrug er, i sin egen sektion.

Nogle ressourcer koster mere at betjene end andre. Hvert endpoint har en fast pris i kreditter pr. API‑opkald. For nogle endpoints varierer antallet af kreditter afhængigt af indstillingerne og svarstørrelserne.

API‑forbruget kan kontrolleres på siden Billing Analytics og opdateres hver få minutter.

Bemærk!

Vi foreslår, at du læser Pages-dokumentationen først for at begrænse forvirring, når du skal bestemme, hvilke værdier du skal sende for urlId i Comment‑API'et.

Webhooks

Webhook-abonnementer har deres egen vejledning. POST, GET og DELETE /api/v1/webhooks samt GET /api/v1/webhooks/sample-payloads er dokumenteret under Managing Subscriptions via API, og hændelses‑payloads under Webhook Structures.

FastComments er en OAuth 2.1 autorisationsserver. En applikation kan hente et token, der er bundet til en FastComments‑konto, og bruge det på alle endpoint i denne vejledning i stedet for en API‑nøgle. Sådan forbinder Zapier‑appen, MCP‑serveren og andre tredjepartsintegrationer.

Tokens udstedes via autorisationskodeflowet med PKCE. Der findes ingen klientlegitimations‑ eller implicit tilladelse.

Opdagelse

Endpoint‑placeringer, understøttede tilladelser og autentificeringsmetoder offentliggøres på den standard metadata‑URL:

Autoriseringsserver Metadata

Copy

1

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

3

De endpoint, den beskriver:

OAuth‑endpoints

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

Kontoer i EU‑regionen bruger https://eu.fastcomments.com som udsteder, med de samme stier.

Registrering af en klient

En klient har brug for et client_id og en registreret redirect_uri, før den kan starte flowet. Der er to måder at få en på:

• Dynamisk klientregistrering. POST /oauth/register med en JSON‑krop i henhold til RFC 7591 (redirect_uris, client_name, client_uri, logo_uri, token_endpoint_auth_method). Svaret indeholder client_id og, for fortrolige klienter, client_secret. Registreringen er uautentificeret og hastighedsbegrænset pr. IP.
• Klient‑ID‑metadata‑dokument. Klienten bruger en https‑URL, den kontrollerer, som sit client_id. FastComments henter den URL og læser de samme metadatafelter fra den. Der er ikke behov for et registreringskald.

Partner‑applikationer, der er listet i FastComments‑dashboardet, såsom Zapier, registreres direkte af FastComments. Kontakt support, hvis du bygger en markedsplads‑liste og har brug for en første‑part‑klient.

Omfang

Omfang

Copy

1

2read GET and HEAD requests

3write every other method

4

En anmodning, der ikke anmoder om noget omfang, får begge tildelt. Brugeren ser de anmodede omfang på samtykkesiden. En anmodning om et omfang, der ikke er et af de to, fejler med invalid_scope.

Trin 1 – Autoriseringsanmodning

Send brugerens browser til autoriserings‑endpointet. PKCE med S256‑metoden er påkrævet for hver klient.

Autoriseringsanmodning

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

Autoriseringsanmodningsparametre

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

Brugeren logger ind på FastComments om nødvendigt og ser en samtykkeside, der navngiver din applikation, den konto den vil blive forbundet til, og de anmodede omfang. Brugeren skal have API‑Admin‑tilladelsen på den konto; alle andre ser en tilladelsesfejl i stedet for samtykkesiden. Godkendelse omdirigerer browseren til din redirect_uri med code og state. Afvisning omdirigerer med error=access_denied.

Autorisationstokenet er gyldigt i 10 minutter og kan udveksles én gang. En anden udveksling af den samme kode tilbagekalder alle tokens, som den første udveksling producerede.

Trin 2 – Token‑anmodning

Udveksl koden for tokens. Kroppen er formular‑kodet. Fortrolige klienter autentificerer med client_secret_basic (HTTP Basic) eller client_secret_post (hemmelighed i kroppen). Offentlige klienter sender kun client_id.

Token‑anmodning cURL‑eksempel

Copy

1

2curl --request POST \

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

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

5 --data 'grant_type=authorization_code' \

6 --data 'client_id=YOUR_CLIENT_ID' \

7 --data 'client_secret=YOUR_CLIENT_SECRET' \

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

9 --data 'code_verifier=YOUR_PKCE_VERIFIER' \

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

11

Token‑anmodningskrop (authorization_code)

Copy

1

2interface OAuthTokenRequestAuthorizationCode {

3 grant_type: 'authorization_code'

4 client_id: string

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

6 client_secret?: string

7 code: string

8 code_verifier: string

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

10 redirect_uri?: string

11 resource?: string

12}

13

Token‑responsstruktur

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

Fejl følger RFC 6749: en JSON‑krop med error og error_description, HTTP 400 for invalid_request, invalid_grant, invalid_scope, invalid_target og unsupported_grant_type, HTTP 401 for invalid_client, HTTP 429 ved hastighedsbegrænsning.

Trin 3 – Kald af API'en

Send adgangstokenet som en bearer‑token. Lejeren er implikeret af tokenet, så tenantId er valgfri. Når den er angivet, skal den matche tokenet, ellers fejler anmodningen.

Bearer‑token cURL‑eksempel

Copy

1

2curl --request GET \

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

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

5

GET /api/v1/me returnerer lejeren, den autoriserende bruger og de tildelte omfang, hvilket gør den til det rette kald for en forbindelsestest. En anmodning med et udløbet eller tilbagekaldt token får HTTP 401. En anmodning, hvis metode kræver et omfang, som tokenet ikke har, får HTTP 403.

Trin 4 – Opfriskning

Opfrisknings‑anmodning cURL‑eksempel

Copy

1

2curl --request POST \

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

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

5 --data 'grant_type=refresh_token' \

6 --data 'client_id=YOUR_CLIENT_ID' \

7 --data 'client_secret=YOUR_CLIENT_SECRET' \

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

9

Token‑anmodningskrop (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

Svaret har samme struktur som kode‑udvekslingen. Opfriskningstokens roteres: hver opfriskning returnerer et nyt refresh_token og tilbagekalder det gamle efter et 30‑sekunders grace‑vindue for samtidige anmodninger. Præsentation af et opfriskningstoken, der blev roteret for mere end 30 sekunder siden, betragtes som replay og tilbagekalder hele tilladelsen. Partner‑applikationer, der er registreret af FastComments, er undtaget fra rotation og får det samme opfriskningstoken med udløbet forlænget med yderligere 30 dage.

En opfriskning tjekker også, at den autoriserende bruger stadig har API‑Admin på kontoen. Hvis ikke, tilbagekaldes tilladelsen, og svaret er invalid_grant.

Tilbagekaldelse

Tilbagekaldelses‑anmodning cURL‑eksempel

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

Tilbagekaldelse af et opfriskningstoken tilbagekalder alle adgangstokens udstedt fra den samme tilladelse. Tilbagekaldelse af et adgangstoken tilbagekalder kun det pågældende token. Endpointet returnerer HTTP 200 med et tomt JSON‑objekt, uanset om tokenet blev fundet, i henhold til RFC 7009.

Brugere kan også tilbagekalde en forbindelse fra Connected Apps i FastComments‑dashboardet. Alle tokens for den pågældende applikation stopper med at fungere med det samme.

Dette API aggregerer dokumenter ved at gruppere dem (hvis groupBy er provided) og anvende flere operationer. Forskellige operationer (f.eks. sum, countDistinct, avg osv.) understøttes.

Omkostningen er variabel. Hver 500 scannede objekter koster 1 API-kredit.

Den maksimale hukommelsesbrug tilladt pr. API-kald er som standard 64MB, og som standard må du kun have én aggregation kørende ad gangen. Hvis du sender flere aggregationer samtidig, vil de blive sat i kø og kørt i den rækkefølge, de blev sendt. Ventende aggregationer vil vente maksimalt 60 sekunder; derefter vil anmodningen timeoute. Individuelle aggregationer kan køre i op til 5 minutter.

Hvis du har managed tenants, kan du aggregere alle child tenant resources i ét kald ved at angive query-parameteren parentTenantId.

Eksempler

Eksempel: Tæl unikke

cURL-eksempel: Antal unikke værdier

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

Svar: Antal unikke værdier

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

Eksempel: Antal distinkte

cURL-eksempel: Antal distinkte værdier

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

Svar:

Svar: Antal distinkte værdier

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

Eksempel: Sum af værdier for flere felter

cURL-eksempel: Sum af værdier

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

Svar:

Svar: Sum af værdier

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

Eksempel: Gennemsnit af værdier for flere felter

cURL-eksempel: Gennemsnit af værdier

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

Svar:

Svar: Gennemsnit af værdier

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

Eksempel: Min/Max for flere felter

cURL-eksempel: Min/max-værdier

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

Svar:

Svar: Min/max-værdier

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

Eksempel: Tæl unikke værdier for flere felter

cURL-eksempel: Antal unikke værdier

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

Svar:

Svar: Antal unikke værdier

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

Eksempel: Oprettelse af forespørgsel

cURL-eksempel: Oprettelse af forespørgsel

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

Svar:

Svar: Oprettelse af forespørgsel

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

Eksempel: Tæl kommentarer, der venter på gennemgang

cURL-eksempel: Tæl kommentarer, der venter på gennemgang

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

Svar:

Svar: Tæl kommentarer, der venter på gennemgang

Copy

1

2{

3 "status": "success",

4 "data": [

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

6 ],

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

8}

9

Eksempel: Opdeling af godkendte, gennemgåede og spam-kommentarer

cURL-eksempel: Opdeling af kommentarer

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

Svar:

Svar: Opdeling af kommentarer

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

Strukturer

Struktur for aggregationsanmodning

Copy

1

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

3

4/** En operation, der vil blive anvendt på et felt */

5export interface AggregationOperation {

6 /** Feltet, der skal opereres på */

7 field: string;

8 /** Typen af operation */

9 op: AggregationOpType;

10 /** Valgfrit alias for output; hvis ikke angivet, beregnes et standardalias */

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

Struktur for aggregationssvar

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

Følgende ressourcer kan aggregeres:

• 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

Dette API bruger paginering, leveret af parametrene skip, limit, before og after. AuditLogs returneres i sider på 1000 som standard, op til et maksimalt limit på 10000, sorteret efter when og id. Siderne er store, fordi dette endpoint normalt bruges til at dump historik i stedet for at bladre gennem den interaktivt.

Hvert 100 log, der returneres, har en kreditomkostning på 1.

Som standard vil du modtage en liste med de nyeste elementer først. På denne måde kan du forespørge startende med skip=0, paginere indtil du finder den sidste post, du har forbrugt.

Alternativt kan du sortere ældste først og paginere indtil der ikke er flere poster.

Sortering kan udføres ved at sætte order til enten ASC eller DESC. Standard er DESC.

Forespørgsel efter dato er mulig via before og after som tidsstempler med millisekunder. before og after er IKKE inklusiv, og hver kan bruges alene.

Find ud af hvad der skete med en person

Hver hændelse registrerer, hvem der udførte den (username, userId, ip) og, separat, hvad den blev udført på. targetLabel er en menneskelig læsbar etiket for det objekt, for eksempel jsmith (jsmith@example.com), og targetId er dens id. Brug target for en case‑insensitiv delstrengssøgning på etiketten, når du kender en persons navn eller e‑mail, men ikke deres id.

Deletes fanger etiketten på tidspunktet for hændelsen, så en fjernet bruger eller moderator stadig kan identificeres efter den underliggende post er væk.

Administrerede lejere

Hvis din lejer administrerer andre lejere, skal du sætte includeManagedTenants=true for at returnere hændelser fra din lejer og alle lejere, den administrerer, i et enkelt svar. Hver returneret logs tenantId fortæller dig, hvilken lejer den kom fra.

AuditLog cURL Eksempel

Copy

1

2curl --request GET \

3 --url 'https://fastcomments.com/api/v1/audit-logs?tenantId=demo&API_KEY=DEMO_API_SECRET&skip=0&order=ASC&before=123&after=456'

4

AuditLog Anmodningsstruktur

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

AuditLog Svarestruktur

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

Dette API bruges til at hente kommentarer til visning for en bruger. For eksempel filtrerer det automatisk uautoriserede eller spam‑kommentarer.

Pagination

Pagination kan udføres på en af to måder, afhængigt af ydelseskrav og brugssag:

1. Hurtigst: Precalculated Pagination:
   1. Dette er hvordan FastComments fungerer, når du bruger vores forudbyggede widgets og klienter.
   2. Klik på "next" øger blot sidetællingen.
   3. Du kan tænke på dette som at blive hentet fra en nøgle‑værdilager.
   4. På denne måde definerer du blot en page‑parameter, der starter på 0, og en sorteringsretning som direction.
   5. Sidestørrelser kan tilpasses via tilpasningsregler.
2. Mest fleksibel: Flexible Pagination:
   1. På denne måde kan du definere brugerdefinerede limit‑ og skip‑parametre. Send ikke page.
   2. Sorteringsdirection understøttes også.
   3. limit er det samlede antal, der skal returneres efter at skip er anvendt.
      • Eksempel: sæt skip = 200, limit = 100 når page size = 100 og page = 2.
   4. Børnekommentarer tæller stadig med i pagineringen. Du kan omgå dette ved at bruge asTree‑optionen.
      • Du kan paginere børn via limitChildren og skipChildren.
      • Du kan begrænse dybden af de returnerede tråde via maxTreeDepth.

Threads

1. Når du bruger Precalculated Pagination, grupperes kommentarer efter side, og kommentarer i tråde påvirker den samlede side.
   1. På denne måde kan tråde bestemmes på klienten baseret på parentId.
   2. For eksempel, med en side med én top‑niveau kommentar og 29 svar, og ved at sætte page=0 i API‑et – får du kun top‑niveau kommentaren og de 29 underkommentarer.
2. Når du bruger Flexible Pagination, kan du definere en parentId‑parameter.
   1. Sæt denne til null for kun at hente top‑niveau kommentarer.
   2. Herefter, for at se tråde, kald API‑et igen og send parentId.
   3. En almindelig løsning er at foretage et API‑kald for top‑niveau kommentarer og derefter foretage parallelle API‑kald for at hente kommentarer til hvert barns kommentarer.
3. NYT Fra februar 2023! Hent som et træ ved at bruge &asTree=true.
   1. Du kan tænke på dette som Flexible Pagination som et træ.
   2. Kun top‑niveau kommentarer tæller i pagineringen.
   3. Sæt parentId=null for at starte træet ved roden (du skal sætte parentId).
   4. Sæt skip og limit for paginering.
   5. Sæt asTree til true.
   6. Kreditomkostningen stiger med 2x, da vores backend skal udføre meget mere arbejde i dette scenarie.
   7. Sæt maxTreeDepth, limitChildren og skipChildren efter ønske.

Trees Explained

Når du bruger asTree, kan det være svært at forstå pagineringen. Her er en praktisk grafik:

Diagram for træpaginering

Fetching Comments in The Context of a User

/comments API'et kan bruges i to kontekster, til forskellige brugssager:

• For at returnere kommentarer sorteret og mærket med information til at bygge din egen klient.
  • I dette tilfælde definer en contextUserId‑forespørgselsparameter.
• For at hente kommentarer fra din backend til tilpassede integrationer.
  • Platformen vil som standard bruge dette uden contextUserId.

Kommentarer Forudberegnet Paginering

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

Kommentarer Fleksibel Paginering

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

Kommentarer Fleksibel Paginering i Bruger‑Kontekst

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

Kommentarer Fleksibel Paginering i Bruger‑Kontekst kun for Top‑Niveau Kommentarer

Copy

1

2curl --request GET \

3 --url 'https://fastcomments.com/api/v1/comments?tenantId=demo&urlId=test&API_KEY=DEMO_API_SECRET&direction=MR&skip=20&limit=10&contextUserId=my-user-id&parentId=null'

4

Get Comments as a Tree

Det er muligt at få kommentarerne returneret som et træ, hvor pagineringen kun tæller top‑niveau kommentarer.

Kommentarer Som‑et‑Træ i Bruger‑Kontekst

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

Vil du kun hente top‑niveau kommentarer og de umiddelbare børn? Her er en måde:

Kommentarer Som‑et‑Træ med Maksimal Dybde

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

Dog kan det i din UI være nødvendigt at vide, om der skal vises en "vis svar"-knap på hver kommentar. Når du henter kommentarer via et træ, er der en hasChildren‑egenskab mærket på kommentarer, når det er relevant.

Get Comments as a Tree, Searching by Hash Tag

Det er muligt at søge efter hashtag ved hjælp af API'et, på tværs af hele din lejer (ikke begrænset til én side eller urlId).

I dette eksempel udelader vi urlId, og vi søger efter flere hashtags. API'et vil kun returnere kommentarer, der har alle de anmodede hashtags.

Kommentarer Som‑et‑Træ i Bruger‑Kontekst, efter Hashtag

Copy

1

2curl --request GET \

3 --url 'https://fastcomments.com/api/v1/comments?tenantId=demo&API_KEY=DEMO_API_SECRET&direction=MR&skip=20&limit=10&contextUserId=my-user-id&parentId=null&asTree=true&hashTag=TestTag&hashTag=OtherTestTag'

4

All Request Params

Kommentarer Anmodningsstruktur

Copy

1

2interface CommentsRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** URL‑ID’en (side‑URL eller artikel‑ID), som kommentarerne er knyttet til. **/

6 urlId?: string

7 /** Begræns de kommentarer, der returneres af denne bruger. **/

8 userId?: string

9 /** Brug dette til at søge efter hashtag. For at grave ned i krydsfeltet af flere hashtags, brug &hashTag=a&hashTag=b. **/

10 hashTag?: string

11 /** Sorteringsretningen. Standard er MR (Mest relevant). Andre muligheder er OF (Ældste først) og NF (Nyeste først). **/

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

13 /** Forudberegnet paginering: Siden der skal hentes, startende med 0. Angiv -1 for alle kommentarer (op til 250). **/

14 page?: number

15 /** Fleksibel paginering: Hvor mange kommentarer skal vi returnere? **/

16 limit?: number

17 /** Fleksibel paginering: Hvor mange underkommentarer skal vi returnere for hver forælder? **/

18 limitChildren?: number

19 /** Fleksibel paginering: Hvor mange kommentarer skal vi springe over? **/

20 skip?: number

21 /** Fleksibel paginering: Hvor mange underkommentarer skal vi springe over for hver forælder? **/

22 skipChildren?: number

23 /** Til bestemmelse af blokerede og flaggede kommentarer. **/

24 contextUserId?: string

25 /** Til bestemmelse af blokerede og flaggede kommentarer. **/

26 anonUserId?: string

27 /** Til hentning af underkommentarer. **/

28 parentId?: string

29 /** Til hentning som et træ. **/

30 asTree?: boolean

31 /** Hvor dybt i træet skal vi returnere data? 0 returnerer ingen børn. 1 returnerer umiddelbare børn osv. **/

32 maxTreeDepth?: number

33}

34

The Response

Kommentarer Svarstruktur

Copy

1

2interface CommentsResponse {

3 status: 'success' | 'failed'

4 /** Inkluderet ved fejl. **/

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 /** Inkluderet ved fejl. **/

7 reason?: string

8 /** Kommentarerne! **/

9 comments: Comment[]

10}

11

Helpful Tips

URL ID

Du vil sandsynligvis bruge Comment‑API'et med urlId‑parameteren. Du kan først kalde Pages‑API'et for at se, hvordan de tilgængelige urlId‑værdier ser ud.

Anonymous Actions

For anonym kommentarering vil du sandsynligvis sende anonUserId, når du henter kommentarer, og når du udfører flagning og blokering.

(!) Dette er påkrævet for mange app‑butikker, da brugere skal kunne flagge bruger‑oprettet indhold, de kan se, selvom de ikke er logget ind. Undladelse kan medføre, at din app fjernes fra den pågældende butik.

Comments Not Being Returned

Tjek at dine kommentarer er godkendt, og ikke er spam.

Denne API giver mulighed for at hente en enkelt kommentar efter id.

Comments Get-By-Id cURL Eksempel

Copy

1

2curl --request GET \

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

4

Comment Get-By-Id Anmodningsstruktur

Copy

1

2interface CommentsGetByIdQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Comments Get-By-Id Svarstruktur

Copy

1

2interface CommentGetByIdResponse {

3 status: 'success' | 'failed'

4 /** Included on failure. **/

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

6 /** Included on failure. **/

7 reason?: string

8 /** The comment! **/

9 comment?: Comment

10}

11

Dette API-endpoint giver mulighed for at oprette kommentarer.

Almindelige anvendelsestilfælde er brugerdefinerede UI'er, integrationer eller imports.

Bemærkninger:

• Dette API kan opdatere kommentarwidgeten "live", hvis ønsket (dette øger creditsCost fra 1 til 2).
• Dette API vil automatisk oprette brugerobjekter i vores system, hvis der angives en e-mail.
• Forsøg på at gemme to kommentarer med forskellige e-mails, men samme brugernavn, vil resultere i en fejl for den anden kommentar.
• Hvis du angiver parentId, og en børnekommentar har notificationSentForParent sat til false, vil vi sende notifikationer for forældrekommentaren. Dette gøres hver time (vi samler notifikationerne for at reducere antallet af sendte e-mails).
• Hvis du vil sende velkomst-e-mails ved oprettelse af brugere, eller e-mails til verifikation af kommentarer, sæt sendEmails til true i forespørgselsparametrene.
• Kommentarer oprettet via dette API vil blive vist på Analytics- og Moderation-siderne i admin-appen.
• "bad words" bliver stadig maskerede i kommentatornavne og kommentartekst, hvis indstillingen er slået til.
• Kommentarer oprettet via dette API kan stadig blive tjekket for spam, hvis ønsket.
• Konfiguration såsom maksimal kommentar-længde, hvis konfigureret via Customization Rule-adminsiden, vil gælde her.

De minimale data, der kræves for at indsende og som vil blive vist i kommentar-widgeten, er følgende:

Minimum Kommentar POST cURL-eksempel

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

En mere realistisk forespørgsel kan se sådan ud:

Kommentar POST cURL-eksempel

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

Kommentar POST-forespørgselsstruktur

Copy

1

2interface CommentPostQueryParams {

3 tenantId: string

4 API_KEY: string

5 doSpamCheck?: 'true' | 'false'

6 /** Om kommentaren skal vises "live" for brugere, der ser instanser af kommentarwidgeten med samme urlId. BEMÆRK: Fordobler kreditforbruget fra 1 til 2. **/

7 isLive?: 'true' | 'false'

8 sendEmails?: 'true' | 'false'

9 populateNotifications?: 'true' | 'false'

10}

11

Kommentar POST-responsstruktur

Copy

1

2

3interface CommentPostResponse {

4 status: 'success' | 'failed'

5 /** Medtages ved fejl. **/

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 /** Medtages ved fejl. **/

8 reason?: string

9 /** Den oprettede kommentar. **/

10 comment?: Comment

11 /** Den tilknyttede bruger, som måske allerede fandtes eller ej. **/

12 user?: User

13}

14

Dette API-endpoint giver mulighed for at opdatere en enkelt kommentar.

Bemærk:

• Dette API kan opdatere kommentar-widgetten "live", hvis ønsket (dette øger grundlæggende creditsCost fra 1 til 2).
  • Dette kan gøre migrering af kommentarer mellem sider "live" (ændring af urlId).
  • Migrationer koster yderligere 2 credits, da siderne forudberegnes og dette er CPU-intensivt.
• I modsætning til create-API'et vil dette API IKKE automatisk oprette brugerobjekter i vores system, hvis e-mail er angivet.
• Kommentarer opdateret via dette API kan stadig kontrolleres for spam, hvis ønsket.
• Konfiguration som maks. kommentar-længde, hvis konfigureret via Customization Rule-adminsiden, gælder her.
• For at give brugere mulighed for at opdatere deres kommentartekst kan du blot angive comment i request body. Vi genererer den resulterende commentHTML.
  • Hvis du angiver både comment og commentHTML, vil vi ikke automatisk generere HTML'en.
  • Hvis brugeren tilføjer mentions eller hashtags i deres nye tekst, vil det stadig blive behandlet som i POST-API'et.
• Når du opdaterer commenterEmail på en kommentar, er det bedst også at angive userId. Ellers skal du sikre, at brugeren med denne e-mail tilhører din tenant, ellers vil anmodningen fejle.
• Hvis den pågældende kommentar er låst (isLocked: true), afvises anmodningen med code: 'locked'. Lås kommentaren op først, opdater den, og lås den derefter igen, hvis ønsket.

Minimalt eksempel på Comment PATCH 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

Struktur for Comment PATCH-anmodning

Copy

1

2interface CommentPatchQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** Brugeren der udfører opdateringen. Kan om ønsket bruges til at kontrollere, at de kan redigere kommentaren. **/

6 contextUserId?: string

7 /** Skal vi tjekke, om den nye kommentar ligner spam? **/

8 doSpamCheck?: 'true' | 'false'

9 /** Om kommentaren skal vises "live" for brugere, der ser forekomster af kommentar-widgetten med samme urlId. BEMÆRK: Fordobler kreditomkostningen fra 1 til 2. **/

10 isLive?: 'true' | 'false'

11}

12

Struktur for Comment PATCH-respons

Copy

1

2

3interface CommentPatchResponse {

4 status: 'success' | 'failed'

5 /** Medtages ved fejl. **/

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 /** Medtages ved fejl. **/

8 reason?: string

9}

10

Dette API-endpoint giver mulighed for at slette en kommentar.

Bemærkninger:

• Dette API kan opdatere kommentar-widgeten "live", hvis ønsket (det øger creditsCost fra 1 til 2).
• Dette API vil slette alle underordnede kommentarer.
• Hvis den målrettede kommentar er låst (isLocked: true), afvises anmodningen med code: 'locked'. Lås kommentaren op først, og slet derefter.

Kommentar DELETE cURL-eksempel

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

Kommentar DELETE Anmodningsstruktur

Copy

1

2interface CommentDeleteQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** Brugeren, der udfører opdateringen. Kan efter ønske bruges til at kontrollere, at de kan slette kommentaren. **/

6 contextUserId?: string

7 /** Hvorvidt kommentaren skal slettes "live" for brugere, der ser instanser af kommentar-widget'en med samme urlId. BEMÆRK: Dobbler kreditomkostningen fra 1 til 2. **/

8 isLive?: 'true' | 'false'

9}

10

Kommentar DELETE Svarstruktur

Copy

1

2

3interface CommentDeleteResponse {

4 status: 'success' | 'failed'

5 /** Inkluderet ved fejl. **/

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

7 /** Inkluderet ved fejl. **/

8 reason?: string

9}

10

Denne API-endpoint giver mulighed for at rapportere en kommentar for en specifik bruger.

Bemærkninger:

• Dette kald skal altid foretages i konteksten af en bruger. Brugeren kan være en FastComments.com-bruger, SSO-bruger eller Tenant-bruger.
• Hvis en flag-til-skjul-tærskel er sat, vil kommentaren automatisk blive skjult live, efter den er blevet rapporteret det definerede antal gange.
• Efter den automatisk er blevet fjernet fra godkendelse (skjult) - kan kommentaren kun gen-godkendes af en administrator eller moderator. Fjernelse af rapportering vil ikke gen-godkende kommentaren.

Comment Flag cURL Eksempel

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

For anonym rapportering skal vi angive en anonUserId. Dette kan være et ID, der repræsenterer den anonyme session, eller et tilfældigt UUID. Dette giver os mulighed for at understøtte rapportering og fjernelse af rapportering af kommentarer, selvom en bruger ikke er logget ind. På denne måde kan kommentaren markeres som rapporteret, når kommentarer hentes med det samme anonUserId.

Anonymous Comment Flag cURL Eksempel

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

Comment Flag Anmodningsstruktur

Copy

1

2interface CommentFlagQueryParams {

3 tenantId: string

4 API_KEY: string

5 userId?: string

6 anonUserId?: string

7}

8

Comment Flag Svarstruktur

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

Denne API-endpoint giver mulighed for at fjerne rapportering af en kommentar for en specifik bruger.

Bemærkninger:

• Dette kald skal altid foretages i konteksten af en bruger. Brugeren kan være en FastComments.com-bruger, SSO-bruger eller Tenant-bruger.
• Efter en kommentar automatisk er blevet fjernet fra godkendelse (skjult) - kan kommentaren kun gen-godkendes af en administrator eller moderator. Fjernelse af rapportering vil ikke gen-godkende kommentaren.

Comment Un-Flag cURL Eksempel

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

For anonym rapportering skal vi angive en anonUserId. Dette kan være et ID, der repræsenterer den anonyme session, eller et tilfældigt UUID.

Anonymous Comment Flag cURL Eksempel

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

Comment Un-Flag Anmodningsstruktur

Copy

1

2interface CommentFlagQueryParams {

3 tenantId: string

4 API_KEY: string

5 userId?: string

6 anonUserId?: string

7}

8

Comment Un-Flag Svarstruktur

Copy

1

2

3interface CommentUnFlagResponse {

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}

10

Denne API-endpoint giver mulighed for at blokere en bruger, der har skrevet en given kommentar. Det understøtter blokering fra kommentarer skrevet af FastComments.com-brugere, SSO-brugere og Tenant-brugere.

Det understøtter en commentIdsToCheck body-parameter til at kontrollere, om andre potentielt synlige kommentarer på klienten skal blokeres/afblokeres efter denne handling udføres.

Bemærkninger:

• Dette kald skal altid foretages i konteksten af en bruger. Brugeren kan være en FastComments.com-bruger, SSO-bruger eller Tenant-bruger.
• userId i anmodningen er brugeren, der udfører blokeringen. For eksempel: Bruger A vil blokere Bruger B. Angiv userId=Bruger A og kommentar-id'et som Bruger B skrev.
• Fuldstændig anonyme kommentarer (ingen bruger-id, ingen e-mail) kan ikke blokeres, og en fejl vil blive returneret.

Comment Block cURL Eksempel

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

For anonym blokering skal vi angive en anonUserId. Dette kan være et ID, der repræsenterer den anonyme session, eller et tilfældigt UUID. Dette giver os mulighed for at understøtte blokering af kommentarer, selvom en bruger ikke er logget ind, ved at hente kommentarerne med det samme anonUserId.

Anonymous Comment Block cURL Eksempel

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

Comment Block Anmodningsstruktur

Copy

1

2interface CommentBlockQueryParams {

3 tenantId: string

4 API_KEY: string

5 userId?: string

6 anonUserId?: string

7 commentIdsToCheck?: string[]

8}

9

Comment Block Svarstruktur

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

Denne API-endpoint giver mulighed for at afblokere en bruger, der har skrevet en given kommentar. Det understøtter afblokering fra kommentarer skrevet af FastComments.com-brugere, SSO-brugere og Tenant-brugere.

Det understøtter en commentIdsToCheck body-parameter til at kontrollere, om andre potentielt synlige kommentarer på klienten skal blokeres/afblokeres efter denne handling udføres.

Bemærkninger:

• Dette kald skal altid foretages i konteksten af en bruger. Brugeren kan være en FastComments.com-bruger, SSO-bruger eller Tenant-bruger.
• userId i anmodningen er brugeren, der udfører afblokeringen. For eksempel: Bruger A vil afblokere Bruger B. Angiv userId=Bruger A og kommentar-id'et som Bruger B skrev.
• Fuldstændig anonyme kommentarer (ingen bruger-id, ingen e-mail) kan ikke blokeres, og en fejl vil blive returneret.

Comment Un-Block cURL Eksempel

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

Anonymous Comment Un-Block cURL Eksempel

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

Comment Un-Block Anmodningsstruktur

Copy

1

2interface CommentUnBlockQueryParams {

3 tenantId: string

4 API_KEY: string

5 userId?: string

6 anonUserId?: string

7 commentIdsToCheck?: string[]

8}

9

Comment Un-Block Svarstruktur

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

Individuelle EmailTemplates kan hentes via deres tilsvarende id (IKKE emailTemplateId).

EmailTemplate efter ID cURL Eksempel

Copy

1

2curl --request GET \

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

4

EmailTemplate efter ID Anmodningsstruktur

Copy

1

2interface EmailTemplatesByIdRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

EmailTemplate efter ID Svarstruktur

Copy

1

2interface EmailTemplateResponse {

3 status: 'success' | 'failed'

4 /** Included on failure. **/

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

6 /** Included on failure. **/

7 reason?: string

8 emailTemplate?: EmailTemplate | null

9}

10

Denne API bruger paginering, leveret af page query-parameteren. EmailTemplates returneres i sider af 100, sorteret efter createdAt og derefter id.

EmailTemplate cURL Eksempel

Copy

1

2curl --request GET \

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

4

EmailTemplate Anmodningsstruktur

Copy

1

2interface EmailTemplatesRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** The page to fetch, starting with 0. **/

6 page: number

7}

8

EmailTemplate Svarstruktur

Copy

1

2interface EmailTemplatesResponse {

3 status: 'success' | 'failed'

4 /** Included on failure. **/

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

6 /** Included on failure. **/

7 reason?: string

8 emailTemplates: EmailTemplate[]

9}

10

Denne API-endpoint giver mulighed for at opdatere en e-mail-skabelon ved kun at angive id'et og attributterne, der skal opdateres.

Bemærk at alle de samme valideringer for oprettelse af en skabelon også gælder, for eksempel:

• Skabelonen skal kunne renderes. Dette kontrolleres ved hver opdatering.
• Du kan ikke have duplikerede skabeloner for det samme domæne (ellers ville en blive ignoreret lydløst).

EmailTemplate PATCH cURL Eksempel

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 Anmodningsstruktur

Copy

1

2interface EmailTemplatePatchQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

EmailTemplate PATCH Svarstruktur

Copy

1

2

3interface EmailTemplatePatchResponse {

4 status: 'success' | 'failed'

5 /** Included on failure. **/

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

8 reason?: string

9 /** The updated email template. **/

10 emailTemplate?: EmailTemplate

11}

12

Denne API-endpoint giver mulighed for at oprette e-mail-skabeloner.

Bemærkninger:

• Du kan ikke have flere skabeloner med det samme emailTemplateId med det samme domæne.
• Men du kan have en wildcard-skabelon (domain = * og en domænespecifik skabelon for det samme emailTemplateId).
• Angivelse af domain er kun relevant, hvis du har forskellige domæner, eller ønsker at bruge specifikke skabeloner til test (domain sat til localhost osv.).
• Hvis du angiver domain, skal det matche en DomainConfig. Ved fejl gives en liste over gyldige domæner.
• Skabelonsyntaksen er EJS og renderes med en timeout på 500ms. P99 for rendering er <5ms, så hvis du rammer 500ms, er der noget galt.
• Din skabelon skal kunne renderes med dine givne testData for at gemme. Renderingsfejl aggregeres og rapporteres i dashboardet (snart tilgængeligt via API).

De minimale data, der kræves for at tilføje en skabelon, er som følger:

Minimum EmailTemplate POST cURL Eksempel

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

Du vil måske have skabeloner per-site, i hvilket tilfælde du definerer domain:

EmailTemplate POST cURL Eksempel

Copy

1

2curl --request POST \

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

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

5 --data '{

6 "emailTemplateId": "comment-user-mention",

7 "displayName": "I'm a custom template.",

8 "ejs": "This is some email content!",

9 "domain": "somespecificsite.com",

10}'

11

EmailTemplate POST Anmodningsstruktur

Copy

1

2interface EmailTemplatePostQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

EmailTemplate POST Svarstruktur

Copy

1

2

3interface EmailTemplatePostResponse {

4 status: 'success' | 'failed'

5 /** Included on failure. **/

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

8 reason?: string

9 /** The created template. **/

10 emailTemplate?: EmailTemplate

11}

12

Denne API-endpoint giver mulighed for at forhåndsvise e-mail-skabeloner.

Minimum EmailTemplate Forhåndsvisning POST cURL Eksempel

Copy

1

2curl --request POST \

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

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

5 --data '{

6 "emailTemplateId": "comment-user-mention",

7 "displayName": "I'm a custom template.",

8 "ejs": "This is an @mention notification! My name is <%= comment.commenterName %>."

9}'

10

EmailTemplate POST Anmodningsstruktur

Copy

1

2interface EmailTemplatePostQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

EmailTemplate POST Svarstruktur

Copy

1

2

3interface EmailTemplatePostResponse {

4 status: 'success' | 'failed'

5 /** Included on failure. **/

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

7 /** Included on failure. **/

8 reason?: string

9 /** The rendered HTML on success. **/

10 html?: string

11}

12

Denne rute giver mulighed for at fjerne en enkelt EmailTemplate efter id.

EmailTemplate Fjernelse cURL Eksempel

Copy

1

2curl --request DELETE \

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

4

EmailTemplate Fjernelse Anmodningsstruktur

Copy

1

2interface EmailTemplateRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

EmailTemplate Fjernelse Svarstruktur

Copy

1

2interface EmailTemplateDeleteResponse {

3 status: 'success' | 'failed'

4 /** Included on failure. **/

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

6 /** Included on failure. **/

7 reason?: string

8}

9

Henter indlæg i et feed, nyeste først. Paginering er cursor-baseret: send _id for det sidste indlæg, du modtog, som afterId for at få den næste side.

Koster én kredit per ti indlæg, der returneres, med et minimum på én kredit.

FeedPost cURL-eksempel

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 anmodningsstruktur

Copy

1

2interface FeedPostsRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** Returner indlæg efter dette indlægs-id. Udelad for den første side. **/

6 afterId?: string

7 /** Standard er 10. Maksimum 1000. **/

8 limit?: number

9 /** Returner kun indlæg med disse tags. Gentag parameteren for mere end ét tag. **/

10 tags?: string[]

11}

12

FeedPost svarstruktur

Copy

1

2interface FeedPostsResponse {

3 status: 'success' | 'failed'

4 /** Inkluderet ved fejl. **/

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

6 /** Inkluderet ved fejl. **/

7 reason?: string

8 feedPosts: FeedPost[]

9}

10

Denne rute opretter et enkelt FeedPost. Hvert indlæg har en forfatter, så fromUserId er påkrævet og skal være id'et på en eksisterende FastComments- eller SSO-bruger på kontoen.

FeedPost Opret cURL Eksempel

Copy

1

2curl --request POST \

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

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

5 --data '{

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

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

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

9 "tags": ["releases"],

10 "links": [

11 {

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

13 "title": "Release notes",

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

15 }

16 ]

17}'

18

FeedPost Opret Anmodningsstruktur

Copy

1

2interface FeedPostPostQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** Skub indlægget til feeds, der er åbne i en browser lige nu. Standard er false. **/

6 isLive?: boolean

7 /** Kør indlægget gennem spam-motoren før gemning. Standard er false. **/

8 doSpamCheck?: boolean

9 /** Spring gentaget-indhold tjekket over, som kører som en del af doSpamCheck. Standard er false. **/

10 skipDupCheck?: boolean

11 /** Op til 256 tegn. Ekkoet til live-lyttere så en klient kan ignorere sin egen udsendelse. **/

12 broadcastId?: string

13}

14

15interface FeedPostPostBody {

16 /** Påkrævet. Et FastComments- eller SSO-bruger-id. **/

17 fromUserId: string

18 title?: string

19 /** HTML. Renset ved gemning. **/

20 contentHTML?: string

21 /** Overskriver display-navnet hentet fra brugeren. **/

22 fromUserDisplayName?: string

23 tags?: string[]

24 media?: FeedPostMediaItem[]

25 links?: FeedPostLink[]

26 meta?: Record<string, string>

27}

28

FeedPost Opret Svarstruktur

Copy

1

2interface FeedPostPostResponse {

3 status: 'success' | 'failed'

4 /** Inkluderet ved fejl. **/

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 /** Inkluderet ved fejl. **/

7 reason?: string

8 feedPost?: FeedPost; // Vi returnerer det komplette oprettede indlæg ved succes.

9}

10

Denne rute opdaterer et enkelt FeedPost. Send kun de felter, du vil ændre.

FeedPost Opdatering cURL Eksempel

Copy

1

2curl --request PATCH \

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

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

5 --data '{

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

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

8}'

9

FeedPost Opdatering Anmodningsstruktur

Copy

1

2interface FeedPostPatchQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

7/** Ethvert skrivbart felt fra FeedPost-strukturen. **/

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

9

FeedPost Opdatering Svarets Struktur

Copy

1

2interface FeedPostPatchResponse {

3 status: 'success' | 'failed'

4 /** Inkluderet ved fejl. **/

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

6 /** Inkluderet ved fejl. **/

7 reason?: string

8}

9

Denne API bruger paginering, leveret af page query-parameteren. HashTags returneres i sider af 100, sorteret efter tag.

HashTag cURL Eksempel

Copy

1

2curl --request GET \

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

4

HashTag Anmodningsstruktur

Copy

1

2interface HashTagsRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** The page to fetch, starting with 0. **/

6 page: number

7}

8

HashTag Svarstruktur

Copy

1

2interface HashTagsResponse {

3 status: 'success' | 'failed'

4 /** Included on failure. **/

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

6 /** Included on failure. **/

7 reason?: string

8 /** The hashtags! **/

9 hashTags: HashTag[]

10}

11

Denne rute giver mulighed for at opdatere en enkelt HashTag.

HashTag Opdatering cURL Eksempel

Copy

1

2curl --request PATCH \

3 --url 'https://fastcomments.com/api/v1/hash-tags/%23example_hash_tag?tenantId=demo&API_KEY=DEMO_API_SECRET' \

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

5 --data '{

6 "url": "https://example.com/some-`page`"

7}'

8

HashTag Opdatering Anmodningsstruktur

Copy

1

2interface HashTagPatchQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

HashTag Opdatering Svarstruktur

Copy

1

2interface HashTagPatchResponse {

3 status: 'success' | 'failed'

4 /** Included on failure. **/

5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-hash-tag' | 'tag-does-not-exist' | 'url-too-long' | 'invalid-tag' | 'already-exists'

6 /** Included on failure. **/

7 reason?: string

8 hashTag?: HashTag; // We return the complete updated hashtag on success.

9}

10

Denne rute giver mulighed for at tilføje en enkelt HashTag.

HashTag Oprettelse cURL Eksempel

Copy

1

2curl --request POST \

3 --url 'https://fastcomments.com/api/v1/hash-tags?tenantId=demo&API_KEY=DEMO_API_SECRET' \

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

5 --data '{

6 "tag": "#example",

7 "url": "https://example.com/some-page"

8}'

9

HashTag Oprettelse Anmodningsstruktur

Copy

1

2interface HashTagPostQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

HashTag Oprettelse Svarstruktur

Copy

1

2interface HashTagPostResponse {

3 status: 'success' | 'failed'

4 /** Included on failure. **/

5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-hash-tag' | 'tag-does-not-exist' | 'url-too-long' | 'invalid-tag'

6 /** Included on failure. **/

7 reason?: string

8 hashTag?: HashTag; // We return the complete created hashtag on success.

9}

10

Denne rute giver mulighed for at tilføje op til 100 HashTag-objekter på én gang.

HashTag Bulk Oprettelse cURL Eksempel

Copy

1

2curl --request PATCH \

3 --url 'https://fastcomments.com/api/v1/hash-tags/bulk?tenantId=demo&API_KEY=DEMO_API_SECRET' \

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

5 --data '{

6 "tags": [

7 {

8 "tag": "#example",

9 "url": "https://example.com/some-page"

10 }

11 ]

12}'

13

HashTag Bulk Oprettelse Anmodningsstruktur

Copy

1

2interface HashTagPostQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

HashTag Bulk Oprettelse Svarstruktur

Copy

1

2interface HashTagBulkPostResponse {

3 status: 'success' | 'failed'

4 /** Included on failure. **/

5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-hash-tag' | 'tag-does-not-exist' | 'url-too-long' | 'invalid-tag'

6 /** Included on failure. **/

7 reason?: string

8 results?: HashTagPostResponse[]; // We return a list of HashTagPostResponse objects for each provided tag.

9}

10