FastComments.com

FastComments PHP SDK

Ceci est le SDK PHP officiel pour FastComments.

SDK PHP officiel pour l'API FastComments

Dépôt

Voir sur GitHub


Installation et utilisation Internal Link

Prérequis

PHP 7.4 et versions ultérieures. Devrait également fonctionner avec PHP 8.0.

Composer

Pour installer les bindings via Composer, ajoutez ce qui suit à composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/fastcomments/fastcomments-php.git"
    }
  ],
  "require": {
    "fastcomments/fastcomments-php": "*@dev"
  }
}

Ensuite, exécutez composer install

Installation manuelle

Téléchargez les fichiers et incluez autoload.php:

<?php
require_once('/path/to/fastcomments/client/vendor/autoload.php');

Prise en main Internal Link

Veuillez suivre la procédure d'installation puis exécutez ce qui suit :

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure API key authorization: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new FastComments\Client\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$add_domain_config_params = new \FastComments\Client\Model\AddDomainConfigParams(); // \FastComments\Client\Model\AddDomainConfigParams

try {
    $result = $apiInstance->addDomainConfig($tenant_id, $add_domain_config_params);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->addDomainConfig: ', $e->getMessage(), PHP_EOL;
}

Modèles Internal Link



Autorisation Internal Link


Schémas d'authentification définis pour l'API:

api_key

  • Type: Clé API
  • Nom du paramètre de la clé API: x-api-key
  • Emplacement: en-tête HTTP

Auteur Internal Link

support@fastcomments.com

aggregate Internal Link

Agrège des documents en les groupant (si groupBy est fourni) et en appliquant plusieurs opérations. Différentes opérations (par ex. sum, countDistinct, avg, etc.) sont prises en charge.

Paramètres

Name Type Location Required Description
tenantId string query Yes
parentTenantId string query No
includeStats boolean query No

Réponse

Retourne: AggregationResponse

Exemple

Exemple : agrégation
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$aggregation_request = new \FastComments\Client\Model\AggregationRequest(); // \FastComments\Client\Model\AggregationRequest
20$parent_tenant_id = 'parent_tenant_id_example'; // string
21$include_stats = True; // bool
22
23try {
24 $result = $apiInstance->aggregate($tenant_id, $aggregation_request, $parent_tenant_id, $include_stats);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->aggregate: ', $e->getMessage(), PHP_EOL;
28}
29

getAuditLogs Internal Link

Paramètres

Nom Type Emplacement Requis Description
tenantId string query Yes
limit number query No
skip number query No
order string query No
after number query No
before number query No

Réponse

Retourne : GetAuditLogs200Response

Exemple

Exemple de getAuditLogs
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation par clé API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (e.g. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé comme valeur par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$limit = 3.4; // float
20$skip = 3.4; // float
21$order = new \FastComments\Client\Model\\FastComments\Client\Model\SORTDIR(); // \FastComments\Client\Model\SORTDIR
22$after = 3.4; // float
23$before = 3.4; // float
24
25try {
26 $result = $apiInstance->getAuditLogs($tenant_id, $limit, $skip, $order, $after, $before);
27 print_r($result);
28} catch (Exception $e) {
29 echo 'Exception when calling DefaultApi->getAuditLogs: ', $e->getMessage(), PHP_EOL;
30}
31

blockFromCommentPublic Internal Link

Paramètres

Nom Type Emplacement Obligatoire Description
tenantId string query Oui
commentId string path Oui
sso string query Non

Réponse

Retourne : BlockFromCommentPublic200Response

Exemple

Exemple blockFromCommentPublic
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous voulez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$comment_id = 'comment_id_example'; // string
14$public_block_from_comment_params = new \FastComments\Client\Model\PublicBlockFromCommentParams(); // \FastComments\Client\Model\PublicBlockFromCommentParams
15$sso = 'sso_example'; // string
16
17try {
18 $result = $apiInstance->blockFromCommentPublic($tenant_id, $comment_id, $public_block_from_comment_params, $sso);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->blockFromCommentPublic: ', $e->getMessage(), PHP_EOL;
22}
23

unBlockCommentPublic Internal Link

Paramètres

Name Type Location Required Description
tenantId string query Oui
commentId string path Oui
sso string query Non

Réponse

Retourne: UnBlockCommentPublic200Response

Exemple

Exemple de unBlockCommentPublic
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$comment_id = 'comment_id_example'; // string
14$public_block_from_comment_params = new \FastComments\Client\Model\PublicBlockFromCommentParams(); // \FastComments\Client\Model\PublicBlockFromCommentParams
15$sso = 'sso_example'; // string
16
17try {
18 $result = $apiInstance->unBlockCommentPublic($tenant_id, $comment_id, $public_block_from_comment_params, $sso);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->unBlockCommentPublic: ', $e->getMessage(), PHP_EOL;
22}
23

checkedCommentsForBlocked Internal Link

Paramètres

Nom Type Emplacement Obligatoire Description
tenantId string query Oui
commentIds string query Oui Une liste d'identifiants de commentaires séparés par des virgules.
sso string query Non

Réponse

Renvoie: CheckedCommentsForBlocked200Response

Exemple

Exemple de checkedCommentsForBlocked
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, fournissez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$comment_ids = 'comment_ids_example'; // string | Une liste d'identifiants de commentaires séparés par des virgules.
14$sso = 'sso_example'; // string
15
16try {
17 $result = $apiInstance->checkedCommentsForBlocked($tenant_id, $comment_ids, $sso);
18 print_r($result);
19} catch (Exception $e) {
20 echo 'Exception when calling PublicApi->checkedCommentsForBlocked: ', $e->getMessage(), PHP_EOL;
21}
22

blockUserFromComment Internal Link

Paramètres

Name Type Location Required Description
tenantId string query Oui
id string path Oui
userId string query Non
anonUserId string query Non

Response

Renvoie: BlockFromCommentPublic200Response

Exemple

Exemple de blockUserFromComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation par clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$block_from_comment_params = new \FastComments\Client\Model\BlockFromCommentParams(); // \FastComments\Client\Model\BlockFromCommentParams
21$user_id = 'user_id_example'; // string
22$anon_user_id = 'anon_user_id_example'; // string
23
24try {
25 $result = $apiInstance->blockUserFromComment($tenant_id, $id, $block_from_comment_params, $user_id, $anon_user_id);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->blockUserFromComment: ', $e->getMessage(), PHP_EOL;
29}
30

createCommentPublic Internal Link

Paramètres

Name Type Location Required Description
tenantId string path Oui
urlId string query Oui
broadcastId string query Oui
sessionId string query Non
sso string query Non

Réponse

Renvoie : CreateCommentPublic200Response

Exemple

Exemple de createCommentPublic
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel : `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$url_id = 'url_id_example'; // string
14$broadcast_id = 'broadcast_id_example'; // string
15$comment_data = new \FastComments\Client\Model\CommentData(); // \FastComments\Client\Model\CommentData
16$session_id = 'session_id_example'; // string
17$sso = 'sso_example'; // string
18
19try {
20 $result = $apiInstance->createCommentPublic($tenant_id, $url_id, $broadcast_id, $comment_data, $session_id, $sso);
21 print_r($result);
22} catch (Exception $e) {
23 echo 'Exception when calling PublicApi->createCommentPublic: ', $e->getMessage(), PHP_EOL;
24}
25

deleteComment Internal Link

Paramètres

Nom Type Location Requis Description
tenantId string query Oui
id string path Oui
contextUserId string query Non
isLive boolean query Non

Réponse

Renvoie: DeleteComment200Response

Exemple

Exemple de deleteComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'authentification par clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour définir le préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous voulez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$context_user_id = 'context_user_id_example'; // string
21$is_live = True; // bool
22
23try {
24 $result = $apiInstance->deleteComment($tenant_id, $id, $context_user_id, $is_live);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->deleteComment: ', $e->getMessage(), PHP_EOL;
28}
29

deleteCommentPublic Internal Link

Paramètres

Name Type Emplacement Obligatoire Description
tenantId string chemin Oui
commentId string chemin Oui
broadcastId string paramètre de requête Oui
editKey string paramètre de requête Non
sso string paramètre de requête Non

Réponse

Retourne : DeleteCommentPublic200Response

Exemple

Exemple de deleteCommentPublic
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // chaîne
13$comment_id = 'comment_id_example'; // chaîne
14$broadcast_id = 'broadcast_id_example'; // chaîne
15$edit_key = 'edit_key_example'; // chaîne
16$sso = 'sso_example'; // chaîne
17
18try {
19 $result = $apiInstance->deleteCommentPublic($tenant_id, $comment_id, $broadcast_id, $edit_key, $sso);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling PublicApi->deleteCommentPublic: ', $e->getMessage(), PHP_EOL;
23}
24

deleteCommentVote Internal Link

Paramètres

Name Type Location Required Description
tenantId string path Oui
commentId string path Oui
voteId string path Oui
urlId string query Oui
broadcastId string query Oui
editKey string query Non
sso string query Non

Réponse

Renvoie : DeleteCommentVote200Response

Exemple

Exemple de deleteCommentVote
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$comment_id = 'comment_id_example'; // string
14$vote_id = 'vote_id_example'; // string
15$url_id = 'url_id_example'; // string
16$broadcast_id = 'broadcast_id_example'; // string
17$edit_key = 'edit_key_example'; // string
18$sso = 'sso_example'; // string
19
20try {
21 $result = $apiInstance->deleteCommentVote($tenant_id, $comment_id, $vote_id, $url_id, $broadcast_id, $edit_key, $sso);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling PublicApi->deleteCommentVote: ', $e->getMessage(), PHP_EOL;
25}
26

flagComment Internal Link

Paramètres

Nom Type Emplacement Obligatoire Description
tenantId string query Oui
id string path Oui
userId string query Non
anonUserId string query Non

Réponse

Renvoie : FlagComment200Response

Exemple

Exemple de flagComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation par clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$user_id = 'user_id_example'; // string
21$anon_user_id = 'anon_user_id_example'; // string
22
23try {
24 $result = $apiInstance->flagComment($tenant_id, $id, $user_id, $anon_user_id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->flagComment: ', $e->getMessage(), PHP_EOL;
28}
29

getComment Internal Link

Paramètres

Name Type Location Required Description
tenantId string query Oui
id string path Oui

Réponse

Renvoie : GetComment200Response

Exemple

Exemple de getComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20
21try {
22 $result = $apiInstance->getComment($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getComment: ', $e->getMessage(), PHP_EOL;
26}
27

getComments Internal Link

Paramètres

Name Type Location Required Description
tenantId string query Oui
page integer query Non
limit integer query Non
skip integer query Non
asTree boolean query Non
skipChildren integer query Non
limitChildren integer query Non
maxTreeDepth integer query Non
urlId string query Non
userId string query Non
anonUserId string query Non
contextUserId string query Non
hashTag string query Non
parentId string query Non
direction string query Non

Réponse

Renvoie : GetComments200Response

Exemple

Exemple de getComments
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de la clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (par exemple Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$page = 56; // int
20$limit = 56; // int
21$skip = 56; // int
22$as_tree = True; // bool
23$skip_children = 56; // int
24$limit_children = 56; // int
25$max_tree_depth = 56; // int
26$url_id = 'url_id_example'; // string
27$user_id = 'user_id_example'; // string
28$anon_user_id = 'anon_user_id_example'; // string
29$context_user_id = 'context_user_id_example'; // string
30$hash_tag = 'hash_tag_example'; // string
31$parent_id = 'parent_id_example'; // string
32$direction = new \FastComments\Client\Model\\FastComments\Client\Model\SortDirections(); // \FastComments\Client\Model\SortDirections
33
34try {
35 $result = $apiInstance->getComments($tenant_id, $page, $limit, $skip, $as_tree, $skip_children, $limit_children, $max_tree_depth, $url_id, $user_id, $anon_user_id, $context_user_id, $hash_tag, $parent_id, $direction);
36 print_r($result);
37} catch (Exception $e) {
38 echo 'Exception when calling DefaultApi->getComments: ', $e->getMessage(), PHP_EOL;
39}
40

getCommentsPublic Internal Link

req tenantId urlId

Paramètres

Nom Type Emplacement Obligatoire Description
tenantId string path Oui
urlId string query Oui
page integer query Non
direction string query Non
sso string query Non
skip integer query Non
skipChildren integer query Non
limit integer query Non
limitChildren integer query Non
countChildren boolean query Non
fetchPageForCommentId string query Non
includeConfig boolean query Non
countAll boolean query Non
includei10n boolean query Non
locale string query Non
modules string query Non
isCrawler boolean query Non
includeNotificationCount boolean query Non
asTree boolean query Non
maxTreeDepth integer query Non
useFullTranslationIds boolean query Non
parentId string query Non
searchText string query Non
hashTags array query Non
userId string query Non
customConfigStr string query Non
afterCommentId string query Non
beforeCommentId string query Non

Réponse

Renvoie: GetCommentsPublic200Response

Exemple

Exemple getCommentsPublic
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$url_id = 'url_id_example'; // string
14$page = 56; // int
15$direction = new \FastComments\Client\Model\\FastComments\Client\Model\SortDirections(); // \FastComments\Client\Model\SortDirections
16$sso = 'sso_example'; // string
17$skip = 56; // int
18$skip_children = 56; // int
19$limit = 56; // int
20$limit_children = 56; // int
21$count_children = True; // bool
22$fetch_page_for_comment_id = 'fetch_page_for_comment_id_example'; // string
23$include_config = True; // bool
24$count_all = True; // bool
25$includei10n = True; // bool
26$locale = 'locale_example'; // string
27$modules = 'modules_example'; // string
28$is_crawler = True; // bool
29$include_notification_count = True; // bool
30$as_tree = True; // bool
31$max_tree_depth = 56; // int
32$use_full_translation_ids = True; // bool
33$parent_id = 'parent_id_example'; // string
34$search_text = 'search_text_example'; // string
35$hash_tags = array('hash_tags_example'); // string[]
36$user_id = 'user_id_example'; // string
37$custom_config_str = 'custom_config_str_example'; // string
38$after_comment_id = 'after_comment_id_example'; // string
39$before_comment_id = 'before_comment_id_example'; // string
40
41try {
42 $result = $apiInstance->getCommentsPublic($tenant_id, $url_id, $page, $direction, $sso, $skip, $skip_children, $limit, $limit_children, $count_children, $fetch_page_for_comment_id, $include_config, $count_all, $includei10n, $locale, $modules, $is_crawler, $include_notification_count, $as_tree, $max_tree_depth, $use_full_translation_ids, $parent_id, $search_text, $hash_tags, $user_id, $custom_config_str, $after_comment_id, $before_comment_id);
43 print_r($result);
44} catch (Exception $e) {
45 echo 'Exception when calling PublicApi->getCommentsPublic: ', $e->getMessage(), PHP_EOL;
46}
47

getCommentText Internal Link

Paramètres

Nom Type Emplacement Obligatoire Description
tenantId string path Oui
commentId string path Oui
editKey string query Non
sso string query Non

Réponse

Renvoie: GetCommentText200Response

Exemple

Exemple de getCommentText
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$comment_id = 'comment_id_example'; // string
14$edit_key = 'edit_key_example'; // string
15$sso = 'sso_example'; // string
16
17try {
18 $result = $apiInstance->getCommentText($tenant_id, $comment_id, $edit_key, $sso);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->getCommentText: ', $e->getMessage(), PHP_EOL;
22}
23

getCommentVoteUserNames Internal Link

Paramètres

Nom Type Emplacement Obligatoire Description
tenantId string path Oui
commentId string path Oui
dir integer query Oui
sso string query Non

Réponse

Renvoie : GetCommentVoteUserNames200Response

Exemple

Exemple de getCommentVoteUserNames
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$comment_id = 'comment_id_example'; // string
14$dir = 56; // int
15$sso = 'sso_example'; // string
16
17try {
18 $result = $apiInstance->getCommentVoteUserNames($tenant_id, $comment_id, $dir, $sso);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->getCommentVoteUserNames: ', $e->getMessage(), PHP_EOL;
22}
23

lockComment Internal Link

Paramètres

Name Type Location Required Description
tenantId string path Oui
commentId string path Oui
broadcastId string query Oui
sso string query Non

Réponse

Retourne : LockComment200Response

Exemple

Exemple de lockComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // chaîne
13$comment_id = 'comment_id_example'; // chaîne
14$broadcast_id = 'broadcast_id_example'; // chaîne
15$sso = 'sso_example'; // chaîne
16
17try {
18 $result = $apiInstance->lockComment($tenant_id, $comment_id, $broadcast_id, $sso);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->lockComment: ', $e->getMessage(), PHP_EOL;
22}
23

pinComment Internal Link

Paramètres

Nom Type Emplacement Obligatoire Description
tenantId string path Oui
commentId string path Oui
broadcastId string query Oui
sso string query Non

Réponse

Renvoie : PinComment200Response

Exemple

Exemple de pinComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$comment_id = 'comment_id_example'; // string
14$broadcast_id = 'broadcast_id_example'; // string
15$sso = 'sso_example'; // string
16
17try {
18 $result = $apiInstance->pinComment($tenant_id, $comment_id, $broadcast_id, $sso);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->pinComment: ', $e->getMessage(), PHP_EOL;
22}
23

saveComment Internal Link

Paramètres

Nom Type Emplacement Obligatoire Description
tenantId string query Oui
isLive boolean query Non
doSpamCheck boolean query Non
sendEmails boolean query Non
populateNotifications boolean query Non

Réponse

Renvoie : SaveComment200Response

Exemple

Exemple de saveComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'authentification par clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$create_comment_params = new \FastComments\Client\Model\CreateCommentParams(); // \FastComments\Client\Model\CreateCommentParams
20$is_live = True; // bool
21$do_spam_check = True; // bool
22$send_emails = True; // bool
23$populate_notifications = True; // bool
24
25try {
26 $result = $apiInstance->saveComment($tenant_id, $create_comment_params, $is_live, $do_spam_check, $send_emails, $populate_notifications);
27 print_r($result);
28} catch (Exception $e) {
29 echo 'Exception when calling DefaultApi->saveComment: ', $e->getMessage(), PHP_EOL;
30}
31

saveCommentsBulk Internal Link

Paramètres

Name Type Location Required Description
tenantId string query Oui
isLive boolean query Non
doSpamCheck boolean query Non
sendEmails boolean query Non
populateNotifications boolean query Non

Réponse

Renvoie: SaveComment200Response

Exemple

Exemple de saveCommentsBulk
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'authentification par clé API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$create_comment_params = array(new \FastComments\Client\Model\CreateCommentParams()); // \FastComments\Client\Model\CreateCommentParams[]
20$is_live = True; // bool
21$do_spam_check = True; // bool
22$send_emails = True; // bool
23$populate_notifications = True; // bool
24
25try {
26 $result = $apiInstance->saveCommentsBulk($tenant_id, $create_comment_params, $is_live, $do_spam_check, $send_emails, $populate_notifications);
27 print_r($result);
28} catch (Exception $e) {
29 echo 'Exception when calling DefaultApi->saveCommentsBulk: ', $e->getMessage(), PHP_EOL;
30}
31

setCommentText Internal Link

Paramètres

Nom Type Location Requis Description
tenantId string path Oui
commentId string path Oui
broadcastId string query Oui
editKey string query Non
sso string query Non

Réponse

Renvoie : SetCommentText200Response

Exemple

Exemple de setCommentText
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$comment_id = 'comment_id_example'; // string
14$broadcast_id = 'broadcast_id_example'; // string
15$comment_text_update_request = new \FastComments\Client\Model\CommentTextUpdateRequest(); // \FastComments\Client\Model\CommentTextUpdateRequest
16$edit_key = 'edit_key_example'; // string
17$sso = 'sso_example'; // string
18
19try {
20 $result = $apiInstance->setCommentText($tenant_id, $comment_id, $broadcast_id, $comment_text_update_request, $edit_key, $sso);
21 print_r($result);
22} catch (Exception $e) {
23 echo 'Exception when calling PublicApi->setCommentText: ', $e->getMessage(), PHP_EOL;
24}
25

unBlockUserFromComment Internal Link

Paramètres

Nom Type Emplacement Obligatoire Description
tenantId string query Oui
id string path Oui
userId string query Non
anonUserId string query Non

Réponse

Renvoie: UnBlockCommentPublic200Response

Exemple

Exemple de unBlockUserFromComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
14 // This is optional, `GuzzleHttp\Client` will be used as default.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$un_block_from_comment_params = new \FastComments\Client\Model\UnBlockFromCommentParams(); // \FastComments\Client\Model\UnBlockFromCommentParams
21$user_id = 'user_id_example'; // string
22$anon_user_id = 'anon_user_id_example'; // string
23
24try {
25 $result = $apiInstance->unBlockUserFromComment($tenant_id, $id, $un_block_from_comment_params, $user_id, $anon_user_id);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->unBlockUserFromComment: ', $e->getMessage(), PHP_EOL;
29}
30

unFlagComment Internal Link

Paramètres

Name Type Location Required Description
tenantId string query Oui
id string path Oui
userId string query Non
anonUserId string query Non

Response

Retourne : FlagComment200Response

Exemple

Exemple de unFlagComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'authentification par clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez la ligne ci-dessous pour définir un préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$user_id = 'user_id_example'; // string
21$anon_user_id = 'anon_user_id_example'; // string
22
23try {
24 $result = $apiInstance->unFlagComment($tenant_id, $id, $user_id, $anon_user_id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->unFlagComment: ', $e->getMessage(), PHP_EOL;
28}
29

unLockComment Internal Link

Paramètres

Name Type Location Required Description
tenantId string path Oui
commentId string path Oui
broadcastId string query Oui
sso string query Non

Réponse

Renvoie: LockComment200Response

Exemple

Exemple de unLockComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$comment_id = 'comment_id_example'; // string
14$broadcast_id = 'broadcast_id_example'; // string
15$sso = 'sso_example'; // string
16
17try {
18 $result = $apiInstance->unLockComment($tenant_id, $comment_id, $broadcast_id, $sso);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->unLockComment: ', $e->getMessage(), PHP_EOL;
22}
23

unPinComment Internal Link

Paramètres

Nom Type Emplacement Obligatoire Description
tenantId string chemin Oui
commentId string chemin Oui
broadcastId string requête Oui
sso string requête Non

Réponse

Renvoie : PinComment200Response

Exemple

Exemple pour unPinComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // chaîne
13$comment_id = 'comment_id_example'; // chaîne
14$broadcast_id = 'broadcast_id_example'; // chaîne
15$sso = 'sso_example'; // chaîne
16
17try {
18 $result = $apiInstance->unPinComment($tenant_id, $comment_id, $broadcast_id, $sso);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->unPinComment: ', $e->getMessage(), PHP_EOL;
22}
23

updateComment Internal Link

Paramètres

Name Type Location Required Description
tenantId string query Oui
id string path Oui
contextUserId string query Non
doSpamCheck boolean query Non
isLive boolean query Non

Réponse

Retourne: FlagCommentPublic200Response

Exemple

Exemple pour updateComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
14 // This is optional, `GuzzleHttp\Client` will be used as default.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$body = new \FastComments\Client\Model\PickAPICommentUpdatableCommentFields(); // \FastComments\Client\Model\PickAPICommentUpdatableCommentFields
21$context_user_id = 'context_user_id_example'; // string
22$do_spam_check = True; // bool
23$is_live = True; // bool
24
25try {
26 $result = $apiInstance->updateComment($tenant_id, $id, $body, $context_user_id, $do_spam_check, $is_live);
27 print_r($result);
28} catch (Exception $e) {
29 echo 'Exception when calling DefaultApi->updateComment: ', $e->getMessage(), PHP_EOL;
30}
31

voteComment Internal Link

Paramètres

Name Type Emplacement Obligatoire Description
tenantId string path Oui
commentId string path Oui
urlId string query Oui
broadcastId string query Oui
sessionId string query Non
sso string query Non

Réponse

Renvoie : VoteComment200Response

Exemple

Exemple de voteComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$comment_id = 'comment_id_example'; // string
14$url_id = 'url_id_example'; // string
15$broadcast_id = 'broadcast_id_example'; // string
16$vote_body_params = new \FastComments\Client\Model\VoteBodyParams(); // \FastComments\Client\Model\VoteBodyParams
17$session_id = 'session_id_example'; // string
18$sso = 'sso_example'; // string
19
20try {
21 $result = $apiInstance->voteComment($tenant_id, $comment_id, $url_id, $broadcast_id, $vote_body_params, $session_id, $sso);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling PublicApi->voteComment: ', $e->getMessage(), PHP_EOL;
25}
26

addDomainConfig Internal Link

Paramètres

Name Type Location Required Description
tenantId string query Oui

Réponse

Renvoie: AddDomainConfig200Response

Exemple

Exemple addDomainConfig
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'authentification par clé API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$add_domain_config_params = new \FastComments\Client\Model\AddDomainConfigParams(); // \FastComments\Client\Model\AddDomainConfigParams
20
21try {
22 $result = $apiInstance->addDomainConfig($tenant_id, $add_domain_config_params);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->addDomainConfig: ', $e->getMessage(), PHP_EOL;
26}
27

deleteDomainConfig Internal Link

Paramètres

Name Type Location Required Description
tenantId string query Oui
domain string path Oui

Réponse

Renvoie : DeleteDomainConfig200Response

Exemple

Exemple de deleteDomainConfig
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation par clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$domain = 'domain_example'; // string
20
21try {
22 $result = $apiInstance->deleteDomainConfig($tenant_id, $domain);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->deleteDomainConfig: ', $e->getMessage(), PHP_EOL;
26}
27

getDomainConfig Internal Link

Paramètres

Nom Type Emplacement Requis Description
tenantId string query Oui
domain string path Oui

Réponse

Renvoie : GetDomainConfig200Response

Exemple

Exemple de getDomainConfig
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation par clé d'API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (par ex. Bearer) pour la clé d'API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$domain = 'domain_example'; // string
20
21try {
22 $result = $apiInstance->getDomainConfig($tenant_id, $domain);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getDomainConfig: ', $e->getMessage(), PHP_EOL;
26}
27

getDomainConfigs Internal Link

Paramètres

Name Type Location Required Description
tenantId string query Oui

Réponse

Retourne : GetDomainConfigs200Response

Exemple

Exemple de getDomainConfigs
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation par clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez la ligne ci-dessous pour configurer un préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19
20try {
21 $result = $apiInstance->getDomainConfigs($tenant_id);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling DefaultApi->getDomainConfigs: ', $e->getMessage(), PHP_EOL;
25}
26

patchDomainConfig Internal Link

Paramètres

Name Type Location Required Description
tenantId string query Oui
domainToUpdate string path Oui

Réponse

Renvoie : GetDomainConfig200Response

Exemple

Exemple pour patchDomainConfig
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation par clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$domain_to_update = 'domain_to_update_example'; // string
20$patch_domain_config_params = new \FastComments\Client\Model\PatchDomainConfigParams(); // \FastComments\Client\Model\PatchDomainConfigParams
21
22try {
23 $result = $apiInstance->patchDomainConfig($tenant_id, $domain_to_update, $patch_domain_config_params);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->patchDomainConfig: ', $e->getMessage(), PHP_EOL;
27}
28

putDomainConfig Internal Link

Paramètres

Nom Type Emplacement Obligatoire Description
tenantId string query Oui
domainToUpdate string path Oui

Réponse

Renvoie : GetDomainConfig200Response

Exemple

Exemple putDomainConfig
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'authentification par clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$domain_to_update = 'domain_to_update_example'; // string
20$update_domain_config_params = new \FastComments\Client\Model\UpdateDomainConfigParams(); // \FastComments\Client\Model\UpdateDomainConfigParams
21
22try {
23 $result = $apiInstance->putDomainConfig($tenant_id, $domain_to_update, $update_domain_config_params);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->putDomainConfig: ', $e->getMessage(), PHP_EOL;
27}
28

createEmailTemplate Internal Link

Paramètres

Nom Type Emplacement Obligatoire Description
tenantId string query Oui

Réponse

Retourne : CreateEmailTemplate200Response

Exemple

Exemple de createEmailTemplate
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation par clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez la ligne ci-dessous pour configurer le préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$create_email_template_body = new \FastComments\Client\Model\CreateEmailTemplateBody(); // \FastComments\Client\Model\CreateEmailTemplateBody
20
21try {
22 $result = $apiInstance->createEmailTemplate($tenant_id, $create_email_template_body);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->createEmailTemplate: ', $e->getMessage(), PHP_EOL;
26}
27

deleteEmailTemplate Internal Link

Paramètres

Nom Type Emplacement Requis Description
tenantId string query Oui
id string path Oui

Réponse

Renvoie : FlagCommentPublic200Response

Exemple

Exemple de deleteEmailTemplate
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'authentification par clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // chaîne
19$id = 'id_example'; // chaîne
20
21try {
22 $result = $apiInstance->deleteEmailTemplate($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->deleteEmailTemplate: ', $e->getMessage(), PHP_EOL;
26}
27

deleteEmailTemplateRenderError Internal Link

Paramètres

Name Type Location Required Description
tenantId string query Oui
id string path Oui
errorId string path Oui

Réponse

Retourne: FlagCommentPublic200Response

Exemple

Exemple de deleteEmailTemplateRenderError
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation par clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer un préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$error_id = 'error_id_example'; // string
21
22try {
23 $result = $apiInstance->deleteEmailTemplateRenderError($tenant_id, $id, $error_id);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->deleteEmailTemplateRenderError: ', $e->getMessage(), PHP_EOL;
27}
28

getEmailTemplate Internal Link

Paramètres

Nom Type Emplacement Obligatoire Description
tenantId string query Oui
id string path Oui

Réponse

Renvoie: GetEmailTemplate200Response

Exemple

Exemple getEmailTemplate
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation par clé API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20
21try {
22 $result = $apiInstance->getEmailTemplate($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getEmailTemplate: ', $e->getMessage(), PHP_EOL;
26}
27

getEmailTemplateDefinitions Internal Link

Paramètres

Nom Type Emplacement Requis Description
tenantId string query Oui

Réponse

Renvoie: GetEmailTemplateDefinitions200Response

Exemple

Exemple de getEmailTemplateDefinitions
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19
20try {
21 $result = $apiInstance->getEmailTemplateDefinitions($tenant_id);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling DefaultApi->getEmailTemplateDefinitions: ', $e->getMessage(), PHP_EOL;
25}
26

getEmailTemplateRenderErrors Internal Link

Paramètres

Nom Type Emplacement Obligatoire Description
tenantId string query Oui
id string path Oui
skip number query Non

Réponse

Retourne : GetEmailTemplateRenderErrors200Response

Exemple

Exemple getEmailTemplateRenderErrors
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'authentification par clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$skip = 3.4; // float
21
22try {
23 $result = $apiInstance->getEmailTemplateRenderErrors($tenant_id, $id, $skip);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->getEmailTemplateRenderErrors: ', $e->getMessage(), PHP_EOL;
27}
28

getEmailTemplates Internal Link

Paramètres

Nom Type Emplacement Obligatoire Description
tenantId string query Oui
skip number query Non

Réponse

Renvoie: GetEmailTemplates200Response

Exemple

Exemple de getEmailTemplates
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation par clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer un préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous voulez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // chaîne
19$skip = 3.4; // nombre à virgule flottante
20
21try {
22 $result = $apiInstance->getEmailTemplates($tenant_id, $skip);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getEmailTemplates: ', $e->getMessage(), PHP_EOL;
26}
27

renderEmailTemplate Internal Link

Paramètres

Name Type Location Required Description
tenantId string query Oui
locale string query Non

Réponse

Renvoie: RenderEmailTemplate200Response

Exemple

Exemple de renderEmailTemplate
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de clé API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (par exemple Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$render_email_template_body = new \FastComments\Client\Model\RenderEmailTemplateBody(); // \FastComments\Client\Model\RenderEmailTemplateBody
20$locale = 'locale_example'; // string
21
22try {
23 $result = $apiInstance->renderEmailTemplate($tenant_id, $render_email_template_body, $locale);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->renderEmailTemplate: ', $e->getMessage(), PHP_EOL;
27}
28

updateEmailTemplate Internal Link

Paramètres

Name Type Location Required Description
tenantId string query Yes
id string path Yes

Réponse

Retourne: FlagCommentPublic200Response

Exemple

Exemple updateEmailTemplate
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
14 // This is optional, `GuzzleHttp\Client` will be used as default.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$update_email_template_body = new \FastComments\Client\Model\UpdateEmailTemplateBody(); // \FastComments\Client\Model\UpdateEmailTemplateBody
21
22try {
23 $result = $apiInstance->updateEmailTemplate($tenant_id, $id, $update_email_template_body);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->updateEmailTemplate: ', $e->getMessage(), PHP_EOL;
27}
28

getEventLog Internal Link

req tenantId urlId userIdWS

Paramètres

Name Type Location Required Description
tenantId string path Oui
urlId string query Oui
userIdWS string query Oui
startTime integer query Oui
endTime integer query Oui

Réponse

Renvoie: GetEventLog200Response

Exemple

Exemple de getEventLog
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$url_id = 'url_id_example'; // string
14$user_id_ws = 'user_id_ws_example'; // string
15$start_time = 56; // int
16$end_time = 56; // int
17
18try {
19 $result = $apiInstance->getEventLog($tenant_id, $url_id, $user_id_ws, $start_time, $end_time);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling PublicApi->getEventLog: ', $e->getMessage(), PHP_EOL;
23}
24

getGlobalEventLog Internal Link

req tenantId urlId userIdWS

Paramètres

Name Type Location Required Description
tenantId string path Oui
urlId string query Oui
userIdWS string query Oui
startTime integer query Oui
endTime integer query Oui

Réponse

Renvoie: GetEventLog200Response

Exemple

Exemple de getGlobalEventLog
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$url_id = 'url_id_example'; // string
14$user_id_ws = 'user_id_ws_example'; // string
15$start_time = 56; // int
16$end_time = 56; // int
17
18try {
19 $result = $apiInstance->getGlobalEventLog($tenant_id, $url_id, $user_id_ws, $start_time, $end_time);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling PublicApi->getGlobalEventLog: ', $e->getMessage(), PHP_EOL;
23}
24

createFeedPost Internal Link

Paramètres

Name Type Location Required Description
tenantId string query Oui
broadcastId string query Non
isLive boolean query Non
doSpamCheck boolean query Non
skipDupCheck boolean query Non

Réponse

Retourne : CreateFeedPost200Response

Exemple

Exemple de createFeedPost
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configuration de l'autorisation par clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$create_feed_post_params = new \FastComments\Client\Model\CreateFeedPostParams(); // \FastComments\Client\Model\CreateFeedPostParams
20$broadcast_id = 'broadcast_id_example'; // string
21$is_live = True; // bool
22$do_spam_check = True; // bool
23$skip_dup_check = True; // bool
24
25try {
26 $result = $apiInstance->createFeedPost($tenant_id, $create_feed_post_params, $broadcast_id, $is_live, $do_spam_check, $skip_dup_check);
27 print_r($result);
28} catch (Exception $e) {
29 echo 'Exception when calling DefaultApi->createFeedPost: ', $e->getMessage(), PHP_EOL;
30}
31

createFeedPostPublic Internal Link

Paramètres

Nom Type Emplacement Obligatoire Description
tenantId string path Oui
broadcastId string query Non
sso string query Non

Réponse

Renvoie : CreateFeedPostPublic200Response

Exemple

Exemple de createFeedPostPublic
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, fournissez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$create_feed_post_params = new \FastComments\Client\Model\CreateFeedPostParams(); // \FastComments\Client\Model\CreateFeedPostParams
14$broadcast_id = 'broadcast_id_example'; // string
15$sso = 'sso_example'; // string
16
17try {
18 $result = $apiInstance->createFeedPostPublic($tenant_id, $create_feed_post_params, $broadcast_id, $sso);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->createFeedPostPublic: ', $e->getMessage(), PHP_EOL;
22}
23

deleteFeedPostPublic Internal Link

Paramètres

Nom Type Emplacement Obligatoire Description
tenantId string path Oui
postId string path Oui
broadcastId string query Non
sso string query Non

Réponse

Renvoie: DeleteFeedPostPublic200Response

Exemple

Exemple de deleteFeedPostPublic
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$post_id = 'post_id_example'; // string
14$broadcast_id = 'broadcast_id_example'; // string
15$sso = 'sso_example'; // string
16
17try {
18 $result = $apiInstance->deleteFeedPostPublic($tenant_id, $post_id, $broadcast_id, $sso);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->deleteFeedPostPublic: ', $e->getMessage(), PHP_EOL;
22}
23

getFeedPosts Internal Link

req tenantId afterId

Paramètres

Name Type Location Required Description
tenantId string query Oui
afterId string query Non
limit integer query Non
tags array query Non

Réponse

Retourne: GetFeedPosts200Response

Exemple

Exemple de getFeedPosts
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$after_id = 'after_id_example'; // string
20$limit = 56; // int
21$tags = array('tags_example'); // string[]
22
23try {
24 $result = $apiInstance->getFeedPosts($tenant_id, $after_id, $limit, $tags);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getFeedPosts: ', $e->getMessage(), PHP_EOL;
28}
29

getFeedPostsPublic Internal Link

req tenantId afterId

Paramètres

Name Type Location Required Description
tenantId string path Oui
afterId string query Non
limit integer query Non
tags array query Non
sso string query Non
isCrawler boolean query Non
includeUserInfo boolean query Non

Réponse

Renvoie : GetFeedPostsPublic200Response

Exemple

Exemple getFeedPostsPublic
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$after_id = 'after_id_example'; // string
14$limit = 56; // int
15$tags = array('tags_example'); // string[]
16$sso = 'sso_example'; // string
17$is_crawler = True; // bool
18$include_user_info = True; // bool
19
20try {
21 $result = $apiInstance->getFeedPostsPublic($tenant_id, $after_id, $limit, $tags, $sso, $is_crawler, $include_user_info);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling PublicApi->getFeedPostsPublic: ', $e->getMessage(), PHP_EOL;
25}
26

getFeedPostsStats Internal Link


Paramètres

Nom Type Emplacement Obligatoire Description
tenantId string path Oui
postIds array query Oui
sso string query Non

Réponse

Renvoie: GetFeedPostsStats200Response

Exemple

Exemple getFeedPostsStats
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$post_ids = array('post_ids_example'); // string[]
14$sso = 'sso_example'; // string
15
16try {
17 $result = $apiInstance->getFeedPostsStats($tenant_id, $post_ids, $sso);
18 print_r($result);
19} catch (Exception $e) {
20 echo 'Exception when calling PublicApi->getFeedPostsStats: ', $e->getMessage(), PHP_EOL;
21}
22

getUserReactsPublic Internal Link

Paramètres

Nom Type Emplacement Obligatoire Description
tenantId string path Yes
postIds array query No
sso string query No

Réponse

Retourne: GetUserReactsPublic200Response

Exemple

Exemple de getUserReactsPublic
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$post_ids = array('post_ids_example'); // string[]
14$sso = 'sso_example'; // string
15
16try {
17 $result = $apiInstance->getUserReactsPublic($tenant_id, $post_ids, $sso);
18 print_r($result);
19} catch (Exception $e) {
20 echo 'Exception when calling PublicApi->getUserReactsPublic: ', $e->getMessage(), PHP_EOL;
21}
22

reactFeedPostPublic Internal Link

Paramètres

Nom Type Location Obligatoire Description
tenantId string path Oui
postId string path Oui
isUndo boolean query Non
broadcastId string query Non
sso string query Non

Réponse

Renvoie: ReactFeedPostPublic200Response

Exemple

Exemple de reactFeedPostPublic
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, fournissez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$post_id = 'post_id_example'; // string
14$react_body_params = new \FastComments\Client\Model\ReactBodyParams(); // \FastComments\Client\Model\ReactBodyParams
15$is_undo = True; // bool
16$broadcast_id = 'broadcast_id_example'; // string
17$sso = 'sso_example'; // string
18
19try {
20 $result = $apiInstance->reactFeedPostPublic($tenant_id, $post_id, $react_body_params, $is_undo, $broadcast_id, $sso);
21 print_r($result);
22} catch (Exception $e) {
23 echo 'Exception when calling PublicApi->reactFeedPostPublic: ', $e->getMessage(), PHP_EOL;
24}
25

updateFeedPost Internal Link

Paramètres

Name Type Location Required Description
tenantId string query Oui
id string path Oui

Réponse

Retourne: FlagCommentPublic200Response

Exemple

Exemple updateFeedPost
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer un préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$feed_post = new \FastComments\Client\Model\FeedPost(); // \FastComments\Client\Model\FeedPost
21
22try {
23 $result = $apiInstance->updateFeedPost($tenant_id, $id, $feed_post);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->updateFeedPost: ', $e->getMessage(), PHP_EOL;
27}
28

updateFeedPostPublic Internal Link

Paramètres

Nom Type Emplacement Obligatoire Description
tenantId string path Oui
postId string path Oui
broadcastId string query Non
sso string query Non

Réponse

Renvoie : CreateFeedPostPublic200Response

Exemple

Exemple pour updateFeedPostPublic
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$post_id = 'post_id_example'; // string
14$update_feed_post_params = new \FastComments\Client\Model\UpdateFeedPostParams(); // \FastComments\Client\Model\UpdateFeedPostParams
15$broadcast_id = 'broadcast_id_example'; // string
16$sso = 'sso_example'; // string
17
18try {
19 $result = $apiInstance->updateFeedPostPublic($tenant_id, $post_id, $update_feed_post_params, $broadcast_id, $sso);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling PublicApi->updateFeedPostPublic: ', $e->getMessage(), PHP_EOL;
23}
24

flagCommentPublic Internal Link

Paramètres

Name Type Location Required Description
tenantId string query Oui
commentId string path Oui
isFlagged boolean query Oui
sso string query Non

Réponse

Renvoie : FlagCommentPublic200Response

Exemple

Exemple de flagCommentPublic
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, fournissez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Cela est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$comment_id = 'comment_id_example'; // string
14$is_flagged = True; // bool
15$sso = 'sso_example'; // string
16
17try {
18 $result = $apiInstance->flagCommentPublic($tenant_id, $comment_id, $is_flagged, $sso);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->flagCommentPublic: ', $e->getMessage(), PHP_EOL;
22}
23

addHashTag Internal Link

Paramètres

Nom Type Emplacement Obligatoire Description
tenantId string query Non

Réponse

Renvoie : AddHashTag200Response

Exemple

Exemple addHashTag
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer un préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous voulez utiliser un client HTTP personnalisé, passez votre client implémentant `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$create_hash_tag_body = new \FastComments\Client\Model\CreateHashTagBody(); // \FastComments\Client\Model\CreateHashTagBody
20
21try {
22 $result = $apiInstance->addHashTag($tenant_id, $create_hash_tag_body);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->addHashTag: ', $e->getMessage(), PHP_EOL;
26}
27

addHashTagsBulk Internal Link

Paramètres

Nom Type Emplacement Requis Description
tenantId string query Non

Réponse

Renvoie: AddHashTagsBulk200Response

Exemple

Exemple addHashTagsBulk
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configuration de l'autorisation par clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$bulk_create_hash_tags_body = new \FastComments\Client\Model\BulkCreateHashTagsBody(); // \FastComments\Client\Model\BulkCreateHashTagsBody
20
21try {
22 $result = $apiInstance->addHashTagsBulk($tenant_id, $bulk_create_hash_tags_body);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->addHashTagsBulk: ', $e->getMessage(), PHP_EOL;
26}
27

deleteHashTag Internal Link

Paramètres

Name Type Location Required Description
tag string chemin Oui
tenantId string requête Non

Réponse

Renvoie : FlagCommentPublic200Response

Exemple

Exemple de deleteHashTag
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
14 // This is optional, `GuzzleHttp\Client` will be used as default.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tag = 'tag_example'; // string
19$tenant_id = 'tenant_id_example'; // string
20$delete_hash_tag_request = new \FastComments\Client\Model\DeleteHashTagRequest(); // \FastComments\Client\Model\DeleteHashTagRequest
21
22try {
23 $result = $apiInstance->deleteHashTag($tag, $tenant_id, $delete_hash_tag_request);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->deleteHashTag: ', $e->getMessage(), PHP_EOL;
27}
28

getHashTags Internal Link

Paramètres

Name Type Location Required Description
tenantId string query Oui
page number query Non

Réponse

Retourne: GetHashTags200Response

Exemple

Exemple de getHashTags
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
14 // This is optional, `GuzzleHttp\Client` will be used as default.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$page = 3.4; // float
20
21try {
22 $result = $apiInstance->getHashTags($tenant_id, $page);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getHashTags: ', $e->getMessage(), PHP_EOL;
26}
27

patchHashTag Internal Link

Paramètres

Nom Type Emplacement Obligatoire Description
tag string path Oui
tenantId string query Non

Réponse

Retourne: PatchHashTag200Response

Exemple

Exemple de patchHashTag
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tag = 'tag_example'; // string
19$tenant_id = 'tenant_id_example'; // string
20$update_hash_tag_body = new \FastComments\Client\Model\UpdateHashTagBody(); // \FastComments\Client\Model\UpdateHashTagBody
21
22try {
23 $result = $apiInstance->patchHashTag($tag, $tenant_id, $update_hash_tag_body);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->patchHashTag: ', $e->getMessage(), PHP_EOL;
27}
28

createModerator Internal Link

Paramètres

Nom Type Emplacement Requis Description
tenantId string query Oui

Réponse

Renvoie : CreateModerator200Response

Exemple

Exemple de createModerator
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'authentification par clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer un préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client implémentant `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$create_moderator_body = new \FastComments\Client\Model\CreateModeratorBody(); // \FastComments\Client\Model\CreateModeratorBody
20
21try {
22 $result = $apiInstance->createModerator($tenant_id, $create_moderator_body);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->createModerator: ', $e->getMessage(), PHP_EOL;
26}
27

deleteModerator Internal Link

Paramètres

Name Type Location Required Description
tenantId string query Oui
id string path Oui
sendEmail string query Non

Réponse

Renvoie: FlagCommentPublic200Response

Exemple

Exemple de deleteModerator
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation par clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$send_email = 'send_email_example'; // string
21
22try {
23 $result = $apiInstance->deleteModerator($tenant_id, $id, $send_email);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->deleteModerator: ', $e->getMessage(), PHP_EOL;
27}
28

getModerator Internal Link

Paramètres

Name Type Location Required Description
tenantId string query Oui
id string path Oui

Réponse

Retourne : GetModerator200Response

Exemple

Exemple de getModerator
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'authentification par clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20
21try {
22 $result = $apiInstance->getModerator($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getModerator: ', $e->getMessage(), PHP_EOL;
26}
27

getModerators Internal Link

Paramètres

Name Type Location Required Description
tenantId string query Oui
skip number query Non

Réponse

Retourne : GetModerators200Response

Exemple

Exemple getModerators
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation par clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // chaîne
19$skip = 3.4; // nombre à virgule flottante
20
21try {
22 $result = $apiInstance->getModerators($tenant_id, $skip);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getModerators: ', $e->getMessage(), PHP_EOL;
26}
27

sendInvite Internal Link

Paramètres

Nom Type Emplacement Requis Description
tenantId string query Oui
id string path Oui
fromName string query Oui

Réponse

Renvoie : FlagCommentPublic200Response

Exemple

Exemple de sendInvite
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour définir un préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // chaîne
19$id = 'id_example'; // chaîne
20$from_name = 'from_name_example'; // chaîne
21
22try {
23 $result = $apiInstance->sendInvite($tenant_id, $id, $from_name);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->sendInvite: ', $e->getMessage(), PHP_EOL;
27}
28

updateModerator Internal Link

Paramètres

Name Type Location Required Description
tenantId string query Oui
id string path Oui

Réponse

Renvoie: FlagCommentPublic200Response

Exemple

Exemple updateModerator
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
14 // This is optional, `GuzzleHttp\Client` will be used as default.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$update_moderator_body = new \FastComments\Client\Model\UpdateModeratorBody(); // \FastComments\Client\Model\UpdateModeratorBody
21
22try {
23 $result = $apiInstance->updateModerator($tenant_id, $id, $update_moderator_body);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->updateModerator: ', $e->getMessage(), PHP_EOL;
27}
28

deleteNotificationCount Internal Link

Paramètres

Nom Type Emplacement Requis Description
tenantId string query Oui
id string path Oui

Réponse

Renvoie : FlagCommentPublic200Response

Exemple

Exemple de deleteNotificationCount
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation par clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer un préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20
21try {
22 $result = $apiInstance->deleteNotificationCount($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->deleteNotificationCount: ', $e->getMessage(), PHP_EOL;
26}
27

getCachedNotificationCount Internal Link

Paramètres

Nom Type Emplacement Obligatoire Description
tenantId string query Oui
id string path Oui

Réponse

Renvoie : GetCachedNotificationCount200Response

Exemple

Exemple de getCachedNotificationCount
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation par clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20
21try {
22 $result = $apiInstance->getCachedNotificationCount($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getCachedNotificationCount: ', $e->getMessage(), PHP_EOL;
26}
27

getNotificationCount Internal Link

Paramètres

Name Type Location Required Description
tenantId string query Oui
userId string query Non
urlId string query Non
fromCommentId string query Non
viewed boolean query Non
type string query Non

Réponse

Retourne : GetNotificationCount200Response

Exemple

Exemple de getNotificationCount
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'authentification par clé API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez la ligne ci-dessous pour définir un préfixe (ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, fournissez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$user_id = 'user_id_example'; // string
20$url_id = 'url_id_example'; // string
21$from_comment_id = 'from_comment_id_example'; // string
22$viewed = True; // bool
23$type = 'type_example'; // string
24
25try {
26 $result = $apiInstance->getNotificationCount($tenant_id, $user_id, $url_id, $from_comment_id, $viewed, $type);
27 print_r($result);
28} catch (Exception $e) {
29 echo 'Exception when calling DefaultApi->getNotificationCount: ', $e->getMessage(), PHP_EOL;
30}
31

getNotifications Internal Link

Paramètres

Name Type Location Required Description
tenantId string query Oui
userId string query Non
urlId string query Non
fromCommentId string query Non
viewed boolean query Non
type string query Non
skip number query Non

Réponse

Renvoie: GetNotifications200Response

Exemple

Exemple de getNotifications
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
14 // This is optional, `GuzzleHttp\Client` will be used as default.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$user_id = 'user_id_example'; // string
20$url_id = 'url_id_example'; // string
21$from_comment_id = 'from_comment_id_example'; // string
22$viewed = True; // bool
23$type = 'type_example'; // string
24$skip = 3.4; // float
25
26try {
27 $result = $apiInstance->getNotifications($tenant_id, $user_id, $url_id, $from_comment_id, $viewed, $type, $skip);
28 print_r($result);
29} catch (Exception $e) {
30 echo 'Exception when calling DefaultApi->getNotifications: ', $e->getMessage(), PHP_EOL;
31}
32

updateNotification Internal Link

Paramètres

Nom Type Emplacement Requis Description
tenantId string query Oui
id string path Oui
userId string query Non

Réponse

Renvoie: FlagCommentPublic200Response

Exemple

Exemple pour updateNotification
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de la clé API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$update_notification_body = new \FastComments\Client\Model\UpdateNotificationBody(); // \FastComments\Client\Model\UpdateNotificationBody
21$user_id = 'user_id_example'; // string
22
23try {
24 $result = $apiInstance->updateNotification($tenant_id, $id, $update_notification_body, $user_id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->updateNotification: ', $e->getMessage(), PHP_EOL;
28}
29

addPage Internal Link

Paramètres

Name Type Location Required Description
tenantId string query Oui

Réponse

Renvoie : AddPageAPIResponse

Exemple

Exemple addPage
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation par clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$create_api_page_data = new \FastComments\Client\Model\CreateAPIPageData(); // \FastComments\Client\Model\CreateAPIPageData
20
21try {
22 $result = $apiInstance->addPage($tenant_id, $create_api_page_data);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->addPage: ', $e->getMessage(), PHP_EOL;
26}
27

deletePage Internal Link

Paramètres

Nom Type Emplacement Obligatoire Description
tenantId string query Yes
id string path Yes

Réponse

Renvoie: DeletePageAPIResponse

Exemple

Exemple de deletePage
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous voulez utiliser un client HTTP personnalisé, fournissez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // C'est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20
21try {
22 $result = $apiInstance->deletePage($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->deletePage: ', $e->getMessage(), PHP_EOL;
26}
27

getPageByURLId Internal Link

Paramètres

Nom Type Emplacement Requis Description
tenantId string query Oui
urlId string query Oui

Réponse

Renvoie : GetPageByURLIdAPIResponse

Exemple

Exemple de getPageByURLId
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'authentification par clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer un préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$url_id = 'url_id_example'; // string
20
21try {
22 $result = $apiInstance->getPageByURLId($tenant_id, $url_id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getPageByURLId: ', $e->getMessage(), PHP_EOL;
26}
27

getPages Internal Link

Paramètres

Nom Type Emplacement Obligatoire Description
tenantId string query Oui

Réponse

Renvoie : GetPagesAPIResponse

Exemple

Exemple de getPages
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de clé API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer un préfixe (p. ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19
20try {
21 $result = $apiInstance->getPages($tenant_id);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling DefaultApi->getPages: ', $e->getMessage(), PHP_EOL;
25}
26

patchPage Internal Link

Paramètres

Nom Type Emplacement Requis Description
tenantId string query Oui
id string path Oui

Réponse

Renvoie: PatchPageAPIResponse

Exemple

Exemple de patchPage
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation par clé API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer un préfixe (p.ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous voulez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$update_api_page_data = new \FastComments\Client\Model\UpdateAPIPageData(); // \FastComments\Client\Model\UpdateAPIPageData
21
22try {
23 $result = $apiInstance->patchPage($tenant_id, $id, $update_api_page_data);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->patchPage: ', $e->getMessage(), PHP_EOL;
27}
28

deletePendingWebhookEvent Internal Link

Paramètres

Name Type Emplacement Requis Description
tenantId string query Oui
id string path Oui

Réponse

Renvoie: FlagCommentPublic200Response

Exemple

Exemple de deletePendingWebhookEvent
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'authentification par clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer un préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20
21try {
22 $result = $apiInstance->deletePendingWebhookEvent($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->deletePendingWebhookEvent: ', $e->getMessage(), PHP_EOL;
26}
27

getPendingWebhookEventCount Internal Link

Paramètres

Name Type Location Required Description
tenantId string query Oui
commentId string query Non
externalId string query Non
eventType string query Non
type string query Non
domain string query Non
attemptCountGT number query Non

Response

Renvoie : GetPendingWebhookEventCount200Response

Exemple

Exemple de getPendingWebhookEventCount
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
14 // This is optional, `GuzzleHttp\Client` will be used as default.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$comment_id = 'comment_id_example'; // string
20$external_id = 'external_id_example'; // string
21$event_type = 'event_type_example'; // string
22$type = 'type_example'; // string
23$domain = 'domain_example'; // string
24$attempt_count_gt = 3.4; // float
25
26try {
27 $result = $apiInstance->getPendingWebhookEventCount($tenant_id, $comment_id, $external_id, $event_type, $type, $domain, $attempt_count_gt);
28 print_r($result);
29} catch (Exception $e) {
30 echo 'Exception when calling DefaultApi->getPendingWebhookEventCount: ', $e->getMessage(), PHP_EOL;
31}
32

getPendingWebhookEvents Internal Link

Paramètres

Nom Type Emplacement Obligatoire Description
tenantId string query Oui
commentId string query Non
externalId string query Non
eventType string query Non
type string query Non
domain string query Non
attemptCountGT number query Non
skip number query Non

Réponse

Renvoie : GetPendingWebhookEvents200Response

Exemple

Exemple de getPendingWebhookEvents
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7// Configurer l'authentification par clé API : api_key
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// Décommentez ci-dessous pour configurer le préfixe (par ex. Bearer) pour la clé API, si nécessaire
10// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
11
12
13$apiInstance = new FastComments\Client\Api\DefaultApi(
14 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
15 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
16 // This is optional, `GuzzleHttp\Client` will be used as default.
17 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
18 new GuzzleHttp\Client(),
19 $config
20);
21$tenant_id = 'tenant_id_example'; // string
22$comment_id = 'comment_id_example'; // string
23$external_id = 'external_id_example'; // string
24$event_type = 'event_type_example'; // string
25$type = 'type_example'; // string
26$domain = 'domain_example'; // string
27$attempt_count_gt = 3.4; // float
28$skip = 3.4; // float
29
30try {
31 $result = $apiInstance->getPendingWebhookEvents($tenant_id, $comment_id, $external_id, $event_type, $type, $domain, $attempt_count_gt, $skip);
32 print_r($result);
33} catch (Exception $e) {
34 echo 'Exception when calling DefaultApi->getPendingWebhookEvents: ', $e->getMessage(), PHP_EOL;
35}
36

createQuestionConfig Internal Link

Paramètres

Nom Type Emplacement Requis Description
tenantId string query Oui

Réponse

Renvoie : CreateQuestionConfig200Response

Exemple

Exemple de createQuestionConfig
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
14 // This is optional, `GuzzleHttp\Client` will be used as default.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$create_question_config_body = new \FastComments\Client\Model\CreateQuestionConfigBody(); // \FastComments\Client\Model\CreateQuestionConfigBody
20
21try {
22 $result = $apiInstance->createQuestionConfig($tenant_id, $create_question_config_body);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->createQuestionConfig: ', $e->getMessage(), PHP_EOL;
26}
27

deleteQuestionConfig Internal Link

Paramètres

Nom Type Location Obligatoire Description
tenantId string query Oui
id string path Oui

Réponse

Renvoie: FlagCommentPublic200Response

Exemple

Exemple de deleteQuestionConfig
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
14 // This is optional, `GuzzleHttp\Client` will be used as default.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20
21try {
22 $result = $apiInstance->deleteQuestionConfig($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->deleteQuestionConfig: ', $e->getMessage(), PHP_EOL;
26}
27

getQuestionConfig Internal Link

Paramètres

Name Type Location Required Description
tenantId string query Oui
id string path Oui

Réponse

Renvoie : GetQuestionConfig200Response

Exemple

Exemple de getQuestionConfig
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20
21try {
22 $result = $apiInstance->getQuestionConfig($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getQuestionConfig: ', $e->getMessage(), PHP_EOL;
26}
27

getQuestionConfigs Internal Link

Paramètres

Nom Type Emplacement Obligatoire Description
tenantId string query Oui
skip number query Non

Réponse

Renvoie: GetQuestionConfigs200Response

Exemple

Exemple de getQuestionConfigs
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer un préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$skip = 3.4; // float
20
21try {
22 $result = $apiInstance->getQuestionConfigs($tenant_id, $skip);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getQuestionConfigs: ', $e->getMessage(), PHP_EOL;
26}
27

updateQuestionConfig Internal Link

Paramètres

Nom Type Emplacement Requis Description
tenantId string query Oui
id string path Oui

Réponse

Retourne : FlagCommentPublic200Response

Exemple

Exemple de updateQuestionConfig
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation par clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour définir un préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$update_question_config_body = new \FastComments\Client\Model\UpdateQuestionConfigBody(); // \FastComments\Client\Model\UpdateQuestionConfigBody
21
22try {
23 $result = $apiInstance->updateQuestionConfig($tenant_id, $id, $update_question_config_body);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->updateQuestionConfig: ', $e->getMessage(), PHP_EOL;
27}
28

createQuestionResult Internal Link

Paramètres

Nom Type Emplacement Requis Description
tenantId string query Oui

Réponse

Renvoie : CreateQuestionResult200Response

Exemple

Exemple de createQuestionResult
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'authentification par clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer un préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$create_question_result_body = new \FastComments\Client\Model\CreateQuestionResultBody(); // \FastComments\Client\Model\CreateQuestionResultBody
20
21try {
22 $result = $apiInstance->createQuestionResult($tenant_id, $create_question_result_body);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->createQuestionResult: ', $e->getMessage(), PHP_EOL;
26}
27

deleteQuestionResult Internal Link

Paramètres

Name Type Location Required Description
tenantId string query Oui
id string path Oui

Réponse

Renvoie : FlagCommentPublic200Response

Exemple

Exemple de deleteQuestionResult
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour définir un préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20
21try {
22 $result = $apiInstance->deleteQuestionResult($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->deleteQuestionResult: ', $e->getMessage(), PHP_EOL;
26}
27

getQuestionResult Internal Link

Paramètres

Nom Type Emplacement Requis Description
tenantId string query Oui
id string path Oui

Réponse

Renvoie : GetQuestionResult200Response

Exemple

Exemple de getQuestionResult
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'authentification par clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // chaîne
19$id = 'id_example'; // chaîne
20
21try {
22 $result = $apiInstance->getQuestionResult($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getQuestionResult: ', $e->getMessage(), PHP_EOL;
26}
27

getQuestionResults Internal Link

Paramètres

Name Type Location Required Description
tenantId string query Oui
urlId string query Non
userId string query Non
startDate string query Non
questionId string query Non
questionIds string query Non
skip number query Non

Réponse

Renvoie: GetQuestionResults200Response

Exemple

Exemple de getQuestionResults
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
14 // This is optional, `GuzzleHttp\Client` will be used as default.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$url_id = 'url_id_example'; // string
20$user_id = 'user_id_example'; // string
21$start_date = 'start_date_example'; // string
22$question_id = 'question_id_example'; // string
23$question_ids = 'question_ids_example'; // string
24$skip = 3.4; // float
25
26try {
27 $result = $apiInstance->getQuestionResults($tenant_id, $url_id, $user_id, $start_date, $question_id, $question_ids, $skip);
28 print_r($result);
29} catch (Exception $e) {
30 echo 'Exception when calling DefaultApi->getQuestionResults: ', $e->getMessage(), PHP_EOL;
31}
32

updateQuestionResult Internal Link

Paramètres

Nom Type Emplacement Requis Description
tenantId string query Oui
id string path Oui

Réponse

Renvoie : FlagCommentPublic200Response

Exemple

Exemple updateQuestionResult
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'authentification par clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$update_question_result_body = new \FastComments\Client\Model\UpdateQuestionResultBody(); // \FastComments\Client\Model\UpdateQuestionResultBody
21
22try {
23 $result = $apiInstance->updateQuestionResult($tenant_id, $id, $update_question_result_body);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->updateQuestionResult: ', $e->getMessage(), PHP_EOL;
27}
28

aggregateQuestionResults Internal Link

Paramètres

Nom Type Emplacement Obligatoire Description
tenantId string query Oui
questionId string query Non
questionIds array query Non
urlId string query Non
timeBucket string query Non
startDate string query Non
forceRecalculate boolean query Non

Réponse

Retourne : AggregateQuestionResults200Response

Exemple

Exemple de aggregateQuestionResults
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'authentification par clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$question_id = 'question_id_example'; // string
20$question_ids = array('question_ids_example'); // string[]
21$url_id = 'url_id_example'; // string
22$time_bucket = new \FastComments\Client\Model\\FastComments\Client\Model\AggregateTimeBucket(); // \FastComments\Client\Model\AggregateTimeBucket
23$start_date = new \DateTime('2013-10-20T19:20:30+01:00'); // \DateTime
24$force_recalculate = True; // bool
25
26try {
27 $result = $apiInstance->aggregateQuestionResults($tenant_id, $question_id, $question_ids, $url_id, $time_bucket, $start_date, $force_recalculate);
28 print_r($result);
29} catch (Exception $e) {
30 echo 'Exception when calling DefaultApi->aggregateQuestionResults: ', $e->getMessage(), PHP_EOL;
31}
32

bulkAggregateQuestionResults Internal Link

Paramètres

Nom Type Emplacement Requis Description
tenantId string query Oui
forceRecalculate boolean query Non

Réponse

Retourne : BulkAggregateQuestionResults200Response

Exemple

Exemple pour bulkAggregateQuestionResults
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7// Décommentez ci-dessous pour configurer un préfixe (par ex. Bearer) pour la clé API, si nécessaire
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
13 // C'est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
14 new GuzzleHttp\Client(),
15 $config
16);
17$tenant_id = 'tenant_id_example'; // string
18$bulk_aggregate_question_results_request = new \FastComments\Client\Model\BulkAggregateQuestionResultsRequest(); // \FastComments\Client\Model\BulkAggregateQuestionResultsRequest
19$force_recalculate = True; // bool
20
21try {
22 $result = $apiInstance->bulkAggregateQuestionResults($tenant_id, $bulk_aggregate_question_results_request, $force_recalculate);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->bulkAggregateQuestionResults: ', $e->getMessage(), PHP_EOL;
26}
27

combineCommentsWithQuestionResults Internal Link

Paramètres

Name Type Location Required Description
tenantId string query Oui
questionId string query Non
questionIds array query Non
urlId string query Non
startDate string query Non
forceRecalculate boolean query Non
minValue number query Non
maxValue number query Non
limit number query Non

Réponse

Renvoie : CombineCommentsWithQuestionResults200Response

Exemple

Exemple de combineCommentsWithQuestionResults
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation par clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$question_id = 'question_id_example'; // string
20$question_ids = array('question_ids_example'); // string[]
21$url_id = 'url_id_example'; // string
22$start_date = new \DateTime('2013-10-20T19:20:30+01:00'); // \DateTime
23$force_recalculate = True; // bool
24$min_value = 3.4; // float
25$max_value = 3.4; // float
26$limit = 3.4; // float
27
28try {
29 $result = $apiInstance->combineCommentsWithQuestionResults($tenant_id, $question_id, $question_ids, $url_id, $start_date, $force_recalculate, $min_value, $max_value, $limit);
30 print_r($result);
31} catch (Exception $e) {
32 echo 'Exception when calling DefaultApi->combineCommentsWithQuestionResults: ', $e->getMessage(), PHP_EOL;
33}
34

addSSOUser Internal Link

Paramètres

Nom Type Emplacement Requis Description
tenantId string query Oui

Réponse

Retourne : AddSSOUserAPIResponse

Exemple

Exemple addSSOUser
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'authentification par clé API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour définir un préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$create_apisso_user_data = new \FastComments\Client\Model\CreateAPISSOUserData(); // \FastComments\Client\Model\CreateAPISSOUserData
20
21try {
22 $result = $apiInstance->addSSOUser($tenant_id, $create_apisso_user_data);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->addSSOUser: ', $e->getMessage(), PHP_EOL;
26}
27

deleteSSOUser Internal Link

Paramètres

Name Type Location Required Description
tenantId string query Oui
id string path Oui
deleteComments boolean query Non
commentDeleteMode string query Non

Réponse

Retourne: DeleteSSOUserAPIResponse

Exemple

Exemple de deleteSSOUser
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
14 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
15 // This is optional, `GuzzleHttp\Client` will be used as default.
16 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
17 new GuzzleHttp\Client(),
18 $config
19);
20$tenant_id = 'tenant_id_example'; // string
21$id = 'id_example'; // string
22$delete_comments = True; // bool
23$comment_delete_mode = 'comment_delete_mode_example'; // string
24
25try {
26 $result = $apiInstance->deleteSSOUser($tenant_id, $id, $delete_comments, $comment_delete_mode);
27 print_r($result);
28} catch (Exception $e) {
29 echo 'Exception when calling DefaultApi->deleteSSOUser: ', $e->getMessage(), PHP_EOL;
30}
31

getSSOUserByEmail Internal Link

Parameters

Name Type Location Required Description
tenantId string query Oui
email string path Oui

Response

Renvoie : GetSSOUserByEmailAPIResponse

Example

Exemple de getSSOUserByEmail
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$email = 'email_example'; // string
20
21try {
22 $result = $apiInstance->getSSOUserByEmail($tenant_id, $email);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getSSOUserByEmail: ', $e->getMessage(), PHP_EOL;
26}
27

getSSOUserById Internal Link

Paramètres

Name Type Location Required Description
tenantId string query Oui
id string path Oui

Réponse

Renvoie : GetSSOUserByIdAPIResponse

Exemple

Exemple getSSOUserById
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
14 // This is optional, `GuzzleHttp\Client` will be used as default.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20
21try {
22 $result = $apiInstance->getSSOUserById($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getSSOUserById: ', $e->getMessage(), PHP_EOL;
26}
27

getSSOUsers Internal Link

Paramètres

Nom Type Location Obligatoire Description
tenantId string query Oui
skip integer query Non

Réponse

Renvoie : GetSSOUsers200Response

Exemple

Exemple de getSSOUsers
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
14 // This is optional, `GuzzleHttp\Client` will be used as default.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$skip = 56; // int
20
21try {
22 $result = $apiInstance->getSSOUsers($tenant_id, $skip);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getSSOUsers: ', $e->getMessage(), PHP_EOL;
26}
27

patchSSOUser Internal Link

Paramètres

Nom Type Emplacement Requis Description
tenantId string query Oui
id string path Oui
updateComments boolean query Non

Réponse

Renvoie : PatchSSOUserAPIResponse

Exemple

Exemple de patchSSOUser
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation par clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer un préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$update_apisso_user_data = new \FastComments\Client\Model\UpdateAPISSOUserData(); // \FastComments\Client\Model\UpdateAPISSOUserData
21$update_comments = True; // bool
22
23try {
24 $result = $apiInstance->patchSSOUser($tenant_id, $id, $update_apisso_user_data, $update_comments);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->patchSSOUser: ', $e->getMessage(), PHP_EOL;
28}
29

putSSOUser Internal Link

Paramètres

Nom Type Emplacement Requis Description
tenantId string query Oui
id string path Oui
updateComments boolean query Non

Réponse

Renvoie: PutSSOUserAPIResponse

Exemple

Exemple putSSOUser
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
14 // This is optional, `GuzzleHttp\Client` will be used as default.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$update_apisso_user_data = new \FastComments\Client\Model\UpdateAPISSOUserData(); // \FastComments\Client\Model\UpdateAPISSOUserData
21$update_comments = True; // bool
22
23try {
24 $result = $apiInstance->putSSOUser($tenant_id, $id, $update_apisso_user_data, $update_comments);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->putSSOUser: ', $e->getMessage(), PHP_EOL;
28}
29

createSubscription Internal Link

Paramètres

Name Type Location Required Description
tenantId string query Oui

Réponse

Renvoie : CreateSubscriptionAPIResponse

Exemple

Exemple de createSubscription
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
14 // This is optional, `GuzzleHttp\Client` will be used as default.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$create_api_user_subscription_data = new \FastComments\Client\Model\CreateAPIUserSubscriptionData(); // \FastComments\Client\Model\CreateAPIUserSubscriptionData
20
21try {
22 $result = $apiInstance->createSubscription($tenant_id, $create_api_user_subscription_data);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->createSubscription: ', $e->getMessage(), PHP_EOL;
26}
27

deleteSubscription Internal Link

Paramètres

Nom Type Emplacement Requis Description
tenantId string query Oui
id string path Oui
userId string query Non

Réponse

Renvoie : DeleteSubscriptionAPIResponse

Exemple

Exemple de deleteSubscription
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation par clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$user_id = 'user_id_example'; // string
21
22try {
23 $result = $apiInstance->deleteSubscription($tenant_id, $id, $user_id);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->deleteSubscription: ', $e->getMessage(), PHP_EOL;
27}
28

getSubscriptions Internal Link

Paramètres

Nom Type Emplacement Obligatoire Description
tenantId string query Oui
userId string query Non

Réponse

Retourne: GetSubscriptionsAPIResponse

Exemple

Exemple de getSubscriptions
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
14 // This is optional, `GuzzleHttp\Client` will be used as default.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$user_id = 'user_id_example'; // string
20
21try {
22 $result = $apiInstance->getSubscriptions($tenant_id, $user_id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getSubscriptions: ', $e->getMessage(), PHP_EOL;
26}
27

getTenantDailyUsages Internal Link

Paramètres

Name Type Location Required Description
tenantId string query Oui
yearNumber number query Non
monthNumber number query Non
dayNumber number query Non
skip number query Non

Réponse

Renvoie : GetTenantDailyUsages200Response

Exemple

Exemple getTenantDailyUsages
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation par clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$year_number = 3.4; // float
20$month_number = 3.4; // float
21$day_number = 3.4; // float
22$skip = 3.4; // float
23
24try {
25 $result = $apiInstance->getTenantDailyUsages($tenant_id, $year_number, $month_number, $day_number, $skip);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->getTenantDailyUsages: ', $e->getMessage(), PHP_EOL;
29}
30

createTenantPackage Internal Link

Paramètres

Nom Type Emplacement Obligatoire Description
tenantId string query Yes

Réponse

Renvoie : CreateTenantPackage200Response

Exemple

Exemple createTenantPackage
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure l'authentification par clé API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer un préfixe (e.g. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, fournissez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$create_tenant_package_body = new \FastComments\Client\Model\CreateTenantPackageBody(); // \FastComments\Client\Model\CreateTenantPackageBody
20
21try {
22 $result = $apiInstance->createTenantPackage($tenant_id, $create_tenant_package_body);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->createTenantPackage: ', $e->getMessage(), PHP_EOL;
26}
27

deleteTenantPackage Internal Link

Paramètres

Name Type Location Required Description
tenantId string query Oui
id string path Oui

Réponse

Renvoie : FlagCommentPublic200Response

Exemple

Exemple de deleteTenantPackage
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation par clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer un préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous voulez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // chaîne
19$id = 'id_example'; // chaîne
20
21try {
22 $result = $apiInstance->deleteTenantPackage($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->deleteTenantPackage: ', $e->getMessage(), PHP_EOL;
26}
27

getTenantPackage Internal Link

Paramètres

Nom Type Emplacement Obligatoire Description
tenantId string query Oui
id string path Oui

Réponse

Renvoie: GetTenantPackage200Response

Exemple

Exemple de getTenantPackage
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20
21try {
22 $result = $apiInstance->getTenantPackage($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getTenantPackage: ', $e->getMessage(), PHP_EOL;
26}
27

getTenantPackages Internal Link

Paramètres

Nom Type Emplacement Obligatoire Description
tenantId string query Oui
skip number query Non

Réponse

Renvoie : GetTenantPackages200Response

Exemple

Exemple de getTenantPackages
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation par clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$skip = 3.4; // float
20
21try {
22 $result = $apiInstance->getTenantPackages($tenant_id, $skip);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getTenantPackages: ', $e->getMessage(), PHP_EOL;
26}
27

replaceTenantPackage Internal Link

Paramètres

Name Type Location Required Description
tenantId string query Oui
id string path Oui

Réponse

Renvoie: FlagCommentPublic200Response

Exemple

Exemple de replaceTenantPackage
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (par exemple Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$replace_tenant_package_body = new \FastComments\Client\Model\ReplaceTenantPackageBody(); // \FastComments\Client\Model\ReplaceTenantPackageBody
21
22try {
23 $result = $apiInstance->replaceTenantPackage($tenant_id, $id, $replace_tenant_package_body);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->replaceTenantPackage: ', $e->getMessage(), PHP_EOL;
27}
28

updateTenantPackage Internal Link

Paramètres

Name Type Location Required Description
tenantId string query Oui
id string path Oui

Réponse

Renvoie : FlagCommentPublic200Response

Exemple

Exemple de updateTenantPackage
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour définir un préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$update_tenant_package_body = new \FastComments\Client\Model\UpdateTenantPackageBody(); // \FastComments\Client\Model\UpdateTenantPackageBody
21
22try {
23 $result = $apiInstance->updateTenantPackage($tenant_id, $id, $update_tenant_package_body);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->updateTenantPackage: ', $e->getMessage(), PHP_EOL;
27}
28

createTenantUser Internal Link

Paramètres

Nom Type Emplacement Obligatoire Description
tenantId string query Oui

Réponse

Retourne: CreateTenantUser200Response

Exemple

Exemple de createTenantUser
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation par clé API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (e.g. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$create_tenant_user_body = new \FastComments\Client\Model\CreateTenantUserBody(); // \FastComments\Client\Model\CreateTenantUserBody
20
21try {
22 $result = $apiInstance->createTenantUser($tenant_id, $create_tenant_user_body);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->createTenantUser: ', $e->getMessage(), PHP_EOL;
26}
27

deleteTenantUser Internal Link

Paramètres

Name Type Location Required Description
tenantId string query Oui
id string path Oui
deleteComments string query Non
commentDeleteMode string query Non

Réponse

Retourne: FlagCommentPublic200Response

Exemple

Exemple pour deleteTenantUser
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de la clé API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client http personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$delete_comments = 'delete_comments_example'; // string
21$comment_delete_mode = 'comment_delete_mode_example'; // string
22
23try {
24 $result = $apiInstance->deleteTenantUser($tenant_id, $id, $delete_comments, $comment_delete_mode);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->deleteTenantUser: ', $e->getMessage(), PHP_EOL;
28}
29

getTenantUser Internal Link

Paramètres

Nom Type Emplacement Obligatoire Description
tenantId string query Yes
id string path Yes

Réponse

Renvoie : GetTenantUser200Response

Exemple

Exemple getTenantUser
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation par clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20
21try {
22 $result = $apiInstance->getTenantUser($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getTenantUser: ', $e->getMessage(), PHP_EOL;
26}
27

getTenantUsers Internal Link


Paramètres

Nom Type Emplacement Requis Description
tenantId string query Oui
skip number query Non

Réponse

Renvoie: GetTenantUsers200Response

Exemple

Exemple getTenantUsers
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation par clé API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour définir un préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$skip = 3.4; // float
20
21try {
22 $result = $apiInstance->getTenantUsers($tenant_id, $skip);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getTenantUsers: ', $e->getMessage(), PHP_EOL;
26}
27

replaceTenantUser Internal Link

Paramètres

Nom Type Emplacement Requis Description
tenantId string query Oui
id string path Oui
updateComments string query Non

Réponse

Retourne : FlagCommentPublic200Response

Exemple

Exemple de replaceTenantUser
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'authentification par clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$replace_tenant_user_body = new \FastComments\Client\Model\ReplaceTenantUserBody(); // \FastComments\Client\Model\ReplaceTenantUserBody
21$update_comments = 'update_comments_example'; // string
22
23try {
24 $result = $apiInstance->replaceTenantUser($tenant_id, $id, $replace_tenant_user_body, $update_comments);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->replaceTenantUser: ', $e->getMessage(), PHP_EOL;
28}
29

Paramètres

Name Type Location Required Description
tenantId string query Yes
id string path Yes
redirectURL string query No

Réponse

Renvoie: FlagCommentPublic200Response

Exemple

Exemple sendLoginLink
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation par clé API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // This is optional, `GuzzleHttp\Client` will be used as default.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$redirect_url = 'redirect_url_example'; // string
21
22try {
23 $result = $apiInstance->sendLoginLink($tenant_id, $id, $redirect_url);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->sendLoginLink: ', $e->getMessage(), PHP_EOL;
27}
28

updateTenantUser Internal Link

Paramètres

Nom Type Emplacement Requis Description
tenantId string query Oui
id string path Oui
updateComments string query Non

Réponse

Renvoie: FlagCommentPublic200Response

Exemple

Exemple de updateTenantUser
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation par clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (p.ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$update_tenant_user_body = new \FastComments\Client\Model\UpdateTenantUserBody(); // \FastComments\Client\Model\UpdateTenantUserBody
21$update_comments = 'update_comments_example'; // string
22
23try {
24 $result = $apiInstance->updateTenantUser($tenant_id, $id, $update_tenant_user_body, $update_comments);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->updateTenantUser: ', $e->getMessage(), PHP_EOL;
28}
29

createTenant Internal Link

Paramètres

Nom Type Emplacement Requis Description
tenantId string query Oui

Réponse

Renvoie : CreateTenant200Response

Exemple

Exemple de createTenant
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'authentification par clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour définir un préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$create_tenant_body = new \FastComments\Client\Model\CreateTenantBody(); // \FastComments\Client\Model\CreateTenantBody
20
21try {
22 $result = $apiInstance->createTenant($tenant_id, $create_tenant_body);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->createTenant: ', $e->getMessage(), PHP_EOL;
26}
27

deleteTenant Internal Link

Paramètres

Nom Type Location Obligatoire Description
tenantId string query Oui
id string path Oui
sure string query Non

Réponse

Renvoie : FlagCommentPublic200Response

Exemple

Exemple de deleteTenant
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'authentification par clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer un préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$sure = 'sure_example'; // string
21
22try {
23 $result = $apiInstance->deleteTenant($tenant_id, $id, $sure);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->deleteTenant: ', $e->getMessage(), PHP_EOL;
27}
28

getTenant Internal Link

Paramètres

Nom Type Emplacement Obligatoire Description
tenantId string query Oui
id string path Oui

Réponse

Renvoie : GetTenant200Response

Exemple

Exemple de getTenant
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'authentification par clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer un préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // chaîne
19$id = 'id_example'; // chaîne
20
21try {
22 $result = $apiInstance->getTenant($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getTenant: ', $e->getMessage(), PHP_EOL;
26}
27

getTenants Internal Link

Paramètres

Name Type Location Required Description
tenantId string query Oui
meta string query Non
skip number query Non

Réponse

Renvoie : GetTenants200Response

Exemple

Exemple de getTenants
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation par clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer un préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$meta = 'meta_example'; // string
20$skip = 3.4; // float
21
22try {
23 $result = $apiInstance->getTenants($tenant_id, $meta, $skip);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->getTenants: ', $e->getMessage(), PHP_EOL;
27}
28

updateTenant Internal Link

Paramètres

Nom Type Emplacement Requis Description
tenantId string query Oui
id string path Oui

Réponse

Retourne: FlagCommentPublic200Response

Exemple

Exemple de updateTenant
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'authentification par clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer un préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$update_tenant_body = new \FastComments\Client\Model\UpdateTenantBody(); // \FastComments\Client\Model\UpdateTenantBody
21
22try {
23 $result = $apiInstance->updateTenant($tenant_id, $id, $update_tenant_body);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->updateTenant: ', $e->getMessage(), PHP_EOL;
27}
28

uploadImage Internal Link

Téléverser et redimensionner une image

Paramètres

Nom Type Emplacement Obligatoire Description
tenantId string chemin Oui
sizePreset string requête Non Préréglage de taille : "Default" (1000x1000px) ou "CrossPlatform" (crée des tailles pour les appareils courants)
urlId string requête Non ID de la page depuis laquelle le téléchargement est effectué, pour la configuration

Réponse

Renvoie : UploadImageResponse

Exemple

Exemple de uploadImage
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$file = '/path/to/file.txt'; // \SplFileObject
14$size_preset = new \FastComments\Client\Model\\FastComments\Client\Model\SizePreset(); // \FastComments\Client\Model\SizePreset | Préréglage de taille : \"Default\" (1000x1000px) ou \"CrossPlatform\" (crée des tailles pour les appareils courants)
15$url_id = 'url_id_example'; // string | ID de la page depuis laquelle le téléchargement est effectué, pour la configuration
16
17try {
18 $result = $apiInstance->uploadImage($tenant_id, $file, $size_preset, $url_id);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->uploadImage: ', $e->getMessage(), PHP_EOL;
22}
23

getUserBadgeProgressById Internal Link

Paramètres

Nom Type Emplacement Requis Description
tenantId string query Oui
id string path Oui

Réponse

Retourne: GetUserBadgeProgressById200Response

Exemple

Exemple de getUserBadgeProgressById
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation par clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20
21try {
22 $result = $apiInstance->getUserBadgeProgressById($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getUserBadgeProgressById: ', $e->getMessage(), PHP_EOL;
26}
27

getUserBadgeProgressByUserId Internal Link

Paramètres

Nom Type Emplacement Requis Description
tenantId string query Oui
userId string path Oui

Réponse

Renvoie: GetUserBadgeProgressById200Response

Exemple

Exemple de getUserBadgeProgressByUserId
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
14 // This is optional, `GuzzleHttp\Client` will be used as default.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$user_id = 'user_id_example'; // string
20
21try {
22 $result = $apiInstance->getUserBadgeProgressByUserId($tenant_id, $user_id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getUserBadgeProgressByUserId: ', $e->getMessage(), PHP_EOL;
26}
27

getUserBadgeProgressList Internal Link

Paramètres

Name Type Location Required Description
tenantId string query Oui
userId string query Non
limit number query Non
skip number query Non

Réponse

Renvoie : GetUserBadgeProgressList200Response

Exemple

Exemple de getUserBadgeProgressList
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
14 // This is optional, `GuzzleHttp\Client` will be used as default.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$user_id = 'user_id_example'; // string
20$limit = 3.4; // float
21$skip = 3.4; // float
22
23try {
24 $result = $apiInstance->getUserBadgeProgressList($tenant_id, $user_id, $limit, $skip);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getUserBadgeProgressList: ', $e->getMessage(), PHP_EOL;
28}
29

createUserBadge Internal Link

Paramètres

Name Type Location Required Description
tenantId string query Oui

Réponse

Renvoie : CreateUserBadge200Response

Exemple

Exemple de createUserBadge
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'authentification par clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer un préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$create_user_badge_params = new \FastComments\Client\Model\CreateUserBadgeParams(); // \FastComments\Client\Model\CreateUserBadgeParams
20
21try {
22 $result = $apiInstance->createUserBadge($tenant_id, $create_user_badge_params);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->createUserBadge: ', $e->getMessage(), PHP_EOL;
26}
27

deleteUserBadge Internal Link

Paramètres

Nom Type Emplacement Requis Description
tenantId string query Oui
id string path Oui

Réponse

Renvoie : UpdateUserBadge200Response

Exemple

Exemple de deleteUserBadge
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation par clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour définir le préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20
21try {
22 $result = $apiInstance->deleteUserBadge($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->deleteUserBadge: ', $e->getMessage(), PHP_EOL;
26}
27

getUserBadge Internal Link

Paramètres

Nom Type Emplacement Requis Description
tenantId string query Yes
id string path Yes

Réponse

Renvoie : GetUserBadge200Response

Exemple

Exemple de getUserBadge
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'authentification par clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20
21try {
22 $result = $apiInstance->getUserBadge($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getUserBadge: ', $e->getMessage(), PHP_EOL;
26}
27

getUserBadges Internal Link

Paramètres

Nom Type Emplacement Obligatoire Description
tenantId string query Oui
userId string query Non
badgeId string query Non
type number query Non
displayedOnComments boolean query Non
limit number query Non
skip number query Non

Réponse

Retourne: GetUserBadges200Response

Exemple

Exemple de getUserBadges
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation par clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$user_id = 'user_id_example'; // string
20$badge_id = 'badge_id_example'; // string
21$type = 3.4; // float
22$displayed_on_comments = True; // bool
23$limit = 3.4; // float
24$skip = 3.4; // float
25
26try {
27 $result = $apiInstance->getUserBadges($tenant_id, $user_id, $badge_id, $type, $displayed_on_comments, $limit, $skip);
28 print_r($result);
29} catch (Exception $e) {
30 echo 'Exception when calling DefaultApi->getUserBadges: ', $e->getMessage(), PHP_EOL;
31}
32

updateUserBadge Internal Link

Paramètres

Nom Type Emplacement Obligatoire Description
tenantId string query Oui
id string path Oui

Réponse

Renvoie: UpdateUserBadge200Response

Exemple

Exemple de updateUserBadge
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
14 // This is optional, `GuzzleHttp\Client` will be used as default.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$update_user_badge_params = new \FastComments\Client\Model\UpdateUserBadgeParams(); // \FastComments\Client\Model\UpdateUserBadgeParams
21
22try {
23 $result = $apiInstance->updateUserBadge($tenant_id, $id, $update_user_badge_params);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->updateUserBadge: ', $e->getMessage(), PHP_EOL;
27}
28

getUserNotificationCount Internal Link

Paramètres

Nom Type Emplacement Obligatoire Description
tenantId string query Oui
sso string query Non

Réponse

Renvoie: GetUserNotificationCount200Response

Exemple

Exemple getUserNotificationCount
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$sso = 'sso_example'; // string
14
15try {
16 $result = $apiInstance->getUserNotificationCount($tenant_id, $sso);
17 print_r($result);
18} catch (Exception $e) {
19 echo 'Exception when calling PublicApi->getUserNotificationCount: ', $e->getMessage(), PHP_EOL;
20}
21

getUserNotifications Internal Link

Paramètres

Name Type Location Required Description
tenantId string query Yes
pageSize integer query No
afterId string query No
includeContext boolean query No
afterCreatedAt integer query No
unreadOnly boolean query No
dmOnly boolean query No
noDm boolean query No
includeTranslations boolean query No
sso string query No

Réponse

Renvoie: GetUserNotifications200Response

Exemple

Exemple pour getUserNotifications
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$page_size = 56; // int
14$after_id = 'after_id_example'; // string
15$include_context = True; // bool
16$after_created_at = 56; // int
17$unread_only = True; // bool
18$dm_only = True; // bool
19$no_dm = True; // bool
20$include_translations = True; // bool
21$sso = 'sso_example'; // string
22
23try {
24 $result = $apiInstance->getUserNotifications($tenant_id, $page_size, $after_id, $include_context, $after_created_at, $unread_only, $dm_only, $no_dm, $include_translations, $sso);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling PublicApi->getUserNotifications: ', $e->getMessage(), PHP_EOL;
28}
29

resetUserNotificationCount Internal Link

Paramètres

Name Type Location Required Description
tenantId string query Oui
sso string query Non

Réponse

Renvoie : ResetUserNotifications200Response

Exemple

Exemple de resetUserNotificationCount
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$sso = 'sso_example'; // string
14
15try {
16 $result = $apiInstance->resetUserNotificationCount($tenant_id, $sso);
17 print_r($result);
18} catch (Exception $e) {
19 echo 'Exception when calling PublicApi->resetUserNotificationCount: ', $e->getMessage(), PHP_EOL;
20}
21

resetUserNotifications Internal Link

Paramètres

Nom Type Emplacement Obligatoire Description
tenantId string query Oui
afterId string query Non
afterCreatedAt integer query Non
unreadOnly boolean query Non
dmOnly boolean query Non
noDm boolean query Non
sso string query Non

Réponse

Retourne : ResetUserNotifications200Response

Exemple

Exemple de resetUserNotifications
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$after_id = 'after_id_example'; // string
14$after_created_at = 56; // int
15$unread_only = True; // bool
16$dm_only = True; // bool
17$no_dm = True; // bool
18$sso = 'sso_example'; // string
19
20try {
21 $result = $apiInstance->resetUserNotifications($tenant_id, $after_id, $after_created_at, $unread_only, $dm_only, $no_dm, $sso);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling PublicApi->resetUserNotifications: ', $e->getMessage(), PHP_EOL;
25}
26

updateUserNotificationCommentSubscriptionStatus Internal Link

Activer ou désactiver les notifications pour un commentaire spécifique.

Parameters

Nom Type Emplacement Obligatoire Description
tenantId string query Oui
notificationId string path Oui
optedInOrOut string path Oui
commentId string query Oui
sso string query Non

Response

Retourne : UpdateUserNotificationStatus200Response

Exemple

Exemple de updateUserNotificationCommentSubscriptionStatus
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$notification_id = 'notification_id_example'; // string
14$opted_in_or_out = 'opted_in_or_out_example'; // string
15$comment_id = 'comment_id_example'; // string
16$sso = 'sso_example'; // string
17
18try {
19 $result = $apiInstance->updateUserNotificationCommentSubscriptionStatus($tenant_id, $notification_id, $opted_in_or_out, $comment_id, $sso);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling PublicApi->updateUserNotificationCommentSubscriptionStatus: ', $e->getMessage(), PHP_EOL;
23}
24

updateUserNotificationPageSubscriptionStatus Internal Link

Activer ou désactiver les notifications pour une page. Lorsque les utilisateurs sont abonnés à une page, des notifications sont créées pour les nouveaux commentaires racine, et aussi

Paramètres

Name Type Location Required Description
tenantId string query Oui
urlId string query Oui
url string query Oui
pageTitle string query Oui
subscribedOrUnsubscribed string path Oui
sso string query Non

Réponse

Retourne : UpdateUserNotificationStatus200Response

Exemple

Exemple de updateUserNotificationPageSubscriptionStatus
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$url_id = 'url_id_example'; // string
14$url = 'url_example'; // string
15$page_title = 'page_title_example'; // string
16$subscribed_or_unsubscribed = 'subscribed_or_unsubscribed_example'; // string
17$sso = 'sso_example'; // string
18
19try {
20 $result = $apiInstance->updateUserNotificationPageSubscriptionStatus($tenant_id, $url_id, $url, $page_title, $subscribed_or_unsubscribed, $sso);
21 print_r($result);
22} catch (Exception $e) {
23 echo 'Exception when calling PublicApi->updateUserNotificationPageSubscriptionStatus: ', $e->getMessage(), PHP_EOL;
24}
25

updateUserNotificationStatus Internal Link

Paramètres

Nom Type Emplacement Requis Description
tenantId string query Oui
notificationId string path Oui
newStatus string path Oui
sso string query Non

Réponse

Renvoie : UpdateUserNotificationStatus200Response

Exemple

Exemple de updateUserNotificationStatus
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$notification_id = 'notification_id_example'; // string
14$new_status = 'new_status_example'; // string
15$sso = 'sso_example'; // string
16
17try {
18 $result = $apiInstance->updateUserNotificationStatus($tenant_id, $notification_id, $new_status, $sso);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->updateUserNotificationStatus: ', $e->getMessage(), PHP_EOL;
22}
23

getUserPresenceStatuses Internal Link

Paramètres

Nom Type Emplacement Obligatoire Description
tenantId string query Oui
urlIdWS string query Oui
userIds string query Oui

Réponse

Renvoie : GetUserPresenceStatuses200Response

Exemple

Exemple getUserPresenceStatuses
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$url_id_ws = 'url_id_ws_example'; // string
14$user_ids = 'user_ids_example'; // string
15
16try {
17 $result = $apiInstance->getUserPresenceStatuses($tenant_id, $url_id_ws, $user_ids);
18 print_r($result);
19} catch (Exception $e) {
20 echo 'Exception when calling PublicApi->getUserPresenceStatuses: ', $e->getMessage(), PHP_EOL;
21}
22

searchUsers Internal Link

Paramètres

Nom Type Emplacement Obligatoire Description
tenantId string path Oui
urlId string query Oui
usernameStartsWith string query Oui
mentionGroupIds array query Non
sso string query Non

Réponse

Renvoie: SearchUsers200Response

Exemple

Exemple de searchUsers
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$url_id = 'url_id_example'; // string
14$username_starts_with = 'username_starts_with_example'; // string
15$mention_group_ids = array('mention_group_ids_example'); // string[]
16$sso = 'sso_example'; // string
17
18try {
19 $result = $apiInstance->searchUsers($tenant_id, $url_id, $username_starts_with, $mention_group_ids, $sso);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling PublicApi->searchUsers: ', $e->getMessage(), PHP_EOL;
23}
24

getUser Internal Link

Paramètres

Name Type Location Required Description
tenantId string query Yes
id string path Yes

Réponse

Retourne: GetUser200Response

Exemple

Exemple getUser
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
14 // This is optional, `GuzzleHttp\Client` will be used as default.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20
21try {
22 $result = $apiInstance->getUser($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getUser: ', $e->getMessage(), PHP_EOL;
26}
27

createVote Internal Link

Paramètres

Nom Type Emplacement Obligatoire Description
tenantId string query Oui
commentId string query Oui
direction string query Oui
userId string query Non
anonUserId string query Non

Réponse

Renvoie: VoteComment200Response

Exemple

Exemple de createVote
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'authentification par clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$comment_id = 'comment_id_example'; // string
20$direction = 'direction_example'; // string
21$user_id = 'user_id_example'; // string
22$anon_user_id = 'anon_user_id_example'; // string
23
24try {
25 $result = $apiInstance->createVote($tenant_id, $comment_id, $direction, $user_id, $anon_user_id);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->createVote: ', $e->getMessage(), PHP_EOL;
29}
30

deleteVote Internal Link

Paramètres

Name Type Location Required Description
tenantId string query Oui
id string path Oui
editKey string query Non

Réponse

Renvoie : DeleteCommentVote200Response

Exemple

Exemple de deleteVote
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'authentification par clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer un préfixe (p. ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // chaîne
19$id = 'id_example'; // chaîne
20$edit_key = 'edit_key_example'; // chaîne
21
22try {
23 $result = $apiInstance->deleteVote($tenant_id, $id, $edit_key);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->deleteVote: ', $e->getMessage(), PHP_EOL;
27}
28

getVotes Internal Link

Paramètres

Name Type Location Required Description
tenantId string query Oui
urlId string query Oui

Réponse

Retourne : GetVotes200Response

Exemple

Exemple de getVotes
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation par clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // C'est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$url_id = 'url_id_example'; // string
20
21try {
22 $result = $apiInstance->getVotes($tenant_id, $url_id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getVotes: ', $e->getMessage(), PHP_EOL;
26}
27

getVotesForUser Internal Link

Paramètres

Nom Type Location Obligatoire Description
tenantId string query Oui
urlId string query Oui
userId string query Non
anonUserId string query Non

Réponse

Renvoie : GetVotesForUser200Response

Exemple

Exemple getVotesForUser
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'authentification par clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer un préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$url_id = 'url_id_example'; // string
20$user_id = 'user_id_example'; // string
21$anon_user_id = 'anon_user_id_example'; // string
22
23try {
24 $result = $apiInstance->getVotesForUser($tenant_id, $url_id, $user_id, $anon_user_id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getVotesForUser: ', $e->getMessage(), PHP_EOL;
28}
29

Besoin d'aide ?

Si vous rencontrez des problèmes ou avez des questions concernant le SDK PHP, veuillez :

Contribuer

Les contributions sont les bienvenues ! Veuillez visiter le dépôt GitHub pour les consignes de contribution.