API לתגובות חיות

שימוש במשאבים

יש לציין כי שליפת נתונים מה-API נספרת כשימוש בחשבון שלך.

כל משאב יציג מהו השימוש שלו בחלקו הנפרד.

חלק מהמשאבים יקרים יותר לשרת מאחרים. לכל נקודת קצה יש עלות קבועה של קרדיטים לכל קריאת API. עבור כמה נקודות קצה, מספר הקרדיטים משתנה בהתאם לאפשרויות ולגודל התגובות.

ניתן לבדוק את השימוש ב-API בדף Billing Analytics והוא מתעדכן כל כמה דקות.

הערה!

אנו ממליצים לקרוא תחילה את תיעוד ה-Pages, כדי לצמצם בלבול בקביעת הערכים שיש להעביר עבור urlId ב-Comment API.

ווב-הוקים

למנויים של ווב-הוקים יש מדריך משלהם. POST, GET ו-DELETE /api/v1/webhooks, וכן GET /api/v1/webhooks/sample-payloads, מתועדים תחת Managing Subscriptions via API, והמטענים של האירועים תחת Webhook Structures.

FastComments הוא שרת אימות OAuth 2.1. אפליקציה יכולה לקבל אסימון הקשור לחשבון FastComments אחד ולהשתמש בו בכל נקודת קצה במדריך זה במקום מפתח API. כך מתחבר אפליקציית Zapier, שרת MCP ושילובים של צד שלישי אחרים.

אסימונים ניתנים דרך זרימת קוד האימות עם PKCE. אין אישורי לקוח או מתן מרומז.

גילוי

כתובות נקודות הקצה, מענקים נתמכים ושיטות אימות מתפרסמים בכתובת המטא‑נתונים הסטנדרטית:

מטא-נתונים של שרת האימות

Copy

1

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

3

הנקודות קצה שהיא מתארת:

נקודות קצה של OAuth

Copy

1

2GET https://fastcomments.com/oauth/authorize

3POST https://fastcomments.com/oauth/token

4POST https://fastcomments.com/oauth/revoke

5POST https://fastcomments.com/oauth/register

6

חשבונות באיזור האיחוד האירופי משתמשים ב‑https://eu.fastcomments.com כמנפיק, עם אותם הנתיבים.

רישום לקוח

לקוח צריך client_id ו‑redirect_uri רשום לפני שהוא יכול להתחיל את הזרימה. ישנן שתי דרכים לקבל אחד:

• רישום דינמי של לקוח. POST /oauth/register עם גוף JSON לפי RFC 7591 (redirect_uris, client_name, client_uri, logo_uri, token_endpoint_auth_method). התגובה מכילה את client_id וללקוחות סודיים, את client_secret. הרישום אינו מאומת ומוגבל בקצב לפי IP.
• מסמך מטא‑נתונים של מזהה לקוח. הלקוח משתמש בכתובת https שהוא שולט בה כמזהה client_id. FastComments מושך את הכתובת וקורא את אותם שדות מטא‑נתונים ממנה. אין צורך בקריאת רישום.

אפליקציות שותף המופיעות בלוח הבקרה של FastComments, כגון Zapier, נרשמות ישירות על ידי FastComments. פנה לתמיכה אם אתה בונה רשימת שוק וצריך לקוח של צד ראשון.

היקפים

היקפים

Copy

1

2read GET and HEAD requests

3write every other method

4

בקשה שלא מבקשת היקף מקבלת את שני ההיקפים. המשתמש רואה את ההיקפים המבוקשים בעמוד ההסכמה. בקשה להיקף שאינו אחד משניים אלו נכשלת עם invalid_scope.

שלב 1 - בקשת אימות

שלח את דפדפן המשתמש לנקודת הקצה של האימות. PKCE עם שיטת S256 נדרש לכל לקוח.

בקשת אימות

Copy

1

2GET https://fastcomments.com/oauth/authorize

3 ?response_type=code

4 &client_id=YOUR_CLIENT_ID

5 &redirect_uri=https://example.com/oauth/callback

6 &scope=read%20write

7 &state=RANDOM_STATE

8 &code_challenge=BASE64URL_SHA256_OF_VERIFIER

9 &code_challenge_method=S256

10

פרמטרים של בקשת אימות

Copy

1

2interface OAuthAuthorizeQueryParams {

3 response_type: 'code'

4 client_id: string

5 /** חייב להתאים בדיוק לאחת מכתובות ה‑redirect הרשומות של הלקוח. **/

6 redirect_uri: string

7 /** מופרדים ברווח. השמט כדי לבקש את שני ההיקפים. **/

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

9 /** נשלח ללא שינוי ב‑redirect. השתמש בו כדי לקשר את הקריאה חזרה למפגש שהתחיל את הזרימה. **/

10 state?: string

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

12 code_challenge: string

13 code_challenge_method: 'S256'

14 /** מחוון משאב RFC 8707 אופציונלי. אם נשלח, יש לשלוח את אותו ערך לנקודת הקצה של האסימון. **/

15 resource?: string

16}

17

המשתמש נכנס ל‑FastComments אם נדרש ורואה עמוד הסכמה שמציג את שם האפליקציה שלך, החשבון שאליו היא תתחבר, וההיקפים המבוקשים. על המשתמש להחזיק בהרשאת API Admin על החשבון; כל משתמש אחר רואה שגיאת הרשאה במקום טופס ההסכמה. אישור מפנה את הדפדפן ל‑redirect_uri שלך עם code ו‑state. דחייה מפנה עם error=access_denied.

קוד האימות תקף למשך 10 דקות וניתן להחליף אותו פעם אחת. החלפה שנייה של אותו קוד מבטלת כל אסימון שהחלפה הראשונה יצרה.

שלב 2 - בקשת אסימון

החלף את הקוד לאסימונים. הגוף מקודד כטופס. לקוחות סודיים מאמתים עם client_secret_basic (HTTP Basic) או client_secret_post (סוד בגוף). לקוחות ציבוריים שולחים רק client_id.

דוגמת cURL לבקשת אסימון

Copy

1

2curl --request POST \

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

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

5 --data 'grant_type=authorization_code' \

6 --data 'client_id=YOUR_CLIENT_ID' \

7 --data 'client_secret=YOUR_CLIENT_SECRET' \

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

9 --data 'code_verifier=YOUR_PKCE_VERIFIER' \

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

11

גוף בקשת אסימון (authorization_code)

Copy

1

2interface OAuthTokenRequestAuthorizationCode {

3 grant_type: 'authorization_code'

4 client_id: string

5 /** ללקוחות סודיים בלבד. ניתן לשלוח כאימות HTTP Basic במקום זאת. **/

6 client_secret?: string

7 code: string

8 code_verifier: string

9 /** חייב להתאים לבקשת האימות שנשלחה. **/

10 redirect_uri?: string

11 resource?: string

12}

13

מבנה תגובת אסימון

Copy

1

2interface OAuthTokenResponse {

3 /** מתחיל ב‑fcat_. תקף לשעה אחת. **/

4 access_token: string

5 token_type: 'bearer'

6 /** שניות עד שפג תוקף אסימון הגישה. 3600. **/

7 expires_in: number

8 /** מתחיל ב‑fcrt_. תקף ל‑30 יום מההנפקה. **/

9 refresh_token: string

10 /** היקפים שהוענקו מופרדים ברווח. **/

11 scope: string

12}

13

השגיאות תואמות ל‑RFC 6749: גוף JSON עם error ו‑error_description, HTTP 400 עבור invalid_request, invalid_grant, invalid_scope, invalid_target ו‑unsupported_grant_type, HTTP 401 עבור invalid_client, HTTP 429 כאשר יש הגבלה בקצב.

שלב 3 - קריאת ה‑API

שלח את אסימון הגישה כאסימון bearer. השוכר (tenant) נרמז מהאסימון, ולכן tenantId הוא אופציונלי. כאשר נמסר, הוא חייב להתאים לאסימון אחרת הבקשה תיכשל.

דוגמת cURL לאסימון Bearer

Copy

1

2curl --request GET \

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

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

5

GET /api/v1/me מחזיר את השוכר, המשתמש המאשר, וההיקפים שהוענקו, מה שהופך אותה לקריאה המתאימה לבדיקת חיבור. בקשה עם אסימון שפג תוקפו או שבוטל מחזירה HTTP 401. בקשה שהמתודה שלה דורשת היקף שהאסימון אינו מחזיק בו מחזירה HTTP 403.

שלב 4 - רענון

דוגמת cURL לבקשת רענון

Copy

1

2curl --request POST \

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

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

5 --data 'grant_type=refresh_token' \

6 --data 'client_id=YOUR_CLIENT_ID' \

7 --data 'client_secret=YOUR_CLIENT_SECRET' \

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

9

גוף בקשת אסימון (refresh_token)

Copy

1

2interface OAuthTokenRequestRefreshToken {

3 grant_type: 'refresh_token'

4 client_id: string

5 client_secret?: string

6 refresh_token: string

7 /** אופציונלי. מצמצם לתת‑קבוצה של ההיקפים שהוענקו במקור. **/

8 scope?: string

9 resource?: string

10}

11

התגובה בעלת המבנה זהה להחלפת הקוד. אסימוני רענון מתחלפים: כל רענון מחזיר refresh_token חדש ומבטל את הקודם לאחר חלון חסד של 30 שניות לבקשות מקבילות. הצגת אסימון רענון שהסתובב לפני יותר מ‑30 שניות מתייחסת כהעתקה חוזרת ומבטלת את כל המענק. אפליקציות שותף שנרשמו על ידי FastComments פטורות מהחלפה ומקבלות את אותו אסימון רענון עם תוקף מורחב בעוד 30 יום.

רענון גם בודק שהמשתמש המאשר עדיין מחזיק בהרשאת API Admin על החשבון. אם לא, המענק מבוטל והתגובה היא invalid_grant.

ביטול

דוגמת cURL לבקשת ביטול

Copy

1

2curl --request POST \

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

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

5 --data 'client_id=YOUR_CLIENT_ID' \

6 --data 'client_secret=YOUR_CLIENT_SECRET' \

7 --data 'token=fcrt_...' \

8 --data 'token_type_hint=refresh_token'

9

ביטול אסימון רענון מבטל כל אסימון גישה שהונפק מאותו מענק. ביטול אסימון גישה מבטל רק את האסימון הזה. נקודת הקצה מחזירה HTTP 200 עם אובייקט JSON ריק בין אם האסימון נמצא ובין אם לא, לפי RFC 7009.

משתמשים יכולים גם לבטל חיבור מ‑אפליקציות מחוברות בלוח הבקרה של FastComments. כל אסימון עבור אותה אפליקציה מפסיק לעבוד מיידית.

API זה מצבר מסמכים על ידי קיבוצם (אם groupBy מסופק) והחלת פעולות מרובות. פעולות שונות (למשל sum, countDistinct, avg וכו') נתמכות.

העלות היא משתנה. כל 500 אובייקטים שנסרקים עולים 1 קרדיט API.

שימוש הזיכרון המקסימלי המותר לקריאת API היא 64MB כברירת מחדל, וכברירת מחדל מותר לך להריץ רק צבירה אחת בכל פעם. אם תשלח מספר צבירות בו-זמנית, הן יתווספו לתור ויורצו בסדר שהוגשו. צבירות ממתינות יחכו מקסימום 60 שניות, לאחר מכן הבקשה תפוג. צבירות בודדות יכולות לרוץ עד 5 דקות.

אם יש לך שוכרים מנוהלים, אתה יכול לצבור את כל משאבי שוכרי הילדים בקריאה אחת על ידי העברת פרמטר השאילתה 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 "operations": [

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

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

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

8 ]

9}'

10

תגובה:

תגובת פירוט תגובות

Copy

1

2{

3 "status": "success",

4 "data": [

5 {

6 "approved": { "distinctCounts": { "true": 2 } },

7 "reviewed": { "distinctCounts": { "false": 2 } },

8 "isSpam": { "distinctCounts": { "false": 2 } }

9 }

10 ],

11 "stats": { "scanned": 2 }

12}

13

מבנים

מבנה בקשת צבירה

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, limit, before, ו-after. AuditLogs מוחזרים בעמודים של 1000 כברירת מחדל, עד למקסימום limit של 10000, ממוינים לפי when ו-id. העמודים גדולים מכיוון שהקצה זה משמש בדרך כלל לייצוא היסטוריה במקום לעבור בעמודים באופן אינטראקטיבי.

כל 100 רשומות שמוחזרות בעלות קרדיט של 1.

בברירת מחדל, תקבל רשימה עם הפריטים החדשים ביותר ראשונים. כך, תוכל לבצע polling החל מ-skip=0, לעבור בעמודים עד שתמצא את הרשומה האחרונה שצורכת.

לחלופין, אתה יכול למיין מהישן לחדש, ולעבור בעמודים עד שאין עוד רשומות.

ניתן למיין על ידי הגדרת order ל-ASC או DESC. ברירת המחדל היא DESC.

ניתן לבצע שאילתא לפי תאריך באמצעות before ו-after כתזמונים במילישניות. before ו-after אינם כולליים, וכל אחד מהם ניתן לשימוש בנפרד.

מציאת מה קרה לאדם

כל אירוע מתעד מי ביצע אותו (username, userId, ip) ובנפרד, על מה הוא בוצע. targetLabel הוא תווית קריאה לבן אדם עבור האובייקט, לדוגמה jsmith (jsmith@example.com), ו-targetId הוא המזהה שלו. השתמש ב-target להתאמת תת-מחרוזת ללא תלות ברישיות על התווית כאשר אתה יודע את שם האדם או האימייל אך לא את המזהה שלו.

מחיקות קולטות את התווית בזמן האירוע, ולכן משתמש או מודרטור שהוסרו עדיין ניתן לזהות לאחר שהרשומה הבסיסית נעלמה.

שכירים מנוהלים

אם השוכר שלך מנהל שכירים אחרים, הגדר includeManagedTenants=true כדי לקבל אירועים מהשוכר שלך ומכל שוכר שהוא מנהל בתגובה אחת. ה-tenantId של כל לוג מוחזר מצביע על השוכר שממנו הוא הגיע.

דוגמת 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 AuditLogsRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5 order?: 'ASC' | 'DESC'

6 /** מקסימום 10000. ברירת מחדל 1000. **/

7 limit?: number

8 skip?: number

9 before?: number

10 after?: number

11 /** רק אירועים שבוצעו על ידי שם משתמש זה. **/

12 username?: string

13 /** רק אירועים מכתובת IP זו. **/

14 ip?: string

15 /** רק אירועים מסוג זה. **/

16 crudType?: 'c' | 'r' | 'u' | 'd' | 'login'

17 /** רק אירועים עבור משאב זה, למשל משתמש או מודרטור. **/

18 resourceName?: string

19 /** רק אירועים שהאובייקט המושפע שלהם בעל מזהה זה. **/

20 targetId?: string

21 /** התאמת תת-מחרוזת ללא תלות ברישיות על תווית האובייקט המושפע. **/

22 target?: string

23 /** גם החזר אירועים משוכרים שהשוכר הזה מנהל. **/

24 includeManagedTenants?: boolean

25}

26

מבנה תגובת AuditLog

Copy

1

2interface AuditLogsResponse {

3 status: 'success' | 'failed'

4 /** כלול בכשל. **/

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

6 /** כלול בכשל. **/

7 reason?: string

8 /** הלוגים! **/

9 auditLogs: AuditLog[]

10}

11

API זה משמש לקבלת תגובות להצגה למשתמש. לדוגמה, הוא מסנן אוטומטית תגובות שלא אושרו או תגובות ספאם.

Pagination

ניתן לבצע דפדוף באחת משתי דרכים, בהתאם לדרישות הביצועים ולמקרה השימוש:

1. הכי מהיר: Precalculated Pagination:
   1. זהו האופן שבו FastComments פועל כאשר אתה משתמש בווידג'טים ובקלאיינטים המוכנים שלנו.
   2. לחיצה על "הבא" פשוט מגדילה את מספר העמוד.
   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.

Threads

1. כאשר משתמשים ב-Precalculated Pagination, תגובות מקובצות לפי page והתגובות בשרשורים משפיעות על העמוד הכולל.
   1. בצורה זו, ניתן לקבוע שרשורים בצד הלקוח בהתבסס על parentId.
   2. לדוגמה, בעמוד עם תגובה ברמה העליונה אחת ו-29 תגובות, והגדרת page=0 ב-API - תקבל רק את התגובה ברמה העליונה ואת 29 הילדים.
2. כאשר משתמשים ב-Flexible Pagination, ניתן להגדיר פרמטר parentId.
   1. הגדר זאת ל-null כדי לקבל רק תגובות ברמה העליונה.
   2. לאחר מכן, כדי לצפות בשרשורים, קרא שוב ל-API והעבר parentId.
   3. פתרון נפוץ הוא לבצע קריאת API לקבלת תגובות ברמה העליונה ולאחר מכן לבצע קריאות API מקבילות לקבלת תגובות הילדים של כל תגובה.
3. NEW As of Feb 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 לפי הצורך.

Trees Explained

כאשר משתמשים ב-asTree, קשה להבין את הדפדוף. הנה גרפיקה שימושית:

Tree Pagination Diagram

Fetching Comments in The Context of a User

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

Get Comments as a Tree

אפשר לקבל את התגובות כמבנה עץ, כאשר הדפדוף סופר רק את התגובות ברמה העליונה.

הערות כעץ בהקשר של משתמש

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

עם זאת, בממשק המשתמש שלך ייתכן שתצטרך לדעת האם להציג כפתור "הצגת תגובות" על כל תגובה. כאשר משיגים תגובות באמצעות עץ, קיימת תכונה hasChildren שמתוייגת לתגובות במידת הצורך.

Get Comments as a Tree, Searching by Hash Tag

אפשר לחפש לפי תגית באמצעות ה-API, בכל השוכר שלך (לא מוגבל לעמוד אחד או ל-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

All Request Params

מבנה בקשת הערות

Copy

1

2interface CommentsRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** ה-`urlId` (כתובת העמוד או מזהה המאמר) שהתגובות משויכות אליו. **/

6 urlId?: string

7 /** מגביל את התגובות המוחזרות על ידי משתמש זה. **/

8 userId?: string

9 /** השתמש בזה לחיפוש לפי תגית. כדי לצלול לחיתוך של מספר תגיות, השתמש ב-&hashTag=a&hashTag=b. **/

10 hashTag?: string

11 /** כיוון המיון. ברירת המחדל היא MR (הכי רלוונטי). אפשרויות אחרות הן OF (הישן ביותר ראשון) ו-NF (החדש ביותר ראשון). **/

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

13 /** דפדוף מחושב מראש: העמוד שיש להביא, מתחיל ב-0. העבר -1 לכל התגובות (עד 250). **/

14 page?: number

15 /** דפדוף גמיש: כמה תגובות עלינו להחזיר? **/

16 limit?: number

17 /** דפדוף גמיש: כמה תגובות ילדים יש להחזיר לכל הורה? **/

18 limitChildren?: number

19 /** דפדוף גמיש: כמה תגובות יש לדלג? **/

20 skip?: number

21 /** דפדוף גמיש: כמה תגובות ילדים יש לדלג עבור כל הורה? **/

22 skipChildren?: number

23 /** לקביעת תגובות חסומות ומסומנות. **/

24 contextUserId?: string

25 /** לקביעת תגובות חסומות ומסומנות. **/

26 anonUserId?: string

27 /** לקבלת תגובות ילדים. **/

28 parentId?: string

29 /** לקבלת תגובות כעץ. **/

30 asTree?: boolean

31 /** עד כמה בעץ נחזיר נתונים? 0 מחזיר ללא ילדים. 1 מחזיר את הילדים הישירים, וכן הלאה. **/

32 maxTreeDepth?: number

33}

34

The Response

מבנה תגובת הערות

Copy

1

2interface CommentsResponse {

3 status: 'success' | 'failed'

4 /** נכלל במקרה של כשל. **/

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 /** נכלל במקרה של כשל. **/

7 reason?: string

8 /** התגובות! **/

9 comments: Comment[]

10}

11

Helpful Tips

URL ID

סביר להניח שתרצה להשתמש ב-API Comment עם הפרמטר urlId. ניתן לקרוא ל-API Pages תחילה, כדי לראות איך נראות ערכי urlId הזמינים עבורך.

Anonymous Actions

בצורת תגובה אנונימית סביר להניח שתרצה להעביר anonUserId בעת שליפת תגובות, וכן בעת סימון והחסימה.

(!) זה נדרש ברבים מחנויות האפליקציות מכיוון שמשתמשים חייבים להיות מסוגלים לסמן תוכן שנוצר על ידי משתמשים שהם רואים, גם אם הם לא מחוברים. חוסר פעולה זו עלול לגרום להסרת האפליקציה שלך מהחנות.

Comments Not Being Returned

ודא שהתגובות שלך אושרו ואינן ספאם.

API זה מספק את היכולת לאחזר תגובה בודדת לפי מזהה.

דוגמת cURL לאחזור תגובה לפי מזהה

Copy

1

2curl --request GET \

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

4

מבנה בקשת אחזור תגובה לפי מזהה

Copy

1

2interface CommentsGetByIdQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

מבנה תגובת אחזור תגובה לפי מזהה

Copy

1

2interface CommentGetByIdResponse {

3 status: 'success' | 'failed'

4 /** Included on failure. **/

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

6 /** Included on failure. **/

7 reason?: string

8 /** The comment! **/

9 comment?: Comment

10}

11

נקודת קצה 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 /** 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. **/

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 /** 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';

7 /** Included on failure. **/

8 reason?: string

9 /** The created comment. **/

10 comment?: Comment

11 /** The associated user, which may or may not have already existed. **/

12 user?: User

13}

14

נקודת קצה זו של ה-API מספקת את היכולת לעדכן תגובה אחת.

הערות:

• API זה יכול לעדכן את ווידג'ט התגובות "בזמן אמת" אם רצוי (זה מגדיל את ה-creditsCost הבסיסי מ-1 ל-2).
  • זה יכול לגרום להגירת תגובות בין עמודים להיות "בזמן אמת" (שינוי של urlId).
  • הגירות עולות בנוסף 2 קרדיטים כיוון שהעמודים מחושבים מראש וזאת פעולה עתירת CPU.
• בניגוד ל-API של יצירה, API זה לא יווצר אוטומטית אובייקטי משתמש במערכת שלנו אם מסופק אימייל.
• תגובות שמעודכנות דרך API זה עדיין יכולות להיבדק כספאם אם רצוי.
• הגדרות כגון אורכו המרבי של תגובה, אם הוגדרו דרך דף הניהול של כלל ההתאמה (Customization Rule), יחולו כאן.
• כדי לאפשר למשתמשים לעדכן את טקסט התגובה שלהם, ניתן פשוט לציין את comment בגוף הבקשה. אנו נייצר את ה-commentHTML הנובע.
  • אם תגדיר גם comment וגם commentHTML לא נייצר את ה-HTML באופן אוטומטי.
  • אם המשתמש יוסיף אזכורים או האשטגים בטקסט החדש שלו, הם עדיין יעובדו כמו ב-API ה-POST.
• בעת עדכון 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 זה יכול לעדכן את ווידג'ט התגובות "בלייב" אם רצוי (זה מעלה את 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 /** האם יש למחוק את התגובה "בלייב" עבור משתמשים הצופים במופעים של ווידג'ט התגובות עם אותו urlId. שימו לב: מכפיל את עלות האשראי מ-1 ל-2. **/

8 isLive?: 'true' | 'false'

9}

10

מבנה תגובת מחיקת תגובה

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, משתמש SSO או משתמש שוכר.
• אם מוגדר סף דיווח-להסתרה, התגובה תוסתר אוטומטית בזמן אמת לאחר שדווחה את מספר הפעמים המוגדר.
• לאחר שהיא מאושרת אוטומטית (מוסתרת) - התגובה יכולה להיות מאושרת מחדש רק על ידי מנהל או מנחה. ביטול הדיווח לא יאשר מחדש את התגובה.

דוגמת 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. זה יכול להיות מזהה שמייצג את ההפעלה האנונימית, או 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 /** Included on failure. **/

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

7 /** Included on failure. **/

8 reason?: string

9 /** Was the comment un-approved (hidden) due to being flagged too many times? **/

10 wasUnapproved?: boolean;

11}

12

נקודת קצה API זו מספקת את היכולת לבטל דיווח על תגובה עבור משתמש ספציפי.

הערות:

• קריאה זו חייבת תמיד להיעשות בהקשר של משתמש. המשתמש יכול להיות משתמש FastComments.com, משתמש SSO או משתמש שוכר.
• לאחר שתגובה מאושרת אוטומטית (מוסתרת) - התגובה יכולה להיות מאושרת מחדש רק על ידי מנהל או מנחה. ביטול הדיווח לא יאשר מחדש את התגובה.

דוגמת 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 /** Included on failure. **/

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

7 /** Included on failure. **/

8 reason?: string

9}

10

נקודת קצה API זו מספקת את היכולת לחסום משתמש שכתב תגובה נתונה. היא תומכת בחסימה מתגובות שנכתבו על ידי משתמשי FastComments.com, משתמשי SSO ומשתמשי שוכר.

היא תומכת בפרמטר גוף commentIdsToCheck כדי לבדוק אם תגובות אחרות שעלולות להיות גלויות בלקוח צריכות להיחסם/להיפתח לאחר ביצוע פעולה זו.

הערות:

• קריאה זו חייבת תמיד להיעשות בהקשר של משתמש. המשתמש יכול להיות משתמש FastComments.com, משתמש SSO או משתמש שוכר.
• ה-userId בבקשה הוא המשתמש שמבצע את החסימה. לדוגמה: משתמש א' רוצה לחסום את משתמש ב'. העבר userId=משתמש א' ואת מזהה התגובה שמשתמש ב' כתב.
• תגובות אנונימיות לחלוטין (ללא מזהה משתמש, ללא אימייל) לא ניתנות לחסימה ושגיאה תוחזר.

דוגמת 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. זה יכול להיות מזהה שמייצג את ההפעלה האנונימית, או 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 /** Included on failure. **/

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

7 /** Included on failure. **/

8 reason?: string

9 /** If commentIdsToCheck is defined, entries in this map with true are also blocked. **/

10 commentStatuses?: Record<string, boolean>;

11}

12

נקודת קצה API זו מספקת את היכולת לבטל חסימה של משתמש שכתב תגובה נתונה. היא תומכת בביטול חסימה מתגובות שנכתבו על ידי משתמשי FastComments.com, משתמשי SSO ומשתמשי שוכר.

היא תומכת בפרמטר גוף commentIdsToCheck כדי לבדוק אם תגובות אחרות שעלולות להיות גלויות בלקוח צריכות להיחסם/להיפתח לאחר ביצוע פעולה זו.

הערות:

• קריאה זו חייבת תמיד להיעשות בהקשר של משתמש. המשתמש יכול להיות משתמש FastComments.com, משתמש SSO או משתמש שוכר.
• ה-userId בבקשה הוא המשתמש שמבצע את ביטול החסימה. לדוגמה: משתמש א' רוצה לבטל חסימה של משתמש ב'. העבר userId=משתמש א' ואת מזהה התגובה שמשתמש ב' כתב.
• תגובות אנונימיות לחלוטין (ללא מזהה משתמש, ללא אימייל) לא ניתנות לחסימה ושגיאה תוחזר.

דוגמת cURL לביטול חסימת תגובה

Copy

1

2curl --request POST \

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

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

5

דוגמת cURL לביטול חסימת תגובה אנונימית

Copy

1

2curl --request POST \

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

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

5

מבנה בקשת ביטול חסימת תגובה

Copy

1

2interface CommentUnBlockQueryParams {

3 tenantId: string

4 API_KEY: string

5 userId?: string

6 anonUserId?: string

7 commentIdsToCheck?: string[]

8}

9

מבנה תגובת ביטול חסימת תגובה

Copy

1

2

3interface CommentUnBlockResponse {

4 status: 'success' | 'failed'

5 /** Included on failure. **/

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

7 /** Included on failure. **/

8 reason?: string

9 /** If commentIdsToCheck is defined, entries in this map with true are still blocked. If false, you might want to un-hide the comments from the user so they don't have to refresh. **/

10 commentStatuses?: Record<string, boolean>;

11}

12

ניתן לאחזר תבניות אימייל בודדות לפי ה-id התואם שלהן (לא emailTemplateId).

דוגמת cURL לתבנית אימייל לפי מזהה

Copy

1

2curl --request GET \

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

4

מבנה בקשת תבנית אימייל לפי מזהה

Copy

1

2interface EmailTemplatesByIdRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

מבנה תגובת תבנית אימייל לפי מזהה

Copy

1

2interface EmailTemplateResponse {

3 status: 'success' | 'failed'

4 /** Included on failure. **/

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

6 /** Included on failure. **/

7 reason?: string

8 emailTemplate?: EmailTemplate | null

9}

10

API זה משתמש בעימוד, המסופק על ידי פרמטר השאילתה page. תבניות אימייל מוחזרות בעמודים של 100, ממוינות לפי createdAt ולאחר מכן id.

דוגמת 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

מבנה בקשת תבנית אימייל

Copy

1

2interface EmailTemplatesRequestQueryParams {

3 tenantId: string

4 API_KEY: string

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

6 page: number

7}

8

מבנה תגובת תבנית אימייל

Copy

1

2interface EmailTemplatesResponse {

3 status: 'success' | 'failed'

4 /** Included on failure. **/

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

6 /** Included on failure. **/

7 reason?: string

8 emailTemplates: EmailTemplate[]

9}

10

נקודת קצה API זו מספקת את היכולת לעדכן תבנית אימייל על ידי ציון המזהה והמאפיינים לעדכון בלבד.

שים לב שכל אותן בדיקות אימות ליצירת תבנית חלות גם כן, לדוגמה:

• התבנית חייבת להירנדר. זה נבדק עם כל עדכון.
• לא יכולות להיות תבניות כפולות לאותו דומיין (אחרת אחת תתעלם בשקט).

דוגמת cURL ל-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

מבנה בקשת PATCH תבנית אימייל

Copy

1

2interface EmailTemplatePatchQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

מבנה תגובת PATCH תבנית אימייל

Copy

1

2

3interface EmailTemplatePatchResponse {

4 status: 'success' | 'failed'

5 /** Included on failure. **/

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

7 /** Included on failure. **/

8 reason?: string

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

10 emailTemplate?: EmailTemplate

11}

12

נקודת קצה API זו מספקת את היכולת ליצור תבניות אימייל.

הערות:

• לא יכולות להיות מספר תבניות עם אותו emailTemplateId עם אותו דומיין.
• אבל אתה יכול לקבל תבנית עם תו כללי (domain = * ותבנית ספציפית לדומיין לאותו emailTemplateId).
• ציון domain רלוונטי רק אם יש לך דומיינים שונים, או רוצה להשתמש בתבניות ספציפיות לבדיקות (domain מוגדר ל-localhost וכד').
• אם אתה כן מציין domain הוא חייב להתאים ל-DomainConfig. בשגיאה מסופקת רשימה של דומיינים חוקיים.
• תחביר התבנית הוא EJS והיא מרונדרת עם timeout של 500ms. P99 לרנדור הוא <5ms, אז אם אתה מגיע ל-500ms משהו לא בסדר.
• התבנית שלך חייבת להירנדר עם ה-testData הנתון כדי להישמר. שגיאות רנדור נאספות ומדווחות בדשבורד (בקרוב יהיה זמין דרך API).

הנתונים המינימליים הנדרשים להוספת תבנית הם כדלקמן:

דוגמת cURL מינימלית ל-POST תבנית אימייל

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:

דוגמת cURL ל-POST תבנית אימייל

Copy

1

2curl --request POST \

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

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

5 --data '{

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

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

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

9 "domain": "somespecificsite.com",

10}'

11

מבנה בקשת POST תבנית אימייל

Copy

1

2interface EmailTemplatePostQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

מבנה תגובת POST תבנית אימייל

Copy

1

2

3interface EmailTemplatePostResponse {

4 status: 'success' | 'failed'

5 /** Included on failure. **/

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

7 /** Included on failure. **/

8 reason?: string

9 /** The created template. **/

10 emailTemplate?: EmailTemplate

11}

12

נקודת קצה 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 /** Included on failure. **/

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

7 /** Included on failure. **/

8 reason?: string

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

10 html?: string

11}

12

נתיב זה מספק הסרה של EmailTemplate יחידה לפי מזהה.

דוגמת cURL להסרת תבנית אימייל

Copy

1

2curl --request DELETE \

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

4

מבנה בקשת הסרת תבנית אימייל

Copy

1

2interface EmailTemplateRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

מבנה תגובת הסרת תבנית אימייל

Copy

1

2interface EmailTemplateDeleteResponse {

3 status: 'success' | 'failed'

4 /** Included on failure. **/

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

6 /** Included on failure. **/

7 reason?: string

8}

9

מקבל פוסטים בתזרים, חדשים תחילה. הדפדוף מבוסס על סמן: העבר את ה-_id של הפוסט האחרון שקיבלת כ-afterId כדי לקבל את העמוד הבא.

עולה קרדיט אחד לכל עשרה פוסטים שמוחזרים, עם מינימום של קרדיט אחד.

דוגמת cURL של FeedPost

Copy

1

2curl --request GET \

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

4

מבנה בקשת FeedPost

Copy

1

2interface FeedPostsRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** החזר פוסטים אחרי מזהה הפוסט הזה. השמט עבור העמוד הראשון. **/

6 afterId?: string

7 /** ברירת מחדל היא 10. מקסימום 1000. **/

8 limit?: number

9 /** החזר רק פוסטים עם התגים האלה. חזור על הפרמטר עבור יותר מתג אחד. **/

10 tags?: string[]

11}

12

מבנה תגובת FeedPost

Copy

1

2interface FeedPostsResponse {

3 status: 'success' | 'failed'

4 /** נכלל במקרה של כשל. **/

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

6 /** נכלל במקרה של כשל. **/

7 reason?: string

8 feedPosts: FeedPost[]

9}

10

נתיב זה יוצר FeedPost יחיד. לכל פוסט יש מחבר, ולכן fromUserId נדרש וחייב להיות המזהה של משתמש FastComments או SSO קיים בחשבון.

דוגמת cURL ליצירת FeedPost

Copy

1

2curl --request POST \

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

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

5 --data '{

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

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

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

9 "tags": ["releases"],

10 "links": [

11 {

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

13 "title": "Release notes",

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

15 }

16 ]

17}'

18

מבנה בקשת יצירת FeedPost

Copy

1

2interface FeedPostPostQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** לדחוף את הפוסט לפידים הפתוחים כרגע בדפדפן. ברירת מחדל היא false. **/

6 isLive?: boolean

7 /** להריץ את הפוסט דרך מנוע הספאם לפני השמירה. ברירת מחדל היא false. **/

8 doSpamCheck?: boolean

9 /** לדלג על בדיקת תוכן חוזר שמופעלת כחלק מ‑doSpamCheck. ברירת מחדל היא false. **/

10 skipDupCheck?: boolean

11 /** עד 256 תווים. משודר למאזינים חיים כך שלקוח יכול להתעלם מהשידור שלו עצמו. **/

12 broadcastId?: string

13}

14

15interface FeedPostPostBody {

16 /** נדרש. מזהה משתמש FastComments או SSO. **/

17 fromUserId: string

18 title?: string

19 /** HTML. מנוקה בעת השמירה. **/

20 contentHTML?: string

21 /** מתעלם משם התצוגה שנלקח מהמשתמש. **/

22 fromUserDisplayName?: string

23 tags?: string[]

24 media?: FeedPostMediaItem[]

25 links?: FeedPostLink[]

26 meta?: Record<string, string>

27}

28

מבנה תגובת יצירת FeedPost

Copy

1

2interface FeedPostPostResponse {

3 status: 'success' | 'failed'

4 /** נכלל במקרה של כשל. **/

5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-from-user-id' | 'invalid-user' | 'broadcast-id-too-long' | 'spam-blocked' | 'user-rate-limited' | 'internal'

6 /** נכלל במקרה של כשל. **/

7 reason?: string

8 feedPost?: FeedPost; // אנו מחזירים את הפוסט המלא שנוצר בהצלחה.

9}

10

נתיב זה מעדכן פוסט יחיד FeedPost. שלח רק את השדות שברצונך לשנות.

דוגמת cURL לעדכון FeedPost

Copy

1

2curl --request PATCH \

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

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

5 --data '{

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

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

8}'

9

מבנה בקשת עדכון FeedPost

Copy

1

2interface FeedPostPatchQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

7/** כל שדה שניתן לכתיבה ממבנה FeedPost. **/

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

9

מבנה תגובת עדכון FeedPost

Copy

1

2interface FeedPostPatchResponse {

3 status: 'success' | 'failed'

4 /** כלול במקרה של כשל. **/

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

6 /** כלול במקרה של כשל. **/

7 reason?: string

8}

9

API זה משתמש בעימוד, המסופק על ידי פרמטר השאילתה page. האשטאגים מוחזרים בעמודים של 100, ממוינים לפי tag.

דוגמת 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

מבנה בקשת האשטאג

Copy

1

2interface HashTagsRequestQueryParams {

3 tenantId: string

4 API_KEY: string

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

6 page: number

7}

8

מבנה תגובת האשטאג

Copy

1

2interface HashTagsResponse {

3 status: 'success' | 'failed'

4 /** Included on failure. **/

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

6 /** Included on failure. **/

7 reason?: string

8 /** The hashtags! **/

9 hashTags: HashTag[]

10}

11

נתיב זה מספק את היכולת לעדכן HashTag יחיד.

דוגמת cURL לעדכון האשטאג

Copy

1

2curl --request PATCH \

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

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

5 --data '{

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

7}'

8

מבנה בקשת עדכון האשטאג

Copy

1

2interface HashTagPatchQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

מבנה תגובת עדכון האשטאג

Copy

1

2interface HashTagPatchResponse {

3 status: 'success' | 'failed'

4 /** Included on failure. **/

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

6 /** Included on failure. **/

7 reason?: string

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

9}

10

נתיב זה מספק את היכולת להוסיף HashTag יחיד.

דוגמת 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

מבנה בקשת יצירת האשטאג

Copy

1

2interface HashTagPostQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

מבנה תגובת יצירת האשטאג

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

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

6 /** Included on failure. **/

7 reason?: string

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

9}

10