API-ји за живо коментарисање

Употреба ресурса

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

Сваки ресурс ће у свом одељку навести каква је та употреба.

Неки ресурси коштају више за обраду него други. Свака крајња тачка има одређену цену у кредитима по API позиву. За неке крајње тачке, број кредита варира у зависности од опција и величине одговора.

Употребу API‑ја можете проверити на страници Аналитика наплате и она се ажурира сваких неколико минута.

Напомена!

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

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

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

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

Ако имате управљане закупце, можете агрегирати све ресурсе под‑закупца у једном позиву прослеђивањем query параметра parentTenantId.

Примери

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

Пример 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

Пример: Расподела одобрених, прегледаних и спам коментара

Пример 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 ",

5 "operations": [

6 { "op": "distinct", "field": "approved", "alias": "approved" },

7 { "op": "distinct", "field": "reviewed", "alias": "reviewed" },

8 { "op": "distinct", "field": "isSpam", "alias": "isSpam" }

9 ]

10}'

11

Одговор:

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

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

Структуре

Структура захтева за агрегирање

Copy

1

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

3

4/** An operation that will be applied on a field */

5export interface AggregationOperation {

6 /** The field to operate on */

7 field: string;

8 /** The type of operation */

9 op: AggregationOpType;

10 /** Optional alias for the output; if not provided, a default alias is computed */

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

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

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

Овај API користи пагинацију, обезбеђену параметрима skip, before и after. AuditLogs се враћају у страницама по 1000, сортиране по when и id.

Повлачење сваке 1000 ставке кошта 10 кредита.

Подразумевано ћете добити листу са најновијим ставкама прво. На тај начин можете почети са skip=0, пагинирајући док не пронађете последњи запис који сте обрадили.

Алтернативно, можете сортирати од најстаријих прво и пагинирати док не буде више записа.

Сортирање се врши постављањем параметра order на ASC или DESC. Подразумевана вредност је ASC.

Претраживање по датуму је могуће помоћу before и after као временских ознака у милисекундама. before и after нису укључиви.

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

Структура захтева за 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

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

Copy

1

2interface CommentsResponse {

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 auditLogs: AuditLog[]

10}

11

Овај API се користи за добијање коментара за приказ кориснику. На пример, аутоматски филтрира неодобрене или спам коментаре.

Пагинација

Пагинација се може извршити на један од два начина, у зависности од захтева за перформансама и случаја употребе:

1. Најбрже: Precalculated Pagination:
   1. Ово је начин на који FastComments функционише када користите наше унапред изграђене виџете и клијенте.
   2. Кликом на „next“ једноставно се повећава број странице.
   3. Ово можете замислити као преузимање из кључ-врједност складишта.
   4. На овај начин, једноставно дефинишете параметар page који почиње од 0 и смер сортирања као direction.
   5. Величине страница се могу прилагодити преко правила прилагођавања.
2. Најфлексибилније: Flexible Pagination:
   1. На овај начин можете дефинисати прилагођене параметре limit и skip. Не прослеђујте page.
   2. Сортирање direction је такође подржано.
   3. limit је укупан број који се враћа након што се примени skip.
      • Пример: поставите skip = 200, limit = 100 када је page size = 100 и page = 2.
   4. Коментари-дете и даље улазе у пагинацију. Ово можете заобићи коришћењем опције asTree.
      • Можете пагинирати децу преко limitChildren и skipChildren.
      • Можете ограничити дубину веза које се враћају преко maxTreeDepth.

Теме

1. Када се користи Precalculated Pagination, коментари се групишу по страници и коментари у темама утичу на целокупну страницу.
   1. На овај начин, теме се могу одредити на клијенту на основу parentId.
   2. На пример, са страницом која има један коментар највишег нивоа и 29 одговора, и постављањем page=0 у API-ју - добићете само коментар највишег нивоа и 29 деце.
2. Када се користи Flexible Pagination, можете дефинисати параметар parentId.
   1. Поставите га на null да бисте добили само коментаре највишег нивоа.
   2. Затим, да бисте видели теме, позовите API поново и проследите parentId.
   3. Уобичајено решење је да направите API позив за коментаре највишег нивоа, а затим паралелне API позиве да добијете коментаре за децу сваког коментара.
3. НОВО Од фебруара 2023! Дохватите као дрво користећи &asTree=true.
   1. Ово можете замислити као Flexible Pagination as a Tree.
   2. Само коментари највишег нивоа се рачунају у пагинацији.
   3. Поставите parentId=null да започнете дрво од корена (морате поставити parentId).
   4. Поставите skip и limit за пагинацију.
   5. Поставите asTree на true.
   6. Трошак кредита се повећава за 2x, јер наш бекенд мора да уради много више посла у овом сценарију.
   7. Поставите maxTreeDepth, limitChildren и skipChildren по жељи.

Објашњење Дрвених Структура

Када се користи asTree, може бити тешко размотрити пагинацију. Ево практичне графике:

Дијаграм Пагинације Дрва

Дохватање Коментара у Контексту Корисника

API /comments може да се користи у два контекста, за различите случајеве употребе:

• За враћање коментара сортираних и означених информацијама за изградњу вашег сопственог клијента.
  • У овом случају, дефинишите параметар упита contextUserId.
• За дохватање коментара из вашег бекенда за прилагођене интеграције.
  • Платформа ће подразумевано користити ово без contextUserId.

Коментари Претходно Израђена Пагинација

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

Коментари Флексибилна Пагинација

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

Коментари Флексибилна Пагинација у Корисничком Контексту

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

Коментари Флексибилна Пагинација у Корисничком Контексту Само за Коментаре Највишег Нивоа

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

Дохватање Коментара као Дрво

Могуће је добити коментаре враћене као дрво, при чему пагинација броји само коментаре највишег нивоа.

Коментари Као-Дрво у Корисничком Контексту

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

Желите ли да добијете само коментаре највишег нивоа и непосредну децу? Ево једног начина:

Коментари Као-Дрво са Максималном Дубином

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

Међутим, у вашем UI можда ћете морати знати да ли да прикажете дугме „прикажи одговоре“ на сваком коментару. При дохватању коментара преко дрвета постоји својство hasChildren означено на коментарима када је применљиво.

Дохватање Коментара као Дрво, Претрага по Хеш Тагу

Могуће је претраживати по хеш тагу користећи API, преко целог вашег tenancy (не ограничено на једну страницу или urlId).

У овом примеру, изостављамо urlId и претражујемо по више хеш тагова. API ће вратити само коментаре који имају све захтеване хеш тагове.

Коментари Као-Дрво у Корисничком Контексту, По Хеш Тагу

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

Сви Параметри Захтева

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

Copy

1

2interface CommentsRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** The urlId (page url, or article id) the comments are associated with. **/

6 urlId?: string

7 /** Limit the comments returned by this user. **/

8 userId?: string

9 /** Use this to search by hashtag. To drill down to the intersection of multiple hashtags, do &hashTag=a&hashTag=b. **/

10 hashTag?: string

11 /** The sort direction. Default is MR (Most Relevant). Other options are OF (Oldest First) and NF (Newest First). **/

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

13 /** Precalculated Pagination: The page to fetch, starting with 0. Pass -1 for all comments (up to 250). **/

14 page?: number

15 /** Flexible Pagination: How many comments should we return? **/

16 limit?: number

17 /** Flexible Pagination: How many child comments should we return for each parent? **/

18 limitChildren?: number

19 /** Flexible Pagination: How many comments should we skip? **/

20 skip?: number

21 /** Flexible Pagination: How many child comments should we skip for each parent? **/

22 skipChildren?: number

23 /** For determining blocked and flagged comments. **/

24 contextUserId?: string

25 /** For determining blocked and flagged comments. **/

26 anonUserId?: string

27 /** For fetching child comments. **/

28 parentId?: string

29 /** For fetching as a tree. **/

30 asTree?: boolean

31 /** How far into the tree should we return data? 0 returns no children. 1 returns immediate children, etc. **/

32 maxTreeDepth?: number

33}

34

Одговор

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

Copy

1

2interface CommentsResponse {

3 status: 'success' | 'failed'

4 /** Included on failure. **/

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

6 /** Included on failure. **/

7 reason?: string

8 /** The comments! **/

9 comments: Comment[]

10}

11

Корисни Савети

URL ID

Вероватно желите да користите API Comment са параметром urlId. Прво можете позвати API Pages да видите како изгледају доступне urlId вредности.

Анонимне Радње

За анонимно коментарисање вероватно желите да проследите anonUserId приликом дохватања коментара, као и приликом означавања и блокирања.

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

Коментари Не Се Враћају

Проверите да ли су ваши коментари одобрени и да нису спам.

Овај 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-ја и даље се могу проверити на спам ако је то потребно.
• Конфигурација као што је максимална дужина коментара, ако је подешена преко странице правила прилагођавања у админ интерфејсу, примењиваће се и овде.

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

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

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

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

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

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-ја омогућава ажурирање појединачног коментара.

Напомене:

• Овај API може ажурирати коментарски виџет уживо ако се жели (ово повећава основни creditsCost са 1 на 2).
  • Ово омогућава да миграције коментара између страница буду уживо (променом urlId).
  • Миграције коштају додатна 2 кредита јер се странице предрачунавају и то је CPU интензивно.
• За разлику од 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 /** Да ли коментар треба да се појави "уживо" корисницима који гледају инстанце коментарског виџета са истим 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

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

Напомене:

• Овај API може ажурирати коментарски видгет "live" ако је потребно (ово повећава creditsCost са 1 на 2).
• Овај API ће обрисати све подкоментаре.
• Ако је циљани коментар закључан (isLocked: true), захтев се одбија са code: 'locked'. Прво откључајте коментар, затим обришите.

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

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

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

Copy

1

2interface CommentDeleteQueryParams {

3 tenantId: string

4 API_KEY: string

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

6 contextUserId?: string

7 /** Да ли коментар треба да буде обрисан "live" за кориснике који гледају instance widget-а за коментаре са истим urlId. NAPOMENA: Повећава цену у кредитима са 1 на 2. **/

8 isLive?: 'true' | 'false'

9}

10

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

Copy

1

2

3interface CommentDeleteResponse {

4 status: 'success' | 'failed'

5 /** Укључено при грешци. **/

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

7 /** Укључено при грешци. **/

8 reason?: string

9}

10

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

Напомене:

• Овај позив увек мора бити извршен у контексту корисника. Корисник може бити 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

За анонимно пријављивање, морамо навести anonUserId. Ово може бити ID који представља анонимну сесију, или случајни UUID. Ово нам омогућава подршку за пријављивање и укидање пријаве коментара чак и ако корисник није пријављен. На овај начин, коментар може бити означен као пријављен када се коментари преузму са истим 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

Овај API ендпоинт пружа могућност уклањања ознаке (un-flag) коментара за одређеног корисника.

Напомене:

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

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

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

За анонимно означавање, морамо навести anonUserId. То може бити ИД који представља анонимну сесију, или насумични UUID.

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

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

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

Copy

1

2interface CommentFlagQueryParams {

3 tenantId: string

4 API_KEY: string

5 userId?: string

6 anonUserId?: string

7}

8

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

Copy

1

2

3interface CommentUnFlagResponse {

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

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

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

Напомене:

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

Пример 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 endpoint омогућава де-блокирање корисника који је написао одређени коментар. Подржава де-блокирање на основу коментара које су написали FastComments.com Users, SSO Users и Tenant Users.

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

Напомене:

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

Primer cURL zahteva za deblokiranje komentara

Copy

1

2curl --request POST \

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

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

5

Primer cURL zahteva za deblokiranje anonimnog komentara

Copy

1

2curl --request POST \

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

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

5

Struktura zahteva za deblokiranje komentara

Copy

1

2interface CommentUnBlockQueryParams {

3 tenantId: string

4 API_KEY: string

5 userId?: string

6 anonUserId?: string

7 commentIdsToCheck?: string[]

8}

9

Struktura odgovora za deblokiranje komentara

Copy

1

2

3interface CommentUnBlockResponse {

4 status: 'success' | 'failed'

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

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

8 reason?: string

9 /** Ako je commentIdsToCheck definisan, unosi u ovoj mapi са true су и даље блокирани. Ако су false, можда ћете пожелети да поново прикажете коментаре кориснику тако да не мора да освежава страницу. **/

10 commentStatuses?: Record<string, boolean>;

11}

12

Појединачни EmailTemplates могу се преузети помоћу одговарајућег id (НЕ emailTemplateId).

EmailTemplate по ID — пример cURL

Copy

1

2curl --request GET \

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

4

EmailTemplate по ID — структура захтева

Copy

1

2interface EmailTemplatesByIdRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

EmailTemplate по ID — структура одговора

Copy

1

2interface EmailTemplateResponse {

3 status: 'success' | 'failed'

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

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

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

7 reason?: string

8 emailTemplate?: EmailTemplate | null

9}

10

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

EmailTemplate cURL пример

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

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

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

7 reason?: string

8 emailTemplates: EmailTemplate[]

9}

10

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

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

• Шаблон мора да се рендерује. Ово се проверава при сваком ажурирању.
• Не можете имати дупликат шаблона за исти домен (иначе би један био тихо игнорисан).

Пример cURL за EmailTemplate PATCH

Copy

1

2curl --request PATCH \

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

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

5 --data '{

6 "displayName": "Some New Name",

7}'

8

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

Copy

1

2interface EmailTemplatePatchQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

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

Copy

1

2

3interface EmailTemplatePatchResponse {

4 status: 'success' | 'failed'

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

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

8 reason?: string

9 /** Ажурирани шаблон е-поште. **/

10 emailTemplate?: EmailTemplate

11}

12

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

Напомене:

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

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

Минималан EmailTemplate POST cURL пример

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:

EmailTemplate POST cURL пример

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 захтева

Copy

1

2interface EmailTemplatePostQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

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

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

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

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

Структура 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' | 'does-not-render';

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

8 reason?: string

9 /** Рендеровани HTML у случају успеха. **/

10 html?: string

11}

12

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

Пример cURL захтева за уклањање EmailTemplate-а

Copy

1

2curl --request DELETE \

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

4

Структура захтева за уклањање EmailTemplate-а

Copy

1

2interface EmailTemplateRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

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

Copy

1

2interface EmailTemplateDeleteResponse {

3 status: 'success' | 'failed'

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

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

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

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.

Пример cURL захтева за ажурирање HashTag-а

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; // Враћамо комплетан ажурирани хештаг при успеху.

9}

10

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

HashTag Create cURL пример

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 Create захтевна структура

Copy

1

2interface HashTagPostQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

HashTag Create одговорна структура

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

Ова рута омогућава додавање до 100 HashTag објеката одједном.

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

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

Copy

1

2interface HashTagPostQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

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

Copy

1

2interface HashTagBulkPostResponse {

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'

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

7 reason?: string

8 results?: HashTagPostResponse[]; // Враћамо листу објеката HashTagPostResponse за сваки прослеђени таг.

9}

10

Ова рута омогућава уклањање HashTag-а по наведеном тагу.

Имајте на уму да, ако аутоматско креирање HashTag-ова није онемогућено, хештегови могу бити поново креирани када корисник наведе хештег у коментару.

cURL пример за уклањање HashTag-а

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

Структура захтева за уклањање HashTag-а

Copy

1

2interface HashTagDeleteQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

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

Copy

1

2interface HashTagDeleteResponse {

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'

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

7 reason?: string

8}

9

Objekat Moderator predstavlja konfiguraciju za moderatora.

Постоје три типа модератора:

1. Администраторски корисници који имају ознаку isCommentModeratorAdmin.
2. SSO корисници са ознаком isCommentModeratorAdmin.
3. Редовни коментатори, или FastComments.com корисници, који су позвани као модератори.

Структура Moderator се користи да представи стање модерације за случај употребе 3.

Ако желите да позовете корисника да буде модератор преко API-ја, користите Moderator API тако што ћете креирати Moderator и inviting њих.

Ако корисник нема FastComments.com налог, мејл са позивом ће им помоћи да се подесе. Ако већ има налог, они ће добити приступ модерацији вашег tenant-а и поље userId објекта Moderator ће бити ажурирано да показује на њихов налог. Ви нећете имати API приступ њиховом налогу, јер у овом случају он припада њима и управља га FastComments.com.

Ако вам је потребно потпуно управљање корисничким налогом, препоручујемо или коришћење SSO-а, или додавање њих као Корисник тенанта и затим додавање објекта Moderator ради праћења њихових статистика.

Структура Moderator се може користити као механизам за праћење статистике за случајеве употребе 1 и 2. Након креирања корисника, додајте Moderator објекат са дефинисаним userId и њихове статистике ће бити праћене на Страница модератора коментара.

Структура за објекат Moderator је следећа:

Структура Moderator

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 кредит по 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

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

Ажурирање Moderator има следећа ограничења:

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

Пример cURL PATCH захтева за Moderator

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

Структура PATCH захтева за Moderator

Copy

1

2interface ModeratorPatchQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Структура одговора PATCH захтева за Moderator

Copy

1

2

3interface ModeratorPatchResponse {

4 status: 'success' | 'failed'

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

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

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

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 за корисника кога познајемо само по е‑пошти:

Пример 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

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

Постоје следећа ограничења за слање позива путем е-поште Moderator-у:

• Moderator већ мора постојати.
• fromName не сме бити дужи од 100 characters.

Напомене:

• Ако корисник са датом е-поштом већ постоји, биће позван да модерира коментаре вашег тенанта.
• Ако корисник са датом е-поштом не постоји, линк за позив ће их провести кроз креирање налога.
• Позив ће истећи након 30 days.

Можемо креирати Moderator за корисника за кога знамо само е-пошту:

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

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

Ово ће послати е-поруку као Bob at TenantName is inviting you to be a moderator...

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

Copy

1

2interface ModeratorSendInviteQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** Е-порука послата кориснику ће изгледати као да је послата са овог имена. **/

6 fromName: string

7}

8

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

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

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 по ID‑у корисника. При SSO‑у, 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 по id корисника. Са SSO, id корисника је у формату <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