FastComments Python SDK

Использование аутентифицированных API (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: Ошибка проверки запроса

Использование публичных API (PublicApi)

Публичные конечные точки не требуют аутентификации:

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}")

Использование панели модерации (ModerationApi)

ModerationApi обеспечивает работу панели модератора. Методы вызываются от имени модератора, передавая токен sso:

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}")

Использование SSO (Single Sign-On)

SDK включает утилиты для генерации безопасных SSO‑токенов:

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}")

Для простого SSO (менее безопасного, для тестирования):

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()

Живые подписки (PubSub)

Модуль pubsub позволяет подписываться на события комментариев в реальном времени (новые комментарии, голоса, правки, уведомления и т.д.) через WebSocket, аналогично LiveEventSubscriber из Java‑SDK FastComments. Для этого требуется дополнительный пакет pubsub, который добавляет WebSocket‑клиент поверх сгенерированного API‑клиента:

pip install "fastcomments[pubsub] @ git+https://github.com/fastcomments/fastcomments-python.git@v3.1.0"

from pubsub import LiveEventSubscriber

subscriber = LiveEventSubscriber()

def handle_live_event(event):
    print(f"Live event: {event.type}")
    if event.comment:
        print(f"  comment: {event.comment.comment}")

result = subscriber.subscribe_to_changes(
    tenant_id_ws="YOUR_TENANT_ID",
    url_id="page-url-id",
    url_id_ws="page-url-id",
    user_id_ws="a-unique-presence-id",  # например, UUID для этой сессии
    handle_live_event=handle_live_event,
    on_connection_status_change=lambda connected, last_event_time: print(
        f"connected={connected}"
    ),
    region=None,  # set to "eu" for the EU region
)

# ... позже, когда обновления больше не нужны:
result.close()

Подписчик запускает соединение в фоновом демоническом потоке, автоматически переподключается с джиттером и получает любые события, пропущенные во время отключения, с конечной точки журнала событий при повторном подключении. Передайте необязательный обратный вызов can_see_comments (List[str] -> Dict[str, str], возвращающий идентификаторы, которые пользователь НЕ ДОЛЖЕН видеть) для фильтрации событий комментариев, недоступных пользователю. Установите disable_live_commenting=True, чтобы subscribe_to_changes стал пустой операцией, возвращающей None.

Распространённые проблемы

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 ...
   • Живые подписки: from pubsub import ... (требуется дополнительный пакет pubsub)

Агрегирует документы, группируя их (если указано groupBy) и применяя несколько операций.
Поддерживаются различные операции (например, sum, countDistinct, avg и т.д.).

Parameters

Response

Returns: 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 для списка всех поддерживаемых параметров конфигурации.

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 aggregation_request = client.AggregationRequest() # AggregationRequest |

32 parent_tenant_id = 'parent_tenant_id_example' # str | (optional)

33 include_stats = True # bool | (optional)

34

35 try:

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

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

38 pprint(api_response)

39 except Exception as e:

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

41

Параметры

Ответ

Возвращает: 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# Определение хоста необязательно и по умолчанию равно 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 | (необязательно)

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

Параметры

Ответ

Возвращает: 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# Defining the host is optional and defaults to https://fastcomments.com

9# See configuration.py for a list of all supported configuration parameters.

10configuration = client.Configuration(

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

12)

13

14

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

16with client.ApiClient(configuration) as api_client:

17 # Create an instance of the API class

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# Указание хоста необязательно, по умолчанию 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 для списка всех поддерживаемых параметров конфигурации.

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 # Create an instance of the API class

29 api_instance = client.DefaultApi(api_client)

30 tenant_id = 'tenant_id_example' # str |

31 id = 'id_example' # str |

32 block_from_comment_params = client.BlockFromCommentParams() # BlockFromCommentParams |

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

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

35

36 try:

37 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))

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

39 pprint(api_response)

40 except Exception as e:

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

42

Параметры

Ответ

Возвращает: 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# Указание хоста является необязательным и по умолчанию https://fastcomments.com

10# См. configuration.py для списка всех поддерживаемых параметров конфигурации.

11configuration = client.Configuration(

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

13)

14

15

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

17with client.ApiClient(configuration) as api_client:

18 # Create an instance of the API class

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 | (optional)

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

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 для списка всех поддерживаемых параметров конфигурации.

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 context_user_id = 'context_user_id_example' # str | (optional)

32 is_live = True # bool | (optional)

33

34 try:

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

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

37 pprint(api_response)

38 except Exception as e:

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

40

Параметры

Ответ

Возвращает: 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

Параметры

Ответ

Returns: 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# Определение хоста необязательно и по умолчанию 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 | (необязательно)

32 anon_user_id = 'anon_user_id_example' # str | (необязательно)

33

34 try:

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

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

37 pprint(api_response)

38 except Exception as e:

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

40

Параметры

Ответ

Возвращает: 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# Задание хоста необязательно и по умолчанию устанавливается в 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

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 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# Войдите в контекст с экземпляром клиента 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 page = 56 # int | (необязательно)

32 limit = 56 # int | (необязательно)

33 skip = 56 # int | (необязательно)

34 as_tree = True # bool | (необязательно)

35 skip_children = 56 # int | (необязательно)

36 limit_children = 56 # int | (необязательно)

37 max_tree_depth = 56 # int | (необязательно)

38 url_id = 'url_id_example' # str | (необязательно)

39 user_id = 'user_id_example' # str | (необязательно)

40 anon_user_id = 'anon_user_id_example' # str | (необязательно)

41 context_user_id = 'context_user_id_example' # str | (необязательно)

42 hash_tag = 'hash_tag_example' # str | (необязательно)

43 parent_id = 'parent_id_example' # str | (необязательно)

44 direction = client.SortDirections() # SortDirections | (необязательно)

45 from_date = 56 # int | (необязательно)

46 to_date = 56 # int | (необязательно)

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

Параметры

Ответ

Returns: 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# Enter a context with an instance of the API client

17with client.ApiClient(configuration) as api_client:

18 # Create an instance of the API class

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 | (опционально)

23 direction = client.SortDirections() # SortDirections | (опционально)

24 sso = 'sso_example' # str | (опционально)

25 skip = 56 # int | (опционально)

26 skip_children = 56 # int | (опционально)

27 limit = 56 # int | (опционально)

28 limit_children = 56 # int | (опционально)

29 count_children = True # bool | (опционально)

30 fetch_page_for_comment_id = 'fetch_page_for_comment_id_example' # str | (опционально)

31 include_config = True # bool | (опционально)

32 count_all = True # bool | (опционально)

33 includei10n = True # bool | (опционально)

34 locale = 'locale_example' # str | (опционально)

35 modules = 'modules_example' # str | (опционально)

36 is_crawler = True # bool | (опционально)

37 include_notification_count = True # bool | (опционально)

38 as_tree = True # bool | (опционально)

39 max_tree_depth = 56 # int | (опционально)

40 use_full_translation_ids = True # bool | (опционально)

41 parent_id = 'parent_id_example' # str | (опционально)

42 search_text = 'search_text_example' # str | (опционально)

43 hash_tags = ['hash_tags_example'] # List[str] | (опционально)

44 user_id = 'user_id_example' # str | (опционально)

45 custom_config_str = 'custom_config_str_example' # str | (опционально)

46 after_comment_id = 'after_comment_id_example' # str | (опционально)

47 before_comment_id = 'before_comment_id_example' # str | (опционально)

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# Указание хоста необязательно, по умолчанию 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# Указание хоста необязательно; по умолчанию используется 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 для списка всех поддерживаемых параметров конфигурации.

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() # 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_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))

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

40 pprint(api_response)

41 except Exception as e:

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

43

Параметры

Ответ

Возвращает: 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 | (необязательно)

33 do_spam_check = True # bool | (необязательно)

34 send_emails = True # bool | (необязательно)

35 populate_notifications = True # bool | (необязательно)

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

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 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 для списка всех поддерживаемых параметров конфигурации.

11configuration = client.Configuration(

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

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 un_block_from_comment_params = client.UnBlockFromCommentParams() # UnBlockFromCommentParams |

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

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

34

35 try:

36 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))

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

38 pprint(api_response)

39 except Exception as e:

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

41

Parameters

Response

Возвращает: FlagCommentResponse

Example

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 | (необязательно)

32 anon_user_id = 'anon_user_id_example' # str | (необязательно)

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# Указание хоста необязательно и по умолчанию 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_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# Указание хоста необязательно и по умолчанию 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

Параметры

Ответ

Returns: 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 | (опционально)

34 do_spam_check = True # bool | (опционально)

35 is_live = True # bool | (опционально)

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# Войти в контекст с экземпляром клиента 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# Определение хоста необязательно; по умолчанию 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# Указание хоста необязательно; по умолчанию используется 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

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

20

21# Раскомментируйте ниже, чтобы при необходимости задать префикс (например, Bearer) для API-ключа

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

23

24# Откройте контекст с экземпляром ApiClient

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.delete_domain_config(tenant_id, domain)

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

34 pprint(api_response)

35 except Exception as e:

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

37

Параметры

Ответ

Возвращает: 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# Определение хоста необязательно и по умолчанию 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

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# Настройте авторизацию по API-ключу: 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

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# Defining the host is optional and defaults to https://fastcomments.com

9# See configuration.py for a list of all supported configuration parameters.

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# Examples for each auth method are provided below, use the example that

17# satisfies your auth use case.

18

19# Configure API key authorization: api_key

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

21

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

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

24

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

26with client.ApiClient(configuration) as api_client:

27 # Create an instance of the API class

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# Клиент должен настроить параметры аутентификации и авторизации

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