FastComments SDK Python

Utilisation des API authentifiées (DefaultApi)

Important : Vous devez définir votre clé API dans la Configuration avant d'effectuer des requêtes authentifiées. Sinon, les requêtes échoueront avec une erreur 401.

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

# Créez et configurez le client API
config = Configuration()
config.host = "https://fastcomments.com"

# OBLIGATOIRE : définissez votre clé API (obtenez-la depuis votre tableau de bord FastComments)
config.api_key = {"api_key": "YOUR_API_KEY_HERE"}

# Créez l'instance API avec le client configuré
api_client = ApiClient(configuration=config)
api = DefaultApi(api_client)

# Vous pouvez maintenant effectuer des appels API authentifiés
try:
    # Exemple : ajouter un utilisateur 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}")
    # Erreurs courantes :
    # - 401 : la clé API est manquante ou invalide
    # - 400 : la validation de la requête a échoué

Utilisation des API publiques (PublicApi)

Les points de terminaison publics ne nécessitent pas d'authentification :

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

Utilisation du tableau de bord de modération (ModerationApi)

Le ModerationApi alimente le tableau de bord des modérateurs. Les méthodes sont appelées au nom d'un modérateur en passant un jeton 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:
    # Compter les commentaires en attente de modération
    response = moderation_api.get_count(GetCountOptions(sso="SSO_TOKEN"))
    print(response)
except Exception as e:
    print(f"Error: {e}")

Utilisation du SSO (Single Sign-On)

Le SDK inclut des utilitaires pour générer des jetons SSO sécurisés :

from sso import FastCommentsSSO, SecureSSOUserData

# Créez les données utilisateur (id, email et nom d'utilisateur sont requis)
user_data = SecureSSOUserData(
    id="user-123",
    email="user@example.com",
    username="johndoe",
    avatar="https://example.com/avatar.jpg"
)

# Signez-le avec votre secret API (HMAC-SHA256)
sso = FastCommentsSSO.new_secure("YOUR_API_SECRET", user_data)

# Générez le jeton SSO à transmettre au widget ou à un appel API
sso_token = sso.create_token()

# Utilisez ce jeton dans votre frontend ou transmettez-le aux appels API
print(f"SSO Token: {sso_token}")

Pour le SSO simple (moins sécurisé, à des fins de test) :

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

Souscriptions en direct (PubSub)

Le module pubsub vous permet de vous abonner aux événements de commentaires en temps réel (nouveaux commentaires, votes, modifications, notifications, etc.) via un WebSocket, reproduisant le LiveEventSubscriber du SDK Java FastComments. Il nécessite l'extra pubsub, qui ajoute un client WebSocket au-dessus du client API généré :

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",  # par ex. un UUID pour cette session
    handle_live_event=handle_live_event,
    on_connection_status_change=lambda connected, last_event_time: print(
        f"connected={connected}"
    ),
    region=None,  # définir sur "eu" pour la région UE
)

# ...plus tard, lorsque vous ne souhaitez plus de mises à jour :
result.close()

Le souscripteur exécute la connexion sur un thread daemon en arrière-plan, se reconnecte de manière transparente avec du jitter, et récupère les événements manqués pendant la déconnexion du point de terminaison du journal d'événements lors de la reconnexion. Passez un rappel optionnel can_see_comments (List[str] -> Dict[str, str], renvoyant les identifiants que l'utilisateur ne doit PAS voir) pour filtrer les événements des commentaires que l'utilisateur n'est pas autorisé à voir. Définissez disable_live_commenting=True pour que subscribe_to_changes devienne une opération nulle qui renvoie None.

Problèmes courants

1. Erreur 401 "missing-api-key" : Assurez-vous d'avoir défini config.api_key = {"api_key": "YOUR_KEY"} avant de créer l'instance DefaultApi.
2. Classe API incorrecte : Utilisez DefaultApi pour les requêtes authentifiées côté serveur, PublicApi pour les requêtes côté client/public, et ModerationApi pour les requêtes du tableau de bord des modérateurs.
3. Erreurs d'importation : Assurez-vous d'importer depuis le bon module :
   • Client API : from client import ...
   • Utilitaires SSO : from sso import ...
   • Souscriptions en direct : from pubsub import ... (nécessite l'extra pubsub)

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

Renvoie : AggregateResponse

Example

Exemple d'agrégation

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# La définition de l'hôte est facultative et vaut par défaut https://fastcomments.com

10# Voir configuration.py pour une liste de tous les paramètres de configuration pris en charge.

11configuration = client.Configuration(

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

13)

14

15# Le client doit configurer les paramètres d'authentification et d'autorisation

16# conformément à la politique de sécurité du serveur API.

17# Des exemples pour chaque méthode d'authentification sont fournis ci-dessous, utilisez l'exemple qui

18# répond à votre cas d'utilisation d'authentification.

19

20# Configurer l'autorisation par clé d'API : api_key

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

22

23# Décommentez ci-dessous pour configurer le préfixe (par ex. Bearer) pour la clé d'API, si nécessaire

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

25

26# Ouvrez un contexte avec une instance du client API

27with client.ApiClient(configuration) as api_client:

28 # Créez une instance de la classe 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

Paramètres

Réponse

Renvoie : GetAuditLogsResponse

Exemple

Exemple 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# Définir l'hôte est facultatif et par défaut https://fastcomments.com

10# Voir configuration.py pour une liste de tous les paramètres de configuration pris en charge.

11configuration = client.Configuration(

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

13)

14

15# Le client doit configurer les paramètres d'authentification et d'autorisation

16# conformément à la politique de sécurité du serveur API.

17# Des exemples pour chaque méthode d'authentification sont fournis ci-dessous, utilisez l'exemple qui

18# répond à votre cas d'utilisation d'authentification.

19

20# Configurer l'autorisation par clé API : api_key

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

22

23# Décommentez ci-dessous pour configurer le préfixe (ex. Bearer) pour la clé API, si nécessaire

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

25

26# Entrer dans un contexte avec une instance du client API

27with client.ApiClient(configuration) as api_client:

28 # Créer une instance de la classe 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

Réponse

Retourne : APIEmptyResponse

Exemple

Exemple 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# La définition de l'hôte est optionnelle et la valeur par défaut est https://fastcomments.com

8# Voir configuration.py pour la liste de tous les paramètres de configuration pris en charge.

9configuration = client.Configuration(

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

11)

12

13

14# Entrer dans un contexte avec une instance du client API

15with client.ApiClient(configuration) as api_client:

16 # Créer une instance de la classe 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

Paramètres

Réponse

Renvoie : BlockSuccess

Exemple

Exemple de 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# La définition de l'hôte est optionnelle et par défaut https://fastcomments.com

9# Voir configuration.py pour la liste de tous les paramètres de configuration pris en charge.

10configuration = client.Configuration(

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

12)

13

14

15# Entrer dans un contexte avec une instance du client API

16with client.ApiClient(configuration) as api_client:

17 # Créer une instance de la classe 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 | (optionnel)

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

Paramètres

Réponse

Renvoie : UnblockSuccess

Exemple

un_block_comment_public Exemple

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# La définition de l'hôte est optionnelle et par défaut https://fastcomments.com

9# Voir configuration.py pour la liste de tous les paramètres de configuration pris en charge.

10configuration = client.Configuration(

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

12)

13

14

15# Entrez dans un contexte avec une instance du client de l'API

16with client.ApiClient(configuration) as api_client:

17 # Créez une instance de la classe 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 | (optionnel)

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

Paramètres

Réponse

Retourne: CheckBlockedCommentsResponse

Exemple

Exemple de 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# La définition de l'hôte est optionnelle et par défaut https://fastcomments.com

8# Voir configuration.py pour la liste de tous les paramètres de configuration pris en charge.

9configuration = client.Configuration(

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

11)

12

13

14# Entrer dans un contexte avec une instance du client API

15with client.ApiClient(configuration) as api_client:

16 # Créer une instance de la classe API

17 api_instance = client.PublicApi(api_client)

18 tenant_id = 'tenant_id_example' # str |

19 comment_ids = 'comment_ids_example' # str | Une liste d'identifiants de commentaires séparés par des virgules.

20 sso = 'sso_example' # str | (optionnel)

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

Paramètres

Réponse

Renvoie : BlockSuccess

Exemple

block_user_from_comment Exemple

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# La définition de l'hôte est facultative et par défaut https://fastcomments.com

10# Voir configuration.py pour la liste de tous les paramètres de configuration pris en charge.

11# Le client doit configurer les paramètres d'authentification et d'autorisation conformément à la politique de sécurité du serveur API.

12# Des exemples pour chaque méthode d'authentification sont fournis ci-dessous, utilisez celui qui répond à votre cas d'utilisation.

13# Configurer l'autorisation par clé API : api_key

14# Décommentez ci-dessous pour définir le préfixe (ex. Bearer) pour la clé API, si nécessaire

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

16

17# Entrer dans un contexte avec une instance du client API

18with client.ApiClient(configuration) as api_client:

19 # Créer une instance de la classe 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

Paramètres

Réponse

Retourne : SaveCommentsResponseWithPresence

Exemple

create_comment_public Exemple

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# Définir l'hôte est facultatif et utilise https://fastcomments.com par défaut

10# Voir configuration.py pour la liste de tous les paramètres de configuration pris en charge.

11configuration = client.Configuration(

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

13)

14

15

16# Entrer dans un contexte avec une instance du client API

17with client.ApiClient(configuration) as api_client:

18 # Créer une instance de la classe 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 | (optionnel)

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

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

Paramètres

Réponse

Retourne : DeleteCommentResult

Exemple

Exemple 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# La définition de l'hôte est facultative et utilise https://fastcomments.com par défaut

9# Voir configuration.py pour la liste de tous les paramètres de configuration pris en charge.

10configuration = client.Configuration(

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

12)

13

14# Le client doit configurer les paramètres d'authentification et d'autorisation

15# conformément à la politique de sécurité du serveur API.

16# Des exemples pour chaque méthode d'authentification sont fournis ci-dessous, utilisez l'exemple qui

17# répond à votre cas d'utilisation d'authentification.

18

19# Configurer l'autorisation de la clé API : api_key

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

21

22# Décommentez ci-dessous pour configurer le préfixe (par ex. Bearer) pour la clé API, si besoin

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

24

25# Entrer dans un contexte avec une instance du client API

26with client.ApiClient(configuration) as api_client:

27 # Créer une instance de la classe 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 | (facultatif)

32 is_live = True # bool | (facultatif)

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

Paramètres

Réponse

Renvoie : PublicAPIDeleteCommentResponse

Exemple

Exemple de 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# Définir l'hôte est facultatif et utilise par défaut https://fastcomments.com

9# Voir configuration.py pour une liste de tous les paramètres de configuration pris en charge.

10configuration = client.Configuration(

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

12)

13

14

15# Entrer dans un contexte avec une instance du client API

16with client.ApiClient(configuration) as api_client:

17 # Créer une instance de la classe 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 | (facultatif)

23 sso = 'sso_example' # str | (facultatif)

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

Paramètres

Réponse

Renvoie : VoteDeleteResponse

Exemple

Exemple 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# La définition de l'hôte est optionnelle et utilise https://fastcomments.com par défaut

9# Voir configuration.py pour une liste de tous les paramètres de configuration pris en charge.

10configuration = client.Configuration(

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

12)

13

14

15# Entrer dans un contexte avec une instance du client API

16with client.ApiClient(configuration) as api_client:

17 # Créer une instance de la classe 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 | (facultatif)

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

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("La réponse de PublicApi->delete_comment_vote :\n")

30 pprint(api_response)

31 except Exception as e:

32 print("Exception lors de l'appel de PublicApi->delete_comment_vote : %s\n" % e)

33

Paramètres

Réponse

Retourne : FlagCommentResponse

Exemple

Exemple de 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# Définir l'hôte est optionnel et par défaut https://fastcomments.com

9# Voir configuration.py pour la liste de tous les paramètres de configuration pris en charge.

10configuration = client.Configuration(

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

12)

13

14# Le client doit configurer les paramètres d'authentification et d'autorisation

15# conformément à la politique de sécurité du serveur API.

16# Des exemples pour chaque méthode d'authentification sont fournis ci-dessous, utilisez l'exemple qui

17# répond à votre cas d'utilisation d'authentification.

18

19# Configurer l'autorisation de clé API : api_key

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

21

22# Décommentez ci-dessous pour configurer le préfixe (par ex. Bearer) pour la clé API, si nécessaire

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

24

25# Entrer dans un contexte avec une instance du client API

26with client.ApiClient(configuration) as api_client:

27 # Créer une instance de la classe 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.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

Paramètres

Réponse

Renvoie : APIGetCommentResponse

Exemple

Exemple 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# La définition de l'hôte est optionnelle et utilise par défaut https://fastcomments.com

8# Voir configuration.py pour la liste de tous les paramètres de configuration pris en charge.

9configuration = client.Configuration(

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

11)

12

13# Le client doit configurer les paramètres d'authentification et d'autorisation

14# conformément à la politique de sécurité du serveur API.

15# Des exemples pour chaque méthode d'authentification sont fournis ci-dessous, utilisez l'exemple qui

16# correspond à votre cas d'utilisation d'authentification.

17

18# Configurer l'authentification par clé API : api_key

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

20

21# Décommentez ci-dessous pour configurer un préfixe (par ex. Bearer) pour la clé API, si nécessaire

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

23

24# Entrez dans un contexte avec une instance du client API

25with client.ApiClient(configuration) as api_client:

26 # Créez une instance de la classe 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

Paramètres

Réponse

Retourne : PublicAPIGetCommentTextResponse

Exemple

Exemple 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# La définition de l'hôte est facultative et utilise https://fastcomments.com par défaut

9# Voir configuration.py pour la liste de tous les paramètres de configuration pris en charge.

10configuration = client.Configuration(

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

12)

13

14

15# Entrez dans un contexte avec une instance du client API

16with client.ApiClient(configuration) as api_client:

17 # Créez une instance de la classe 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 | (optionnel)

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

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

Paramètres

Réponse

Renvoie : GetCommentVoteUserNamesSuccessResponse

Exemple

Exemple 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# La définition de l'hôte est optionnelle et par défaut https://fastcomments.com

8# Voir configuration.py pour la liste de tous les paramètres de configuration pris en charge.

9configuration = client.Configuration(

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

11)

12

13

14# Entrez dans un contexte avec une instance du client API

15with client.ApiClient(configuration) as api_client:

16 # Créez une instance de la classe 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 | (facultatif)

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

Paramètres

Réponse

Returns: APIGetCommentsResponse

Exemple

get_comments Exemple

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# La définition de l'hôte est facultative et par défaut https://fastcomments.com

10# Voir configuration.py pour la liste de tous les paramètres de configuration pris en charge.

11configuration = client.Configuration(

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

13)

14

15# Le client doit configurer les paramètres d'authentification et d'autorisation en conformité avec la politique de sécurité du serveur API.

16# Des exemples pour chaque méthode d'authentification sont fournis ci-dessous, utilisez l'exemple qui correspond à votre cas d'utilisation.

17

18# Configurer l'autorisation par clé API : api_key

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

20

21# Décommentez ci-dessous pour configurer le préfixe (par ex. Bearer) pour la clé API, si nécessaire

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

23

24# Entrer dans un contexte avec une instance du client API

25with client.ApiClient(configuration) as api_client:

26 # Créer une instance de la classe API

27 api_instance = client.DefaultApi(api_client)

28 tenant_id = 'tenant_id_example' # str |

29 page = 56 # int | (optional)

30 limit = 56 # int | (optional)

31 skip = 56 # int | (optional)

32 as_tree = True # bool | (optional)

33 skip_children = 56 # int | (optional)

34 limit_children = 56 # int | (optional)

35 max_tree_depth = 56 # int | (optional)

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

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

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

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

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

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

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

43 from_date = 56 # int | (optional)

44 to_date = 56 # int | (optional)

45

46 try:

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

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

49 pprint(api_response)

50 except Exception as e:

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

52

req tenantId urlId

Paramètres

Réponse

Renvoie : GetCommentsResponseWithPresencePublicComment

Exemple

Exemple 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# Définir l'hôte est facultatif et la valeur par défaut est https://fastcomments.com

10# Voir configuration.py pour une liste de tous les paramètres de configuration pris en charge.

11configuration = client.Configuration(

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

13)

14

15

16# Entrer dans un contexte avec une instance du client API

17with client.ApiClient(configuration) as api_client:

18 # Créer une instance de la classe 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 | (facultatif)

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

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

25 skip = 56 # int | (facultatif)

26 skip_children = 56 # int | (facultatif)

27 limit = 56 # int | (facultatif)

28 limit_children = 56 # int | (facultatif)

29 count_children = True # bool | (facultatif)

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

31 include_config = True # bool | (facultatif)

32 count_all = True # bool | (facultatif)

33 includei10n = True # bool | (facultatif)

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

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

36 is_crawler = True # bool | (facultatif)

37 include_notification_count = True # bool | (facultatif)

38 as_tree = True # bool | (facultatif)

39 max_tree_depth = 56 # int | (facultatif)

40 use_full_translation_ids = True # bool | (facultatif)

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

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

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

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

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

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

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

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

Paramètres

Réponse

Retourne : APIEmptyResponse

Exemple

Exemple de 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# La définition de l'hôte est facultative et par défaut https://fastcomments.com

8# Voir configuration.py pour la liste de tous les paramètres de configuration pris en charge.

9configuration = client.Configuration(

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

11)

12

13

14# Entrer dans un contexte avec une instance du client API

15with client.ApiClient(configuration) as api_client:

16 # Créer une instance de la classe 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 | (optionnel)

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

Paramètres

Réponse

Renvoie : ChangeCommentPinStatusResponse

Exemple

Exemple de 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# La définition de l'hôte est optionnelle et vaut https://fastcomments.com par défaut

8# Voir configuration.py pour la liste de tous les paramètres de configuration pris en charge.

9configuration = client.Configuration(

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

11)

12

13

14# Entrez dans un contexte avec une instance du client API

15with client.ApiClient(configuration) as api_client:

16 # Créez une instance de la classe 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 | (optionnel)

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

Paramètres

Réponse

Retourne : APISaveCommentResponse

Exemple

Exemple 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# Définir l'hôte est optionnel et utilise https://fastcomments.com comme valeur par défaut

10# Voir configuration.py pour une liste de tous les paramètres de configuration pris en charge.

11# Le client doit configurer les paramètres d'authentification et d'autorisation

12# conformément à la politique de sécurité du serveur API.

13# Des exemples pour chaque méthode d'authentification sont fournis ci-dessous, utilisez l'exemple qui

14# correspond à votre cas d'utilisation d'authentification.

15# Configurer l'autorisation par clé d'API : api_key

16# Décommentez ci-dessous pour configurer le préfixe (ex. Bearer) de la clé d'API, si nécessaire

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

18

19# Entrer dans un contexte avec une instance du client API

20with client.ApiClient(configuration) as api_client:

21 # Créer une instance de la classe 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 | (facultatif)

26 do_spam_check = True # bool | (facultatif)

27 send_emails = True # bool | (facultatif)

28 populate_notifications = True # bool | (facultatif)

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

Paramètres

Réponse

Renvoie : SaveCommentsBulkResponse

Exemple

Exemple 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# Définir l'hôte est facultatif et par défaut https://fastcomments.com

10# Voir configuration.py pour une liste de tous les paramètres de configuration pris en charge.

11# Le client doit configurer les paramètres d'authentification et d'autorisation

12# conformément à la politique de sécurité du serveur API.

13# Des exemples pour chaque méthode d'authentification sont fournis ci-dessous, utilisez l'exemple qui

14# correspond à votre cas d'utilisation d'authentification.

15

16# Configurer l'autorisation par clé API : api_key

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

18

19# Décommentez ci-dessous pour configurer le préfixe (par ex. Bearer) pour la clé API, si nécessaire

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

21

22# Entrer dans un contexte avec une instance du client API

23with client.ApiClient(configuration) as api_client:

24 # Créer une instance de la classe API

25 api_instance = client.DefaultApi(api_client)

26 tenant_id = 'tenant_id_example' # str |

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

28 is_live = True # bool | (optionnel)

29 do_spam_check = True # bool | (optionnel)

30 send_emails = True # bool | (optionnel)

31 populate_notifications = True # bool | (optionnel)

32

33 try:

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

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

36 pprint(api_response)

37 except Exception as e:

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

39

Paramètres

Réponse

Retourne : PublicAPISetCommentTextResponse

Exemple

Exemple 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# Définir l'hôte est facultatif et par défaut https://fastcomments.com

10# Voir configuration.py pour la liste de tous les paramètres de configuration supportés.

11configuration = client.Configuration(

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

13)

14

15

16# Entrer dans un contexte avec une instance du client API

17with client.ApiClient(configuration) as api_client:

18 # Créer une instance de la classe 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 | (optionnel)

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

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

Paramètres

Réponse

Renvoie : UnblockSuccess

Exemple

un_block_user_from_comment Exemple

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# La définition de l'hôte est facultative et par défaut https://fastcomments.com

10# Voir configuration.py pour la liste de tous les paramètres de configuration pris en charge.

11configuration = client.Configuration(

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

13)

14

15# Le client doit configurer les paramètres d'authentification et d'autorisation

16# conformément à la politique de sécurité du serveur API.

17# Des exemples pour chaque méthode d'authentification sont fournis ci-dessous, utilisez l'exemple qui

18# répond à votre cas d'utilisation d'authentification.

19

20# Configurer l'autorisation par clé d'API : api_key

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

22

23# Décommentez ci-dessous pour configurer le préfixe (par ex. Bearer) pour la clé d'API, si nécessaire

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

25

26# Entrer dans un contexte avec une instance du client API

27with client.ApiClient(configuration) as api_client:

28 # Créer une instance de la classe API

29 api_instance = client.DefaultApi(api_client)

30 tenant_id = 'tenant_id_example' # str |

31 id = 'id_example' # str |

32 un_block_from_comment_params = client.UnBlockFromCommentParams() # UnBlockFromCommentParams |

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.un_block_user_from_comment(tenant_id, id, un_block_from_comment_params, UnBlockUserFromCommentOptions(user_id=user_id, anon_user_id=anon_user_id))

38 print("La réponse de DefaultApi->un_block_user_from_comment:\n")

39 pprint(api_response)

40 except Exception as e:

41 print("Exception lors de l'appel à DefaultApi->un_block_user_from_comment : %s\n" % e)

42

Paramètres

Réponse

Renvoie : FlagCommentResponse

Exemple

Exemple 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# Définir l'hôte est facultatif et la valeur par défaut est https://fastcomments.com

9# Voir configuration.py pour une liste de tous les paramètres de configuration pris en charge.

10# Le client doit configurer les paramètres d'authentification et d'autorisation

11# conformément à la politique de sécurité du serveur API.

12# Des exemples pour chaque méthode d'authentification sont fournis ci‑dessous, utilisez l'exemple qui

13# correspond à votre cas d'utilisation d'authentification.

14

15# Configurer l'autorisation par clé API : api_key

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

17

18# Décommentez ci‑dessous pour configurer le préfixe (ex. Bearer) pour la clé API, si nécessaire

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

20

21# Entrer dans un contexte avec une instance du client API

22with client.ApiClient(configuration) as api_client:

23 # Créer une instance de la classe API

24 api_instance = client.DefaultApi(api_client)

25 tenant_id = 'tenant_id_example' # str |

26 id = 'id_example' # str |

27 user_id = 'user_id_example' # str | (facultatif)

28 anon_user_id = 'anon_user_id_example' # str | (facultatif)

29

30 try:

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

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

33 pprint(api_response)

34 except Exception as e:

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

36

Paramètres

Response

Renvoie : APIEmptyResponse

Exemple

Exemple de 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# Définir l'hôte est optionnel et la valeur par défaut est https://fastcomments.com

8# Voir configuration.py pour la liste de tous les paramètres de configuration pris en charge.

9configuration = client.Configuration(

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

11)

12

13

14# Entrer dans un contexte avec une instance du client API

15with client.ApiClient(configuration) as api_client:

16 # Créer une instance de la classe 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 | (optionnel)

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

Paramètres

Réponse

Retourne : ChangeCommentPinStatusResponse

Exemple

Exemple de 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# La définition de l'hôte est optionnelle et la valeur par défaut est https://fastcomments.com

8# Consultez configuration.py pour la liste de tous les paramètres de configuration pris en charge.

9configuration = client.Configuration(

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

11)

12

13

14# Entrez dans un contexte avec une instance du client API

15with client.ApiClient(configuration) as api_client:

16 # Créez une instance de la classe 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 | (optionnel)

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

Paramètres

Réponse

Retourne : APIEmptyResponse

Exemple

Exemple de 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# Définir l'hôte est facultatif et utilise https://fastcomments.com par défaut

10# Voir configuration.py pour la liste de tous les paramètres de configuration pris en charge.

11configuration = client.Configuration(

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

13)

14

15# Le client doit configurer les paramètres d'authentification et d'autorisation

16# conformément à la politique de sécurité du serveur API.

17# Des exemples pour chaque méthode d'authentification sont fournis ci-dessous, utilisez l'exemple qui

18# correspond à votre cas d'utilisation d'authentification.

19

20# Configurer l'autorisation par clé API : api_key

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

22

23# Décommentez ci-dessous pour configurer le préfixe (ex. Bearer) pour la clé API, si nécessaire

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

25

26# Entrer dans un contexte avec une instance du client API

27with client.ApiClient(configuration) as api_client:

28 # Créer une instance de la classe 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 | (optionnel)

34 do_spam_check = True # bool | (optionnel)

35 is_live = True # bool | (optionnel)

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

Paramètres

Réponse

Renvoie : VoteResponse

Exemple

Exemple 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# La définition de l'hôte est optionnelle et par défaut https://fastcomments.com

10# Voir configuration.py pour la liste de tous les paramètres de configuration pris en charge.

11configuration = client.Configuration(

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

13)

14

15

16# Entrer dans un contexte avec une instance du client API

17with client.ApiClient(configuration) as api_client:

18 # Créer une instance de la classe 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 | (facultatif)

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

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("La réponse de PublicApi->vote_comment :\n")

31 pprint(api_response)

32 except Exception as e:

33 print("Exception lors de l'appel de PublicApi->vote_comment : %s\n" % e)

34

Paramètres

Réponse

Retourne : GetCommentsForUserResponse

Exemple

Exemple 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# Définir l'hôte est facultatif et utilise https://fastcomments.com par défaut

10# Voir configuration.py pour la liste de tous les paramètres de configuration pris en charge.

11configuration = client.Configuration(

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

13)

14

15

16# Entrer dans un contexte avec une instance du client API

17with client.ApiClient(configuration) as api_client:

18 # Créer une instance de la classe API

19 api_instance = client.PublicApi(api_client)

20 user_id = 'user_id_example' # str | (optionnel)

21 direction = client.SortDirections() # SortDirections | (optionnel)

22 replies_to_user_id = 'replies_to_user_id_example' # str | (optionnel)

23 page = 3.4 # float | (optionnel)

24 includei10n = True # bool | (optionnel)

25 locale = 'locale_example' # str | (optionnel)

26 is_crawler = True # bool | (optionnel)

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

Paramètres

Réponse

Renvoie : AddDomainConfigResponse

Exemple

Exemple 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# La définition de l'hôte est optionnelle et la valeur par défaut est https://fastcomments.com

9# Voir configuration.py pour la liste de tous les paramètres de configuration pris en charge.

10configuration = client.Configuration(

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

12)

13

14# Le client doit configurer les paramètres d'authentification et d'autorisation

15# conformément à la politique de sécurité du serveur API.

16# Des exemples pour chaque méthode d'authentification sont fournis ci‑dessous, utilisez l'exemple qui

17# correspond à votre cas d'utilisation d'authentification.

18

19# Configurer l'autorisation par clé API : api_key

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

21

22# Décommentez ci‑dessous pour configurer un préfixe (par ex. Bearer) pour la clé API, si nécessaire

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

24

25# Entrez dans un contexte avec une instance du client API

26with client.ApiClient(configuration) as api_client:

27 # Créez une instance de la classe 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

Parameters

Réponse

Renvoie : DeleteDomainConfigResponse

Exemple

Exemple de 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# La définition de l'hôte est optionnelle et par défaut https://fastcomments.com

8# Voir configuration.py pour la liste de tous les paramètres de configuration pris en charge.

9configuration = client.Configuration(

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

11)

12

13# Le client doit configurer les paramètres d'authentification et d'autorisation

14# conformément à la politique de sécurité du serveur API.

15# Des exemples pour chaque méthode d'authentification sont fournis ci-dessous, utilisez l'exemple qui

16# correspond à votre cas d'utilisation d'authentification.

17

18# Configurer l'authentification par clé API : api_key

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

20

21# Décommentez ci-dessous pour configurer le préfixe (par ex. Bearer) pour la clé API, si nécessaire

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

23

24# Entrez dans un contexte avec une instance du client API

25with client.ApiClient(configuration) as api_client:

26 # Créez une instance de la classe 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

Paramètres

Réponse

Renvoie : GetDomainConfigResponse

Exemple

Exemple 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# La définition de l'hôte est optionnelle et par défaut vaut https://fastcomments.com

8# Voir configuration.py pour la liste de tous les paramètres de configuration pris en charge.

9configuration = client.Configuration(

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

11)

12

13# Le client doit configurer les paramètres d'authentification et d'autorisation

14# conformément à la politique de sécurité du serveur API.

15# Des exemples pour chaque méthode d'authentification sont fournis ci-dessous, utilisez celui

16# qui convient à votre cas d'utilisation d'authentification.

17

18# Configure API key authorization: api_key

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

20

21# Décommentez ci-dessous pour définir un préfixe (p. ex. Bearer) pour la clé API, si nécessaire

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

23

24# Entrez dans un contexte avec une instance du client API

25with client.ApiClient(configuration) as api_client:

26 # Créez une instance de la classe 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

Paramètres

Réponse

Renvoie : GetDomainConfigsResponse

Exemple

Exemple 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# La définition de l'hôte est optionnelle et par défaut https://fastcomments.com

8# Voir configuration.py pour la liste de tous les paramètres de configuration pris en charge.

9configuration = client.Configuration(

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

11)

12

13# Le client doit configurer les paramètres d'authentification et d'autorisation

14# conformément à la politique de sécurité du serveur API.

15# Des exemples pour chaque méthode d'authentification sont fournis ci-dessous, utilisez l'exemple qui

16# correspond à votre cas d'utilisation d'authentification.

17

18# Configurer l'authentification par clé API : api_key

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

20

21# Décommentez ci-dessous pour configurer le préfixe (par exemple Bearer) pour la clé API, si nécessaire

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

23

24# Entrez dans le contexte avec une instance du client API

25with client.ApiClient(configuration) as api_client:

26 # Créez une instance de la classe 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

Paramètres

Réponse

Renvoie : PatchDomainConfigResponse

Exemple

Exemple de 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# La définition de l'hôte est optionnelle et a pour valeur par défaut https://fastcomments.com

9# Voir configuration.py pour la liste de tous les paramètres de configuration pris en charge.

10configuration = client.Configuration(

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

12)

13

14# Le client doit configurer les paramètres d'authentification et d'autorisation

15# conformément à la politique de sécurité du serveur API.

16# Des exemples pour chaque méthode d'authentification sont fournis ci‑dessous, utilisez celui

17# qui correspond à votre cas d'utilisation d'authentification.

18

19# Configure API key authorization: api_key

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

21

22# Décommentez ci‑dessous pour configurer un préfixe (p. ex. Bearer) pour la clé API, si nécessaire

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

24

25# Entrez dans un contexte avec une instance du client API

26with client.ApiClient(configuration) as api_client:

27 # Créez une instance de la classe 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

Paramètres

Réponse

Renvoie : PutDomainConfigResponse

Exemple

Exemple de 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# Définir l'hôte est optionnel et par défaut https://fastcomments.com

9# Voir configuration.py pour la liste de tous les paramètres de configuration pris en charge.

10configuration = client.Configuration(

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

12)

13

14# Le client doit configurer les paramètres d'authentification et d'autorisation

15# conformément à la politique de sécurité du serveur API.

16# Des exemples pour chaque méthode d'authentification sont fournis ci-dessous ; utilisez l'exemple qui

17# correspond à votre cas d'utilisation d'authentification.

18

19# Configurer l'authentification par clé API: api_key

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

21

22# Décommentez ci-dessous pour configurer un préfixe (par ex. Bearer) pour la clé API, si nécessaire

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

24

25# Entrez dans un contexte avec une instance du client API

26with client.ApiClient(configuration) as api_client:

27 # Créez une instance de la classe 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

Paramètres

Réponse

Retourne : CreateEmailTemplateResponse

Exemple

Exemple de 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# La définition de l'hôte est optionnelle et la valeur par défaut est https://fastcomments.com

9# Voir configuration.py pour la liste de tous les paramètres de configuration pris en charge.

10configuration = client.Configuration(

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

12)

13

14# Le client doit configurer les paramètres d'authentification et d'autorisation

15# conformément à la stratégie de sécurité du serveur API.

16# Des exemples pour chaque méthode d'authentification sont fournis ci‑dessous, utilisez l'exemple qui

17# correspond à votre cas d'utilisation d'authentification.

18

19# Configurer l'autorisation par clé API : api_key

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

21

22# Décommentez ci‑dessous pour définir un préfixe (par ex. Bearer) pour la clé API, si nécessaire

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

24

25# Entrer dans un contexte avec une instance du client API

26with client.ApiClient(configuration) as api_client:

27 # Créer une instance de la classe 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