Коришћење ресурса

Треба напоменути да се дохватање података са API-ја рачуна као коришћење на вашем налогу.

Сваки ресурс ће у свом одељку навести шта тачно подразумева то коришћење.

Неки ресурси су скупљи за послуживање од других. Сваки endpoint има фиксни трошак у кредитима по позиву API-ја. За неке endpoint-e, број кредита варира у зависности од опција и величине одговора.

API коришћење можете провјерити на страници Аналитика наплате и ажурира се сваких неколико минута.

Напомена!

Препоручујемо да прво прочитате документацију за Pages, како бисте смањили конфузију при одређивању које вредности проследити за urlId у Comment API.

Овај API агрегира документе групишући их (ако је groupBy наведен) и примјењујући више операција. Подржане су различите операције (нпр. sum, countDistinct, avg, итд).

Трошак је променљиво. Сваких 500 скенираних објеката кошта 1 API кредит.

Максимална меморија дозвољена по API позиву по подразумеваној поставци је 64MB, и по подразумеваној поставци можете имати само једну агрегaцију која се извршава у једном тренутку. Ако пошаљете више агрегaција истовремено, биће стављене у ред и извршаваће се по редослиједу слања. Очекујуће агрегaције ће чекати највише 60 секунди, након чега ће захтјев истeћи. Појединачне агрегaције могу трајати до 5 минута.

Ако имате managed tenants, можете агрегирати све child tenant ресурсе у једном позиву прослеђивањем parentTenantId query параметра.

Примјери

Примјер: Бројање јединствених

cURL пример: Бројање јединствених вредности

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

Одговор: Бројање јединствених вредности

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

Примјер: Бројање различитих

cURL пример: Бројање различитих вредности

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

Одговор:

Одговор: Бројање различитих вредности

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

Примјер: Сума вриједности више поља

cURL пример: Сума вредности

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

Одговор:

Одговор: Сума вредности

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

Примјер: Просјечне вриједности више поља

cURL пример: Просјечне вриједности

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

Одговор:

Одговор: Просјечне вриједности

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

Примјер: Минималне/Максималне вриједности више поља

cURL пример: Минималне/Максималне вредности

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

Одговор:

Одговор: Минималне/Максималне вредности

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

Примјер: Бројање јединствених вриједности више поља

cURL пример: Бројање јединствених вредности

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

Одговор:

Одговор: Бројање јединствених вредности

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

Примјер: Креирање упита

cURL пример: Креирање упита

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

Одговор:

Одговор: Креирање упита

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

Примјер: Бројање коментара који чекају рецензију

cURL пример: Бројање коментара на чекању рецензије

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

Одговор:

Одговор: Бројање коментара на чекању рецензије

Copy

1

2{

3 "status": "success",

4 "data": [

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

6 ],

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

8}

9

Примјер: Преглед по статусу (approved, reviewed, spam)

cURL пример: Преглед коментара по статусу

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

Одговор:

Одговор: Преглед коментара по статусу

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

Структуре

Структура Aggregate захтева

Copy

1

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

3

4/** Операција која ће се извршити над пољем */

5export interface AggregationOperation {

6 /** Поље над којим се извршава операција */

7 field: string;

8 /** Тип операције */

9 op: AggregationOpType;

10 /** Опциони алијас за излаз; ако није наведен, израчунава се подразумевани алијас */

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

Структура Aggregate одговора

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

Следећи ресурси се могу агрегирати:

• AffiliateEvent
• AnonymousVote
• BannedUser
• BatchJob
• BlockedUser
• Comment
• CommentDeleted
• CommentIdToSyncOutbound
• CommentScheduled
• CommentSyncLog
• CustomConfig
• CustomEmailTemplateRenderError
• EmailToSend
• EventLogEntry
• ImportedCommentScheduled
• ModerationGroup
• Moderator
• Page
• PageReact
• PendingVote
• QuestionResult
• SSOUser
• SentEmail
• SpamEvent
• Tenant
• TenantAuditLog
• TenantBadge
• TenantDailyUsage
• TenantInvoiceHistory
• TenantPackage
• User
• UserBadge
• UserBadgeProgress
• UserNotification
• UserSubscription
• UserUsage
• Vote

Ovaj API koristi paginaciju, koja se obezbjeđuje parametrima skip, before, i after. AuditLog zapisi se vraćaju u stranicama po 1000, poredani po when i id.

Dohvatanje svake 1000 zapisa ima trošak kredita od 10.

Po zadanim postavkama dobićete listu s najnovijim stavkama na početku. Na ovaj način možete započeti preuzimanje sa skip=0, paginirati dok ne nađete posljednji zapis koji ste obradili.

Alternativno, možete sortirati od najstarijih prema najnovijim, i paginirati dok ne bude više zapisa.

Sortiranje se može uraditi postavljanjem order na ASC ili DESC. Zadano je ASC.

Upit po datumu je moguć putem before i after kao timestampova sa milisekundama. before i after NISU uključivi.

Primjer cURL zahtjeva 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 zahtjeva AuditLog

Copy

1

2interface CommentsRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5 order?: 'ASC' | 'DESC'

6 skip?: number

7 before?: number

8 after?: number

9}

10

Struktura odgovora AuditLog

Copy

1

2interface CommentsResponse {

3 status: 'success' | 'failed'

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

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

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

7 reason?: string

8 /** Logovi! **/

9 auditLogs: AuditLog[]

10}

11

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

Pagination

Paginacija se može obaviti na jedan od dva načina, u zavisnosti od zahtjeva za performansama i slučaja upotrebe:

1. Fastest: Prekalkulisana paginacija:
   1. Ovako FastComments radi kada koristite naše unaprijed izgrađene widgete i klijente.
   2. Klik na "next" jednostavno povećava broj stranice.
   3. Možete ovo smatrati dohvaćenim iz key-value skladišta.
   4. Na ovaj način, jednostavno definirajte parametar page koji počinje od 0 i smjer sortiranja kao direction.
   5. Veličine stranica se mogu prilagoditi putem pravila za prilagodbu.
2. Most Flexible: Fleksibilna paginacija:
   1. Na ovaj način možete definirati prilagođene parametre limit i skip. Ne šaljite page.
   2. Smjer sortiranja direction je također podržan.
   3. limit je ukupan broj koji će biti vraćen nakon što se primijeni skip.
      • Primjer: postavite skip = 200, limit = 100 kada je page size = 100 i page = 2.
   4. Child komentari se i dalje računaju u paginaciji. Možete zaobići ovo korištenjem opcije asTree.
      • Možete paginirati djecu putem limitChildren i skipChildren.
      • Možete ograničiti dubinu threadova koji se vraćaju putem maxTreeDepth.

Threads

1. Kada koristite Precalculated Pagination, komentari se grupišu po page-u i komentari u threadovima utiču na ukupnu stranicu.
   1. Na ovaj način, threadovi se mogu odrediti na klijentu na osnovu parentId.
   2. Na primjer, sa stranicom koja ima jedan komentar najvišeg nivoa i 29 odgovora, i postavljanjem page=0 u API-ju - dobićete samo komentar najvišeg nivoa i 29 djece.
   3. Example image here illustrating multiple pages.
2. Kada koristite Flexible Pagination, možete definirati parametar parentId.
   1. Postavite ovo na null da biste dobili samo komentare najvišeg nivoa.
   2. Zatim, da biste vidjeli threadove, pozovite API ponovo i pošaljite parentId.
   3. Uobičajeno rješenje je napraviti API poziv za komentare najvišeg nivoa, a zatim paralelne API pozive za dobavljanje komentara djece za svaki komentar.
3. NOVO (od feb 2023.)! Dohvatite kao stablo koristeći &asTree=true.
   1. Možete ovo zamisliti kao Fleksibilna paginacija kao stablo.
   2. Samo komentari najvišeg nivoa se računaju u paginaciji.
   3. Postavite parentId=null da počnete stablo od korijena (morate postaviti parentId).
   4. Postavite skip i limit za paginaciju.
   5. Postavite asTree na true.
   6. Troškovi kredita se povećavaju za 2x, jer naš backend mora uraditi mnogo više posla u ovom scenariju.
   7. Postavite maxTreeDepth, limitChildren, i skipChildren po želji.

Trees Explained

Kada koristite asTree, može biti teško razmišljati o paginaciji. Evo korisne grafike:

Dijagram paginacije stabla

Fetching Comments in The Context of a User

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

• Za vraćanje komentara sortiranih i označenih informacijama za izgradnju vlastitog klijenta.
  • U tom slučaju, definirajte query parametar contextUserId.
• Za dohvat komentara iz vašeg backenda za prilagođene integracije.
  • Platforma će podrazumijevati ovo ako nema contextUserId.

Prekalkulisana paginacija komentara

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

Fleksibilna paginacija komentara

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

Fleksibilna paginacija komentara u kontekstu korisnika

Copy

1

2curl --request GET \

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

4

Fleksibilna paginacija komentara u korisničkom kontekstu samo za komentare najvišeg nivoa

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

Moguće je dobiti komentare vraćene kao stablo, pri čemu paginacija broji samo komentare najvišeg nivoa.

Komentari kao stablo u kontekstu korisnika

Copy

1

2curl --request GET \

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

4

Želite da dobijete samo komentare najvišeg nivoa i neposrednu djecu? Evo jednog načina:

Komentari kao stablo sa maksimalnom dubinom

Copy

1

2curl --request GET \

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

4

Međutim, u vašem UI možda ćete trebati znati da li da prikažete dugme "show replies" (prikaži odgovore) na svakom komentaru. Kada dohvaćate komentare putem stabla, postoji svojstvo hasChildren koje se dodaje na komentare kada je primjenjivo.

Get Comments as a Tree, Searching by Hash Tag

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

U ovom primjeru, izostavljamo urlId, i pretražujemo po više hashtag-ova. API će vratiti samo komentare koji imaju sve tražene hashtag-ove.

Komentari kao stablo u kontekstu korisnika, po hashtag-u

Copy

1

2curl --request GET \

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

4

All Request Params

Struktura zahtjeva za komentare

Copy

1

2interface CommentsRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** urlId (URL stranice, ili ID članka) sa kojim su komentari povezani. **/

6 urlId?: string

7 /** Ograniči komentare vraćene za ovog korisnika. **/

8 userId?: string

9 /** Koristite ovo za pretragu po hashtag-u. Da biste suzili na presjek više hashtag-ova, uradite &hashTag=a&hashTag=b. **/

10 hashTag?: string

11 /** Smjer sortiranja. Zadano je MR (Najrelevantnije). Druge opcije su OF (Najstarije prvo) i NF (Najnovije prvo). **/

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

13 /** Prekalkulisana paginacija: Stranica koju treba dohvatiti, počevši od 0. Pošaljite -1 za sve komentare (do 250). **/

14 page?: number

15 /** Fleksibilna paginacija: Koliko komentara da vratimo? **/

16 limit?: number

17 /** Fleksibilna paginacija: Koliko dječjih komentara da vratimo za svaki parent? **/

18 limitChildren?: number

19 /** Fleksibilna paginacija: Koliko komentara da preskočimo? **/

20 skip?: number

21 /** Fleksibilna paginacija: Koliko dječjih komentara da preskočimo za svaki parent? **/

22 skipChildren?: number

23 /** Za određivanje blokiranih i prijavljenih komentara. **/

24 contextUserId?: string

25 /** Za određivanje blokiranih i prijavljenih komentara. **/

26 anonUserId?: string

27 /** Za dohvat podkomentara. **/

28 parentId?: string

29 /** Za dohvat kao stablo. **/

30 asTree?: boolean

31 /** Koliko duboko u stablu da vratimo podatke? 0 vraća nijedno dijete. 1 vraća neposrednu djecu, itd. **/

32 maxTreeDepth?: number

33}

34

The Response

Struktura odgovora za komentare

Copy

1

2interface CommentsResponse {

3 status: 'success' | 'failed'

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

5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-url-id' | 'missing-date' | 'unauthorized-page' | 'invalid-pagination-request' | 'invalid-limit' | 'invalid-limit-children' | 'invalid-skip' | 'invalid-skip-children' | 'invalid-max-tree-depth'

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

7 reason?: string

8 /** Komentari! **/

9 comments: Comment[]

10}

11

Helpful Tips

URL ID

Vjerojatno ćete željeti koristiti Comment API sa parametrom urlId. Možete prvo pozvati Pages API, da vidite kako izgledaju vrijednosti urlId dostupne vama.

Anonymous Actions

Za anonimno komentiranje vjerojatno ćete htjeti poslati anonUserId prilikom dohvaćanja komentara, kao i prilikom označavanja i blokiranja.

(!) Ovo je zahtjev za mnoge prodavnice aplikacija jer korisnici moraju moći prijaviti sadržaj koji su korisnici kreirali i koji mogu vidjeti, čak i ako nisu prijavljeni. Nepostupanje po tome može uzrokovati da vaša aplikacija bude uklonjena iz navedene prodavnice.

Comments Not Being Returned

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

Овај API омогућава преузимање појединачног коментара по id-ју.

Пример cURL захтјева за добијање коментара по ID-ју

Copy

1

2curl --request GET \

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

4

Структура захтјева за добијање коментара по ID-ју

Copy

1

2interface CommentsGetByIdQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Структура одговора за добијање коментара по ID-ју

Copy

1

2interface CommentGetByIdResponse {

3 status: 'success' | 'failed'

4 /** Укључено у случају неуспјеха. **/

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

6 /** Укључено у случају неуспјеха. **/

7 reason?: string

8 /** Коментар! **/

9 comment?: Comment

10}

11

Ова API крајња тачка омогућава креирање коментара.

Уобичајени случајеви употребе су прилагођени кориснички интерфејси, интеграције или увози.

Напомене:

• Овај API може ажурирати видгет коментара „у живо“ ако је потребно (ова опција повећава creditsCost са 1 на 2).
• Овај API ће аутоматски креирати објекте корисника у нашем систему ако је е-пошта обезбеђена.
• Покушај да се сачувају два коментара са различитим е-поштама, али истим корисничким именом, резултираће грешком за други коментар.
• Ако одредите parentId, и ако подкоментар има notificationSentForParent постављено на false, послаћемо обавештења за родитељски коментар. То се ради на сваких сат времена (групишемо обавештења заједно да бисмо смањили број послатих имејлова).
• Ако желите слање добродошлих имејлова при креирању корисника, или имејлова за верификацију коментара, поставите sendEmails на true у параметрима упита.
• Коментари креирани овим API-јем ће се појавити на страницама Аналитике и Модерације у административној апликацији.
• „лоше речи“ су и даље маскиране у именима коментатора и тексту коментара ако је та опција укључена.
• Коментари креирани овим API-јем и даље могу бити проверавани на спам ако је то потребно.
• Конфигурације као што је максимална дужина коментара, ако су подешене преко странице администрације правила прилагођавања (Customization Rule), важе и овде.

Минимални подаци потребни да се пошаљу и приказују у видгету коментара су следећи:

Минимални пример POST cURL захтева за коментар

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

Реалнији пример захтева може изгледати овако:

Пример POST cURL захтева за коментар

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

Структура POST захтева за коментар

Copy

1

2interface CommentPostQueryParams {

3 tenantId: string

4 API_KEY: string

5 doSpamCheck?: 'true' | 'false'

6 /** Да ли коментар треба да се појави "у живо" за кориснике који гледају инстанце видгета коментара са истим urlId. НАПОМЕНА: Дуплира трошак кредита са 1 на 2. **/

7 isLive?: 'true' | 'false'

8 sendEmails?: 'true' | 'false'

9 populateNotifications?: 'true' | 'false'

10}

11

Структура одговора POST захтева за коментар

Copy

1

2

3interface CommentPostResponse {

4 status: 'success' | 'failed'

5 /** Укључено у случају неуспјеха. **/

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 /** Укључено у случају неуспјеха. **/

8 reason?: string

9 /** Креирани коментар. **/

10 comment?: Comment

11 /** Повезани корисник, који можда већ постоји или можда није постојао. **/

12 user?: User

13}

14

Овај API endpoint омогућава ажурирање појединачног коментара.

Напомене:

• Овај API може ажурирати коментарски видџет "live" ако је потребно (ово повећава основни creditsCost са 1 на 2).
  • Ово може учинити миграцију коментара између страница "live" (промјена urlId).
  • Миграције коштају додатна 2 кредита јер се странице претрачунавају и ово је интензивно за CPU.
• За разлику од create API, овај API НЕће аутоматски креирати корисничке објекте у нашем систему ако је наведен имејл.
• Коментари ажурирани преко овог API-ја и даље се могу провјерити на спам ако је то жељено.
• Конфигурације као што је максимална дужина коментара, ако су подешене преко администраторске странице Customization Rule, примјењиваће се овдје.
• Да бисте омогућили корисницима да ажурирају текст свог коментара, можете једноставно навести comment у тијелу захтјева. Ми ћемо генерисати резултујући commentHTML.
  • Ако дефинишете и comment и commentHTML, нећемо аутоматски генерисати HTML.
  • Ако корисник дода помињања или хештегове у свом новом тексту, они ће и даље бити обрађени као код POST API-ја.
• Када ажурирате commenterEmail на коментару, најбоље је да такође наведете userId. У супротном, морате осигурати да корисник са тим имејлом припада вашем tenant-у, иначе ће захтјев не успјети.
• Ако је циљни коментар закључан (isLocked: true), захтјев се одбија са code: 'locked'. Прво откључајте коментар, ажурирајте га, па поново закључајте ако је потребно.

Минимални cURL примјер за PATCH коментара

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

Структура PATCH захтјева за коментар

Copy

1

2interface CommentPatchQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** Корисник који врши ажурирање. Ако је потребно, може се користити да се провјери да ли могу уређивати коментар. **/

6 contextUserId?: string

7 /** Да ли да провјеримо да ли нови коментар изгледа као спам? **/

8 doSpamCheck?: 'true' | 'false'

9 /** Да ли би коментар требао бити приказан "live" корисницима који гледају инстанце коментарског видџета са истим urlId. НАПОМЕНА: Повећава трошак кредита са 1 на 2. **/

10 isLive?: 'true' | 'false'

11}

12

Структура PATCH одговора за коментар

Copy

1

2

3interface CommentPatchResponse {

4 status: 'success' | 'failed'

5 /** Укључено при неуспјеху. **/

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 /** Укључено при неуспјеху. **/

8 reason?: string

9}

10

Ovaj API endpoint omogućava brisanje komentara.

Napomene:

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

Primjer cURL zahtjeva za brisanje komentara

Copy

1

2curl --request DELETE \

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

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

5

Struktura zahtjeva za brisanje komentara

Copy

1

2interface CommentDeleteQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** Korisnik koji vrši ažuriranje. Po potrebi se može koristiti za provjeru da li mogu obrisati komentar. **/

6 contextUserId?: string

7 /** Da li komentar treba biti obrisan "uživo" za korisnike koji gledaju instance widgeta za komentare sa istim urlId. NAPOMENA: Udvostručuje trošak kredita sa 1 na 2. **/

8 isLive?: 'true' | 'false'

9}

10

Struktura odgovora za brisanje komentara

Copy

1

2

3interface CommentDeleteResponse {

4 status: 'success' | 'failed'

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

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

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

8 reason?: string

9}

10

Овај API ендпоинт омогућава означавање коментара за одређеног корисника.

Notes:

• Овај позив увијек мора бити направљен у контексту корисника. Корисник може бити FastComments.com User, SSO User, или Tenant User.
• Ако је подешен праг за означавање који сакрива, коментар ће бити аутоматски скривен у реалном времену након што буде означен дефинисани број пута.
• Након што је аутоматски опозван (скривен) - коментар може поново одобрити само администратор или модератор. Уклањање ознаке неће поново одобрити коментар.

Пример cURL захтева за означавање коментара

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 anonymous flagging, we must specify an anonUserId. This can be an ID that represents the anonymous session, or a random UUID. This allows us to support flagging and un-flagging comments even if a user is not logged in. This way, the comment can be marked as flagged when comments are fetched with the same anonUserId.

Пример cURL захтева за анонимно означавање коментара

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

Структура захтева за означавање коментара

Copy

1

2interface CommentFlagQueryParams {

3 tenantId: string

4 API_KEY: string

5 userId?: string

6 anonUserId?: string

7}

8

Структура одговора за означавање коментара

Copy

1

2

3interface CommentFlagResponse {

4 status: 'success' | 'failed'

5 /** Укључено у случају неуспјеха. **/

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 /** Укључено у случају неуспјеха. **/

8 reason?: string

9 /** Да ли је коментар аутоматски опозван (скривен) због превеликог броја ознака? **/

10 wasUnapproved?: boolean;

11}

12

Ovaj API endpoint omogućava poništavanje označavanja (un-flag) komentara za određenog korisnika.

Napomene:

• Ovaj poziv uvijek mora biti izvršen u kontekstu korisnika. Korisnik može biti FastComments.com User, SSO User, ili Tenant User.
• Nakon što je komentar automatski označen kao neodobren (skriven) — komentar može ponovo biti odobren samo od strane administratora ili moderatora. Uklanjanje oznake (un-flag) neće ponovo odobriti komentar.

Primjer cURL zahtjeva za uklanjanje oznake komentara

Copy

1

2curl --request POST \

3 --url 'https://fastcomments.com/api/v1/comments/some-comment-id/un-flag?tenantId=demo&API_KEY=DEMO_API_SECRET&userId=some-user-id' \

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

5

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

Primjer cURL zahtjeva za uklanjanje oznake anonimnog komentara

Copy

1

2curl --request POST \

3 --url 'https://fastcomments.com/api/v1/comments/some-comment-id/un-flag?tenantId=demo&API_KEY=DEMO_API_SECRET&anonUserId=some-anon-user-id' \

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

5

Struktura zahtjeva za uklanjanje oznake komentara

Copy

1

2interface CommentFlagQueryParams {

3 tenantId: string

4 API_KEY: string

5 userId?: string

6 anonUserId?: string

7}

8

Struktura odgovora za uklanjanje oznake komentara

Copy

1

2

3interface CommentUnFlagResponse {

4 status: 'success' | 'failed'

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

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

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

8 reason?: string

9}

10

Овај API endpoint пружа могућност блокирања корисника који је написао одређени коментар. Подржава блокирање коментара написаних од FastComments.com Users, SSO Users, и Tenant Users.

Подржава body параметар commentIdsToCheck који провјерава да ли би други потенцијално видљиви коментари на клијенту требало да буду блокирани/деблокирани након извршења ове акције.

Напомене:

• Овај позив мора увијек бити направљен у контексту корисника. Корисник може бити FastComments.com User, SSO User, или Tenant User.
• userId у захтјеву је корисник који извршава блокирање. На примјер: User A жели да блокира User B. Прослиједите userId=User A и id коментара који је написао User B.
• Потпуно анонимни коментари (није присутан user id, нема е-поште) не могу бити блокирани и биће враћена грешка.

Примјер cURL захтјева за блокирање коментара

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

За анонимно блокирање, морамо навести anonUserId. Ово може бити id који представља анонимну сесију или насумични UUID. Ово нам омогућава подршку блокирања коментара чак и ако корисник није пријављен тако што ћемо преузети коментаре са истим anonUserId.

Примјер cURL захтјева за блокирање анонимног коментара

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

Структура захтјева за блокирање коментара

Copy

1

2interface CommentBlockQueryParams {

3 tenantId: string

4 API_KEY: string

5 userId?: string

6 anonUserId?: string

7 commentIdsToCheck?: string[]

8}

9

Структура одговора за блокирање коментара

Copy

1

2

3interface CommentBlockResponse {

4 status: 'success' | 'failed'

5 /** Укључено у случају неуспјеха. **/

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 /** Укључено у случају неуспјеха. **/

8 reason?: string

9 /** Ако је commentIdsToCheck дефинисан, уноси у овој мапи који имају вриједност true ће такође бити блокирани. **/

10 commentStatuses?: Record<string, boolean>;

11}

12

Овај API ендпоинт омогућава уклањање блокаде корисника који је написао одређени коментар. Подржава уклањање блокаде за коментаре написане од стране FastComments.com Users, SSO Users, и Tenant Users.

Подржава commentIdsToCheck параметар у тијелу захтјева за провјеру да ли неки други потенцијално видљиви коментари на клијенту требају бити блокирани/одблокирани након извршења ове акције.

Напомене:

• Овaј позив увијек мора бити направљен у контексту корисника. Корисник може бити FastComments.com User, SSO User, или Tenant User.
• userId у захтјеву је корисник који уклања блокаду. На примјер: User A жели да уклони блокаду User B. Прослиједите userId=User A и ид коментара који је User B написао.
• Потпуно анонимни коментари (без user id, без е-поште) не могу бити блокирани и вратиће се грешка.

Примјер cURL захтјева за уклањање блокаде коментара

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

Примјер cURL захтјева за уклањање блокаде анонимног коментара

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

Структура захтјева за уклањање блокаде коментара

Copy

1

2interface CommentUnBlockQueryParams {

3 tenantId: string

4 API_KEY: string

5 userId?: string

6 anonUserId?: string

7 commentIdsToCheck?: string[]

8}

9

Структура одговора за уклањање блокаде коментара

Copy

1

2

3interface CommentUnBlockResponse {

4 status: 'success' | 'failed'

5 /** Укључено у случају неуспјеха. **/

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 /** Укључено у случају неуспјеха. **/

8 reason?: string

9 /** Ако је commentIdsToCheck дефинисан, уноси у овој мапи који су true су и даље блокирани. Ако су false, можда ћете желети да поново прикажете коментаре кориснику да не мора да освежи страницу. **/

10 commentStatuses?: Record<string, boolean>;

11}

12

Pojedinačni EmailTemplates se mogu dohvatiti po odgovarajućem id-u (NE emailTemplateId).

EmailTemplate po ID cURL primjer

Copy

1

2curl --request GET \

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

4

Struktura zahtjeva za EmailTemplate po ID

Copy

1

2interface EmailTemplatesByIdRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Struktura odgovora za EmailTemplate po ID

Copy

1

2interface EmailTemplateResponse {

3 status: 'success' | 'failed'

4 /** Uključeno u slučaju greške. **/

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

6 /** Uključeno u slučaju greške. **/

7 reason?: string

8 emailTemplate?: EmailTemplate | null

9}

10

Овај API користи пагинацију, обезбијеђену параметром упита page. EmailTemplates се враћају у страницама по 100, уређене по createdAt, а затим по id.

Примјер cURL за 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

Структура захтјева EmailTemplate

Copy

1

2interface EmailTemplatesRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** Страница за преузимање, почиње од 0. **/

6 page: number

7}

8

Структура одговора EmailTemplate

Copy

1

2interface EmailTemplatesResponse {

3 status: 'success' | 'failed'

4 /** Укључено у случају неуспјеха. **/

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

6 /** Укључено у случају неуспјеха. **/

7 reason?: string

8 emailTemplates: EmailTemplate[]

9}

10

Ovaj API endpoint omogućava ažuriranje email predloška tako što se navede samo id i atributi koje treba ažurirati.

Imajte na umu da se sve iste validacije koje važe pri kreiranju predloška također primjenjuju, na primjer:

• Predložak se mora renderirati. Ovo se provjerava pri svakom ažuriranju.
• Ne možete imati duplikate predložaka za istu domenu (inače bi jedan bio tiho ignorisan).

EmailTemplate PATCH cURL primjer

Copy

1

2curl --request PATCH \

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

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

5 --data '{

6 "displayName": "Some New Name",

7}'

8

EmailTemplate PATCH struktura zahtjeva

Copy

1

2interface EmailTemplatePatchQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

EmailTemplate PATCH struktura odgovora

Copy

1

2

3interface EmailTemplatePatchResponse {

4 status: 'success' | 'failed'

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

6 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'empty-request' | 'internal' | 'invalid-input' | 'not-found' | 'unexpected-param' | 'invalid-email-template-id' | 'unauthorized' | 'domain-invalid' | 'duplicate' | 'does-not-render';

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

8 reason?: string

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

10 emailTemplate?: EmailTemplate

11}

12

Овај API ендпоинт пружа могућност креирања email шаблона.

Напомене:

• Не можете имати више шаблона са истим emailTemplateId за исти домен.
• Међутим, можете имати wildcard шаблон (domain = * и домен-специфичан шаблон за исти emailTemplateId).
• Наглашавање domain је релевантно само ако имате различите домене, или желите користити специфичне шаблоне за тестирање (domain подешен на localhost итд).
• Ако наведете domain, он мора одговарати DomainConfig. У случају грешке пружа се листа валидних домена.
• Синтакса шаблона је EJS и рендерује се са тајмаутом од 500ms. P99 за рендеровање је <5ms, тако да ако достигнете 500ms нешто није у реду.
• Ваш шаблон мора да се рендерује са датим testData да би се сачувао. Грешке при рендеровању се агрегирају и пријављују на контролној табли (ускоро доступно и преко API).

Минимални подаци потребни за додавање шаблона су следећи:

Минимални пример POST cURL за 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

Можда ћете желети имати шаблоне по сајту, у том случају дефинишете domain:

Примјер POST cURL за 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

Структура захтјева POST за EmailTemplate

Copy

1

2interface EmailTemplatePostQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Структура одговора POST за EmailTemplate

Copy

1

2

3interface EmailTemplatePostResponse {

4 status: 'success' | 'failed'

5 /** Укључено при неуспјеху. **/

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 /** Укључено при неуспјеху. **/

8 reason?: string

9 /** Креирани шаблон. **/

10 emailTemplate?: EmailTemplate

11}

12

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

Minimalni primjer POST cURL pregleda EmailTemplate

Copy

1

2curl --request POST \

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

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

5 --data '{

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

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

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

9}'

10

Struktura POST zahtjeva za EmailTemplate

Copy

1

2interface EmailTemplatePostQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Struktura POST odgovora za EmailTemplate

Copy

1

2

3interface EmailTemplatePostResponse {

4 status: 'success' | 'failed'

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

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

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

8 reason?: string

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

10 html?: string

11}

12

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

Primjer cURL zahtjeva za uklanjanje EmailTemplate

Copy

1

2curl --request DELETE \

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

4

Struktura zahtjeva za uklanjanje EmailTemplate

Copy

1

2interface EmailTemplateRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Struktura odgovora za uklanjanje EmailTemplate

Copy

1

2interface EmailTemplateDeleteResponse {

3 status: 'success' | 'failed'

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

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

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

7 reason?: string

8}

9

Овај API користи пагинацију, која се обезбјеђује параметром упита page. HashTags се враћају у страницама по 100, уређени по tag.

HashTag cURL примјер

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

Copy

1

2interface HashTagsRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** Страница за преузимање, почиње од 0. **/

6 page: number

7}

8

Структура одговора за HashTag

Copy

1

2interface HashTagsResponse {

3 status: 'success' | 'failed'

4 /** Укључено у случају неуспјеха. **/

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

6 /** Укључено у случају неуспјеха. **/

7 reason?: string

8 /** Хаштагови! **/

9 hashTags: HashTag[]

10}

11

Ова рута омогућава ажурирање појединачног HashTag-а.

HashTag ажурирање — пример cURL

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

Copy

1

2interface HashTagPatchQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Структура одговора за ажурирање HashTag-а

Copy

1

2interface HashTagPatchResponse {

3 status: 'success' | 'failed'

4 /** Укључено у случају неуспјеха. **/

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 /** Укључено у случају неуспјеха. **/

7 reason?: string

8 hashTag?: HashTag; // На успјех враћамо потпуно ажурирани HashTag.

9}

10

Ovaj endpoint omogućava dodavanje jednog HashTag.

Primjer cURL zahtjeva za kreiranje HashTag-a

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

Struktura zahtjeva za kreiranje HashTag-a

Copy

1

2interface HashTagPostQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Struktura odgovora za kreiranje HashTag-a

Copy

1

2interface HashTagPostResponse {

3 status: 'success' | 'failed'

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

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

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

7 reason?: string

8 hashTag?: HashTag; // Pri uspjehu vraćamo kompletno kreirani hashtag.

9}

10

Ovaj endpoint omogućava dodavanje do 100 HashTag objekata odjednom.

Primjer cURL zahtjeva za masovno kreiranje HashTag-ova

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

Struktura zahtjeva za masovno kreiranje HashTag-ova

Copy

1

2interface HashTagPostQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Struktura odgovora za masovno kreiranje HashTag-ova

Copy

1

2interface HashTagBulkPostResponse {

3 status: 'success' | 'failed'

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

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

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

7 reason?: string

8 results?: HashTagPostResponse[]; // Vraćamo listu HashTagPostResponse objekata za svaki dostavljeni tag.

9}

10

Ovaj endpoint omogućava uklanjanje HashTag-a na osnovu proslijeđenog taga.

Imajte na umu da, osim ako automatsko kreiranje HashTag-ova nije onemogućeno, hashtagovi mogu biti ponovo kreirani od strane korisnika koji uključe hashtag prilikom komentarisanja.

Primjer cURL zahtjeva za uklanjanje HashTag-a

Copy

1

2curl --request DELETE \

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

4

Struktura zahtjeva za uklanjanje HashTag-a

Copy

1

2interface HashTagDeleteQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Struktura odgovora pri uklanjanju HashTag-a

Copy

1

2interface HashTagDeleteResponse {

3 status: 'success' | 'failed'

4 /** Uključeno u slučaju greške. **/

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

6 /** Uključeno u slučaju greške. **/

7 reason?: string

8}

9

Objekat Moderator predstavlja konfiguraciju za moderatora.

Postoje tri tipa moderatora:

1. Administrator korisnici koji imaju zastavicu isCommentModeratorAdmin.
2. SSO korisnici sa zastavicom isCommentModeratorAdmin.
3. Redovni komentatori, ili FastComments.com korisnici, koji su pozvani kao moderatori.

Struktura Moderator se koristi za predstavljanje stanja moderacije u slučaju upotrebe 3.

Ako želite pozvati korisnika da bude moderator putem API-ja, koristite Moderator API kreiranjem Moderator i inviting njima.

Ako korisnik nema FastComments.com nalog, pozivni email će im pomoći da se podese. Ako već imaju nalog, biće im dodan moderacijski pristup vašem tenant-u i Moderator objektu će se ažurirati userId da pokazuje na njihovog korisnika. Nećete imati API pristup njihovom korisniku, jer u ovom slučaju nalog pripada njima i upravlja ga FastComments.com.

Ako zahtijevate potpunu kontrolu nad korisničkim nalogom, preporučujemo ili korištenje SSO-a, ili dodavanje korisnika kao Korisnik tenanta i zatim dodavanje Moderator objekta za praćenje njihove statistike.

Struktura Moderator može se koristiti kao mehanizam za praćenje statistike za slučajeve upotrebe 1 i 2. Nakon kreiranja korisnika, dodajte Moderator objekat sa definisanim userId i njihove statistike će biti praćene na Stranici za moderatore komentara.

Struktura za Moderator objekat je sljedeća:

Struktura moderatora

Copy

1

2interface Moderator {

3 name: string

4 email: string

5 tenantId: string

6 userId?: string|null

7 acceptedInvite?: boolean

8 markReviewedCount?: number

9 deletedCount?: number

10 markedSpamCount?: number

11 approvedCount?: number

12 editedCount?: number

13 bannedCount?: number

14 createdAt: string

15 moderationGroupIds?: string[]|null

16}

17

Ова рута враћа једног модератора по њиховом id-у.

Пример cURL захтева за модератора по id-у

Copy

1

2curl --request GET \

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

4

Структура захтева за модератора

Copy

1

2interface ModeratorByIdQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Структура одговора за модератора

Copy

1

2interface ModeratorByIdResponse {

3 status: 'success' | 'failed'

4 /** Укључено у случају неуспјеха. **/

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

6 /** Укључено у случају неуспјеха. **/

7 reason?: string

8 moderator?: Moderator

9}

10

Овај API користи пагинацију, коју обезбјеђује параметар упита skip. Модератори се враћају у страницама по 100, сортирани по createdAt и id.

Трошак се заснива на броју враћених модератора и износи 1 credit per 10 за сваких 10 враћених модератора.

Пример cURL захтева за Модератора

Copy

1

2curl --request GET \

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

4

Структура захтева за Модератора

Copy

1

2interface ModeratorsRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** Број модератора које треба прескочити за пагинацију. **/

6 skip?: number

7}

8

Структура одговора за Модератора

Copy

1

2interface ModeratorsResponse {

3 status: 'success' | 'failed'

4 /** Укључено у случају неуспеха. **/

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

6 /** Укључено у случају неуспеха. **/

7 reason?: string

8 moderators?: Moderator[]

9}

10

Ovaj API endpoint omogućava ažuriranje Moderator po id.

Ažuriranje Moderator ima sljedeća ograničenja:

• Sljedeće vrijednosti se ne smiju dostaviti prilikom ažuriranja Moderator:
  • acceptedInvite
  • markReviewedCount
  • deletedCount
  • markedSpamCount
  • approvedCount
  • editedCount
  • bannedCount
  • verificationId
  • createdAt
• Kada je naveden userId, taj korisnik mora postojati.
• Kada je naveden userId, on mora pripadati istom tenantId koji je naveden u query parametrima.
• Dva moderatora u istom tenantu ne mogu se dodati sa istim email.
• Ne smijete mijenjati tenantId povezan sa Moderator.

Moderator PATCH cURL Primjer

Copy

1

2curl --request PATCH \

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

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

5 --data '{

6 "name": "Some New Name",

7}'

8

Moderator PATCH Struktura zahtjeva

Copy

1

2interface ModeratorPatchQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Moderator PATCH Struktura odgovora

Copy

1

2

3interface ModeratorPatchResponse {

4 status: 'success' | 'failed'

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

6 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'name-required' | 'email-required' | 'unexpected-param' | 'not-found';

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

8 reason?: string

9}

10

Ова рута омогућава додавање једног Moderator.

Креирање Moderator-а има сљедећа ограничења:

• Морају увијек бити наведени name и email. userId је опционо.
• Сљедеће вриједности не смију бити наведене при креирању Moderator-а:
  • acceptedInvite
  • markReviewedCount
  • deletedCount
  • markedSpamCount
  • approvedCount
  • editedCount
  • bannedCount
  • verificationId
  • createdAt
• Када је userId назначен, тај корисник мора постојати.
• Када је userId назначен, он мора припадати истом tenantId-у наведеном у параметрима упита.
• Два модератора у истом тенанту не могу бити додата са истим email-ом.

Можемо креирати Moderator-а за корисника чији познајемо само email:

Пример cURL захтева за креирање модератора преко е-поште

Copy

1

2curl --request POST \

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

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

5 --data '{

6 "name": "Some Name",

7 "email": "someone@someone.com"

8}'

9

Или можемо креирати Moderator-а за корисника који припада нашем тенанту, како бисмо пратили њихове статистике модерирања:

Пример cURL захтева за креирање модератора преко корисника тенанта

Copy

1

2curl --request POST \

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

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

5 --data '{

6 "name": "Some Name",

7 "email": "someone@someone.com",

8 "userId": "some-tenant-user-id"

9}'

10

Структура захтева за креирање модератора

Copy

1

2interface ModeratorPostQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Структура одговора при креирању модератора

Copy

1

2interface ModeratorPostResponse {

3 status: 'success' | 'failed'

4 /** Укључено у случају неуспјеха. **/

5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'name-required' | 'email-required' | 'unexpected-param' | 'not-found'

6 /** Укључено у случају неуспјеха. **/

7 reason?: string

8 moderator?: Moderator; // При успјеху враћамо комплетног креираног модератора.

9}

10

Ova ruta omogućava slanje pozivnice jednom Moderatoru.

Slijedeća ograničenja postoje za slanje email pozivnice Moderatoru:

• Moderator mora već postojati.
• fromName ne smije biti duži od 100 characters.

Napomene:

• Ako korisnik sa navedenim emailom već postoji, bit će pozvan da moderira komentare vašeg tenanta.
• Ako korisnik sa navedenim emailom ne postoji link za pozivnicu će ih provesti kroz proces kreiranja naloga.
• Pozivnica će isteći nakon 30 days.

Možemo kreirati Moderatora za korisnika čiji email znamo:

Primjer cURL zahtjeva za pozivnicu moderatoru

Copy

1

2curl --request POST \

3 --url 'https://fastcomments.com/api/v1/moderators/xyz/send-invite?tenantId=demo&API_KEY=DEMO_API_SECRET&fromName=Bob' \

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

5

Ovo će poslati e-mail poput Bob at TenantName is inviting you to be a moderator...

Struktura zahtjeva za pozivnicu moderatora

Copy

1

2interface ModeratorSendInviteQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** E-mail poslan korisniku će izgledati kao da je poslan s ovog imena. **/

6 fromName: string

7}

8

Struktura odgovora za pozivnicu moderatora

Copy

1

2interface ModeratorSendInviteResponse {

3 status: 'success' | 'failed'

4 /** Included on failure. **/

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

6 /** Included on failure. **/

7 reason?: string

8}

9

Ова рута омогућава уклањање Moderator по id-у.

Пример cURL захтева за уклањање модератора

Copy

1

2curl --request DELETE \

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

4

Структура захтева за уклањање модератора

Copy

1

2interface ModeratorDeleteQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Структура одговора за уклањање модератора

Copy

1

2interface ModeratorDeleteResponse {

3 status: 'success' | 'failed'

4 /** Укључено у случају неуспјеха. **/

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

6 /** Укључено у случају неуспјеха. **/

7 reason?: string

8}

9

Ова рута враћа појединачни NotificationCount по user id. Са SSO-ом, user id је у формату <tenant id>:<user id>.

Ако нема непрочитаних обавијести, неће постојати NotificationCount - па ћете добити 404.

Ово се разликује од notifications/count тиме што је много брже, али не дозвољава филтрирање.

cURL примјер NotificationCount по ID

Copy

1

2curl --request GET \

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

4# -> {"status":"success","data":{"count":1,"createdAt":"2023-03-06T18:45:01.726Z","expireAt":"2024-03-06T01:25:01.726Z","id":"example"}}

5

Структура захтева NotificationCount

Copy

1

2interface NotificationCountGetQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Структура одговора NotificationCount

Copy

1

2interface NotificationCountGetResponse {

3 status: 'success' | 'failed'

4 /** Укључено у случају неуспеха. **/

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

6 /** Укључено у случају неуспеха. **/

7 reason?: string

8 data?: NotificationCount

9}

10

Ова рута брише један NotificationCount по корисничком ид-у. Код SSO, кориснички ид је у формату <tenant id>:<user id>.

Ово ће очистити број непрочитаних обавештења корисника (црвено звонце у коментарском виџету ће избледети и број ће нестати).

Пример cURL захтева за брисање NotificationCount

Copy

1

2curl --request DELETE \

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

4# -> {"status":"success"}

5

Структура захтева за брисање NotificationCount

Copy

1

2interface NotificationCountDeleteQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Структура одговора за брисање NotificationCount

Copy

1

2interface NotificationCountDeleteResponse {

3 status: 'success' | 'failed'

4 /** Укључено при неуспеху. **/

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

6 /** Укључено при неуспеху. **/

7 reason?: string

8}

9