FastComments SDK לפייתון

Using Authenticated APIs (DefaultApi)

חשוב: עליך להגדיר את מפתח ה‑API שלך ב‑Configuration לפני ביצוע בקשות מאומתות. אם לא תעשה זאת, הבקשות יכשלו עם שגיאת 401.

from client import ApiClient, Configuration, DefaultApi
from client.models import CreateAPISSOUserData

# יצור והגדרת לקוח ה‑API
config = Configuration()
config.host = "https://fastcomments.com"

# חובה: הגדר את מפתח ה‑API שלך (קבל זאת מלוח הבקרה של FastComments)
config.api_key = {"api_key": "YOUR_API_KEY_HERE"}

# צור את מופע ה‑API עם הלקוח המוגדר
api_client = ApiClient(configuration=config)
api = DefaultApi(api_client)

# עכשיו ניתן לבצע קריאות API מאומתות
try:
    # דוגמה: הוספת משתמש SSO
    user_data = CreateAPISSOUserData(
        id="user-123",
        email="user@example.com",
        display_name="John Doe"
    )

    response = api.add_sso_user("YOUR_TENANT_ID", user_data)
    print(f"User created: {response}")

except Exception as e:
    print(f"Error: {e}")
    # שגיאות נפוצות:
    # - 401: מפתח ה‑API חסר או לא תקין
    # - 400: אימות הבקשה נכשל

Using Public APIs (PublicApi)

Public endpoints don't require authentication:

from client import ApiClient, Configuration, PublicApi

config = Configuration()
config.host = "https://fastcomments.com"

api_client = ApiClient(configuration=config)
public_api = PublicApi(api_client)

try:
    response = public_api.get_comments_public("YOUR_TENANT_ID", "page-url-id")
    print(response)
except Exception as e:
    print(f"Error: {e}")

Using the Moderation Dashboard (ModerationApi)

The ModerationApi powers the moderator dashboard. Methods are called on behalf of a moderator by passing an sso token:

from client import ApiClient, Configuration, ModerationApi
from client.api.moderation_api import GetCountOptions

config = Configuration()
config.host = "https://fastcomments.com"

api_client = ApiClient(configuration=config)
moderation_api = ModerationApi(api_client)

try:
    # ספירת ההערות שממתינות למודעות
    response = moderation_api.get_count(GetCountOptions(sso="SSO_TOKEN"))
    print(response)
except Exception as e:
    print(f"Error: {e}")

Using SSO (Single Sign-On)

The SDK includes utilities for generating secure SSO tokens:

from sso import FastCommentsSSO, SecureSSOUserData

# יצירת נתוני משתמש (id, email, ו‑username נדרשים)
user_data = SecureSSOUserData(
    id="user-123",
    email="user@example.com",
    username="johndoe",
    avatar="https://example.com/avatar.jpg"
)

# חתימה עם סוד ה‑API שלך (HMAC‑SHA256)
sso = FastCommentsSSO.new_secure("YOUR_API_SECRET", user_data)

# יצירת טוקן SSO להעברה לווידג'ט או לקריאת API
sso_token = sso.create_token()

# השתמש בטוקן זה בממשק הקדמי או העבר אותו לקריאות API
print(f"SSO Token: {sso_token}")

For simple SSO (less secure, for testing):

from sso import FastCommentsSSO, SimpleSSOUserData

user_data = SimpleSSOUserData(
    username="johndoe",
    email="user@example.com"
)

sso = FastCommentsSSO.new_simple(user_data)
sso_token = sso.create_token()

Common Issues

1. שגיאת 401 "missing-api-key": ודא שהגדרת config.api_key = {"api_key": "YOUR_KEY"} לפני יצירת מופע ה‑DefaultApi.
2. מחלקת API שגויה: השתמש ב‑DefaultApi לבקשות מאומתות בצד השרת, ב‑PublicApi לבקשות ציבוריות/צד הלקוח, וב‑ModerationApi לבקשות מדף המודרטור.
3. שגיאות ייבוא: ודא שאתה מייבא מהמודול הנכון:
   • לקוח API: from client import ...
   • כלי SSO: from sso import ...

Aggregates documents by grouping them (if groupBy is provided) and applying multiple operations. Different operations (e.g. sum, countDistinct, avg, etc.) are supported.

Parameters

Response

מחזירה: AggregateResponse

Example

דוגמת אגירה

Copy

1

2import client

3from client.api.default_api import AggregateOptions

4from client.models.aggregate_response import AggregateResponse

5from client.models.aggregation_request import AggregationRequest

6from client.rest import ApiException

7from pprint import pprint

8

9# הגדרת המארח היא אופציונלית והערך ברירת המחדל הוא https://fastcomments.com

10# ראה configuration.py לקבלת רשימה של כל פרמטרי ההגדרות הנתמכים.

11# על הלקוח להגדיר את פרמטרי האימות והאישור

12# בהתאם למדיניות האבטחה של השרת.

13# דוגמאות לכל שיטת אימות מוצגות למטה, השתמשו בדוגמה

14# המתאימה למקרה השימוש שלכם.

15

16# הגדרת אימות מפתח API: api_key

17configuration.api_key['api_key'] = os.environ["API_KEY"]

18

19# בטלו את ההערה למטה כדי להוסיף קידומת (למשל Bearer) למפתח ה‑API, אם נדרש

20# configuration.api_key_prefix['api_key'] = 'Bearer'

21

22# הכנסו להקשר עם מופע של לקוח ה‑API

23with client.ApiClient(configuration) as api_client:

24 # צור מופע של מחלקת ה‑API

25 api_instance = client.DefaultApi(api_client)

26 tenant_id = 'tenant_id_example' # str |

27 aggregation_request = client.AggregationRequest() # AggregationRequest |

28 parent_tenant_id = 'parent_tenant_id_example' # str | (אופציונלי)

29 include_stats = True # bool | (אופציונלי)

30

31 try:

32 api_response = api_instance.aggregate(tenant_id, aggregation_request, AggregateOptions(parent_tenant_id=parent_tenant_id, include_stats=include_stats))

33 print("The response of DefaultApi->aggregate:\n")

34 pprint(api_response)

35 except Exception as e:

36 print("Exception when calling DefaultApi->aggregate: %s\n" % e)

37

פרמטרים

תגובה

מחזיר: GetAuditLogsResponse

דוגמה

דוגמה ל‑get_audit_logs

Copy

1

2import client

3from client.api.default_api import GetAuditLogsOptions

4from client.models.get_audit_logs_response import GetAuditLogsResponse

5from client.models.sortdir import SORTDIR

6from client.rest import ApiException

7from pprint import pprint

8

9# הגדרת המארח היא אופציונלית ומוגדרת כברירת מחדל ל‑https://fastcomments.com

10# ראו configuration.py לקבלת רשימה של כל פרמטרי התצורה הנתמכים.

11configuration = client.Configuration(

12 host = "https://fastcomments.com"

13)

14

15# הלקוח חייב להגדיר את פרמטרי האימות וההרשאות

16# בהתאם למדיניות האבטחה של שרת ה‑API.

17# דוגמאות לכל שיטת אימות מסופקות למטה, השתמשו בדוגמה המתאימה

18# למקרה השימוש שלכם באימות.

19

20# הגדרת הרשאת מפתח API: api_key

21configuration.api_key['api_key'] = os.environ["API_KEY"]

22

23# בטלו את ההערה בקו הבא כדי להגדיר קידומת (למשל Bearer) למפתח ה‑API, אם נדרש

24# configuration.api_key_prefix['api_key'] = 'Bearer'

25

26# פתחו הקשר עם מופע של לקוח ה‑API

27with client.ApiClient(configuration) as api_client:

28 # צרו מופע של מחלקת ה‑API

29 api_instance = client.DefaultApi(api_client)

30 tenant_id = 'tenant_id_example' # str |

31 limit = 3.4 # float | (optional)

32 skip = 3.4 # float | (optional)

33 order = client.SORTDIR() # SORTDIR | (optional)

34 after = 3.4 # float | (optional)

35 before = 3.4 # float | (optional)

36

37 try:

38 api_response = api_instance.get_audit_logs(tenant_id, GetAuditLogsOptions(limit=limit, skip=skip, order=order, after=after, before=before))

39 print("The response of DefaultApi->get_audit_logs:\n")

40 pprint(api_response)

41 except Exception as e:

42 print("Exception when calling DefaultApi->get_audit_logs: %s\n" % e)

43

תגובה

מחזיר: APIEmptyResponse

דוגמה

דוגמה ל-logout_public

Copy

1

2import client

3from client.models.api_empty_response import APIEmptyResponse

4from client.rest import ApiException

5from pprint import pprint

6

7# הגדרת ה-host אינה חובה וברירת המחדל היא https://fastcomments.com

8# עיין בקובץ configuration.py לקבלת רשימה של כל פרמטרי התצורה הנתמכים.

9configuration = client.Configuration(

10 host = "https://fastcomments.com"

11)

12

13

14# הכנס להקשר עם מופע של לקוח ה-API

15with client.ApiClient(configuration) as api_client:

16 # צור מופע של מחלקת ה-API

17 api_instance = client.PublicApi(api_client)

18

19 try:

20 api_response = api_instance.logout_public()

21 print("The response of PublicApi->logout_public:\n")

22 pprint(api_response)

23 except Exception as e:

24 print("Exception when calling PublicApi->logout_public: %s\n" % e)

25

פרמטרים

תגובה

מחזיר: BlockSuccess

דוגמה

דוגמה של block_from_comment_public

Copy

1

2import client

3from client.models.block_success import BlockSuccess

4from client.models.public_block_from_comment_params import PublicBlockFromCommentParams

5from client.rest import ApiException

6from pprint import pprint

7

8# קביעת ה-host אופציונלית ובברירת המחדל היא https://fastcomments.com

9# עיין ב-configuration.py לרשימת כל פרמטרי התצורה הנתמכים.

10configuration = client.Configuration(

11 host = "https://fastcomments.com"

12)

13

14

15# הכנס להקשר עם מופע של ה-API client

16with client.ApiClient(configuration) as api_client:

17 # צור מופע של מחלקת ה-API

18 api_instance = client.PublicApi(api_client)

19 tenant_id = 'tenant_id_example' # str |

20 comment_id = 'comment_id_example' # str |

21 public_block_from_comment_params = client.PublicBlockFromCommentParams() # PublicBlockFromCommentParams |

22 sso = 'sso_example' # str | (אופציונלי)

23

24 try:

25 api_response = api_instance.block_from_comment_public(tenant_id, comment_id, public_block_from_comment_params, sso=sso)

26 print("The response of PublicApi->block_from_comment_public:\n")

27 pprint(api_response)

28 except Exception as e:

29 print("Exception when calling PublicApi->block_from_comment_public: %s\n" % e)

30

Parameters

תגובה

מחזיר: UnblockSuccess

דוגמה

דוגמה ל-un_block_comment_public

Copy

1

2import client

3from client.models.public_block_from_comment_params import PublicBlockFromCommentParams

4from client.models.unblock_success import UnblockSuccess

5from client.rest import ApiException

6from pprint import pprint

7

8# הגדרת ה-host אופציונלית והברירת מחדל היא https://fastcomments.com

9# ראה configuration.py לקבלת רשימה של כל פרמטרי התצורה הנתמכים.

10configuration = client.Configuration(

11 host = "https://fastcomments.com"

12)

13

14

15# נכנס להקשר עם מופע של לקוח ה-API

16with client.ApiClient(configuration) as api_client:

17 # צור מופע של מחלקת ה-API

18 api_instance = client.PublicApi(api_client)

19 tenant_id = 'tenant_id_example' # str |

20 comment_id = 'comment_id_example' # str |

21 public_block_from_comment_params = client.PublicBlockFromCommentParams() # PublicBlockFromCommentParams |

22 sso = 'sso_example' # str | (optional)

23

24 try:

25 api_response = api_instance.un_block_comment_public(tenant_id, comment_id, public_block_from_comment_params, sso=sso)

26 print("The response of PublicApi->un_block_comment_public:\n")

27 pprint(api_response)

28 except Exception as e:

29 print("Exception when calling PublicApi->un_block_comment_public: %s\n" % e)

30

פרמטרים

תגובה

מחזיר: CheckBlockedCommentsResponse

דוגמה

דוגמה ל-checked_comments_for_blocked

Copy

1

2import client

3from client.models.check_blocked_comments_response import CheckBlockedCommentsResponse

4from client.rest import ApiException

5from pprint import pprint

6

7# הגדרת ה-host היא אופציונלית וברירת המחדל היא https://fastcomments.com

8# ראה configuration.py לרשימת כל פרמטרי הקונפיגורציה הנתמכים.

9configuration = client.Configuration(

10 host = "https://fastcomments.com"

11)

12

13

14# נכנסים לקונטקסט עם מופע של לקוח ה-API

15with client.ApiClient(configuration) as api_client:

16 # צור מופע של מחלקת ה-API

17 api_instance = client.PublicApi(api_client)

18 tenant_id = 'tenant_id_example' # str |

19 comment_ids = 'comment_ids_example' # str | רשימת מזהי תגובות מופרדת בפסיקים.

20 sso = 'sso_example' # str | (אופציונלי)

21

22 try:

23 api_response = api_instance.checked_comments_for_blocked(tenant_id, comment_ids, sso=sso)

24 print("The response of PublicApi->checked_comments_for_blocked:\n")

25 pprint(api_response)

26 except Exception as e:

27 print("Exception when calling PublicApi->checked_comments_for_blocked: %s\n" % e)

28

פרמטרים

תגובה

מחזיר: BlockSuccess

דוגמה

block_user_from_comment דוגמה

Copy

1

2import client

3from client.api.default_api import BlockUserFromCommentOptions

4from client.models.block_from_comment_params import BlockFromCommentParams

5from client.models.block_success import BlockSuccess

6from client.rest import ApiException

7from pprint import pprint

8

9# הגדרת המארח היא אופציונלית והערך ברירת המחדל הוא https://fastcomments.com

10# ראה configuration.py לקבלת רשימה של כל פרמטרי ההגדרה הנתמכים.

11# על הלקוח להגדיר את פרמטרי האימות וההרשאה

12# בהתאם למדיניות האבטחה של שרת ה-API.

13# דוגמאות לכל שיטת אימות מוצגות למטה, השתמשו בדוגמא המתאימה ל

14# הצרכים שלכם.

15# הגדר את האישור באמצעות מפתח API: api_key

16# בטלו את ההערה של הקו מתחת כדי להגדיר קידומת (לדוגמה, Bearer) למפתח ה-API, אם נדרש

17# הכנסו להקשר עם מופע של לקוח ה-API

18with client.ApiClient(configuration) as api_client:

19 # צור מופע של מחלקת ה-API

20 api_instance = client.DefaultApi(api_client)

21 tenant_id = 'tenant_id_example' # str |

22 id = 'id_example' # str |

23 block_from_comment_params = client.BlockFromCommentParams() # BlockFromCommentParams |

24 user_id = 'user_id_example' # str | (optional)

25 anon_user_id = 'anon_user_id_example' # str | (optional)

26

27 try:

28 api_response = api_instance.block_user_from_comment(tenant_id, id, block_from_comment_params, BlockUserFromCommentOptions(user_id=user_id, anon_user_id=anon_user_id))

29 print("The response of DefaultApi->block_user_from_comment:\n")

30 pprint(api_response)

31 except Exception as e:

32 print("Exception when calling DefaultApi->block_user_from_comment: %s\n" % e)

33

פרמטרים

תגובה

מחזיר: SaveCommentsResponseWithPresence

דוגמה

create_comment_public דוגמה

Copy

1

2import client

3from client.api.public_api import CreateCommentPublicOptions

4from client.models.comment_data import CommentData

5from client.models.save_comments_response_with_presence import SaveCommentsResponseWithPresence

6from client.rest import ApiException

7from pprint import pprint

8

9# הגדרת ה-host היא אופציונלית ומוגדרת כברירת מחדל ל-https://fastcomments.com

10# ראה configuration.py עבור רשימת כל פרמטרי ההגדרה הנתמכים.

11configuration = client.Configuration(

12 host = "https://fastcomments.com"

13)

14

15

16# הכנס לקונטקסט עם מופע של ה-API client

17with client.ApiClient(configuration) as api_client:

18 # צור מופע של מחלקת ה-API

19 api_instance = client.PublicApi(api_client)

20 tenant_id = 'tenant_id_example' # str |

21 url_id = 'url_id_example' # str |

22 broadcast_id = 'broadcast_id_example' # str |

23 comment_data = client.CommentData() # CommentData |

24 session_id = 'session_id_example' # str | (לא חובה)

25 sso = 'sso_example' # str | (לא חובה)

26

27 try:

28 api_response = api_instance.create_comment_public(tenant_id, url_id, broadcast_id, comment_data, CreateCommentPublicOptions(session_id=session_id, sso=sso))

29 print("The response of PublicApi->create_comment_public:\n")

30 pprint(api_response)

31 except Exception as e:

32 print("Exception when calling PublicApi->create_comment_public: %s\n" % e)

33

פרמטרים

תגובה

מחזירה: DeleteCommentResult

דוגמה

delete_comment דוגמה

Copy

1

2import client

3from client.api.default_api import DeleteCommentOptions

4from client.models.delete_comment_result import DeleteCommentResult

5from client.rest import ApiException

6from pprint import pprint

7

8# הגדרת המארח היא אופציונלית ומוגדרת כברירת מחדל ל‑https://fastcomments.com

9# ראו configuration.py לקבלת רשימת כל פרמטרי התצורה הנתמכים.

10# הלקוח חייב להגדיר את פרמטרי האימות וההרשאה

11# בהתאם למדיניות האבטחה של שרת ה‑API.

12# דוגמאות לכל שיטת אימות מסופקות למטה, השתמשו בדוגמא שתואמת

13# את משימת האימות שלכם.

14

15# הגדרת הרשאת מפתח API: api_key

16configuration.api_key['api_key'] = os.environ["API_KEY"]

17

18# בטל את ההערה למטה כדי להגדיר קידומת (למשל Bearer) למפתח ה‑API, אם נדרש

19# configuration.api_key_prefix['api_key'] = 'Bearer'

20

21# תחלקו הקשר עם מופע של לקוח ה‑API

22with client.ApiClient(configuration) as api_client:

23 # צרו מופע של מחלקת ה‑API

24 api_instance = client.DefaultApi(api_client)

25 tenant_id = 'tenant_id_example' # str |

26 id = 'id_example' # str |

27 context_user_id = 'context_user_id_example' # str | (optional)

28 is_live = True # bool | (optional)

29

30 try:

31 api_response = api_instance.delete_comment(tenant_id, id, DeleteCommentOptions(context_user_id=context_user_id, is_live=is_live))

32 print("The response of DefaultApi->delete_comment:\n")

33 pprint(api_response)

34 except Exception as e:

35 print("Exception when calling DefaultApi->delete_comment: %s\n" % e)

36

פרמטרים

תגובה

מחזיר: PublicAPIDeleteCommentResponse

דוגמה

delete_comment_public דוגמה

Copy

1

2import client

3from client.api.public_api import DeleteCommentPublicOptions

4from client.models.public_api_delete_comment_response import PublicAPIDeleteCommentResponse

5from client.rest import ApiException

6from pprint import pprint

7

8# הגדרת המארח היא אופציונלית ומוגדרת כברירת מחדל ל-https://fastcomments.com

9# ראה configuration.py לקבלת רשימה של כל פרמטרי ההגדרה הנתמכים.

10configuration = client.Configuration(

11 host = "https://fastcomments.com"

12)

13

14

15# השתמש בהקשר עם מופע של לקוח ה-API

16with client.ApiClient(configuration) as api_client:

17 # צור מופע של מחלקת ה-API

18 api_instance = client.PublicApi(api_client)

19 tenant_id = 'tenant_id_example' # str |

20 comment_id = 'comment_id_example' # str |

21 broadcast_id = 'broadcast_id_example' # str |

22 edit_key = 'edit_key_example' # str | (אופציונלי)

23 sso = 'sso_example' # str | (אופציונלי)

24

25 try:

26 api_response = api_instance.delete_comment_public(tenant_id, comment_id, broadcast_id, DeleteCommentPublicOptions(edit_key=edit_key, sso=sso))

27 print("The response of PublicApi->delete_comment_public:\n")

28 pprint(api_response)

29 except Exception as e:

30 print("Exception when calling PublicApi->delete_comment_public: %s\n" % e)

31

פרמטרים

תגובה

מחזיר: VoteDeleteResponse

דוגמה

delete_comment_vote דוגמה

Copy

1

2import client

3from client.api.public_api import DeleteCommentVoteOptions

4from client.models.vote_delete_response import VoteDeleteResponse

5from client.rest import ApiException

6from pprint import pprint

7

8# הגדרת המארח היא אופציונלית ובברירת מחדל https://fastcomments.com

9# ראו configuration.py עבור רשימה של כל פרמטרי התצורה הנתמכים.

10configuration = client.Configuration(

11 host = "https://fastcomments.com"

12)

13

14

15# הכנסו להקשר עם מופע של לקוח API

16with client.ApiClient(configuration) as api_client:

17 # צור מופע של מחלקת API

18 api_instance = client.PublicApi(api_client)

19 tenant_id = 'tenant_id_example' # str |

20 comment_id = 'comment_id_example' # str |

21 vote_id = 'vote_id_example' # str |

22 url_id = 'url_id_example' # str |

23 broadcast_id = 'broadcast_id_example' # str |

24 edit_key = 'edit_key_example' # str | (לא חובה)

25 sso = 'sso_example' # str | (לא חובה)

26

27 try:

28 api_response = api_instance.delete_comment_vote(tenant_id, comment_id, vote_id, url_id, broadcast_id, DeleteCommentVoteOptions(edit_key=edit_key, sso=sso))

29 print("The response of PublicApi->delete_comment_vote:\n")

30 pprint(api_response)

31 except Exception as e:

32 print("Exception when calling PublicApi->delete_comment_vote: %s\n" % e)

33

פרמטרים

תגובה

מחזיר: FlagCommentResponse

דוגמה

דוגמת flag_comment

Copy

1

2import client

3from client.api.default_api import FlagCommentOptions

4from client.models.flag_comment_response import FlagCommentResponse

5from client.rest import ApiException

6from pprint import pprint

7

8# הגדרת ה‑host היא אופציונלית והערך ברירת המחדל הוא https://fastcomments.com

9# ראה configuration.py לקבלת רשימה של כל פרמטרי הקונפיגורציה הנתמכים.

10# על הלקוח להגדיר את פרמטרי האימות וההרשאה

11# בהתאם למדיניות האבטחה של שרת ה‑API.

12# דוגמאות לכל סוג אימות ניתנות למטה, השתמשו בדוגמה המתאימה למקרה שלכם.

13

14# הגדרת הרשאת מפתח API: api_key

15configuration.api_key['api_key'] = os.environ["API_KEY"]

16

17# בטל את ההערה שלמטה כדי להגדיר קידומת (למשל Bearer) למפתח ה‑API, אם נדרש

18# configuration.api_key_prefix['api_key'] = 'Bearer'

19

20# היכנסו להקשר עם מופע של לקוח ה‑API

21with client.ApiClient(configuration) as api_client:

22 # צור מופע של מחלקת ה‑API

23 api_instance = client.DefaultApi(api_client)

24 tenant_id = 'tenant_id_example' # str |

25 id = 'id_example' # str |

26 user_id = 'user_id_example' # str | (optional)

27 anon_user_id = 'anon_user_id_example' # str | (optional)

28

29 try:

30 api_response = api_instance.flag_comment(tenant_id, id, FlagCommentOptions(user_id=user_id, anon_user_id=anon_user_id))

31 print("The response of DefaultApi->flag_comment:\n")

32 pprint(api_response)

33 except Exception as e:

34 print("Exception when calling DefaultApi->flag_comment: %s\n" % e)

35

פרמטרים

תגובה

מחזיר: APIGetCommentResponse

דוגמה

דוגמה ל-get_comment

Copy

1

2import client

3from client.models.api_get_comment_response import APIGetCommentResponse

4from client.rest import ApiException

5from pprint import pprint

6

7# הגדרת ה-host אופציונלית ומוגדרת כברירת מחדל ל-https://fastcomments.com

8# ראה את configuration.py עבור רשימה של כל פרמטרי התצורה הנתמכים.

9configuration = client.Configuration(

10 host = "https://fastcomments.com"

11)

12

13# על הלקוח להגדיר את פרמטרי האימות וההרשאה

14# בהתאם למדיניות האבטחה של שרת ה-API.

15# דוגמאות לכל שיטת אימות מסופקות להלן; השתמש בדוגמה

16# שמתאימה למקרה השימוש שלך.

17

18# Configure API key authorization: api_key

19configuration.api_key['api_key'] = os.environ["API_KEY"]

20

21# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed

22# configuration.api_key_prefix['api_key'] = 'Bearer'

23

24# הכנס להקשר עם מופע של לקוח ה-API

25with client.ApiClient(configuration) as api_client:

26 # Create an instance of the API class

27 api_instance = client.DefaultApi(api_client)

28 tenant_id = 'tenant_id_example' # str |

29 id = 'id_example' # str |

30

31 try:

32 api_response = api_instance.get_comment(tenant_id, id)

33 print("The response of DefaultApi->get_comment:\n")

34 pprint(api_response)

35 except Exception as e:

36 print("Exception when calling DefaultApi->get_comment: %s\n" % e)

37

פרמטרים

תגובה

מחזירה: PublicAPIGetCommentTextResponse

דוגמה

דוגמת get_comment_text

Copy

1

2import client

3from client.api.public_api import GetCommentTextOptions

4from client.models.public_api_get_comment_text_response import PublicAPIGetCommentTextResponse

5from client.rest import ApiException

6from pprint import pprint

7

8# הגדרת המארח היא אופציונלית ומערכת ברירת המחדל היא https://fastcomments.com

9# ראו configuration.py לקבלת רשימה של כל הפרמטרים הנתמכים.

10configuration = client.Configuration(

11 host = "https://fastcomments.com"

12)

13

14

15# הכנסו להקשר עם מופע של לקוח ה-API

16with client.ApiClient(configuration) as api_client:

17 # צור מופע של מחלקת ה-API

18 api_instance = client.PublicApi(api_client)

19 tenant_id = 'tenant_id_example' # str |

20 comment_id = 'comment_id_example' # str |

21 edit_key = 'edit_key_example' # str | (optional)

22 sso = 'sso_example' # str | (optional)

23

24 try:

25 api_response = api_instance.get_comment_text(tenant_id, comment_id, GetCommentTextOptions(edit_key=edit_key, sso=sso))

26 print("The response of PublicApi->get_comment_text:\n")

27 pprint(api_response)

28 except Exception as e:

29 print("Exception when calling PublicApi->get_comment_text: %s\n" % e)

30

פרמטרים

תגובה

מחזיר: GetCommentVoteUserNamesSuccessResponse

דוגמה

get_comment_vote_user_names דוגמה

Copy

1

2import client

3from client.models.get_comment_vote_user_names_success_response import GetCommentVoteUserNamesSuccessResponse

4from client.rest import ApiException

5from pprint import pprint

6

7# הגדרת ה-host היא אופציונלית וברירת המחדל היא https://fastcomments.com

8# ראה את configuration.py לרשימת כל פרמטרי התצורה הנתמכים.

9configuration = client.Configuration(

10 host = "https://fastcomments.com"

11)

12

13

14# כניסה להקשר עם מופע של לקוח ה-API

15with client.ApiClient(configuration) as api_client:

16 # צור מופע של מחלקת ה-API

17 api_instance = client.PublicApi(api_client)

18 tenant_id = 'tenant_id_example' # str |

19 comment_id = 'comment_id_example' # str |

20 dir = 56 # int |

21 sso = 'sso_example' # str | (אופציונלי)

22

23 try:

24 api_response = api_instance.get_comment_vote_user_names(tenant_id, comment_id, dir, sso=sso)

25 print("The response of PublicApi->get_comment_vote_user_names:\n")

26 pprint(api_response)

27 except Exception as e:

28 print("Exception when calling PublicApi->get_comment_vote_user_names: %s\n" % e)

29

פרמטרים

תגובה

מחזירה: APIGetCommentsResponse

דוגמה

דוגמת get_comments

Copy

1

2import client

3from client.api.default_api import GetCommentsOptions

4from client.models.api_get_comments_response import APIGetCommentsResponse

5from client.models.sort_directions import SortDirections

6from client.rest import ApiException

7from pprint import pprint

8

9# הגדרת המארח היא אופציונלית ובברירת מחדל https://fastcomments.com

10# ראה configuration.py עבור רשימת כל פרמטרי התצורה הנתמכים.

11configuration = client.Configuration(

12 host = "https://fastcomments.com"

13)

14

15# הלקוח חייב להגדיר את פרמטרי האימות וההרשאה

16# בהתאם למדיניות האבטחה של שרת ה-API.

17# דוגמאות לכל שיטת אימות מסופקות למטה, השתמשו בדוגמה שת

18# תענה על צרכי האימות שלכם.

19

20# הגדרת אימות עם מפתח API: api_key

21configuration.api_key['api_key'] = os.environ["API_KEY"]

22

23# בטלו את ההערה למטה כדי להגדיר קידומת (למשל Bearer) למפתח API, אם נדרש

24# configuration.api_key_prefix['api_key'] = 'Bearer'

25

26# Enter a context with an instance of the API client

27with client.ApiClient(configuration) as api_client:

28 # Create an instance of the API class

29 api_instance = client.DefaultApi(api_client)

30 tenant_id = 'tenant_id_example' # str |

31 page = 56 # int | (optional)

32 limit = 56 # int | (optional)

33 skip = 56 # int | (optional)

34 as_tree = True # bool | (optional)

35 skip_children = 56 # int | (optional)

36 limit_children = 56 # int | (optional)

37 max_tree_depth = 56 # int | (optional)

38 url_id = 'url_id_example' # str | (optional)

39 user_id = 'user_id_example' # str | (optional)

40 anon_user_id = 'anon_user_id_example' # str | (optional)

41 context_user_id = 'context_user_id_example' # str | (optional)

42 hash_tag = 'hash_tag_example' # str | (optional)

43 parent_id = 'parent_id_example' # str | (optional)

44 direction = client.SortDirections() # SortDirections | (optional)

45 from_date = 56 # int | (optional)

46 to_date = 56 # int | (optional)

47

48 try:

49 api_response = api_instance.get_comments(tenant_id, GetCommentsOptions(page=page, limit=limit, skip=skip, as_tree=as_tree, skip_children=skip_children, limit_children=limit_children, max_tree_depth=max_tree_depth, url_id=url_id, user_id=user_id, anon_user_id=anon_user_id, context_user_id=context_user_id, hash_tag=hash_tag, parent_id=parent_id, direction=direction, from_date=from_date, to_date=to_date))

50 print("The response of DefaultApi->get_comments:\n")

51 pprint(api_response)

52 except Exception as e:

53 print("Exception when calling DefaultApi->get_comments: %s\n" % e)

54

req tenantId urlId

פרמטרים

תגובה

מחזיר: GetCommentsResponseWithPresencePublicComment

דוגמה

דוגמת get_comments_public

Copy

1

2import client

3from client.api.public_api import GetCommentsPublicOptions

4from client.models.get_comments_response_with_presence_public_comment import GetCommentsResponseWithPresencePublicComment

5from client.models.sort_directions import SortDirections

6from client.rest import ApiException

7from pprint import pprint

8

9# הגדרת המארח היא אופציונלית וערכה המחדל הוא https://fastcomments.com

10# ראו configuration.py לקבלת רשימה של כל פרמטרי התצורה הנתמכים.

11configuration = client.Configuration(

12 host = "https://fastcomments.com"

13)

14

15

16# היכנסו להקשר עם מופע של לקוח ה‑API

17with client.ApiClient(configuration) as api_client:

18 # יצירת מופע של מחלקת ה‑API

19 api_instance = client.PublicApi(api_client)

20 tenant_id = 'tenant_id_example' # str |

21 url_id = 'url_id_example' # str |

22 page = 56 # int | (optional)

23 direction = client.SortDirections() # SortDirections | (optional)

24 sso = 'sso_example' # str | (optional)

25 skip = 56 # int | (optional)

26 skip_children = 56 # int | (optional)

27 limit = 56 # int | (optional)

28 limit_children = 56 # int | (optional)

29 count_children = True # bool | (optional)

30 fetch_page_for_comment_id = 'fetch_page_for_comment_id_example' # str | (optional)

31 include_config = True # bool | (optional)

32 count_all = True # bool | (optional)

33 includei10n = True # bool | (optional)

34 locale = 'locale_example' # str | (optional)

35 modules = 'modules_example' # str | (optional)

36 is_crawler = True # bool | (optional)

37 include_notification_count = True # bool | (optional)

38 as_tree = True # bool | (optional)

39 max_tree_depth = 56 # int | (optional)

40 use_full_translation_ids = True # bool | (optional)

41 parent_id = 'parent_id_example' # str | (optional)

42 search_text = 'search_text_example' # str | (optional)

43 hash_tags = ['hash_tags_example'] # List[str] | (optional)

44 user_id = 'user_id_example' # str | (optional)

45 custom_config_str = 'custom_config_str_example' # str | (optional)

46 after_comment_id = 'after_comment_id_example' # str | (optional)

47 before_comment_id = 'before_comment_id_example' # str | (optional)

48

49 try:

50 api_response = api_instance.get_comments_public(tenant_id, url_id, GetCommentsPublicOptions(page=page, direction=direction, sso=sso, skip=skip, skip_children=skip_children, limit=limit, limit_children=limit_children, count_children=count_children, fetch_page_for_comment_id=fetch_page_for_comment_id, include_config=include_config, count_all=count_all, includei10n=includei10n, locale=locale, modules=modules, is_crawler=is_crawler, include_notification_count=include_notification_count, as_tree=as_tree, max_tree_depth=max_tree_depth, use_full_translation_ids=use_full_translation_ids, parent_id=parent_id, search_text=search_text, hash_tags=hash_tags, user_id=user_id, custom_config_str=custom_config_str, after_comment_id=after_comment_id, before_comment_id=before_comment_id))

51 print("The response of PublicApi->get_comments_public:\n")

52 pprint(api_response)

53 except Exception as e:

54 print("Exception when calling PublicApi->get_comments_public: %s\n" % e)

55

פרמטרים

תגובה

מחזיר: APIEmptyResponse

דוגמה

דוגמה ל-lock_comment

Copy

1

2import client

3from client.models.api_empty_response import APIEmptyResponse

4from client.rest import ApiException

5from pprint import pprint

6

7# הגדרת ה-host היא אופציונלית וברירת המחדל היא https://fastcomments.com

8# ראה configuration.py לרשימת כל פרמטרי התצורה הנתמכים.

9configuration = client.Configuration(

10 host = "https://fastcomments.com"

11)

12

13

14# כניסה להקשר עם מופע של לקוח ה-API

15with client.ApiClient(configuration) as api_client:

16 # יצירת מופע של מחלקת ה-API

17 api_instance = client.PublicApi(api_client)

18 tenant_id = 'tenant_id_example' # str |

19 comment_id = 'comment_id_example' # str |

20 broadcast_id = 'broadcast_id_example' # str |

21 sso = 'sso_example' # str | (אופציונלי)

22

23 try:

24 api_response = api_instance.lock_comment(tenant_id, comment_id, broadcast_id, sso=sso)

25 print("The response of PublicApi->lock_comment:\n")

26 pprint(api_response)

27 except Exception as e:

28 print("Exception when calling PublicApi->lock_comment: %s\n" % e)

29

פרמטרים

תגובה

מחזיר: ChangeCommentPinStatusResponse

דוגמה

דוגמה ל-pin_comment

Copy

1

2import client

3from client.models.change_comment_pin_status_response import ChangeCommentPinStatusResponse

4from client.rest import ApiException

5from pprint import pprint

6

7# הגדרת ה-host היא אופציונלית וברירת המחדל היא https://fastcomments.com

8# ראו את configuration.py עבור רשימת כל פרמטרי התצורה הנתמכים.

9configuration = client.Configuration(

10 host = "https://fastcomments.com"

11)

12

13

14# הכנסו להקשר עם מופע של לקוח ה-API

15with client.ApiClient(configuration) as api_client:

16 # צרו מופע של מחלקת ה-API

17 api_instance = client.PublicApi(api_client)

18 tenant_id = 'tenant_id_example' # str |

19 comment_id = 'comment_id_example' # str |

20 broadcast_id = 'broadcast_id_example' # str |

21 sso = 'sso_example' # str | (אופציונלי)

22

23 try:

24 api_response = api_instance.pin_comment(tenant_id, comment_id, broadcast_id, sso=sso)

25 print("The response of PublicApi->pin_comment:\n")

26 pprint(api_response)

27 except Exception as e:

28 print("Exception when calling PublicApi->pin_comment: %s\n" % e)

29

פרמטרים

תגובה

מחזיר: APISaveCommentResponse

דוגמה

דוגמה ל‑save_comment

Copy

1

2import client

3from client.api.default_api import SaveCommentOptions

4from client.models.api_save_comment_response import APISaveCommentResponse

5from client.models.create_comment_params import CreateCommentParams

6from client.rest import ApiException

7from pprint import pprint

8

9# הגדרת המארח היא אופציונלית ובברירת המחדל היא https://fastcomments.com

10# ראה את הקובץ configuration.py עבור רשימה של כל פרמטרי תצורה נתמכים.

11

12# על הלקוח להגדיר את פרמטרי האימות והאישור בהתאם למדיניות האבטחה של שרת ה‑API.

13# דוגמאות לכל שיטת אימות מסופקות למטה, השתמשו בדוגמה שמתאימה למקרה השימוש שלכם.

14

15# הגדרת הרשאת מפתח API: api_key

16# בטלו את ההערה מהשורה למטה כדי להגדיר מקדמה (למשל Bearer) עבור מפתח API, אם נדרש

17# configuration.api_key_prefix['api_key'] = 'Bearer'

18

19# הכנס לקונטקסט עם מופע של לקוח ה‑API

20with client.ApiClient(configuration) as api_client:

21 # צור מופע של מחלקת ה‑API

22 api_instance = client.DefaultApi(api_client)

23 tenant_id = 'tenant_id_example' # str |

24 create_comment_params = client.CreateCommentParams() # CreateCommentParams |

25 is_live = True # bool | (אופציונלי)

26 do_spam_check = True # bool | (אופציונלי)

27 send_emails = True # bool | (אופציונלי)

28 populate_notifications = True # bool | (אופציונלי)

29

30 try:

31 api_response = api_instance.save_comment(tenant_id, create_comment_params, SaveCommentOptions(is_live=is_live, do_spam_check=do_spam_check, send_emails=send_emails, populate_notifications=populate_notifications))

32 print("The response of DefaultApi->save_comment:\n")

33 pprint(api_response)

34 except Exception as e:

35 print("Exception when calling DefaultApi->save_comment: %s\n" % e)

36

פרמטרים

תשובה

מחזיר: SaveCommentsBulkResponse

דוגמה

דוגמת save_comments_bulk

Copy

1

2import client

3from client.api.default_api import SaveCommentsBulkOptions

4from client.models.create_comment_params import CreateCommentParams

5from client.models.save_comments_bulk_response import SaveCommentsBulkResponse

6from client.rest import ApiException

7from pprint import pprint

8

9# הגדרת המארח היא אופציונלית ובברירת מחדל https://fastcomments.com

10# ראו configuration.py לקבלת רשימה של כל פרמטרי ההגדרה הנתמכים.

11configuration = client.Configuration(

12 host = "https://fastcomments.com"

13)

14

15# הלקוח חייב להגדיר את פרמטרי האימות וההרשאה

16# בהתאם למדיניות האבטחה של שרת ה-API.

17# דוגמאות לכל שיטת אימות מסופקות למטה, השתמשו בדוגמה שמתאימה

18# מצבת את מקרה השימוש שלכם באימות.

19

20# קוונפיגורציה של אימות מפתח API: api_key

21configuration.api_key['api_key'] = os.environ["API_KEY"]

22

23# בטלו את ההערה למטה כדי להגדיר קידומת (למשל Bearer) למפתח API, במידת הצורך

24# configuration.api_key_prefix['api_key'] = 'Bearer'

25

26# היכנסו להקשר עם מופע של לקוח ה-API

27with client.ApiClient(configuration) as api_client:

28 # צור מופע של מחלקת ה-API

29 api_instance = client.DefaultApi(api_client)

30 tenant_id = 'tenant_id_example' # str |

31 create_comment_params = [client.CreateCommentParams()] # List[CreateCommentParams] |

32 is_live = True # bool | (optional)

33 do_spam_check = True # bool | (optional)

34 send_emails = True # bool | (optional)

35 populate_notifications = True # bool | (optional)

36

37 try:

38 api_response = api_instance.save_comments_bulk(tenant_id, create_comment_params, SaveCommentsBulkOptions(is_live=is_live, do_spam_check=do_spam_check, send_emails=send_emails, populate_notifications=populate_notifications))

39 print("The response of DefaultApi->save_comments_bulk:\n")

40 pprint(api_response)

41 except Exception as e:

42 print("Exception when calling DefaultApi->save_comments_bulk: %s\n" % e)

43

פרמטרים

תגובה

מחזיר: PublicAPISetCommentTextResponse

דוגמה

דוגמת set_comment_text

Copy

1

2import client

3from client.api.public_api import SetCommentTextOptions

4from client.models.comment_text_update_request import CommentTextUpdateRequest

5from client.models.public_api_set_comment_text_response import PublicAPISetCommentTextResponse

6from client.rest import ApiException

7from pprint import pprint

8

9# הגדרת המארח היא אופציונלית ומשמשת כברירת מחדל https://fastcomments.com

10# ראו configuration.py לקבלת רשימת כל פרמטרי הקונפיגורציה הנתמכים.

11configuration = client.Configuration(

12 host = "https://fastcomments.com"

13)

14

15

16# הכנסו להקשר עם מופע של לקוח ה‑API

17# צרו מופע של מחלקת ה‑API

18with client.ApiClient(configuration) as api_client:

19 api_instance = client.PublicApi(api_client)

20 tenant_id = 'tenant_id_example' # str |

21 comment_id = 'comment_id_example' # str |

22 broadcast_id = 'broadcast_id_example' # str |

23 comment_text_update_request = client.CommentTextUpdateRequest() # CommentTextUpdateRequest |

24 edit_key = 'edit_key_example' # str | (אופציונלי)

25 sso = 'sso_example' # str | (אופציונלי)

26

27 try:

28 api_response = api_instance.set_comment_text(tenant_id, comment_id, broadcast_id, comment_text_update_request, SetCommentTextOptions(edit_key=edit_key, sso=sso))

29 print("The response of PublicApi->set_comment_text:\n")

30 pprint(api_response)

31 except Exception as e:

32 print("Exception when calling PublicApi->set_comment_text: %s\n" % e)

33

פרמטרים

תגובה

מחזיר: UnblockSuccess

דוגמה

un_block_user_from_comment דוגמה

Copy

1

2import client

3from client.api.default_api import UnBlockUserFromCommentOptions

4from client.models.un_block_from_comment_params import UnBlockFromCommentParams

5from client.models.unblock_success import UnblockSuccess

6from client.rest import ApiException

7from pprint import pprint

8

9# הגדרת המארח היא אופציונלית וכברירת מחדל https://fastcomments.com

10# ראה configuration.py לקבלת רשימה של כל פרמטרי התצורה הנתמכים.

11# הלקוח חייב להגדיר את פרמטי האימות וההרשאה

12# בהתאם למדיניות האבטחה של שרת ה-API.

13# דוגמאות לכל שיטת אימות ניתנות למטה, השתמשו בדוגמה המתאימה למקרה השימוש שלכם.

14

15# הגדרת הרשאת מפתח API: api_key

16configuration.api_key['api_key'] = os.environ["API_KEY"]

17

18# בטלו את ההערה למטה כדי להגדיר קידומת (לדוגמה Bearer) עבור מפתח ה-API, במידת הצורך

19# configuration.api_key_prefix['api_key'] = 'Bearer'

20

21# הכנסו להקשר עם מופע של לקוח ה-API

22with client.ApiClient(configuration) as api_client:

23 # צור מופע של מחלקת ה-API

24 api_instance = client.DefaultApi(api_client)

25 tenant_id = 'tenant_id_example' # str |

26 id = 'id_example' # str |

27 un_block_from_comment_params = client.UnBlockFromCommentParams() # UnBlockFromCommentParams |

28 user_id = 'user_id_example' # str | (אופציונלי)

29 anon_user_id = 'anon_user_id_example' # str | (אופציונלי)

30

31 try:

32 api_response = api_instance.un_block_user_from_comment(tenant_id, id, un_block_from_comment_params, UnBlockUserFromCommentOptions(user_id=user_id, anon_user_id=anon_user_id))

33 print("The response of DefaultApi->un_block_user_from_comment:\n")

34 pprint(api_response)

35 except Exception as e:

36 print("Exception when calling DefaultApi->un_block_user_from_comment: %s\n" % e)

37

פרמטרים

תגובה

מחזיר: FlagCommentResponse

דוגמה

דוגמת un_flag_comment

Copy

1

2import client

3from client.api.default_api import UnFlagCommentOptions

4from client.models.flag_comment_response import FlagCommentResponse

5from client.rest import ApiException

6from pprint import pprint

7

8# הגדרת המארח היא אופציונלית ומוגדרת כברירת מחדל ל‑https://fastcomments.com

9# ראה configuration.py עבור רשימת כל פרמטרי ההגדרה הנתמכים.

10configuration = client.Configuration(

11 host = "https://fastcomments.com"

12)

13

14# הלקוח חייב לקבוע את פרמטרי האימות וההרשאה

15# בהתאם למדיניות האבטחה של שרת ה‑API.

16# דוגמאות לכל שיטת אימות ניתנות למטה, השתמשו בדוגמה שהיא

17# מתאימה למקרה השימוש שלכם באימות.

18

19# הגדר הרשאת מפתח API: api_key

20configuration.api_key['api_key'] = os.environ["API_KEY"]

21

22# בטלו את ההערה של הקוד להלן כדי להגדיר קידומת (למשל Bearer) למפתח API, אם נדרש

23# configuration.api_key_prefix['api_key'] = 'Bearer'

24

25# הכנסו לקונטקסט עם מופע של לקוח ה‑API

26with client.ApiClient(configuration) as api_client:

27 # צרו מופע של מחלקת ה‑API

28 api_instance = client.DefaultApi(api_client)

29 tenant_id = 'tenant_id_example' # str |

30 id = 'id_example' # str |

31 user_id = 'user_id_example' # str | (optional)

32 anon_user_id = 'anon_user_id_example' # str | (optional)

33

34 try:

35 api_response = api_instance.un_flag_comment(tenant_id, id, UnFlagCommentOptions(user_id=user_id, anon_user_id=anon_user_id))

36 print("The response of DefaultApi->un_flag_comment:\n")

37 pprint(api_response)

38 except Exception as e:

39 print("Exception when calling DefaultApi->un_flag_comment: %s\n" % e)

40

פרמטרים

תגובה

מחזיר: APIEmptyResponse

דוגמה

דוגמה ל-un_lock_comment

Copy

1

2import client

3from client.models.api_empty_response import APIEmptyResponse

4from client.rest import ApiException

5from pprint import pprint

6

7# קביעת ה-host היא אופציונלית ומוגדרת כברירת מחדל ל- https://fastcomments.com

8# ראה את configuration.py עבור רשימה של כל פרמטרי התצורה הנתמכים.

9configuration = client.Configuration(

10 host = "https://fastcomments.com"

11)

12

13

14# פתח בלוק הקשר (context) עם מופע של ApiClient

15with client.ApiClient(configuration) as api_client:

16 # צור מופע של מחלקת ה-API

17 api_instance = client.PublicApi(api_client)

18 tenant_id = 'tenant_id_example' # str |

19 comment_id = 'comment_id_example' # str |

20 broadcast_id = 'broadcast_id_example' # str |

21 sso = 'sso_example' # str | (אופציונלי)

22

23 try:

24 api_response = api_instance.un_lock_comment(tenant_id, comment_id, broadcast_id, sso=sso)

25 print("The response of PublicApi->un_lock_comment:\n")

26 pprint(api_response)

27 except Exception as e:

28 print("Exception when calling PublicApi->un_lock_comment: %s\n" % e)

29

פרמטרים

תגובה

מחזיר: ChangeCommentPinStatusResponse

דוגמה

דוגמה ל-un_pin_comment

Copy

1

2import client

3from client.models.change_comment_pin_status_response import ChangeCommentPinStatusResponse

4from client.rest import ApiException

5from pprint import pprint

6

7# הגדרת ה-host אופציונלית ומוגדרת כברירת מחדל ל-https://fastcomments.com

8# ראה את configuration.py לקבלת רשימת כל פרמטרי הקונפיגורציה הנתמכים.

9configuration = client.Configuration(

10 host = "https://fastcomments.com"

11)

12

13

14# כניסה להקשר עם מופע של לקוח ה-API

15with client.ApiClient(configuration) as api_client:

16 # צור מופע של מחלקת ה-API

17 api_instance = client.PublicApi(api_client)

18 tenant_id = 'tenant_id_example' # str |

19 comment_id = 'comment_id_example' # str |

20 broadcast_id = 'broadcast_id_example' # str |

21 sso = 'sso_example' # str | (אופציונלי)

22

23 try:

24 api_response = api_instance.un_pin_comment(tenant_id, comment_id, broadcast_id, sso=sso)

25 print("The response of PublicApi->un_pin_comment:\n")

26 pprint(api_response)

27 except Exception as e:

28 print("Exception when calling PublicApi->un_pin_comment: %s\n" % e)

29

פרמטרים

תגובה

מחזירה: APIEmptyResponse

דוגמה

update_comment דוגמה

Copy

1

2import client

3from client.api.default_api import UpdateCommentOptions

4from client.models.api_empty_response import APIEmptyResponse

5from client.models.updatable_comment_params import UpdatableCommentParams

6from client.rest import ApiException

7from pprint import pprint

8

9# הגדרת המארח היא אופציונלית ובברירת מחדל https://fastcomments.com

10# ראו configuration.py לרשימת כל פרמטרי התצורה הנתמכים.

11configuration = client.Configuration(

12 host = "https://fastcomments.com"

13)

14

15# הלקוח חייב להגדיר את פרמטרי האימות וההרשאה

16# בהתאם למדיניות האבטחה של שרת ה-API.

17# דוגמאות עבור כל שיטת אימות מסופקות להלן, השתמשו בדוגמה

18# המתאימה למקרה השימוש שלכם באימות.

19

20# הגדרת אימות מפתח API: api_key

21configuration.api_key['api_key'] = os.environ["API_KEY"]

22

23# בטלו את ההערה לשורה הבאה כדי להגדיר קידומת (למשל Bearer) למפתח API, אם נדרש

24# configuration.api_key_prefix['api_key'] = 'Bearer'

25

26# היכנסו להקשר עם מופע של לקוח ה-API

27with client.ApiClient(configuration) as api_client:

28 # צור מופע של מחלקת ה-API

29 api_instance = client.DefaultApi(api_client)

30 tenant_id = 'tenant_id_example' # str |

31 id = 'id_example' # str |

32 updatable_comment_params = client.UpdatableCommentParams() # UpdatableCommentParams |

33 context_user_id = 'context_user_id_example' # str | (optional)

34 do_spam_check = True # bool | (optional)

35 is_live = True # bool | (optional)

36

37 try:

38 api_response = api_instance.update_comment(tenant_id, id, updatable_comment_params, UpdateCommentOptions(context_user_id=context_user_id, do_spam_check=do_spam_check, is_live=is_live))

39 print("The response of DefaultApi->update_comment:\n")

40 pprint(api_response)

41 except Exception as e:

42 print("Exception when calling DefaultApi->update_comment: %s\n" % e)

43

פרמטרים

תגובה

מחזירה: VoteResponse

דוגמה

דוגמת vote_comment

Copy

1

2import client

3from client.api.public_api import VoteCommentOptions

4from client.models.vote_body_params import VoteBodyParams

5from client.models.vote_response import VoteResponse

6from client.rest import ApiException

7from pprint import pprint

8

9# הגדרת המארח היא אופציונלית ומוגדרת כברירת מחדל ל-https://fastcomments.com

10# ראה configuration.py לקבלת רשימת כל פרמטרי ההגדרות הנתמכים.

11configuration = client.Configuration(

12 host = "https://fastcomments.com"

13)

14

15

16# הכנס הקשר (context) עם מופע של לקוח ה-API

17with client.ApiClient(configuration) as api_client:

18 # צור מופע של מחלקת ה-API

19 api_instance = client.PublicApi(api_client)

20 tenant_id = 'tenant_id_example' # str |

21 comment_id = 'comment_id_example' # str |

22 url_id = 'url_id_example' # str |

23 broadcast_id = 'broadcast_id_example' # str |

24 vote_body_params = client.VoteBodyParams() # VoteBodyParams |

25 session_id = 'session_id_example' # str | (optional)

26 sso = 'sso_example' # str | (optional)

27

28 try:

29 api_response = api_instance.vote_comment(tenant_id, comment_id, url_id, broadcast_id, vote_body_params, VoteCommentOptions(session_id=session_id, sso=sso))

30 print("The response of PublicApi->vote_comment:\n")

31 pprint(api_response)

32 except Exception as e:

33 print("Exception when calling PublicApi->vote_comment: %s\n" % e)

34

פרמטרים

תגובה

מחזירה: GetCommentsForUserResponse

דוגמה

דוגמה get_comments_for_user

Copy

1

2import client

3from client.api.public_api import GetCommentsForUserOptions

4from client.models.get_comments_for_user_response import GetCommentsForUserResponse

5from client.models.sort_directions import SortDirections

6from client.rest import ApiException

7from pprint import pprint

8

9# הגדרת המארח היא אופציונלית ובברירת מחדל https://fastcomments.com

10# ראה configuration.py לקבלת רשימה של כל פרמטרי ההגדרה הנתמכים.

11configuration = client.Configuration(

12 host = "https://fastcomments.com"

13)

14

15

16# הכנס לקונטקסט עם מופע של לקוח ה-API

17with client.ApiClient(configuration) as api_client:

18 # צור מופע של מחלקת ה-API

19 api_instance = client.PublicApi(api_client)

20 user_id = 'user_id_example' # str | (אופציונלי)

21 direction = client.SortDirections() # SortDirections | (אופציונלי)

22 replies_to_user_id = 'replies_to_user_id_example' # str | (אופציונלי)

23 page = 3.4 # float | (אופציונלי)

24 includei10n = True # bool | (אופציונלי)

25 locale = 'locale_example' # str | (אופציונלי)

26 is_crawler = True # bool | (אופציונלי)

27

28 try:

29 api_response = api_instance.get_comments_for_user(GetCommentsForUserOptions(user_id=user_id, direction=direction, replies_to_user_id=replies_to_user_id, page=page, includei10n=includei10n, locale=locale, is_crawler=is_crawler))

30 print("The response of PublicApi->get_comments_for_user:\n")

31 pprint(api_response)

32 except Exception as e:

33 print("Exception when calling PublicApi->get_comments_for_user: %s\n" % e)

34

פרמטרים

תגובה

מחזיר: AddDomainConfigResponse

דוגמה

דוגמה ל-add_domain_config

Copy

1

2import client

3from client.models.add_domain_config_params import AddDomainConfigParams

4from client.models.add_domain_config_response import AddDomainConfigResponse

5from client.rest import ApiException

6from pprint import pprint

7

8# הגדרת ה-host אופציונלית וברירת המחדל היא https://fastcomments.com

9# עיין ב-configuration.py עבור רשימת כל פרמטרי התצורה הנתמכים.

10configuration = client.Configuration(

11 host = "https://fastcomments.com"

12)

13

14# הלקוח חייב להגדיר את פרמטרי האימות וההרשאה

15# בהתאם למדיניות האבטחה של שרת ה-API.

16# דוגמאות לכל שיטת אימות מסופקות למטה, השתמש בדוגמה

17# שמתאימה למקרה השימוש שלך באימות.

18

19# הגדר הרשאת מפתח API: api_key

20configuration.api_key['api_key'] = os.environ["API_KEY"]

21

22# הסר את ההערה למטה כדי להגדיר קידומת (למשל Bearer) למפתח ה-API, אם נדרש

23# configuration.api_key_prefix['api_key'] = 'Bearer'

24

25# היכנס להקשר עם מופע של לקוח ה-API

26with client.ApiClient(configuration) as api_client:

27 # צור מופע של מחלקת ה-API

28 api_instance = client.DefaultApi(api_client)

29 tenant_id = 'tenant_id_example' # str |

30 add_domain_config_params = client.AddDomainConfigParams() # AddDomainConfigParams |

31

32 try:

33 api_response = api_instance.add_domain_config(tenant_id, add_domain_config_params)

34 print("The response of DefaultApi->add_domain_config:\n")

35 pprint(api_response)

36 except Exception as e:

37 print("Exception when calling DefaultApi->add_domain_config: %s\n" % e)

38

פרמטרים

תגובה

מחזיר: DeleteDomainConfigResponse

דוגמה

דוגמה ל-delete_domain_config

Copy

1

2import client

3from client.models.delete_domain_config_response import DeleteDomainConfigResponse

4from client.rest import ApiException

5from pprint import pprint

6

7# הגדרת ה-host אופציונלית ומוגדרת כברירת מחדל ל-https://fastcomments.com

8# ראו את configuration.py לרשימת כל פרמטרי התצורה הנתמכים.

9configuration = client.Configuration(

10 host = "https://fastcomments.com"

11)

12

13# הלקוח חייב להגדיר את פרמטרי האימות והרשאה

14# בהתאם למדיניות האבטחה של שרת ה-API.

15# דוגמאות לכל שיטת אימות מסופקות להלן; השתמשו בדוגמה ש

16# מתאימה למקרה השימוש שלכם באימות.

17

18# הגדר אישור באמצעות מפתח ה-API: api_key

19# הסירו את ההערה למטה כדי להגדיר קידומת (למשל Bearer) למפתח ה-API, אם יש צורך

20# configuration.api_key_prefix['api_key'] = 'Bearer'

21

22# הכנסו לקונטקסט עם מופע של לקוח ה-API

23with client.ApiClient(configuration) as api_client:

24 # צרו מופע של מחלקת ה-API

25 api_instance = client.DefaultApi(api_client)

26 tenant_id = 'tenant_id_example' # str |

27 domain = 'domain_example' # str |

28

29 try:

30 api_response = api_instance.delete_domain_config(tenant_id, domain)

31 print("The response of DefaultApi->delete_domain_config:\n")

32 pprint(api_response)

33 except Exception as e:

34 print("Exception when calling DefaultApi->delete_domain_config: %s\n" % e)

35

פרמטרים

תגובה

מחזיר: GetDomainConfigResponse

דוגמה

דוגמה ל-get_domain_config

Copy

1

2import client

3from client.models.get_domain_config_response import GetDomainConfigResponse

4from client.rest import ApiException

5from pprint import pprint

6

7# הגדרת ה-host היא אופציונלית והערך המחדל הוא https://fastcomments.com

8# ראה את configuration.py לרשימה של כל פרמטרי התצורה הנתמכים.

9configuration = client.Configuration(

10 host = "https://fastcomments.com"

11)

12

13# הלקוח חייב להגדיר את פרמטרי האימות והרשאות

14# בהתאם למדיניות האבטחה של שרת ה-API.

15# דוגמאות לכל שיטת אימות מוצגות למטה, השתמש בדוגמה ש

16# מתאימה למקרה השימוש שלך.

17

18# Configure API key authorization: api_key

19configuration.api_key['api_key'] = os.environ["API_KEY"]

20

21# בטל את ההערה למטה כדי להגדיר קידומת (למשל Bearer) עבור מפתח ה-API, אם יש צורך

22# configuration.api_key_prefix['api_key'] = 'Bearer'

23

24# הכנס להקשר עם מופע של לקוח ה-API

25with client.ApiClient(configuration) as api_client:

26 # צור מופע של מחלקת ה-API

27 api_instance = client.DefaultApi(api_client)

28 tenant_id = 'tenant_id_example' # str |

29 domain = 'domain_example' # str |

30

31 try:

32 api_response = api_instance.get_domain_config(tenant_id, domain)

33 print("The response of DefaultApi->get_domain_config:\n")

34 pprint(api_response)

35 except Exception as e:

36 print("Exception when calling DefaultApi->get_domain_config: %s\n" % e)

37

פרמטרים

תגובה

מחזיר: GetDomainConfigsResponse

דוגמה

דוגמה ל-get_domain_configs

Copy

1

2import client

3from client.models.get_domain_configs_response import GetDomainConfigsResponse

4from client.rest import ApiException

5from pprint import pprint

6

7# הגדרת ה-host היא אופציונלית וברירת המחדל היא https://fastcomments.com

8# ראו את configuration.py לרשימת כל פרמטרי התצורה הנתמכים.

9configuration = client.Configuration(

10 host = "https://fastcomments.com"

11)

12

13# על הלקוח להגדיר את פרמטרי האימות וההרשאות

14# בהתאם למדיניות האבטחה של שרת ה-API.

15# דוגמות לכל שיטת אימות מופיעות למטה, השתמשו בדוגמה ש

16# מתאימה למקרה השימוש שלכם.

17

18# Configure API key authorization: api_key

19configuration.api_key['api_key'] = os.environ["API_KEY"]

20

21# בטלו את ההערה למטה כדי להגדיר קידומת (למשל Bearer) עבור מפתח ה-API, אם נדרש

22# configuration.api_key_prefix['api_key'] = 'Bearer'

23

24# הכנסו להקשר (context) עם מופע של לקוח ה-API

25with client.ApiClient(configuration) as api_client:

26 # צרו מופע של מחלקת ה-API

27 api_instance = client.DefaultApi(api_client)

28 tenant_id = 'tenant_id_example' # str |

29

30 try:

31 api_response = api_instance.get_domain_configs(tenant_id)

32 print("The response of DefaultApi->get_domain_configs:\n")

33 pprint(api_response)

34 except Exception as e:

35 print("Exception when calling DefaultApi->get_domain_configs: %s\n" % e)

36

פרמטרים

תגובה

מחזיר: PatchDomainConfigResponse

דוגמה

דוגמה ל-patch_domain_config

Copy

1

2import client

3from client.models.patch_domain_config_params import PatchDomainConfigParams

4from client.models.patch_domain_config_response import PatchDomainConfigResponse

5from client.rest import ApiException

6from pprint import pprint

7

8# הגדרת ה-host אופציונלית ומוגדרת כברירת מחדל ל-https://fastcomments.com

9# ראו את configuration.py לרשימת כל פרמטרי התצורה הנתמכים.

10configuration = client.Configuration(

11 host = "https://fastcomments.com"

12)

13

14# הלקוח חייב להגדיר את פרמטרי האימות וההרשאה

15# בהתאם למדיניות האבטחה של שרת ה-API.

16# דוגמאות לכל שיטת אימות ניתנות למטה, השתמשו בדוגמה ש-

17# מתאימה למקרה השימוש שלכם.

18

19# הגדרות האישור בעזרת מפתח API: api_key

20configuration.api_key['api_key'] = os.environ["API_KEY"]

21

22# הסירו את ההערה למטה כדי להגדיר קידומת (למשל Bearer) למפתח ה-API, אם צריך

23# configuration.api_key_prefix['api_key'] = 'Bearer'

24

25# צרו קונטקסט עם מופע של לקוח ה-API

26with client.ApiClient(configuration) as api_client:

27 # צרו מופע של מחלקת ה-API

28 api_instance = client.DefaultApi(api_client)

29 tenant_id = 'tenant_id_example' # str |

30 domain_to_update = 'domain_to_update_example' # str |

31 patch_domain_config_params = client.PatchDomainConfigParams() # PatchDomainConfigParams |

32

33 try:

34 api_response = api_instance.patch_domain_config(tenant_id, domain_to_update, patch_domain_config_params)

35 print("The response of DefaultApi->patch_domain_config:\n")

36 pprint(api_response)

37 except Exception as e:

38 print("Exception when calling DefaultApi->patch_domain_config: %s\n" % e)

39

פרמטרים

תגובה

מחזיר: PutDomainConfigResponse

דוגמה

דוגמת put_domain_config

Copy

1

2import client

3from client.models.put_domain_config_response import PutDomainConfigResponse

4from client.models.update_domain_config_params import UpdateDomainConfigParams

5from client.rest import ApiException

6from pprint import pprint

7

8# הגדרת host היא אופציונלית וברירת המחדל היא https://fastcomments.com

9# ראו את configuration.py לרשימת כל פרמטרי הקונפיגורציה הנתמכים.

10configuration = client.Configuration(

11 host = "https://fastcomments.com"

12)

13

14# ה-client חייב להגדיר את פרמטרי האימות וההרשאה

15# בהתאם למדיניות האבטחה של שרת ה-API.

16# דוגמאות לכל שיטת אימות מוצגות למטה, השתמשו בדוגמה ש

17# מתאימה למקרה השימוש שלכם.

18

19# הגדרת הרשאת מפתח ה-API: api_key

20configuration.api_key['api_key'] = os.environ["API_KEY"]

21

22# הסירו את ההערה למטה כדי להגדיר קידומת (למשל Bearer) עבור מפתח ה-API, אם נדרש

23# configuration.api_key_prefix['api_key'] = 'Bearer'

24

25# כניסה להקשר עם מופע של ה-API client

26with client.ApiClient(configuration) as api_client:

27 # יצירת מופע של מחלקת ה-API

28 api_instance = client.DefaultApi(api_client)

29 tenant_id = 'tenant_id_example' # str |

30 domain_to_update = 'domain_to_update_example' # str |

31 update_domain_config_params = client.UpdateDomainConfigParams() # UpdateDomainConfigParams |

32

33 try:

34 api_response = api_instance.put_domain_config(tenant_id, domain_to_update, update_domain_config_params)

35 print("The response of DefaultApi->put_domain_config:\n")

36 pprint(api_response)

37 except Exception as e:

38 print("Exception when calling DefaultApi->put_domain_config: %s\n" % e)

39

פרמטרים

תגובה

מחזיר: CreateEmailTemplateResponse

דוגמה

דוגמה ל-create_email_template

Copy

1

2import client

3from client.models.create_email_template_body import CreateEmailTemplateBody

4from client.models.create_email_template_response import CreateEmailTemplateResponse

5from client.rest import ApiException

6from pprint import pprint

7

8# הגדרת host היא אופציונלית והערך המחדל הוא https://fastcomments.com

9# ראה configuration.py לרשימה של כל פרמטרי התצורה הנתמכים.

10configuration = client.Configuration(

11 host = "https://fastcomments.com"

12)

13

14# The client must configure the authentication and authorization parameters

15# in accordance with the API server security policy.

16# דוגמאות לכל שיטת אימות מובאות למטה, השתמשו בדוגמה

17# שמתאימה למקרה השימוש שלכם.

18

19# הגדרו הרשאת מפתח API: api_key

20configuration.api_key['api_key'] = os.environ["API_KEY"]

21

22# הסירו את ההערה למטה כדי להגדיר קידומת (למשל Bearer) למפתח ה-API, אם נדרש

23# configuration.api_key_prefix['api_key'] = 'Bearer'

24

25# פתחו הקשר באמצעות מופע של ApiClient

26with client.ApiClient(configuration) as api_client:

27 # צרו מופע של מחלקת ה-API

28 api_instance = client.DefaultApi(api_client)

29 tenant_id = 'tenant_id_example' # str |

30 create_email_template_body = client.CreateEmailTemplateBody() # CreateEmailTemplateBody |

31

32 try:

33 api_response = api_instance.create_email_template(tenant_id, create_email_template_body)

34 print("The response of DefaultApi->create_email_template:\n")

35 pprint(api_response)

36 except Exception as e:

37 print("Exception when calling DefaultApi->create_email_template: %s\n" % e)

38

פרמטרים