Wykorzystanie zasobów

Należy zauważyć, że pobieranie danych z API jest naliczane jako użycie na Twoim koncie.

Każdy zasób wskaże, jakie jest to użycie, w swojej własnej sekcji.

Niektóre zasoby są droższe w obsłudze niż inne. Każde endpoint ma stały koszt kredytów za wywołanie API. Dla niektórych endpointów liczba kredytów różni się w zależności od opcji i rozmiaru odpowiedzi.

Użycie API można sprawdzić na stronie Billing Analytics i jest ono aktualizowane co kilka minut.

Uwaga!

Zalecamy najpierw przeczytać dokumentację Pages, aby ograniczyć nieporozumienia przy ustalaniu, jakie wartości przekazać dla urlId w Comment API.

To API agreguje dokumenty, grupując je (jeśli zostanie podany parametr groupBy) i stosując wiele operacji. Obsługiwane są różne operacje (np. sum, countDistinct, avg, itp.).

Koszt jest zmienny. Za każde 500 przeskanowanych obiektów pobierany jest 1 kredyt API.

Maksymalne zużycie pamięci przy pojedynczym wywołaniu API domyślnie wynosi 64MB, a domyślnie można mieć uruchomioną tylko jedną agregację na raz. Jeśli wyślesz wiele agregacji jednocześnie, zostaną one umieszczone w kolejce i wykonywane w kolejności zgłoszeń. Agregacje oczekujące będą czekać maksymalnie 60 sekund, po tym czasie żądanie wygaśnie. Pojedyncze agregacje mogą działać do 5 minut.

Jeśli masz zarządzanych tenantów, możesz agregować zasoby wszystkich podrzędnych tenantów w jednym wywołaniu, przekazując parametr zapytania parentTenantId.

Przykłady

Przykład: Zliczanie unikalnych

Przykład cURL: zliczanie unikalnych wartości

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

Odpowiedź: zliczanie unikalnych wartości

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

Przykład: Zliczanie różnych wartości

Przykład cURL: liczba różnych wartości

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

Odpowiedź:

Odpowiedź: liczba różnych wartości

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

Przykład: Suma wartości wielu pól

Przykład cURL: suma wartości

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

Odpowiedź:

Odpowiedź: suma wartości

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

Przykład: Średnie wartości wielu pól

Przykład cURL: średnie wartości

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

Odpowiedź:

Odpowiedź: średnie wartości

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

Przykład: Wartości minimalne/maksymalne wielu pól

Przykład cURL: wartości min/max

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

Odpowiedź:

Odpowiedź: wartości min/max

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

Przykład: Zliczanie unikalnych wartości wielu pól

Przykład cURL: zliczanie unikalnych wartości

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

Odpowiedź:

Odpowiedź: zliczanie unikalnych wartości

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

Przykład: Tworzenie zapytania

Przykład cURL: tworzenie zapytania

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

Odpowiedź:

Odpowiedź: tworzenie zapytania

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

Przykład: Zliczanie komentarzy oczekujących na recenzję

Przykład cURL: zliczanie komentarzy oczekujących na recenzję

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

Odpowiedź:

Odpowiedź: zliczanie komentarzy oczekujących na recenzję

Copy

1

2{

3 "status": "success",

4 "data": [

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

6 ],

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

8}

9

Przykład: Podział komentarzy na zatwierdzone, zrecenzowane i spam

Przykład cURL: rozkład komentarzy

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

Odpowiedź:

Odpowiedź: rozkład komentarzy

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

Struktury

Struktura żądania agregacji

Copy

1

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

3

4/** Operacja, która zostanie zastosowana na polu */

5export interface AggregationOperation {

6 /** Pole, na którym wykona się operacja */

7 field: string;

8 /** Typ operacji */

9 op: AggregationOpType;

10 /** Opcjonalny alias dla wyniku; jeśli nie zostanie podany, zostanie obliczony domyślny alias */

11 alias?: string;

12 expandArray?: boolean;

13}

14

15export interface QueryPredicate {

16 key: string

17 value: string | number | boolean

18 operator: 'eq' | 'not_eq' | 'greater_than' | 'less_than' | 'contains'

19}

20

21export interface AggregationRequest {

22 query?: QueryPredicate[];

23 resourceName: string;

24 groupBy?: string[];

25 operations: AggregationOperation[];

26 sort?: {

27 field: string;

28 dir: 'asc' | 'desc';

29 };

30}

31

32type DistinctAccumulator = Record<string, number>;

33type GroupValues = Record<string, string>;

34

35export type AggregationValue = {

36 distinctCounts?: DistinctAccumulator

37 distinctCount?: number

38 numericValue?: number

39 stringValue?: string

40 groups?: GroupValues

41};

42

Struktura odpowiedzi agregacji

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

Następujące zasoby można agregować:

• 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

To API używa paginacji, zapewnianej przez parametry skip, before i after. AuditLogs są zwracane stronami po 1000, posortowane według when i id.

Pobranie każdej partii 1000 logów kosztuje 10 kredytów.

Domyślnie otrzymasz listę z najnowszymi elementami na początku. Dzięki temu możesz odpytywać zaczynając od skip=0, paginując aż znajdziesz ostatni rekord, który przetworzyłeś.

Alternatywnie możesz sortować od najstarszych i paginować, aż nie będzie więcej rekordów.

Sortowanie można ustawić przez przypisanie wartości order na ASC lub DESC. Domyślną wartością jest ASC.

Zapytania według daty są możliwe przy użyciu before i after jako znaczników czasu z milisekundami. before i after NIE są włączające.

Przykład żądania 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

Struktura żądania 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 odpowiedzi AuditLog

Copy

1

2interface CommentsResponse {

3 status: 'success' | 'failed'

4 /** Dołączone w przypadku niepowodzenia. **/

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

6 /** Dołączone w przypadku niepowodzenia. **/

7 reason?: string

8 /** Logi! **/

9 auditLogs: AuditLog[]

10}

11

To API służy do pobierania komentarzy do wyświetlenia użytkownikowi. Na przykład automatycznie filtruje komentarze niezatwierdzone lub oznaczone jako spam.

Paginacja

Paginację można wykonać na jeden z dwóch sposobów, w zależności od wymagań dotyczących wydajności i przypadku użycia:

1. Najszybszy: Prekalkulowana paginacja:
   1. Tak działa FastComments, gdy korzystasz z naszych wbudowanych widgetów i klientów.
   2. Kliknięcie „dalej” po prostu zwiększa numer strony.
   3. Można to sobie wyobrazić jako pobierane z magazynu klucz-wartość.
   4. W ten sposób wystarczy zdefiniować parametr page zaczynający się od 0 oraz kierunek sortowania direction.
   5. Rozmiary stron można dostosować za pomocą reguł dostosowywania.
2. Najbardziej elastyczny: Elastyczna paginacja:
   1. W ten sposób możesz zdefiniować niestandardowe parametry limit i skip. Nie przekazuj page.
   2. Obsługiwany jest również kierunek sortowania direction.
   3. limit to łączna liczba do zwrócenia po zastosowaniu skip.
      • Przykład: ustaw skip = 200, limit = 100 gdy page size = 100 i page = 2.
   4. Komentarze podrzędne nadal liczą się w paginacji. Można to obejść, używając opcji asTree.
      • Możesz paginować dzieci za pomocą limitChildren i skipChildren.
      • Możesz ograniczyć głębokość zwracanych wątków za pomocą maxTreeDepth.

Wątki

1. Przy użyciu Precalculated Pagination, komentarze są grupowane według strony, a komentarze w wątkach wpływają na ogólną stronę.
   1. W ten sposób wątki można określić po stronie klienta na podstawie parentId.
   2. Na przykład, mając stronę z jednym komentarzem najwyższego poziomu i 29 odpowiedziami, przy ustawieniu page=0 w API - otrzymasz tylko komentarz najwyższego poziomu i 29 dzieci.
   3. Example image here illustrating multiple pages.
2. Przy użyciu Flexible Pagination, możesz zdefiniować parametr parentId.
   1. Ustaw go na null, aby pobrać tylko komentarze najwyższego poziomu.
   2. Aby wyświetlić wątki, wywołaj API ponownie i przekaż parentId.
   3. Popularnym rozwiązaniem jest wykonanie wywołania API dla komentarzy najwyższego poziomu, a następnie równoległe wywołania API, aby pobrać komentarze dla dzieci każdego komentarza.
3. NOWE Od lutego 2023! Pobierz jako drzewo używając &asTree=true.
   1. Można to traktować jako Flexible Pagination as a Tree.
   2. Tylko komentarze najwyższego poziomu liczą się w paginacji.
   3. Ustaw parentId=null, aby rozpocząć drzewo od korzenia (musisz ustawić parentId).
   4. Ustaw skip i limit dla paginacji.
   5. Ustaw asTree na true.
   6. Koszt kredytów wzrasta o 2x, ponieważ nasz backend musi wykonać znacznie więcej pracy w tym scenariuszu.
   7. Ustaw maxTreeDepth, limitChildren i skipChildren według potrzeb.

Wyjaśnienie drzew

Gdy używasz asTree, trudno przewidzieć paginację. Oto pomocna grafika:

Tree Pagination Diagram

Pobieranie komentarzy w kontekście użytkownika

API /comments może być używane w dwóch kontekstach, dla różnych przypadków użycia:

• Do zwracania komentarzy posortowanych i oznaczonych informacjami do budowy własnego klienta.
  • W tym przypadku zdefiniuj parametr zapytania contextUserId.
• Do pobierania komentarzy z twojego backendu do niestandardowych integracji.
  • Platforma domyślnie będzie używać tego bez contextUserId.

Prekalkulowana paginacja komentarzy

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

Elastyczna paginacja komentarzy

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

Elastyczna paginacja komentarzy w kontekście użytkownika

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

Elastyczna paginacja komentarzy w kontekście użytkownika — tylko komentarze najwyższego poziomu

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

Pobierz komentarze jako drzewo

Możliwe jest pobranie komentarzy zwróconych jako drzewo, gdzie paginacja liczy tylko komentarze najwyższego poziomu.

Komentarze jako drzewo w kontekście użytkownika

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

Chcesz pobrać tylko komentarze najwyższego poziomu i bezpośrednie dzieci? Oto jeden sposób:

Komentarze jako drzewo z maksymalną głębokością

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

Jednak w interfejsie użytkownika możesz potrzebować wiedzieć, czy pokazać przycisk „show replies” przy każdym komentarzu. Podczas pobierania komentarzy jako drzewo do komentarzy, gdy dotyczy, dołączana jest właściwość hasChildren.

Pobierz komentarze jako drzewo, wyszukując według hashtagu

Możliwe jest wyszukiwanie po hashtagu za pomocą API, w całym tenantcie (nie ograniczając się do jednej strony ani urlId).

W tym przykładzie pomijamy urlId i wyszukujemy po wielu hashtagach. API zwróci tylko komentarze, które zawierają wszystkie żądane hashtagi.

Komentarze jako drzewo w kontekście użytkownika, według hashtagu

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

Wszystkie parametry żądania

Struktura żądania komentarzy

Copy

1

2interface CommentsRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** Identyfikator urlId (adres strony lub identyfikator artykułu), z którym powiązane są komentarze. **/

6 urlId?: string

7 /** Ogranicz komentarze zwracane przez tego użytkownika. **/

8 userId?: string

9 /** Użyj tego do wyszukiwania po hashtagu. Aby zawęzić do przecięcia wielu hashtagów, użyj &hashTag=a&hashTag=b. **/

10 hashTag?: string

11 /** Kierunek sortowania. Domyślnie MR (Most Relevant). Pozostałe opcje to OF (Oldest First) i NF (Newest First). **/

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

13 /** Prekalkulowana paginacja: Strona do pobrania, zaczynając od 0. Przekaż -1, aby pobrać wszystkie komentarze (do 250). **/

14 page?: number

15 /** Elastyczna paginacja: Ile komentarzy powinniśmy zwrócić? **/

16 limit?: number

17 /** Elastyczna paginacja: Ile komentarzy podrzędnych powinniśmy zwrócić dla każdego rodzica? **/

18 limitChildren?: number

19 /** Elastyczna paginacja: Ile komentarzy powinniśmy pominąć? **/

20 skip?: number

21 /** Elastyczna paginacja: Ile komentarzy podrzędnych powinniśmy pominąć dla każdego rodzica? **/

22 skipChildren?: number

23 /** Do określania zablokowanych i zgłoszonych komentarzy. **/

24 contextUserId?: string

25 /** Do określania zablokowanych i zgłoszonych komentarzy. **/

26 anonUserId?: string

27 /** Do pobierania komentarzy podrzędnych. **/

28 parentId?: string

29 /** Do pobierania jako drzewo. **/

30 asTree?: boolean

31 /** Jak głęboko w drzewie powinny być zwrócone dane? 0 zwraca brak dzieci. 1 zwraca bezpośrednie dzieci itd. **/

32 maxTreeDepth?: number

33}

34

Odpowiedź

Struktura odpowiedzi komentarzy

Copy

1

2interface CommentsResponse {

3 status: 'success' | 'failed'

4 /** Dołączane w przypadku niepowodzenia. **/

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 /** Dołączane w przypadku niepowodzenia. **/

7 reason?: string

8 /** Komentarze! **/

9 comments: Comment[]

10}

11

Przydatne wskazówki

Identyfikator URL

Prawdopodobnie chcesz użyć API Comment z parametrem urlId. Możesz najpierw wywołać API Pages, aby zobaczyć, jak wyglądają dostępne wartości urlId.

Anonimowe działania

Dla anonimowego komentowania prawdopodobnie chcesz przekazać anonUserId podczas pobierania komentarzy oraz podczas wykonywania zgłoszeń i blokad.

(!) Jest to wymagane przez wiele sklepów z aplikacjami, ponieważ użytkownicy muszą mieć możliwość zgłaszania treści tworzonych przez użytkowników, które widzą, nawet jeśli nie są zalogowani. Brak takiej możliwości może spowodować usunięcie Twojej aplikacji z danego sklepu.

Komentarze nie są zwracane

Sprawdź, czy Twoje komentarze zostały zatwierdzone i nie są spamem.

To API umożliwia pobranie pojedynczego komentarza po identyfikatorze.

Przykład cURL pobierania komentarza po ID

Copy

1

2curl --request GET \

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

4

Struktura żądania pobierania komentarza po ID

Copy

1

2interface CommentsGetByIdQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Struktura odpowiedzi pobierania komentarza po ID

Copy

1

2interface CommentGetByIdResponse {

3 status: 'success' | 'failed'

4 /** Dołączane w przypadku niepowodzenia. **/

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

6 /** Dołączane w przypadku niepowodzenia. **/

7 reason?: string

8 /** Komentarz! **/

9 comment?: Comment

10}

11

Ten endpoint API umożliwia tworzenie komentarzy.

Typowe przypadki użycia to niestandardowe interfejsy użytkownika, integracje lub importy.

Uwagi:

• Ten interfejs API może zaktualizować widżet komentarzy "na żywo", jeśli jest taka potrzeba (zwiększa to creditsCost z 1 do 2).
• Ten interfejs API automatycznie utworzy obiekty użytkowników w naszym systemie, jeśli podany zostanie adres e-mail.
• Próba zapisania dwóch komentarzy z różnymi adresami e-mail, ale taką samą nazwą użytkownika, spowoduje błąd dla drugiego komentarza.
• Jeśli określasz parentId, a komentarz potomny ma notificationSentForParent ustawione na false, wyślemy powiadomienia dla komentarza nadrzędnego. Odbywa się to co godzinę (grupujemy powiadomienia, aby zmniejszyć liczbę wysyłanych e-maili).
• Jeśli chcesz wysyłać e-maile powitalne podczas tworzenia użytkowników lub e-maile weryfikacyjne komentarzy, ustaw sendEmails na true w parametrach zapytania.
• Komentarze utworzone za pomocą tego interfejsu API będą widoczne na stronach Analityka i Moderacja w aplikacji administracyjnej.
• „wulgaryzmy” nadal są maskowane w nazwach komentujących i tekście komentarza, jeśli ustawienie jest włączone.
• Komentarze utworzone przez ten interfejs API nadal mogą być sprawdzane pod kątem spamu, jeśli zajdzie taka potrzeba.
• Konfiguracje, takie jak maksymalna długość komentarza, jeśli są skonfigurowane za pomocą strony administracyjnej Customization Rule, będą miały tu zastosowanie.

Minimalne dane wymagane do przesłania, które będą wyświetlane w widżecie komentarzy, są następujące:

Minimalny przykład POST komentarza 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

Bardziej realistyczne żądanie może wyglądać następująco:

Przykład POST komentarza 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

Struktura żądania POST komentarza

Copy

1

2interface CommentPostQueryParams {

3 tenantId: string

4 API_KEY: string

5 doSpamCheck?: 'true' | 'false'

6 /** Czy komentarz powinien pojawić się "na żywo" dla użytkowników przeglądających instancje widżetu komentarzy o tym samym urlId. Uwaga: Podwaja koszt kredytów z 1 do 2. **/

7 isLive?: 'true' | 'false'

8 sendEmails?: 'true' | 'false'

9 populateNotifications?: 'true' | 'false'

10}

11

Struktura odpowiedzi POST komentarza

Copy

1

2

3interface CommentPostResponse {

4 status: 'success' | 'failed'

5 /** Zawarte w przypadku niepowodzenia. **/

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 /** Zawarte w przypadku niepowodzenia. **/

8 reason?: string

9 /** Utworzony komentarz. **/

10 comment?: Comment

11 /** Powiązany użytkownik, który mógł już istnieć lub nie. **/

12 user?: User

13}

14

Ten endpoint API umożliwia aktualizację pojedynczego komentarza.

Notes:

• To API może zaktualizować widżet komentarzy „na żywo”, jeśli chcesz (to zwiększa podstawowy creditsCost z 1 do 2).
  • To może sprawić, że migracje komentarzy między stronami będą „na żywo” (zmieniając urlId).
  • Migracje kosztują dodatkowe 2 kredyty, ponieważ strony są wstępnie przeliczane i jest to proces intensywny dla CPU.
• W przeciwieństwie do API tworzenia, to API NIE utworzy automatycznie obiektów użytkownika w naszym systemie, jeśli zostanie podany adres e-mail.
• Komentarze zaktualizowane przez to API nadal mogą być sprawdzane pod kątem spamu, jeśli chcesz.
• Ustawienia takie jak maksymalna długość komentarza, jeśli skonfigurowane na stronie administracyjnej Customization Rule, będą miały tutaj zastosowanie.
• Aby umożliwić użytkownikom aktualizację tekstu komentarza, możesz po prostu określić comment w ciele żądania. My wygenerujemy wynikowy commentHTML.
  • Jeśli zdefiniujesz zarówno comment, jak i commentHTML, nie wygenerujemy automatycznie HTML.
  • Jeśli użytkownik doda wzmianki lub hashtagi w nowym tekście, zostaną one przetworzone tak samo jak w API POST.
• Podczas aktualizacji commenterEmail w komentarzu najlepiej podać także userId. W przeciwnym razie musisz upewnić się, że użytkownik z tym adresem e-mail należy do Twojego tenantu, inaczej żądanie się nie powiedzie.

Minimalny przykład PATCH cURL komentarza

Copy

1

2curl --request PATCH \

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

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

5 --data '{

6 "comment": "some-new-comment-text"

7}'

8

Struktura żądania PATCH komentarza

Copy

1

2interface CommentPatchQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** The user doing the update. If desired can be used to check that they can edit the comment. **/

6 contextUserId?: string

7 /** Should we check if the new comment looks like spam? **/

8 doSpamCheck?: 'true' | 'false'

9 /** Whether the comment should appear "live" to users viewing instances of the comment widget with the same urlId. NOTE: Doubles credit cost from 1 to 2. **/

10 isLive?: 'true' | 'false'

11}

12

Struktura odpowiedzi PATCH komentarza

Copy

1

2

3interface CommentPatchResponse {

4 status: 'success' | 'failed'

5 /** Included on failure. **/

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'

7 /** Included on failure. **/

8 reason?: string

9}

10

Ten endpoint API umożliwia usunięcie komentarza.

Notes:

• To API może zaktualizować widżet komentarzy "na żywo", jeśli zajdzie taka potrzeba (zwiększa to creditsCost z 1 do 2).
• To API usunie wszystkie komentarze podrzędne.

Przykład żądania cURL usunięcia komentarza

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 żądania usunięcia komentarza

Copy

1

2interface CommentDeleteQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** Użytkownik wykonujący aktualizację. W razie potrzeby można użyć do sprawdzenia, czy może usunąć komentarz. **/

6 contextUserId?: string

7 /** Czy komentarz powinien zostać usunięty "na żywo" dla użytkowników przeglądających instancje widżetu komentarzy z tym samym urlId. UWAGA: Podwaja koszt kredytów z 1 do 2. **/

8 isLive?: 'true' | 'false'

9}

10

Struktura odpowiedzi usunięcia komentarza

Copy

1

2

3interface CommentDeleteResponse {

4 status: 'success' | 'failed'

5 /** Dołączone w przypadku niepowodzenia. **/

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

7 /** Dołączone w przypadku niepowodzenia. **/

8 reason?: string

9}

10

This API endpoint provides the ability to flag a comment for a specific user.

Notes:

• This call must always be made in the context of a user. The user can be a FastComments.com User, SSO User, or Tenant User.
• If a flag-to-hide threshold is set, the comment will be automatically hidden live after it has been flagged the defined number of times.
• After it is automatically un-approved (hidden) - the comment can only be re-approved by an administrator or moderator. Un-flagging will not re-approve the comment.

Przykład cURL: zgłoszenie komentarza

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.

Przykład cURL: anonimowe zgłoszenie komentarza

Copy

1

2curl --request POST \

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

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

5

Struktura żądania zgłoszenia komentarza

Copy

1

2interface CommentFlagQueryParams {

3 tenantId: string

4 API_KEY: string

5 userId?: string

6 anonUserId?: string

7}

8

Struktura odpowiedzi zgłoszenia komentarza

Copy

1

2

3interface CommentFlagResponse {

4 status: 'success' | 'failed'

5 /** Dołączone w przypadku niepowodzenia. **/

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 /** Dołączone w przypadku niepowodzenia. **/

8 reason?: string

9 /** Czy komentarz został cofnięty/odrzucony (ukryty) z powodu zbyt wielu zgłoszeń? **/

10 wasUnapproved?: boolean;

11}

12

Ten endpoint API umożliwia usunięcie flagi z komentarza dla konkretnego użytkownika.

Notes:

• To wywołanie musi być zawsze wykonane w kontekście użytkownika. The user can be a FastComments.com User, SSO User, or Tenant User.
• Po tym, jak komentarz zostanie automatycznie odrzucony (ukryty) - komentarz może zostać ponownie zatwierdzony tylko przez administratora lub moderatora. Usunięcie flagi nie spowoduje ponownego zatwierdzenia komentarza.

Przykład cURL: cofnięcie flagi komentarza

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

W przypadku anonimowego zgłaszania musimy określić anonUserId. Może to być identyfikator reprezentujący sesję anonimową lub losowy UUID.

Przykład cURL: cofnięcie flagi anonimowego komentarza

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 żądania cofnięcia flagi komentarza

Copy

1

2interface CommentFlagQueryParams {

3 tenantId: string

4 API_KEY: string

5 userId?: string

6 anonUserId?: string

7}

8

Struktura odpowiedzi cofnięcia flagi komentarza

Copy

1

2

3interface CommentUnFlagResponse {

4 status: 'success' | 'failed'

5 /** Dołączone w przypadku niepowodzenia. **/

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 /** Dołączone w przypadku niepowodzenia. **/

8 reason?: string

9}

10

Ten endpoint API umożliwia zablokowanie użytkownika, który napisał dany komentarz. Obsługuje blokowanie komentarzy napisanych przez użytkowników FastComments.com, użytkowników SSO oraz użytkowników najemcy.

Obsługuje parametr w treści żądania commentIdsToCheck, aby sprawdzić, czy inne potencjalnie widoczne komentarze po stronie klienta powinny zostać zablokowane/odblokowane po wykonaniu tej akcji.

Notes:

• To wywołanie musi być zawsze wykonane w kontekście użytkownika. Użytkownikiem może być użytkownik FastComments.com, użytkownik SSO lub użytkownik najemcy.
• The userId in the request is the user that is doing the blocking. For example: User A wants to Block User B. Pass userId=User A and the comment id that User B wrote.
• Całkowicie anonimowe komentarze (bez identyfikatora użytkownika, bez adresu e-mail) nie mogą być zablokowane i zostanie zwrócony błąd.

Przykład cURL blokowania komentarza

Copy

1

2curl --request POST \

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

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

5

For anonymous blocking, we must specify an anonUserId. This can be an ID that represents the anonymous session, or a random UUID. This allows us to support blocking comments even if a user is not logged in by fetching the comments with the same anonUserId.

Przykład cURL blokowania anonimowego komentarza

Copy

1

2curl --request POST \

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

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

5

Struktura żądania blokowania komentarza

Copy

1

2interface CommentBlockQueryParams {

3 tenantId: string

4 API_KEY: string

5 userId?: string

6 anonUserId?: string

7 commentIdsToCheck?: string[]

8}

9

Struktura odpowiedzi blokowania komentarza

Copy

1

2

3interface CommentBlockResponse {

4 status: 'success' | 'failed'

5 /** Dołączone w przypadku niepowodzenia. **/

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 /** Dołączone w przypadku niepowodzenia. **/

8 reason?: string

9 /** Jeśli commentIdsToCheck jest zdefiniowane, wpisy w tej mapie z wartością true również są zablokowane. **/

10 commentStatuses?: Record<string, boolean>;

11}

12

Ten punkt końcowy API umożliwia odblokowanie użytkownika, który napisał dany komentarz. Obsługuje odblokowywanie komentarzy napisanych przez użytkowników FastComments.com, użytkowników SSO oraz użytkowników najemcy.

Obsługuje parametr w body commentIdsToCheck, aby sprawdzić, czy po wykonaniu tej akcji inne potencjalnie widoczne komentarze po stronie klienta powinny zostać zablokowane/odblokowane.

Uwagi:

• To wywołanie musi być zawsze wykonane w kontekście użytkownika. Użytkownik może być użytkownikiem FastComments.com, użytkownikiem SSO lub użytkownikiem najemcy.
• Pole userId w żądaniu to użytkownik, który wykonuje odblokowanie. Na przykład: User A chce odblokować User B. Przekaż userId=User A oraz identyfikator komentarza, który napisał User B.
• Całkowicie anonimowe komentarze (bez id użytkownika, bez adresu e-mail) nie mogą być zablokowane i zostanie zwrócony błąd.

Przykład cURL — odblokowanie komentarza

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

Przykład cURL — odblokowanie anonimowego komentarza

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 żądania odblokowania komentarza

Copy

1

2interface CommentUnBlockQueryParams {

3 tenantId: string

4 API_KEY: string

5 userId?: string

6 anonUserId?: string

7 commentIdsToCheck?: string[]

8}

9

Struktura odpowiedzi odblokowania komentarza

Copy

1

2

3interface CommentUnBlockResponse {

4 status: 'success' | 'failed'

5 /** Dołączone w przypadku niepowodzenia. **/

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 /** Dołączone w przypadku niepowodzenia. **/

8 reason?: string

9 /** Jeśli commentIdsToCheck jest zdefiniowane, wpisy w tej mapie z wartością true są nadal zablokowane. Jeśli false, możesz chcieć przywrócić widoczność komentarzy dla użytkownika, aby nie musiał odświeżać strony. **/

10 commentStatuses?: Record<string, boolean>;

11}

12

Poszczególne obiekty EmailTemplate można pobrać za pomocą odpowiadającego im id (NIE emailTemplateId).

Przykład cURL dla EmailTemplate według ID

Copy

1

2curl --request GET \

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

4

Struktura żądania EmailTemplate według ID

Copy

1

2interface EmailTemplatesByIdRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Struktura odpowiedzi EmailTemplate według ID

Copy

1

2interface EmailTemplateResponse {

3 status: 'success' | 'failed'

4 /** Dołączone w przypadku niepowodzenia. **/

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

6 /** Dołączone w przypadku niepowodzenia. **/

7 reason?: string

8 emailTemplate?: EmailTemplate | null

9}

10

To API używa paginacji, dostarczanej przez parametr zapytania page. EmailTemplates są zwracane w stronach po 100, posortowane według createdAt, a następnie id.

Przykład żądania 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

Struktura żądania EmailTemplate

Copy

1

2interface EmailTemplatesRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** Strona do pobrania, zaczynając od 0. **/

6 page: number

7}

8

Struktura odpowiedzi EmailTemplate

Copy

1

2interface EmailTemplatesResponse {

3 status: 'success' | 'failed'

4 /** Dołączone w przypadku niepowodzenia. **/

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

6 /** Dołączone w przypadku niepowodzenia. **/

7 reason?: string

8 emailTemplates: EmailTemplate[]

9}

10

Ten punkt końcowy API umożliwia aktualizację szablonu e-mail poprzez podanie jedynie id oraz atrybutów do zaktualizowania.

Zauważ, że wszystkie te same walidacje, które obowiązują przy tworzeniu szablonu, mają zastosowanie również tutaj, na przykład:

• Szablon musi się renderować. Jest to sprawdzane przy każdej aktualizacji.
• Nie można mieć zduplikowanych szablonów dla tej samej domeny (w przeciwnym razie jeden zostałby zignorowany bez komunikatu).

Przykład cURL dla EmailTemplate PATCH

Copy

1

2curl --request PATCH \

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

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

5 --data '{

6 "displayName": "Some New Name",

7}'

8

Struktura żądania PATCH EmailTemplate

Copy

1

2interface EmailTemplatePatchQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Struktura odpowiedzi PATCH EmailTemplate

Copy

1

2

3interface EmailTemplatePatchResponse {

4 status: 'success' | 'failed'

5 /** Dołączone w przypadku niepowodzenia. **/

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 /** Dołączone w przypadku niepowodzenia. **/

8 reason?: string

9 /** Zaktualizowany szablon e-mail. **/

10 emailTemplate?: EmailTemplate

11}

12

This API endpoint provides the ability to create email templates.

Notes:

• You can't have multiple templates with the same emailTemplateId with the same domain.
• But you can have a wildcard template (domain = * and a domain specific template for the same emailTemplateId).
• Specifying domain is only relevant if you have different domains, or want to use specific templates for testing (domain set to localhost etc).
• If you do specify domain it must match a DomainConfig. On error a list of valid domains is provided.
• The template syntax is EJS and is rendered with a 500ms timeout. P99 for rendering is <5ms, so if you hit 500ms something is wrong.
• Your template must render with your given testData to save. Render errors are aggregated and reported on in the dashboard (soon available via API).

The minimum data required to add a template is as follows:

Minimalny przykład cURL POST dla 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

You may want to have templates per-site, in which case you define domain:

Przykład cURL POST dla EmailTemplate

Copy

1

2curl --request POST \

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

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

5 --data '{

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

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

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

9 "domain": "somespecificsite.com",

10}'

11

Struktura żądania POST EmailTemplate

Copy

1

2interface EmailTemplatePostQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Struktura odpowiedzi POST EmailTemplate

Copy

1

2

3interface EmailTemplatePostResponse {

4 status: 'success' | 'failed'

5 /** Zawarte w przypadku niepowodzenia. **/

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 /** Zawarte w przypadku niepowodzenia. **/

8 reason?: string

9 /** Utworzony szablon. **/

10 emailTemplate?: EmailTemplate

11}

12

Ten punkt końcowy API umożliwia podgląd szablonów e-mail.

Minimalny przykład żądania cURL POST podglądu 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 żądania POST EmailTemplate

Copy

1

2interface EmailTemplatePostQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Struktura odpowiedzi POST EmailTemplate

Copy

1

2

3interface EmailTemplatePostResponse {

4 status: 'success' | 'failed'

5 /** Dołączone w przypadku niepowodzenia. **/

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

7 /** Dołączone w przypadku niepowodzenia. **/

8 reason?: string

9 /** Wyrenderowany HTML w przypadku powodzenia. **/

10 html?: string

11}

12

Ta trasa umożliwia usunięcie pojedynczego EmailTemplate według identyfikatora.

Przykład żądania cURL usunięcia 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 żądania usunięcia EmailTemplate

Copy

1

2interface EmailTemplateRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Struktura odpowiedzi usunięcia EmailTemplate

Copy

1

2interface EmailTemplateDeleteResponse {

3 status: 'success' | 'failed'

4 /** Dołączone w przypadku niepowodzenia. **/

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

6 /** Dołączone w przypadku niepowodzenia. **/

7 reason?: string

8}

9

To API używa paginacji, udostępnianej przez parametr zapytania page. HashTags są zwracane w stronach po 100, posortowane według tag.

Przykład żądania cURL dla HashTag

Copy

1

2curl --request GET \

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

4

Struktura żądania HashTag

Copy

1

2interface HashTagsRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** Strona do pobrania, zaczynając od 0. **/

6 page: number

7}

8

Struktura odpowiedzi HashTag

Copy

1

2interface HashTagsResponse {

3 status: 'success' | 'failed'

4 /** Dołączone w przypadku niepowodzenia. **/

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

6 /** Dołączone w przypadku niepowodzenia. **/

7 reason?: string

8 /** Hashtagi! **/

9 hashTags: HashTag[]

10}

11

Ten endpoint umożliwia zaktualizowanie pojedynczego HashTag.

Przykład żądania cURL aktualizacji 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

Struktura żądania aktualizacji HashTag

Copy

1

2interface HashTagPatchQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Struktura odpowiedzi aktualizacji HashTag

Copy

1

2interface HashTagPatchResponse {

3 status: 'success' | 'failed'

4 /** Dołączane w przypadku niepowodzenia. **/

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 /** Dołączane w przypadku niepowodzenia. **/

7 reason?: string

8 hashTag?: HashTag; // Zwracamy kompletny, zaktualizowany obiekt `HashTag` w przypadku powodzenia.

9}

10

Ta trasa umożliwia dodanie pojedynczego HashTag.

Przykład cURL tworzenia HashTag

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 żądania tworzenia HashTag

Copy

1

2interface HashTagPostQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Struktura odpowiedzi tworzenia HashTag

Copy

1

2interface HashTagPostResponse {

3 status: 'success' | 'failed'

4 /** Dołączone w przypadku niepowodzenia. **/

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 /** Dołączone w przypadku niepowodzenia. **/

7 reason?: string

8 hashTag?: HashTag; // Zwracamy pełny utworzony hashtag w przypadku powodzenia.

9}

10

Ta ścieżka umożliwia dodanie do 100 HashTag obiektów jednocześnie.

Przykład cURL — masowe tworzenie 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

Struktura żądania — masowe tworzenie HashTag

Copy

1

2interface HashTagPostQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Struktura odpowiedzi — masowe tworzenie HashTag

Copy

1

2interface HashTagBulkPostResponse {

3 status: 'success' | 'failed'

4 /** Zwracane w przypadku niepowodzenia. **/

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 /** Zwracane w przypadku niepowodzenia. **/

7 reason?: string

8 results?: HashTagPostResponse[]; // Zwracamy listę obiektów HashTagPostResponse dla każdego dostarczonego tagu.

9}

10

Ta trasa umożliwia usunięcie HashTag na podstawie podanego tagu.

Należy pamiętać, że jeśli automatyczne tworzenie HashTag nie jest wyłączone, hashtagi mogą zostać ponownie utworzone przez użytkownika, który poda hashtag podczas komentowania.

Przykład żądania cURL usunięcia 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

Struktura żądania usunięcia HashTag

Copy

1

2interface HashTagDeleteQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Struktura odpowiedzi usunięcia HashTag

Copy

1

2interface HashTagDeleteResponse {

3 status: 'success' | 'failed'

4 /** Dołączone w przypadku niepowodzenia. **/

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

6 /** Dołączone w przypadku niepowodzenia. **/

7 reason?: string

8}

9

Obiekt Moderator reprezentuje konfigurację moderatora.

Istnieją trzy typy moderatorów:

1. Użytkownicy administratorzy, którzy mają flagę isCommentModeratorAdmin.
2. Użytkownicy SSO z flagą isCommentModeratorAdmin.
3. Zwykli komentatorzy, lub użytkownicy FastComments.com, którzy są zapraszani jako moderatorzy.

Struktura Moderator jest używana do reprezentowania stanu moderacji w przypadku użycia 3.

Jeśli chcesz zaprosić użytkownika na moderatora za pomocą API, użyj API Moderator, tworząc Moderator i inviting ich.

Jeśli użytkownik nie ma konta na FastComments.com, wiadomość e-mail z zaproszeniem pomoże mu się skonfigurować. Jeśli ma już konto, otrzyma dostęp moderatorski do Twojego tenanta, a pole userId obiektu Moderator zostanie zaktualizowane, aby wskazywać na jego użytkownika. Nie będziesz mieć dostępu API do ich użytkownika, ponieważ w tym przypadku konto należy do nich i jest zarządzane przez FastComments.com.

Jeśli potrzebujesz pełnego zarządzania kontem użytkownika, zalecamy albo użycie SSO, albo dodanie go jako Użytkownik tenanta i następnie dodanie obiektu Moderator do śledzenia ich statystyk.

Struktura Moderator może być używana jako mechanizm śledzenia statystyk dla przypadków użycia 1 i 2. Po utworzeniu użytkownika dodaj obiekt Moderator z określonym polem userId, a jego statystyki będą śledzone na stronie moderatorów komentarzy.

Struktura obiektu Moderator jest następująca:

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

Ten endpoint zwraca pojedynczego moderatora na podstawie jego/jej id.

Przykład cURL — Moderator według ID

Copy

1

2curl --request GET \

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

4

Struktura żądania moderatora

Copy

1

2interface ModeratorByIdQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Struktura odpowiedzi moderatora

Copy

1

2interface ModeratorByIdResponse {

3 status: 'success' | 'failed'

4 /** Dołączone w przypadku niepowodzenia. **/

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

6 /** Dołączone w przypadku niepowodzenia. **/

7 reason?: string

8 moderator?: Moderator

9}

10

To API używa paginacji, realizowanej przez parametr zapytania skip. Moderatorzy są zwracani stronami po 100, posortowani według createdAt i id.

Koszt zależy od liczby zwróconych moderatorów — 1 credit per 10 zwróconych moderatorów.

Przykład cURL dla Moderatora

Copy

1

2curl --request GET \

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

4

Struktura żądania Moderatora

Copy

1

2interface ModeratorsRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** Liczba moderatorów do pominięcia w paginacji. **/

6 skip?: number

7}

8

Struktura odpowiedzi Moderatora

Copy

1

2interface ModeratorsResponse {

3 status: 'success' | 'failed'

4 /** Zawarte w przypadku niepowodzenia. **/

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

6 /** Zawarte w przypadku niepowodzenia. **/

7 reason?: string

8 moderators?: Moderator[]

9}

10

Ten punkt końcowy API umożliwia zaktualizowanie Moderator za pomocą id.

Aktualizacja Moderator ma następujące ograniczenia:

• Następujące wartości nie mogą być podane podczas aktualizacji Moderator:
  • acceptedInvite
  • markReviewedCount
  • deletedCount
  • markedSpamCount
  • approvedCount
  • editedCount
  • bannedCount
  • verificationId
  • createdAt
• Jeżeli zostanie podane userId, użytkownik musi istnieć.
• Jeżeli zostanie podane userId, musi należeć do tego samego tenantId, który został podany w parametrach zapytania.
• Dwóch moderatorów w tym samym tenant nie może mieć tego samego email.
• Nie można zmienić tenantId powiązanego z Moderator.

Przykład żądania 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

Struktura żądania PATCH Moderatora

Copy

1

2interface ModeratorPatchQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Struktura odpowiedzi PATCH Moderatora

Copy

1

2

3interface ModeratorPatchResponse {

4 status: 'success' | 'failed'

5 /** Dołączone w przypadku niepowodzenia. **/

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

7 /** Dołączone w przypadku niepowodzenia. **/

8 reason?: string

9}

10

Ten endpoint umożliwia dodanie pojedynczego Moderator.

Tworzenie Moderator ma następujące ograniczenia:

• Zawsze należy podać name i email. userId jest opcjonalne.
• Następujące wartości nie mogą być podawane podczas tworzenia Moderator:
  • acceptedInvite
  • markReviewedCount
  • deletedCount
  • markedSpamCount
  • approvedCount
  • editedCount
  • bannedCount
  • verificationId
  • createdAt
• Jeśli podano userId, użytkownik musi istnieć.
• Jeśli podano userId, musi należeć do tego samego tenantId podanego w parametrach zapytania.
• Dwóch moderatorów w tym samym tenant nie może zostać dodanych z tym samym email.

Możemy utworzyć Moderator dla użytkownika, którego znamy tylko adres e-mail:

Przykład cURL: utworzenie Moderator na podstawie adresu e-mail

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

Lub możemy utworzyć Moderator dla użytkownika, który należy do naszego tenant, aby śledzić ich statystyki moderacji:

Przykład cURL: utworzenie Moderator dla użytkownika należącego do tenant

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

Struktura żądania tworzenia Moderator

Copy

1

2interface ModeratorPostQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Struktura odpowiedzi tworzenia Moderator

Copy

1

2interface ModeratorPostResponse {

3 status: 'success' | 'failed'

4 /** Dołączone w przypadku niepowodzenia. **/

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

6 /** Dołączone w przypadku niepowodzenia. **/

7 reason?: string

8 moderator?: Moderator; // Zwracamy kompletnie utworzonego moderatora w przypadku powodzenia.

9}

10

Ta trasa udostępnia możliwość zaproszenia pojedynczego Moderator.

The following restrictions exist to send an invite email to a Moderator:

• The Moderator must already exist.
• The fromName may not be longer than 100 characters.

Notes:

• Jeśli użytkownik z podanym adresem e-mail już istnieje, zostanie zaproszony do moderowania komentarzy twojego tenanta.
• Jeśli użytkownik z podanym adresem e-mail nie istnieje link zaproszenia poprowadzi go przez proces tworzenia konta.
• Zaproszenie wygaśnie po 30 days.

Możemy utworzyć Moderator dla użytkownika, którego znamy tylko adres e-mail:

Przykład żądania cURL: Zaproszenie moderatora

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

To wyśle e-mail podobny do Bob at TenantName is inviting you to be a moderator...

Struktura żądania zaproszenia moderatora

Copy

1

2interface ModeratorSendInviteQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** E-mail wysyłany do użytkownika będzie wyglądał, jakby był wysłany z tej nazwy. **/

6 fromName: string

7}

8

Struktura odpowiedzi zaproszenia 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 /** Zawarte w przypadku niepowodzenia. **/

7 reason?: string

8}

9

Ta ścieżka umożliwia usunięcie Moderator po id.

Przykład cURL usunięcia moderatora

Copy

1

2curl --request DELETE \

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

4

Struktura żądania usunięcia moderatora

Copy

1

2interface ModeratorDeleteQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Struktura odpowiedzi usunięcia moderatora

Copy

1

2interface ModeratorDeleteResponse {

3 status: 'success' | 'failed'

4 /** Dołączone w przypadku niepowodzenia. **/

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

6 /** Dołączone w przypadku niepowodzenia. **/

7 reason?: string

8}

9

Ta trasa zwraca pojedynczy NotificationCount według identyfikatora użytkownika. Przy SSO identyfikator użytkownika ma format <tenant id>:<user id>.

Jeśli nie ma nieprzeczytanych powiadomień, nie będzie NotificationCount - otrzymasz wtedy 404.

To różni się od notifications/count tym, że jest znacznie szybsze, ale nie pozwala na filtrowanie.

Przykład cURL NotificationCount według 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

Struktura żądania NotificationCount

Copy

1

2interface NotificationCountGetQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Struktura odpowiedzi NotificationCount

Copy

1

2interface NotificationCountGetResponse {

3 status: 'success' | 'failed'

4 /** Dołączone w przypadku niepowodzenia. **/

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

6 /** Dołączone w przypadku niepowodzenia. **/

7 reason?: string

8 data?: NotificationCount

9}

10

Ta ścieżka usuwa pojedynczy NotificationCount według identyfikatora użytkownika. Przy SSO identyfikator użytkownika ma format <tenant id>:<user id>.

Spowoduje to wyczyszczenie nieprzeczytanej liczby powiadomień użytkownika (czerwony dzwonek w widżecie komentarzy zniknie, a liczba przestanie być wyświetlana).

Przykład cURL DELETE 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

Struktura żądania usunięcia NotificationCount

Copy

1

2interface NotificationCountDeleteQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Struktura odpowiedzi usunięcia NotificationCount

Copy

1

2interface NotificationCountDeleteResponse {

3 status: 'success' | 'failed'

4 /** Dołączone w przypadku niepowodzenia. **/

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

6 /** Dołączone w przypadku niepowodzenia. **/

7 reason?: string

8}

9