FastComments.com

FastComments PHP SDK


Това е официалният PHP SDK за FastComments.

Официален PHP SDK за FastComments API

Репозитория

Вижте в GitHub


Инсталация и използване Internal Link

Изисквания

PHP 7.4 и по-нови. Трябва да работи и с PHP 8.0.

Composer

За да инсталирате пакета чрез Composer, добавете следното към composer.json:

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

След това изпълнете composer install

Ръчна инсталация

Изтеглете файловете и включете autoload.php:

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

Първи стъпки Internal Link

Моля, следвайте процедурата за инсталиране и след това изпълнете следното:

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



// Конфигуриране на авторизацията с API ключ: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Разкоментирайте по-долу, за да зададете префикс (напр. Bearer) за API ключ, ако е необходимо
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new FastComments\Client\Api\DefaultApi(
    // Ако искате да използвате персонален HTTP клиент, подайте клиент, който имплементира `GuzzleHttp\ClientInterface`.
    // Това е по избор, `GuzzleHttp\Client` ще се използва по подразбиране.
    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;
}

Модели Internal Link

Авторизация Internal Link


Схеми за удостоверяване, дефинирани за API:

api_key

  • Тип: API key
  • Име на параметъра за API key: x-api-key
  • Местоположение: HTTP header

Автор Internal Link

support@fastcomments.com

Агрегиране Internal Link

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

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
parentTenantId string query Не
includeStats boolean query Не

Отговор

Връща: AggregationResponse

Пример

Пример за aggregate
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на удостоверяване с API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Разкоментирайте по-долу, за да настроите префикс (напр. Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате потребителски HTTP клиент, подайте ваш клиент, който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е по избор; като по подразбиране ще се използва `GuzzleHttp\Client`.
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

Получаване на журнал за одит Internal Link

Параметри

Name Type Location Required Description
tenantId string query Да
limit number query Не
skip number query Не
order string query Не
after number query Не
before number query Не

Отговор

Връща: GetAuditLogs200Response

Пример

getAuditLogs Пример
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7// Конфигуриране на упълномощаване с API ключ: api_key
8$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
9// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
10// Премахнете коментара по-долу, за да зададете префикс (например Bearer) за API ключа, ако е необходимо
11// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
12
13
14$apiInstance = new FastComments\Client\Api\DefaultApi(
15 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
16 // Ако искате да използвате персонализиран HTTP клиент, предайте вашия клиент, който реализира `GuzzleHttp\ClientInterface`.
17 // This is optional, `GuzzleHttp\Client` will be used as default.
18 // Това е по избор, по подразбиране ще се използва `GuzzleHttp\Client`.
19 new GuzzleHttp\Client(),
20 $config
21);
22$tenant_id = 'tenant_id_example'; // string
23$limit = 3.4; // float
24$skip = 3.4; // float
25$order = new \FastComments\Client\Model\\FastComments\Client\Model\SORTDIR(); // \FastComments\Client\Model\SORTDIR
26$after = 3.4; // float
27$before = 3.4; // float
28
29try {
30 $result = $apiInstance->getAuditLogs($tenant_id, $limit, $skip, $order, $after, $before);
31 print_r($result);
32} catch (Exception $e) {
33 echo 'Exception when calling DefaultApi->getAuditLogs: ', $e->getMessage(), PHP_EOL;
34}
35

Блокиране от публичен коментар Internal Link

Параметри

Name Type Location Required Description
tenantId string query Yes
commentId string path Yes
sso string query No

Отговор

Връща: BlockFromCommentPublic200Response

Пример

Пример за blockFromCommentPublic
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Ако искате да използвате собствен HTTP клиент, подайте клиента си, който реализира `GuzzleHttp\ClientInterface`.
9 // Това е по избор, като по подразбиране ще се използва `GuzzleHttp\Client`.
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

Разблокиране на публичен коментар Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Yes
commentId string path Yes
sso string query No

Отговор

Връща: UnBlockCommentPublic200Response

Пример

unBlockCommentPublic Пример
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Ако искате да използвате потребителски HTTP клиент, предайте вашия клиент, който имплементира `GuzzleHttp\ClientInterface`.
9 // Това е по избор, по подразбиране ще бъде използван `GuzzleHttp\Client`.
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

Проверка за блокирани коментари Internal Link

Параметри

Име Тип Location Задължителен Описание
tenantId string query Да
commentIds string query Да Списък от id-та на коментари, разделени със запетаи.
sso string query Не

Отговор

Връща: CheckedCommentsForBlocked200Response

Пример

Пример за checkedCommentsForBlocked
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Ако искате да използвате собствен HTTP клиент, подайте вашия клиент, който имплементира `GuzzleHttp\ClientInterface`.
9 // Това е незадължително, по подразбиране ще се използва `GuzzleHttp\Client`.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // string
13$comment_ids = 'comment_ids_example'; // string | Списък от id-та на коментари, разделени със запетаи.
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

Блокиране на потребител от коментар Internal Link

Параметри

Name Type Location Required Description
tenantId string query Да
id string path Да
userId string query Не
anonUserId string query Не

Отговор

Връща: BlockFromCommentPublic200Response

Пример

Пример за blockUserFromComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на удостоверяване с API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Премахнете коментара по-долу, за да зададете префикс (например Bearer) за API ключ, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате персонализиран HTTP клиент, подайте вашия клиент, който реализира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, `GuzzleHttp\Client` ще бъде използван по подразбиране.
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

Създаване на публичен коментар Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string path Да
urlId string query Да
broadcastId string query Да
sessionId string query Не
sso string query Не

Отговор

Връща: CreateCommentPublic200Response

Пример

Пример за createCommentPublic
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Ако искате да използвате персонализиран HTTP клиент, предайте вашия клиент, който имплементира `GuzzleHttp\ClientInterface`.
9 // Това е по избор, `GuzzleHttp\Client` ще бъде използван по подразбиране.
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

Изтриване на коментар Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
id string path Да
contextUserId string query Не
isLive boolean query Не

Отговор

Връща: DeleteComment200Response

Пример

deleteComment Пример
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на упълномощаване чрез API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Премахнете коментара по-долу за да зададете префикс (напр. Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате персонализиран HTTP клиент, предайте вашия клиент който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, `GuzzleHttp\Client` ще бъде използван по подразбиране.
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

Изтриване на публичен коментар Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string path Да
commentId string path Да
broadcastId string query Да
editKey string query Не
sso string query Не

Връща

Връща: DeleteCommentPublic200Response

Пример

Пример за deleteCommentPublic
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Ако искате да използвате персонализиран HTTP клиент, предайте своя клиент, който имплементира `GuzzleHttp\ClientInterface`.
9 // Това е незадължително, по подразбиране ще се използва `GuzzleHttp\Client`.
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$edit_key = 'edit_key_example'; // string
16$sso = 'sso_example'; // string
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

Изтриване на глас за коментар Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string path Да
commentId string path Да
voteId string path Да
urlId string query Да
broadcastId string query Да
editKey string query Не
sso string query Не

Отговор

Връща: DeleteCommentVote200Response

Пример

deleteCommentVote Пример
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Ако искате да използвате персонализиран HTTP клиент, подайте вашия клиент, който имплементира `GuzzleHttp\ClientInterface`.
9 // Това е по избор, `GuzzleHttp\Client` ще бъде използван по подразбиране.
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 'Изключение при извикване на PublicApi->deleteCommentVote: ', $e->getMessage(), PHP_EOL;
25}
26

Докладване на коментар Internal Link

Параметри

Name Type Location Required Description
tenantId string query Да
id string path Да
userId string query Не
anonUserId string query Не

Отговор

Връща: FlagComment200Response

Пример

flagComment Пример
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на удостоверяване с API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Разкоментирайте по-долу, за да зададете префикс (напр. Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате персонализиран HTTP клиент, предайте вашия клиент, който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, по подразбиране ще се използва `GuzzleHttp\Client`.
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

Получаване на коментар Internal Link

Параметри

Name Type Location Required Description
tenantId string query Да
id string path Да

Отговор

Връща: GetComment200Response

Пример

Пример за getComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на удостоверяване с 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 // Ако искате да използвате потребителски HTTP клиент, предайте вашия клиент, който имплементира `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->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

Получаване на коментари Internal Link

Параметри

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

Отговор

Връща: GetComments200Response

Пример

Пример за getComments
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на удостоверяване чрез API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Разкоментрайте по-долу, за да зададете префикс (например Bearer) за API ключ, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате персонализиран HTTP клиент, предайте вашия клиент, който реализира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, по подразбиране ще се използва `GuzzleHttp\Client`.
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

Получаване на публични коментари Internal Link


req tenantId urlId

Параметри

Name Type Location Required Description
tenantId string path Yes
urlId string query Yes
page integer query No
direction string query No
sso string query No
skip integer query No
skipChildren integer query No
limit integer query No
limitChildren integer query No
countChildren boolean query No
fetchPageForCommentId string query No
includeConfig boolean query No
countAll boolean query No
includei10n boolean query No
locale string query No
modules string query No
isCrawler boolean query No
includeNotificationCount boolean query No
asTree boolean query No
maxTreeDepth integer query No
useFullTranslationIds boolean query No
parentId string query No
searchText string query No
hashTags array query No
userId string query No
customConfigStr string query No
afterCommentId string query No
beforeCommentId string query No

Отговор

Връща: GetCommentsPublic200Response

Пример

Пример за getCommentsPublic
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Ако искате да използвате персонален HTTP клиент, подайте вашия клиент, който реализира `GuzzleHttp\ClientInterface`.
9 // Това е незадължително; по подразбиране ще бъде използван `GuzzleHttp\Client`.
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

Получаване на текст на коментар Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string path Да
commentId string path Да
editKey string query Не
sso string query Не

Отговор

Връща: GetCommentText200Response

Пример

Пример за getCommentText
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Ако искате да използвате персонализиран HTTP клиент, подайте своя клиент, който реализира `GuzzleHttp\ClientInterface`.
9 // Това е по избор, по подразбиране ще се използва `GuzzleHttp\Client`.
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

Получаване на имената на потребителите, гласували за коментар Internal Link

Параметри

Name Type Location Required Description
tenantId string path Yes
commentId string path Yes
dir integer query Yes
sso string query No

Отговор

Връща: GetCommentVoteUserNames200Response

Пример

Пример за getCommentVoteUserNames
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Ако искате да използвате персонализиран HTTP клиент, подайте вашия клиент, който имплементира `GuzzleHttp\ClientInterface`.
9 // Това е по избор, по подразбиране ще се използва `GuzzleHttp\Client`.
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

Заключване на коментар Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string path Да
commentId string path Да
broadcastId string query Да
sso string query Не

Отговор

Връща: LockComment200Response

Пример

Пример за lockComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Ако желаете да използвате персонализиран HTTP клиент, предайте своя клиент, който имплементира `GuzzleHttp\ClientInterface`.
9 // Това е по избор, по подразбиране ще се използва `GuzzleHttp\Client`.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // низ
13$comment_id = 'comment_id_example'; // низ
14$broadcast_id = 'broadcast_id_example'; // низ
15$sso = 'sso_example'; // низ
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

Закачване на коментар Internal Link

Параметри

Име Тип Локация Задължително Описание
tenantId string path Да
commentId string path Да
broadcastId string query Да
sso string query Не

Отговор

Връща: PinComment200Response

Пример

Пример за pinComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Ако искате да използвате персонализиран HTTP клиент, предайте вашия клиент, който имплементира `GuzzleHttp\ClientInterface`.
9 // Това е по избор, `GuzzleHttp\Client` ще се използва по подразбиране.
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

Записване на коментар Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Yes
isLive boolean query No
doSpamCheck boolean query No
sendEmails boolean query No
populateNotifications boolean query No

Отговор

Връща: SaveComment200Response

Пример

Пример за saveComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на удостоверяване с API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Разкоментирайте по-долу, за да зададете префикс (напр. Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате потребителски HTTP клиент, предайте вашия клиент, който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, по подразбиране ще се използва `GuzzleHttp\Client`.
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

Масово записване на коментари Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
isLive boolean query Не
doSpamCheck boolean query Не
sendEmails boolean query Не
populateNotifications boolean query Не

Отговор

Връща: SaveComment200Response

Пример

Пример за saveCommentsBulk
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_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

Задаване на текст на коментар Internal Link

Параметри

Name Type Location Required Description
tenantId string path Да
commentId string path Да
broadcastId string query Да
editKey string query Не
sso string query Не

Отговор

Връща: SetCommentText200Response

Пример

Пример за setCommentText
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Ако искате да използвате персонализиран HTTP клиент, подайте вашия клиент, който имплементира `GuzzleHttp\ClientInterface`.
9 // Това е по избор, по подразбиране ще бъде използван `GuzzleHttp\Client`.
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

Разблокиране на потребител от коментар Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
id string path Да
userId string query Не
anonUserId string query Не

Отговор

Връща: UnBlockCommentPublic200Response

Пример

unBlockUserFromComment Пример
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на удостоверяване с API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Разкоментирайте долното, за да зададете префикс (например Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате персонализиран HTTP клиент, подайте вашия клиент, който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, `GuzzleHttp\Client` ще се използва по подразбиране.
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

Премахване на доклад за коментар Internal Link

Параметри

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

Отговор

Връща: FlagComment200Response

Пример

Пример за unFlagComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7// Конфигуриране на API ключ за автентикация: api_key
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// Разкоментирайте по-долу, за да зададете префикс (например Bearer) за API ключа, ако е необходимо
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 // Ако искате да използвате собствен HTTP клиент, подайте вашия клиент, който имплементира `GuzzleHttp\ClientInterface`.
16 // This is optional, `GuzzleHttp\Client` will be used as default.
17 // Това е по избор, по подразбиране ще се използва `GuzzleHttp\Client`.
18 new GuzzleHttp\Client(),
19 $config
20);
21$tenant_id = 'tenant_id_example'; // string
22$id = 'id_example'; // string
23$user_id = 'user_id_example'; // string
24$anon_user_id = 'anon_user_id_example'; // string
25
26try {
27 $result = $apiInstance->unFlagComment($tenant_id, $id, $user_id, $anon_user_id);
28 print_r($result);
29} catch (Exception $e) {
30 echo 'Exception when calling DefaultApi->unFlagComment: ', $e->getMessage(), PHP_EOL;
31}
32

Отключване на коментар Internal Link

Параметри

Name Type Location Required Description
tenantId string path Да
commentId string path Да
broadcastId string query Да
sso string query Не

Отговор

Връща: LockComment200Response

Пример

unLockComment Пример
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Ако искате да използвате потребителски http клиент, подайте вашия клиент, който имплементира `GuzzleHttp\ClientInterface`.
9 // Това е по избор, `GuzzleHttp\Client` ще се използва като подразбиране.
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

Откачане на коментар Internal Link

Параметри

Name Type Location Required Description
tenantId string path Да
commentId string path Да
broadcastId string query Да
sso string query Не

Отговор

Връща: PinComment200Response

Пример

Пример за unPinComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Ако искате да използвате персонализиран HTTP клиент, предайте клиента си, който имплементира `GuzzleHttp\ClientInterface`.
9 // Това е по избор, по подразбиране ще се използва `GuzzleHttp\Client`.
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->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

Актуализиране на коментар Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
id string path Да
contextUserId string query Не
doSpamCheck boolean query Не
isLive boolean query Не

Отговор

Връща: FlagCommentPublic200Response

Пример

Пример за updateComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на удостоверяване с API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Разкоментирайте по-долу, за да настроите префикс (например Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате персонализиран HTTP клиент, предайте вашия клиент, който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, `GuzzleHttp\Client` ще се използва по подразбиране.
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

Гласуване за коментар Internal Link

Параметри

Name Type Location Required Description
tenantId string path Yes
commentId string path Yes
urlId string query Yes
broadcastId string query Yes
sessionId string query No
sso string query No

Отговор

Връща: VoteComment200Response

Пример

Пример за voteComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Ако искате да използвате персонализиран HTTP клиент, предайте вашия клиент, който имплементира `GuzzleHttp\ClientInterface`.
9 // Това е по избор, по подразбиране ще се използва `GuzzleHttp\Client`.
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

Добавяне на конфигурация на домейн Internal Link


Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да

Отговор

Връща: AddDomainConfig200Response

Пример

Пример за addDomainConfig
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на удостоверяване с API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Разкоментирайте долния ред, за да зададете префикс (например Bearer) за API ключ, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате потребителски HTTP клиент, предайте ваш клиент, който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, по подразбиране ще се използва `GuzzleHttp\Client`.
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

Изтриване на конфигурация на домейн Internal Link

Параметри

Name Type Location Required Description
tenantId string query Да
domain string path Да

Отговор

Връща: DeleteDomainConfig200Response

Пример

deleteDomainConfig Пример
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Настройка на удостоверяване с API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Разкоментирайте по-долу, за да зададете префикс (напр. Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате собствен HTTP клиент, подайте вашия клиент, който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, по подразбиране ще се използва `GuzzleHttp\Client`.
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

Получаване на конфигурация на домейн Internal Link

Параметри

Name Type Location Required Description
tenantId string query Да
domain string path Да

Отговор

Връща: GetDomainConfig200Response

Пример

Пример за getDomainConfig
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на удостоверяване с API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Разкоментирайте по-долу, за да зададете префикс (например Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате потребителски HTTP клиент, предайте вашия клиент, който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, `GuzzleHttp\Client` ще бъде използван по подразбиране.
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

Получаване на конфигурации на домейни Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да

Отговор

Връща: GetDomainConfigs200Response

Пример

Пример за getDomainConfigs
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на удостоверяване с API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Разкоментирайте по-долу, за да зададете префикс (например Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате собствен HTTP клиент, предайте вашия клиент, който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, `GuzzleHttp\Client` ще бъде използван по подразбиране.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // низ
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

Частично обновяване на конфигурация на домейн Internal Link

Параметри

Name Type Location Required Description
tenantId string query Да
domainToUpdate string path Да

Отговор

Връща: GetDomainConfig200Response

Пример

patchDomainConfig Пример
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на удостоверяване с API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Премахнете коментара по-долу, за да зададете префикс (например Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате потребителски http клиент, предайте вашия клиент, който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, по подразбиране ще се използва `GuzzleHttp\Client`.
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

Замяна на конфигурация на домейн Internal Link

Параметри

Name Type Location Required Description
tenantId string query Да
domainToUpdate string path Да

Отговор

Връща: GetDomainConfig200Response

Пример

Пример за putDomainConfig
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на удостоверяване с API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Разкоментирайте по-долу, за да зададете префикс (напр. Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате потребителски HTTP клиент, подайте вашия клиент, който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, по подразбиране ще се използва `GuzzleHttp\Client`.
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

Създаване на шаблон за имейл Internal Link

Параметри

Name Type Location Required Description
tenantId string query Да

Отговор

Връща: CreateEmailTemplate200Response

Пример

Пример за createEmailTemplate
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на удостоверяване с API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Премахнете коментара по-долу, за да зададете префикс (например Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате персонализиран HTTP клиент, предайте вашия клиент, който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, `GuzzleHttp\Client` ще се използва като по подразбиране.
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

Изтриване на шаблон за имейл Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Yes
id string path Yes

Отговор

Връща: FlagCommentPublic200Response

Пример

Пример за deleteEmailTemplate
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на удостоверяване с API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Разкоментирайте долния ред за да зададете префикс (напр. Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате собствен HTTP клиент, предайте клиента, който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, по подразбиране ще бъде използван `GuzzleHttp\Client`.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
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

Изтриване на грешка при рендиране на шаблон за имейл Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
id string path Да
errorId string path Да

Отговор

Връща: FlagCommentPublic200Response

Пример

Пример за deleteEmailTemplateRenderError
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7// Конфигуриране на удостоверяване чрез API ключ: api_key
8$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
9// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
10// Разкоментирайте по-долу, за да зададете префикс (например Bearer) за API ключа, ако е необходимо
11// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
12
13
14$apiInstance = new FastComments\Client\Api\DefaultApi(
15 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
16 // Ако искате да използвате персонализиран HTTP клиент, подайте вашия клиент, който имплементира `GuzzleHttp\ClientInterface`.
17 // This is optional, `GuzzleHttp\Client` will be used as default.
18 // Това е по избор, по подразбиране ще се използва `GuzzleHttp\Client`.
19 new GuzzleHttp\Client(),
20 $config
21);
22$tenant_id = 'tenant_id_example'; // string
23$id = 'id_example'; // string
24$error_id = 'error_id_example'; // string
25
26try {
27 $result = $apiInstance->deleteEmailTemplateRenderError($tenant_id, $id, $error_id);
28 print_r($result);
29} catch (Exception $e) {
30 echo 'Exception when calling DefaultApi->deleteEmailTemplateRenderError: ', $e->getMessage(), PHP_EOL;
31}
32

Получаване на шаблон за имейл Internal Link

Параметри

Name Type Location Required Description
tenantId string query Да
id string path Да

Отговор

Връща: GetEmailTemplate200Response

Пример

Пример за getEmailTemplate
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на удостоверяване с API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Разкоментирайте по-долу, за да настроите префикс (напр. Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате собствен HTTP клиент, предайте клиент, който реализира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, по подразбиране ще се използва `GuzzleHttp\Client`.
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

Получаване на дефиниции на имейл шаблони Internal Link

Параметри

Име Тип Местоположение Задължителен Описание
tenantId string query Да

Отговор

Връща: GetEmailTemplateDefinitions200Response

Пример

Пример за getEmailTemplateDefinitions
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на удостоверяване чрез API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Премахнете коментара по-долу, за да зададете префикс (напр. Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате персонализиран HTTP клиент, предайте вашия клиент който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, по подразбиране ще бъде използван `GuzzleHttp\Client`.
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

Получаване на грешки при рендиране на имейл шаблони Internal Link

Параметри

Name Type Location Required Description
tenantId string query Да
id string path Да
skip number query Не

Отговор

Връща: GetEmailTemplateRenderErrors200Response

Пример

Пример за getEmailTemplateRenderErrors
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на удостоверяване с API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Разкоментирайте долния ред, за да зададете префикс (например Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате персонализиран HTTP клиент, подайте клиент, който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е незадължително, по подразбиране ще се използва `GuzzleHttp\Client`.
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

Получаване на шаблони за имейл Internal Link

Параметри

Name Type Location Required Description
tenantId string query Yes
skip number query No

Отговор

Връща: GetEmailTemplates200Response

Пример

Пример за getEmailTemplates
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на удостоверяване с API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Разкоментирайте по-долу, за да зададете префикс (напр. Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате потребителски HTTP клиент, предайте вашия клиент, който реализира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, `GuzzleHttp\Client` ще бъде използван като подразбиране.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$skip = 3.4; // float
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

Рендиране на шаблон за имейл Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
locale string query Не

Отговор

Връща: RenderEmailTemplate200Response

Пример

Пример за renderEmailTemplate
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на упълномощаване с API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Разкоментирайте по-долу, за да зададете префикс (например Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате собствен HTTP клиент, предайте вашия клиент, който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, като по подразбиране ще се използва `GuzzleHttp\Client`.
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

Актуализиране на шаблон за имейл Internal Link

Параметри

Name Type Location Required Description
tenantId string query Да
id string path Да

Отговор

Връща: FlagCommentPublic200Response

Пример

Пример за updateEmailTemplate
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на удостоверяване чрез API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Разкоментирйте по-долу, за да зададете префикс (например Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате персонализиран HTTP клиент, предайте вашия клиент, който реализира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, като по подразбиране ще се използва `GuzzleHttp\Client`.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // низ
19$id = 'id_example'; // низ
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

Получаване на журнал на събития Internal Link

req tenantId urlId userIdWS

Параметри

Име Тип Местоположение Задължително Описание
tenantId string path Да
urlId string query Да
userIdWS string query Да
startTime integer query Да
endTime integer query Да

Отговор

Връща: GetEventLog200Response

Пример

getEventLog Пример
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Ако искате да използвате персонализиран HTTP клиент, предайте вашия клиент, който имплементира `GuzzleHttp\ClientInterface`.
9 // Това е по избор, по подразбиране ще се използва `GuzzleHttp\Client`.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // низ
13$url_id = 'url_id_example'; // низ
14$user_id_ws = 'user_id_ws_example'; // низ
15$start_time = 56; // цяло число
16$end_time = 56; // цяло число
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

Получаване на глобален журнал на събития Internal Link

req tenantId urlId userIdWS

Параметри

Име Тип Местоположение Задължително Описание
tenantId string path Да
urlId string query Да
userIdWS string query Да
startTime integer query Да
endTime integer query Да

Отговор

Връща: GetEventLog200Response

Пример

Пример getGlobalEventLog
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Ако искате да използвате персонален http клиент, предайте вашия клиент, който имплементира `GuzzleHttp\ClientInterface`.
9 // Това е незадължително, по подразбиране ще се използва `GuzzleHttp\Client`.
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

Създаване на публикация във фийда Internal Link

Параметри

Name Type Location Required Description
tenantId string query Да
broadcastId string query Не
isLive boolean query Не
doSpamCheck boolean query Не
skipDupCheck boolean query Не

Отговор

Връща: CreateFeedPost200Response

Пример

Пример за createFeedPost
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 // Това е по избор, `GuzzleHttp\Client` ще се използва като подразбиращ се.
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

Създаване на публична публикация във фийда Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string path Да
broadcastId string query Не
sso string query Не

Отговор

Връща: CreateFeedPostPublic200Response

Пример

Пример за createFeedPostPublic
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Ако искате да използвате персонален HTTP клиент, предайте клиент, който имплементира `GuzzleHttp\ClientInterface`.
9 // Това е по избор, `GuzzleHttp\Client` ще бъде използван по подразбиране.
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

Изтриване на публична публикация във фийда Internal Link

Параметри

Name Type Location Required Description
tenantId string path Да
postId string path Да
broadcastId string query Не
sso string query Не

Отговор

Връща: DeleteFeedPostPublic200Response

Пример

Пример за deleteFeedPostPublic
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Ако искате да използвате персонализиран HTTP клиент, предайте вашия клиент, който имплементира `GuzzleHttp\ClientInterface`.
9 // Това е незадължително, по подразбиране ще се използва `GuzzleHttp\Client`.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // низ
13$post_id = 'post_id_example'; // низ
14$broadcast_id = 'broadcast_id_example'; // низ
15$sso = 'sso_example'; // низ
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

Получаване на публикации във фийда Internal Link

req tenantId afterId

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
afterId string query Не
limit integer query Не
tags array query Не

Отговор

Връща: GetFeedPosts200Response

Пример

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

Получаване на публични публикации във фийда Internal Link

req tenantId afterId

Parameters

Name Type Location Required Description
tenantId string path Да
afterId string query Не
limit integer query Не
tags array query Не
sso string query Не
isCrawler boolean query Не
includeUserInfo boolean query Не

Response

Връща: GetFeedPostsPublic200Response

Пример

Пример за getFeedPostsPublic
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Ако искате да използвате собствен HTTP клиент, подайте вашия клиент, който имплементира `GuzzleHttp\ClientInterface`.
9 // Това е по избор, по подразбиране ще бъде използван `GuzzleHttp\Client`.
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

Получаване на статистика за публикации във фийда Internal Link

Parameters

Name Type Location Required Description
tenantId string path Да
postIds array query Да
sso string query Не

Response

Връща: GetFeedPostsStats200Response

Example

Пример за getFeedPostsStats
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Ако искате да използвате потребителски HTTP клиент, подайте клиента си, който реализира `GuzzleHttp\ClientInterface`.
9 // Това е по избор, по подразбиране ще бъде използван `GuzzleHttp\Client`.
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

Получаване на публичните реакции на потребител Internal Link

Параметри

Name Type Location Required Description
tenantId string path Да
postIds array query Не
sso string query Не

Отговор

Връща: GetUserReactsPublic200Response

Пример

Пример за getUserReactsPublic
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Ако искате да използвате потребителски HTTP клиент, предайте вашия клиент, който реализира `GuzzleHttp\ClientInterface`.
9 // Това е по избор, по подразбиране ще се използва `GuzzleHttp\Client`.
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

Реакция на публична публикация във фийда Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string path Да
postId string path Да
isUndo boolean query Не
broadcastId string query Не
sso string query Не

Отговор

Връща: ReactFeedPostPublic200Response

Пример

Пример за reactFeedPostPublic
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Ако искате да използвате персонализиран HTTP клиент, подайте вашия клиент, който имплементира `GuzzleHttp\ClientInterface`.
9 // Това е незадължително, по подразбиране ще се използва `GuzzleHttp\Client`.
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

Актуализиране на публикация във фийда Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
id string path Да

Отговор

Връща: FlagCommentPublic200Response

Пример

Пример за updateFeedPost
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на удостоверяване с API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Ако е необходимо, премахнете коментара по-долу, за да зададете префикс (напр. Bearer) за API ключа
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате персонален HTTP клиент, предайте вашия клиент, който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, `GuzzleHttp\Client` ще се използва по подразбиране.
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

Актуализиране на публична публикация във фийда Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string path Да
postId string path Да
broadcastId string query Не
sso string query Не

Отговор

Връща: CreateFeedPostPublic200Response

Пример

Пример за updateFeedPostPublic
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Ако искате да използвате потребителски http клиент, предайте своя клиент, който имплементира `GuzzleHttp\ClientInterface`.
9 // Това е по избор, `GuzzleHttp\Client` ще бъде използван по подразбиране.
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

Докладване на публичен коментар Internal Link

Параметри

Name Тип Location Required Описание
tenantId string query Да
commentId string path Да
isFlagged boolean query Да
sso string query Не

Отговор

Връща: FlagCommentPublic200Response

Пример

Пример flagCommentPublic
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Ако искате да използвате собствен HTTP клиент, предайте вашия клиент, който имплементира `GuzzleHttp\ClientInterface`.
9 // Това е по избор; по подразбиране ще се използва `GuzzleHttp\Client`.
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

Добавяне на хаштаг Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Не

Отговор

Връща: AddHashTag200Response

Пример

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

Масово добавяне на хаштагове Internal Link

Параметри

Име Тип Локация Задължително Описание
tenantId string query Не

Отговор

Връща: AddHashTagsBulk200Response

Пример

Пример за addHashTagsBulk
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на упълномощаване чрез 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 // Ако искате да използвате собствен HTTP клиент, подайте клиента си, който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, по подразбиране ще се използва `GuzzleHttp\Client`.
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

Изтриване на хаштаг Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tag string path Да
tenantId string query Не

Отговор

Връща: FlagCommentPublic200Response

Пример

Пример за deleteHashTag
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на удостоверяване с API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Разкоментирайте по-долу, за да зададете префикс (например Bearer) за API ключ, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате персонализиран HTTP клиент, предайте клиента си, който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, по подразбиране ще се използва `GuzzleHttp\Client`.
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

Получаване на хаштагове Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Yes
page number query No

Отговор

Връща: GetHashTags200Response

Пример

Пример за getHashTags
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7// Конфигуриране на удостоверяване с API ключ: api_key
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// Разкоментирайте по-долу, за да зададете префикс (например Bearer) за API ключа, ако е необходимо
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 // Ако искате да използвате потребителски HTTP клиент, подайте клиент, който имплементира `GuzzleHttp\ClientInterface`.
16 // This is optional, `GuzzleHttp\Client` will be used as default.
17 // Това е по избор, по подразбиране ще се използва `GuzzleHttp\Client`.
18 new GuzzleHttp\Client(),
19 $config
20);
21$tenant_id = 'tenant_id_example'; // string
22$page = 3.4; // float
23
24try {
25 $result = $apiInstance->getHashTags($tenant_id, $page);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->getHashTags: ', $e->getMessage(), PHP_EOL;
29}
30

Частично обновяване на хаштаг Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tag string path Да
tenantId string query Не

Отговор

Връща: PatchHashTag200Response

Пример

Пример за patchHashTag
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на API ключ за упълномощаване: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Разкоментирайте по-долу, за да зададете префикс (напр. Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате собствен HTTP клиент, подайте клиента си, който реализира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, по подразбиране ще се използва `GuzzleHttp\Client`.
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

Създаване на модератор Internal Link

Параметри

Name Type Location Required Description
tenantId string query Yes

Отговор

Връща: CreateModerator200Response

Пример

createModerator Пример
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// Разкоментирайте по-долу, за да зададете префикс (например Bearer) за API ключ, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате персонализиран HTTP клиент, подайте вашия клиент, който реализира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, `GuzzleHttp\Client` ще се използва като подразбиране.
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

Изтриване на модератор Internal Link

Параметри

Name Type Location Required Description
tenantId string query Да
id string path Да
sendEmail string query Не

Отговор

Връща: FlagCommentPublic200Response

Пример

Пример за deleteModerator
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на удостоверяване с API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Разкоментирайте по-долу за да настроите префикс (напр. Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате потребителски HTTP клиент, подайте ваш клиент, който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, `GuzzleHttp\Client` ще се използва като по подразбиране.
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

Получаване на модератор Internal Link

Параметри

Name Type Location Required Description
tenantId string query Да
id string path Да

Отговор

Връща: GetModerator200Response

Пример

Пример за getModerator
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигурирайте удостоверяването с API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Разкоментирайте по-долу за настройка на префикс (напр. Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате персонализиран HTTP клиент, предайте вашия клиент който реализира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, по подразбиране ще се използва `GuzzleHttp\Client`.
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

Получаване на модератори Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Yes
skip number query No

Отговор

Връща: GetModerators200Response

Пример

Пример за getModerators
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7// Конфигуриране на упълномощаването с API ключ: api_key
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// Премахнете коментара по-долу, за да зададете префикс (например Bearer) за API ключа, ако е необходимо
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 // Ако искате да използвате собствен HTTP клиент, подайте клиента, който имплементира `GuzzleHttp\ClientInterface`.
16 // This is optional, `GuzzleHttp\Client` will be used as default.
17 // Това е опционално, по подразбиране ще се използва `GuzzleHttp\Client`.
18 new GuzzleHttp\Client(),
19 $config
20);
21$tenant_id = 'tenant_id_example'; // string
22$skip = 3.4; // float
23
24try {
25 $result = $apiInstance->getModerators($tenant_id, $skip);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->getModerators: ', $e->getMessage(), PHP_EOL;
29}
30

Изпращане на покана Internal Link

Параметри

Name Type Location Required Description
tenantId string query Да
id string path Да
fromName string query Да

Отговор

Връща: FlagCommentPublic200Response

Пример

Пример за sendInvite
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на удостоверяване с API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Премахнете коментара по-долу, за да зададете префикс (напр. Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате персонализиран HTTP клиент, предайте ваш клиент, който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, `GuzzleHttp\Client` ще се използва по подразбиране.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$from_name = 'from_name_example'; // string
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

Актуализиране на модератор Internal Link

Параметри

Name Type Location Required Description
tenantId string query Да
id string path Да

Отговор

Връща: FlagCommentPublic200Response

Пример

Пример за 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

Изтриване на брой известия Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
id string path Да

Отговор

Връща: FlagCommentPublic200Response

Пример

Пример за deleteNotificationCount
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на удостоверяване с API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Разкоментирайте по-долу, за да зададете префикс (например Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако желаете да използвате потребителски http клиент, подайте вашия клиент, който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, по подразбиране ще се използва `GuzzleHttp\Client`.
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

Получаване на кеширан брой известия Internal Link

Параметри

Name Type Location Required Description
tenantId string query Да
id string path Да

Отговор

Връща: GetCachedNotificationCount200Response

Пример

Пример за getCachedNotificationCount
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->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

Получаване на брой известия Internal Link

Параметри

Name Type Location Required Description
tenantId string query Да
userId string query Не
urlId string query Не
fromCommentId string query Не
viewed boolean query Не
type string query Не

Отговор

Връща: GetNotificationCount200Response

Пример

Пример за getNotificationCount
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на авторизация по API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Разкоментирайте по-долу, за да зададете префикс (напр. Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате персонализиран HTTP клиент, подайте клиента си, който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, `GuzzleHttp\Client` ще се използва по подразбиране.
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

Получаване на известия Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
userId string query Не
urlId string query Не
fromCommentId string query Не
viewed boolean query Не
type string query Не
skip number query Не

Отговор

Връща: GetNotifications200Response

Пример

Пример getNotifications
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на удостоверяване чрез API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Премахнете коментара по-долу, за да зададете префикс (напр. Bearer) за API ключ, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате персонализиран HTTP клиент, предайте вашия клиент, който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, `GuzzleHttp\Client` ще се използва по подразбиране.
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

Актуализиране на известие Internal Link

Параметри

Name Type Location Required Description
tenantId string query Да
id string path Да
userId string query Не

Отговор

Връща: FlagCommentPublic200Response

Пример

Пример за updateNotification
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_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

Добавяне на страница Internal Link

Параметри

Name Type Location Required Description
tenantId string query Да

Отговор

Връща: AddPageAPIResponse

Пример

Пример за addPage
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на удостоверяване с API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Разкоментирайте по-долу, за да зададете префикс (например Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате свой потребител за HTTP, предайте клиент, който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, по подразбиране ще се използва `GuzzleHttp\Client`.
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

Изтриване на страница Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
id string path Да

Отговор

Връща: DeletePageAPIResponse

Пример

Пример за deletePage
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на удостоверяване с API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Разкоментирайте по-долу, за да зададете префикс (напр. Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате потребителски HTTP клиент, подайте вашия клиент, който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, `GuzzleHttp\Client` ще се използва по подразбиране.
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

Получаване на страница по URL идентификатор Internal Link

Параметри

Name Type Location Required Description
tenantId string query Да
urlId string query Да

Отговор

Връща: GetPageByURLIdAPIResponse

Пример

Пример за getPageByURLId
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на удостоверяване чрез API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Премахнете коментара по-долу, за да зададете префикс (напр. Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате персонализиран HTTP клиент, подайте вашия клиент, който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, по подразбиране ще се използва `GuzzleHttp\Client`.
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

Получаване на страници Internal Link

Параметри

Name Type Location Required Description
tenantId string query Да

Отговор

Връща: GetPagesAPIResponse

Пример

Пример за getPages
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на удостоверяване с API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Разкоментирайте по-долу, за да зададете префикс (например Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате персонализиран HTTP клиент, предайте вашия клиент, който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е опционално, по подразбиране ще се използва `GuzzleHttp\Client`.
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

Частично обновяване на страница Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Yes
id string path Yes

Отговор

Връща: PatchPageAPIResponse

Пример

Пример за patchPage
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на упълномощаване чрез API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Разкоментирайте по-долу, за да зададете префикс (напр. Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако желаете да използвате персонализиран HTTP клиент, предайте вашия клиент който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, `GuzzleHttp\Client` ще бъде използван по подразбиране.
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

Изтриване на чакащо уебхук събитие Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
id string path Да

Отговор

Връща: FlagCommentPublic200Response

Пример

Пример за deletePendingWebhookEvent
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на удостоверяване с API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Разкоментирайте по-долу, за да зададете префикс (напр. Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате собствен HTTP клиент, подайте клиент, който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, по подразбиране ще се използва `GuzzleHttp\Client`.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // низ
19$id = 'id_example'; // низ
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

Получаване на брой чакащи уебхук събития Internal Link

Параметри

Име Type Location Задължително Описание
tenantId string query Да
commentId string query Не
externalId string query Не
eventType string query Не
type string query Не
domain string query Не
attemptCountGT number query Не

Отговор

Връща: GetPendingWebhookEventCount200Response

Пример

getPendingWebhookEventCount Пример
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7// Конфигуриране на оторизация с API ключ: api_key
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// Разкоментирайте по-долу, за да зададете префикс (например Bearer) за API ключа, ако е необходимо
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 // Ако искате да използвате персонализиран HTTP клиент, подайте ваш клиент, който реализира `GuzzleHttp\ClientInterface`.
16 // This is optional, `GuzzleHttp\Client` will be used as default.
17 // Това е по избор, `GuzzleHttp\Client` ще се използва по подразбиране.
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
29try {
30 $result = $apiInstance->getPendingWebhookEventCount($tenant_id, $comment_id, $external_id, $event_type, $type, $domain, $attempt_count_gt);
31 print_r($result);
32} catch (Exception $e) {
33 echo 'Exception when calling DefaultApi->getPendingWebhookEventCount: ', $e->getMessage(), PHP_EOL;
34}
35

Получаване на чакащи уебхук събития Internal Link

Parameters

Name Type Location Required Description
tenantId string query Да
commentId string query Не
externalId string query Не
eventType string query Не
type string query Не
domain string query Не
attemptCountGT number query Не
skip number query Не

Response

Връща: GetPendingWebhookEvents200Response

Пример

Пример getPendingWebhookEvents
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 // Това е по избор, `GuzzleHttp\Client` ще се използва по подразбиране.
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$skip = 3.4; // float
26
27try {
28 $result = $apiInstance->getPendingWebhookEvents($tenant_id, $comment_id, $external_id, $event_type, $type, $domain, $attempt_count_gt, $skip);
29 print_r($result);
30} catch (Exception $e) {
31 echo 'Exception when calling DefaultApi->getPendingWebhookEvents: ', $e->getMessage(), PHP_EOL;
32}
33

Създаване на конфигурация за въпрос Internal Link

Параметри

Name Type Location Required Description
tenantId string query Да

Отговор

Връща: CreateQuestionConfig200Response

Пример

Пример за createQuestionConfig
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7// Конфигуриране на удостоверяване с API ключ: api_key
8$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
9// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
10// Разкоментирайте по-долу, за да зададете префикс (например Bearer) за API ключа, ако е необходимо
11// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
12
13
14$apiInstance = new FastComments\Client\Api\DefaultApi(
15 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
16 // Ако искате да използвате потребителски HTTP клиент, подайте клиент, който имплементира `GuzzleHttp\ClientInterface`.
17 // This is optional, `GuzzleHttp\Client` will be used as default.
18 // Това е по избор, по подразбиране ще се използва `GuzzleHttp\Client`.
19 new GuzzleHttp\Client(),
20 $config
21);
22$tenant_id = 'tenant_id_example'; // string
23$create_question_config_body = new \FastComments\Client\Model\CreateQuestionConfigBody(); // \FastComments\Client\Model\CreateQuestionConfigBody
24
25try {
26 $result = $apiInstance->createQuestionConfig($tenant_id, $create_question_config_body);
27 print_r($result);
28} catch (Exception $e) {
29 echo 'Exception when calling DefaultApi->createQuestionConfig: ', $e->getMessage(), PHP_EOL;
30}
31

Изтриване на конфигурация за въпрос Internal Link

Параметри

Name Type Location Required Description
tenantId string query Да
id string path Да

Отговор

Връща: FlagCommentPublic200Response

Пример

Пример за deleteQuestionConfig
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на упълномощаване чрез API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Разкоментирайте по-долу, за да зададете префикс (например Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате персонализиран HTTP клиент, подайте ваш клиент, който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, `GuzzleHttp\Client` ще бъде използван по подразбиране.
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

Получаване на конфигурация за въпрос Internal Link

Параметри

Име Тип Разположение Задължително Описание
tenantId string query Да
id string path Да

Отговор

Връща: GetQuestionConfig200Response

Пример

Пример getQuestionConfig
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на удостоверяване чрез API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Разкоментирайте по-долу за настройка на префикс (напр. Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате собствен HTTP клиент, подайте ваш клиент, който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, по подразбиране ще се използва `GuzzleHttp\Client`.
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

Получаване на конфигурации за въпроси Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
skip number query Не

Отговор

Връща: GetQuestionConfigs200Response

Пример

Пример за getQuestionConfigs
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7// Конфигуриране на удостоверяване с API ключ: api_key
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// Премахнете коментара по-долу, за да зададете префикс (например Bearer) за API ключа, ако е необходимо
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 // Ако искате да използвате собствен HTTP клиент, предайте клиент, който имплементира `GuzzleHttp\ClientInterface`.
16 // This is optional, `GuzzleHttp\Client` will be used as default.
17 // Това е по избор, по подразбиране ще бъде използван `GuzzleHttp\Client`.
18 new GuzzleHttp\Client(),
19 $config
20);
21$tenant_id = 'tenant_id_example'; // string
22$skip = 3.4; // float
23
24try {
25 $result = $apiInstance->getQuestionConfigs($tenant_id, $skip);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->getQuestionConfigs: ', $e->getMessage(), PHP_EOL;
29}
30

Актуализиране на конфигурация за въпрос Internal Link


Параметри

Име Тип Местоположение Задължителен Описание
tenantId string query Да
id string path Да

Отговор

Връща: FlagCommentPublic200Response

Пример

Пример за updateQuestionConfig
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на удостоверяване с API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Разкоментирайте по-долу, за да зададете префикс (напр. Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате потребителски HTTP клиент, предайте вашия клиент, който реализира `GuzzleHttp\ClientInterface`.
14 // Това е по избор; по подразбиране ще се използва `GuzzleHttp\Client`.
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

Създаване на резултат от въпрос Internal Link

Параметри

Име Тип Location Задължително Описание
tenantId string query Да

Отговор

Връща: CreateQuestionResult200Response

Пример

Пример за createQuestionResult
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на удостоверяване с API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Разкоментирайте по-долу, за да зададете префикс (напр. Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате персонализиран HTTP клиент, подайте ваш клиент, който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е незадължително; по подразбиране ще се използва `GuzzleHttp\Client`.
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

Изтриване на резултат от въпрос Internal Link

Параметри

Име Тип Location Задължително Описание
tenantId string query Да
id string path Да

Отговор

Връща: FlagCommentPublic200Response

Пример

Пример за 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// 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 // Това е незадължително, `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->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

Получаване на резултат от въпрос Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
id string path Да

Отговор

Връща: GetQuestionResult200Response

Пример

Пример за getQuestionResult
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Настройване на авторизацията с 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 // Ако искате да използвате персонализиран HTTP клиент, предайте вашия клиент, който имплементира `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->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

Получаване на резултати от въпроси Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
urlId string query Не
userId string query Не
startDate string query Не
questionId string query Не
questionIds string query Не
skip number query Не

Отговор

Връща: GetQuestionResults200Response

Пример

getQuestionResults Пример
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на упълномощаване с API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Разкоментирайте по-долу, за да зададете префикс (например Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате собствен HTTP клиент, предайте вашия клиент, който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, по подразбиране ще се използва `GuzzleHttp\Client`.
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

Актуализиране на резултат от въпрос Internal Link

Параметри

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

Отговор

Връща: FlagCommentPublic200Response

Пример

Пример за updateQuestionResult
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_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

Агрегиране на резултати от въпроси Internal Link

Параметри

Name Type Location Required Description
tenantId string query Да
questionId string query Не
questionIds array query Не
urlId string query Не
timeBucket string query Не
startDate string query Не
forceRecalculate boolean query Не

Отговор

Връща: AggregateQuestionResults200Response

Пример

Пример за aggregateQuestionResults
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 // Ако искате да използвате потребителски HTTP клиент, предайте клиент, който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, `GuzzleHttp\Client` will be used as default.
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

Масово агрегиране на резултати от въпроси Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
forceRecalculate boolean query Не

Отговор

Връща: BulkAggregateQuestionResults200Response

Пример

Пример за bulkAggregateQuestionResults
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на удостоверяване с API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Разкоментирайте по-долу, за да зададете префикс (например Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате собствен HTTP клиент, предайте клиента си, който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, по подразбиране ще се използва `GuzzleHttp\Client`.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$bulk_aggregate_question_results_request = new \FastComments\Client\Model\BulkAggregateQuestionResultsRequest(); // \FastComments\Client\Model\BulkAggregateQuestionResultsRequest
20$force_recalculate = True; // bool
21
22try {
23 $result = $apiInstance->bulkAggregateQuestionResults($tenant_id, $bulk_aggregate_question_results_request, $force_recalculate);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->bulkAggregateQuestionResults: ', $e->getMessage(), PHP_EOL;
27}
28

Комбиниране на коментари с резултати от въпроси Internal Link

Параметри

Name Type Location Required Description
tenantId string query Да
questionId string query Не
questionIds array query Не
urlId string query Не
startDate string query Не
forceRecalculate boolean query Не
minValue number query Не
maxValue number query Не
limit number query Не

Отговор

Връща: CombineCommentsWithQuestionResults200Response

Пример

Пример за combineCommentsWithQuestionResults
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$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

Добавяне на SSO потребител Internal Link

Параметри

Name Type Location Required Description
tenantId string query Да

Отговор

Връща: AddSSOUserAPIResponse

Пример

Пример за addSSOUser
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на удостоверяване с API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Разкоментирайте по-долу, за да зададете префикс (напр. Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате потребителски HTTP клиент, подайте клиента си, който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, по подразбиране ще се използва `GuzzleHttp\Client`.
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

Изтриване на SSO потребител Internal Link

Параметри

Name Type Location Required Description
tenantId string query Да
id string path Да
deleteComments boolean query Не
commentDeleteMode string query Не

Отговор

Връща: DeleteSSOUserAPIResponse

Пример

Пример за deleteSSOUser
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на удостоверяване с API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Премахнете коментара по-долу, за да зададете префикс (напр. Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате персонализиран HTTP клиент, подайте вашия клиент, който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е по избор; по подразбиране ще бъде използван `GuzzleHttp\Client`.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$delete_comments = True; // bool
21$comment_delete_mode = 'comment_delete_mode_example'; // string
22
23try {
24 $result = $apiInstance->deleteSSOUser($tenant_id, $id, $delete_comments, $comment_delete_mode);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->deleteSSOUser: ', $e->getMessage(), PHP_EOL;
28}
29

Получаване на SSO потребител по имейл Internal Link

Параметри

Name Type Location Required Description
tenantId string query Да
email string path Да

Отговор

Връща: GetSSOUserByEmailAPIResponse

Пример

Пример за 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// 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 // Това е по избор, `GuzzleHttp\Client` ще бъде използван по подразбиране.
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

Получаване на SSO потребител по идентификатор Internal Link

Параметри

Name Type Location Required Description
tenantId string query Да
id string path Да

Отговор

Връща: GetSSOUserByIdAPIResponse

Пример

Пример за getSSOUserById
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на удостоверяване с API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Разкоментирайте по-долу, за да зададете префикс (напр. Bearer) за API ключ, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате собствен HTTP клиент, подайте вашия клиент, който реализира интерфейса `GuzzleHttp\ClientInterface`.
14 // Това е по избор; по подразбиране ще се използва `GuzzleHttp\Client`.
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

Получаване на SSO потребители Internal Link

Параметри

Name Type Location Required Description
tenantId string query Да
skip integer query Не

Отговор

Връща: GetSSOUsers200Response

Пример

Пример за getSSOUsers
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на удостоверяване чрез API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Разкоментирайте по-долу, за да зададете префикс (напр. Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате потребителски http клиент, предайте вашия клиент който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, по подразбиране ще се използва `GuzzleHttp\Client`.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // низ
19$skip = 56; // цяло число
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

Частично обновяване на SSO потребител Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
id string path Да
updateComments boolean query Не

Отговор

Връща: PatchSSOUserAPIResponse

Пример

Пример за patchSSOUser
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на удостоверяване с API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Премахнете коментара по-долу за настройка на префикс (напр. Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате потребителски HTTP клиент, подайте вашия клиент, който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, `GuzzleHttp\Client` ще бъде използван по подразбиране.
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

Замяна на SSO потребител Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
id string path Да
updateComments boolean query Не

Отговор

Връща: PutSSOUserAPIResponse

Пример

Пример за putSSOUser
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на авторизацията чрез API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Разкоментирайте по-долу, за да зададете префикс (напр. Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате персонализиран HTTP клиент, предайте клиент, който реализира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, по подразбиране ще се използва `GuzzleHttp\Client`.
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

Създаване на абонамент Internal Link

Параметри

Name Type Location Required Description
tenantId string query Yes

Отговор

Връща: CreateSubscriptionAPIResponse

Пример

Пример за createSubscription
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на авторизация с API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Разкоментирайте по-долу, за да зададете префикс (например Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате персонализиран HTTP клиент, предайте клиента си, който реализира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, по подразбиране ще се използва `GuzzleHttp\Client`.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // низ
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

Изтриване на абонамент Internal Link

Параметри

Name Type Location Required Description
tenantId string query Да
id string path Да
userId string query Не

Отговор

Връща: DeleteSubscriptionAPIResponse

Пример

Пример за deleteSubscription
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на автентикация с API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Разкоментирайте по-долу за да зададете префикс (например Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате персонализиран HTTP клиент, предайте вашия клиент, който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, `GuzzleHttp\Client` ще бъде използван по подразбиране.
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

Получаване на абонаменти Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
userId string query Не

Отговор

Връща: GetSubscriptionsAPIResponse

Пример

Пример за getSubscriptions
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7// Конфигуриране на удостоверяване с API ключ: api_key
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// Разкоментирайте по-долу, за да зададете префикс (напр. Bearer) за API ключа, ако е необходимо
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 // Ако искате да използвате персонализиран HTTP клиент, подайте ваш клиент, който имплементира `GuzzleHttp\ClientInterface`.
16 // This is optional, `GuzzleHttp\Client` will be used as default.
17 // Това е незадължително, по подразбиране ще бъде използван `GuzzleHttp\Client`.
18 new GuzzleHttp\Client(),
19 $config
20);
21$tenant_id = 'tenant_id_example'; // string
22$user_id = 'user_id_example'; // string
23
24try {
25 $result = $apiInstance->getSubscriptions($tenant_id, $user_id);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->getSubscriptions: ', $e->getMessage(), PHP_EOL;
29}
30

Получаване на дневна употреба на наемателя Internal Link

Параметри

Name Type Location Required Description
tenantId string query Да
yearNumber number query Не
monthNumber number query Не
dayNumber number query Не
skip number query Не

Отговор

Връща: GetTenantDailyUsages200Response

Пример

Пример за getTenantDailyUsages
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$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

Създаване на пакет за наемател Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да

Отговор

Връща: CreateTenantPackage200Response

Пример

Пример за createTenantPackage
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на удостоверяване с API ключ: api_key
7// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Ако искате да използвате персонализиран HTTP клиент, подайте вашия клиент, който имплементира `GuzzleHttp\ClientInterface`.
13 // Това е по избор, `GuzzleHttp\Client` ще бъде използван по подразбиране.
14 new GuzzleHttp\Client(),
15 $config
16);
17$tenant_id = 'tenant_id_example'; // string
18$create_tenant_package_body = new \FastComments\Client\Model\CreateTenantPackageBody(); // \FastComments\Client\Model\CreateTenantPackageBody
19
20try {
21 $result = $apiInstance->createTenantPackage($tenant_id, $create_tenant_package_body);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling DefaultApi->createTenantPackage: ', $e->getMessage(), PHP_EOL;
25}
26

Изтриване на пакет за наемател Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
id string path Да

Отговор

Връща: FlagCommentPublic200Response

Пример

Пример за deleteTenantPackage
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на авторизация с API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Разкоментирайте по-долу, за да зададете префикс (например Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате персонализиран HTTP клиент, предайте вашия клиент, който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, `GuzzleHttp\Client` ще се използва по подразбиране.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // низ
19$id = 'id_example'; // низ
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

Получаване на пакет за наемател Internal Link

Параметри

Name Type Location Required Description
tenantId string query Да
id string path Да

Отговор

Връща: GetTenantPackage200Response

Пример

Пример за 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// 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->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

Получаване на пакети за наемател Internal Link

Параметри

Name Type Location Required Description
tenantId string query Да
skip number query Не

Отговор

Връща: GetTenantPackages200Response

Пример

Пример за getTenantPackages
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на удостоверяване с API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Разкоментирайте по-долу, за да зададете префикс (например Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате собствен HTTP клиент, предайте вашия клиент, който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, `GuzzleHttp\Client` will be used as default.
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

Замяна на пакет за наемател Internal Link

Параметри

Name Type Location Required Description
tenantId string query Да
id string path Да

Отговор

Връща: FlagCommentPublic200Response

Пример

Пример за 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// Разкоментирайте по-долу, за да зададете префикс (например Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате персонализиран HTTP клиент, подайте ваш клиент, който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, по подразбиране ще се използва `GuzzleHttp\Client`.
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

Актуализиране на пакет за наемател Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
id string path Да

Отговор

Връща: FlagCommentPublic200Response

Пример

Пример за updateTenantPackage
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на удостоверяване с API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Разкоментирайте по-долу, за да зададете префикс (напр. Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате персонализиран HTTP клиент, подавайте клиент, който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, по подразбиране ще се използва `GuzzleHttp\Client`.
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

Създаване на потребител за наемателя Internal Link

Параметри

Name Type Location Required Description
tenantId string query Да

Отговор

Връща: CreateTenantUser200Response

Пример

Пример за createTenantUser
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_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

Изтриване на потребител на наемателя Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
id string path Да
deleteComments string query Не
commentDeleteMode string query Не

Отговор

Връща: FlagCommentPublic200Response

Пример

deleteTenantUser Пример
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на авторизация с API ключ: api_key
7// Разкоментирайте по-долу, за да зададете префикс (например Bearer) за API ключа, ако е необходимо
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Ако искате да използвате персонализиран HTTP клиент, предайте вашия клиент, който реализира `GuzzleHttp\ClientInterface`.
13 // Това е незадължително, по подразбиране ще се използва `GuzzleHttp\Client`.
14 new GuzzleHttp\Client(),
15 $config
16);
17$tenant_id = 'tenant_id_example'; // string
18$id = 'id_example'; // string
19$delete_comments = 'delete_comments_example'; // string
20$comment_delete_mode = 'comment_delete_mode_example'; // string
21
22try {
23 $result = $apiInstance->deleteTenantUser($tenant_id, $id, $delete_comments, $comment_delete_mode);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->deleteTenantUser: ', $e->getMessage(), PHP_EOL;
27}
28

Получаване на потребител на наемателя Internal Link

Параметри

Име Тип Location Задължително Описание
tenantId string query Да
id string path Да

Отговор

Връща: GetTenantUser200Response

Пример

Пример за getTenantUser
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на удостоверяване с API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Разкоментирайте по-долу, за да зададете префикс (напр. Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате собствен HTTP клиент, подайте ваш клиент, който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, `GuzzleHttp\Client` ще се използва по подразбиране.
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

Получаване на потребители на наемателя Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
skip number query Не

Отговор

Връща: GetTenantUsers200Response

Пример

Пример за getTenantUsers
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на удостоверяване с API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Разкоментирайте долния ред, за да зададете префикс (напр. Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако се нуждаете от потребителски HTTP клиент, подайте ваш клиент, който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е незадължително, по подразбиране ще се използва `GuzzleHttp\Client`.
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

Замяна на потребител на наемателя Internal Link


Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
id string path Да
updateComments string query Не

Отговор

Връща: FlagCommentPublic200Response

Пример

replaceTenantUser Пример
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на упълномощаване с API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Разкоментирайте по-долу, за да зададете префикс (напр. Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате персонализиран HTTP клиент, подайте клиент, който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е незадължително, по подразбиране ще се използва `GuzzleHttp\Client`.
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

Параметри

Name Type Location Required Description
tenantId string query Да
id string path Да
redirectURL string query Не

Отговор

Връща: FlagCommentPublic200Response

Пример

Пример за sendLoginLink
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на удостоверяване с 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 // Ако искате да използвате потребителски HTTP клиент, подайте вашия клиент, който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е опционално, по подразбиране ще се използва `GuzzleHttp\Client`.
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

Актуализиране на потребител на наемателя Internal Link

Параметри

Name Type Location Required Description
tenantId string query Да
id string path Да
updateComments string query Не

Отговор

Връща: FlagCommentPublic200Response

Пример

Пример за updateTenantUser
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на удостоверяване чрез API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Разкоментирайте по-долу за да настроите префикс (напр. Bearer) за API ключа, ако е необходим
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате потребителски HTTP клиент, предайте вашия клиент, който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, по подразбиране ще се използва `GuzzleHttp\Client`.
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

Създаване на наемател Internal Link

Параметри

Име Тип Локация Задължително Описание
tenantId string query Да

Отговор

Връща: CreateTenant200Response

Пример

Пример за createTenant
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на удостоверяване с API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Разкоментирайте по-долу, за да зададете префикс (напр. Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате персонализиран HTTP клиент, предайте вашия клиент, който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, по подразбиране ще се използва `GuzzleHttp\Client`.
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

Изтриване на наемател Internal Link

Параметри

Name Type Location Required Description
tenantId string query Да
id string path Да
sure string query Не

Отговор

Връща: FlagCommentPublic200Response

Пример

Пример за deleteTenant
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на удостоверяване с API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Разкоментирайте по-долу, за да зададете префикс (например Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате персонализиран HTTP клиент, подайте ваш клиент, който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, `GuzzleHttp\Client` ще се използва като подразбиране.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // низ
19$id = 'id_example'; // низ
20$sure = 'sure_example'; // низ
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

Получаване на наемател Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
id string path Да

Отговор

Връща: GetTenant200Response

Пример

getTenant Пример
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// Разкоментирайте по-долу, за да зададете префикс (напр. Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате персонализиран HTTP клиент, подайте клиента си, който реализира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, по подразбиране ще се използва `GuzzleHttp\Client`.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
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

Получаване на наематели Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
meta string query Не
skip number query Не

Response

Връща: GetTenants200Response

Пример

Пример за getTenants
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на удостоверяване чрез API ключ: api_key
7// Разкоментирайте по-долу, за да зададете префикс (напр. Bearer) за API ключа, ако е необходимо
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
13 // Това е незадължително, `GuzzleHttp\Client` ще бъде използван по подразбиране.
14 new GuzzleHttp\Client(),
15 $config
16);
17$tenant_id = 'tenant_id_example'; // string
18$meta = 'meta_example'; // string
19$skip = 3.4; // float
20
21try {
22 $result = $apiInstance->getTenants($tenant_id, $meta, $skip);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getTenants: ', $e->getMessage(), PHP_EOL;
26}
27

Актуализиране на наемател Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
id string path Да

Отговор

Връща: FlagCommentPublic200Response

Пример

Пример за updateTenant
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_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

Качване на изображение Internal Link


Качване и преоразмеряване на изображение

Параметри

Name Type Location Required Description
tenantId string path Да
sizePreset string query Не Предварително зададен размер: "Default" (1000x1000px) or "CrossPlatform" (създава размери за популярни устройства)
urlId string query Не ID на страницата, от която се извършва качването, за конфигуриране

Отговор

Връща: UploadImageResponse

Пример

uploadImage Пример
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Ако искате да използвате персонализиран HTTP клиент, предайте вашия клиент, който имплементира `GuzzleHttp\ClientInterface`.
9 // Това е незадължително, по подразбиране ще се използва `GuzzleHttp\Client`.
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 | Предварително зададен размер: \"Default\" (1000x1000px) или \"CrossPlatform\" (създава размери за популярни устройства)
15$url_id = 'url_id_example'; // string | ID на страницата, от която се извършва качването, за конфигуриране
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

Получаване на напредъка на значката на потребителя по идентификатор Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
id string path Да

Отговор

Връща: GetUserBadgeProgressById200Response

Пример

Пример getUserBadgeProgressById
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на удостоверяване с API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Разкоментирайте долния ред, за да зададете префикс (напр. Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате персонализиран HTTP клиент, предайте вашия клиент, който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е по избор; `GuzzleHttp\Client` ще се използва по подразбиране.
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

Получаване на напредъка на значката на потребителя по потребителски идентификатор Internal Link

Параметри

Name Type Location Required Description
tenantId string query Да
userId string path Да

Отговор

Връща: GetUserBadgeProgressById200Response

Пример

Пример за 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// Разкоментирайте по-долу, за да зададете префикс (например Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате потребителски HTTP клиент, предайте вашия клиент, който реализира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, по подразбиране ще се използва `GuzzleHttp\Client`.
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

Получаване на списък с напредъка на значките на потребителя Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
userId string query Не
limit number query Не
skip number query Не

Отговор

Връща: GetUserBadgeProgressList200Response

Пример

Пример за getUserBadgeProgressList
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на упълномощаването с API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Разкоментирайте по-долу, за да зададете префикс (напр. Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате персонализиран HTTP клиент, подайте ваш клиент, който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, по подразбиране ще бъде използван `GuzzleHttp\Client`.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // низ
19$user_id = 'user_id_example'; // низ
20$limit = 3.4; // число с плаваща запетая
21$skip = 3.4; // число с плаваща запетая
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

Създаване на значка за потребител Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да

Отговор

Връща: CreateUserBadge200Response

Пример

Пример за createUserBadge
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// Ако е необходимо, премахнете коментара по-долу, за да зададете префикс (напр. Bearer) за API ключа
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате потребителски HTTP клиент, предайте вашия клиент, който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, по подразбиране ще се използва `GuzzleHttp\Client`.
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

Изтриване на значка за потребител Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
id string path Да

Отговор

Връща: UpdateUserBadge200Response

Пример

Пример за deleteUserBadge
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на удостоверяване с API ключ: api_key
7// Разкоментирайте по-долу, за да зададете префикс (например Bearer) за API ключа, ако е необходимо
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Ако искате да използвате персонализиран HTTP клиент, предайте вашия клиент, който реализира `GuzzleHttp\ClientInterface`.
13 // Това е по избор, като по подразбиране ще бъде използван `GuzzleHttp\Client`.
14 new GuzzleHttp\Client(),
15 $config
16);
17$tenant_id = 'tenant_id_example'; // string
18$id = 'id_example'; // string
19
20try {
21 $result = $apiInstance->deleteUserBadge($tenant_id, $id);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling DefaultApi->deleteUserBadge: ', $e->getMessage(), PHP_EOL;
25}
26

Получаване на значка за потребител Internal Link

Параметри

Name Type Location Required Description
tenantId string query Да
id string path Да

Отговор

Връща: GetUserBadge200Response

Пример

getUserBadge Пример
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на удостоверяване чрез API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Разкоментирайте по-долу, за да зададете префикс (напр. Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате потребителски HTTP клиент, подайте вашия клиент който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е опционално, по подразбиране ще се използва `GuzzleHttp\Client`.
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

Получаване на значки за потребител Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
userId string query Не
badgeId string query Не
type number query Не
displayedOnComments boolean query Не
limit number query Не
skip number query Не

Отговор

Връща: GetUserBadges200Response

Пример

getUserBadges Пример
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Настройка на удостоверяване чрез API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Разкоментирайте долния ред, за да настроите префикс (напр. Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате персонализиран HTTP клиент, подайте вашия клиент, който реализира `GuzzleHttp\ClientInterface`.
14 // Това е незадължително, по подразбиране ще се използва `GuzzleHttp\Client`.
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

Актуализиране на значка за потребител Internal Link

Параметри

Name Type Location Required Description
tenantId string query Да
id string path Да

Отговор

Връща: UpdateUserBadge200Response

Пример

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// Разкоментирайте по-долу, за да зададете префикс (например Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате собствен HTTP клиент, предайте клиента си, който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, `GuzzleHttp\Client` ще се използва по подразбиране.
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

Получаване на брой известия за потребител Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
sso string query Не

Отговор

Връща: GetUserNotificationCount200Response

Пример

Пример за getUserNotificationCount
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Ако искате да използвате собствен HTTP клиент, подайте ваш клиент, който имплементира `GuzzleHttp\ClientInterface`.
9 // Това е по избор, `GuzzleHttp\Client` ще се използва по подразбиране.
10 new GuzzleHttp\Client()
11);
12$tenant_id = 'tenant_id_example'; // низ
13$sso = 'sso_example'; // низ
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

Получаване на известия за потребител Internal Link

Параметри

Name Type Location Required Description
tenantId string query Да
pageSize integer query Не
afterId string query Не
includeContext boolean query Не
afterCreatedAt integer query Не
unreadOnly boolean query Не
dmOnly boolean query Не
noDm boolean query Не
includeTranslations boolean query Не
sso string query Не

Отговор

Връща: GetUserNotifications200Response

Пример

Пример за getUserNotifications
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Ако искате да използвате потребителски http клиент, подайте ваш клиент, който реализира `GuzzleHttp\ClientInterface`.
9 // Това е по избор, `GuzzleHttp\Client` ще се използва по подразбиране.
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

Нулиране на броя известия на потребител Internal Link

Параметри

Name Type Location Required Description
tenantId string query Да
sso string query Не

Отговор

Връща: ResetUserNotifications200Response

Пример

Пример за resetUserNotificationCount
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Ако искате да използвате собствен HTTP клиент, предайте клиента си, който имплементира `GuzzleHttp\ClientInterface`.
9 // Това е по избор, `GuzzleHttp\Client` ще бъде използван по подразбиране.
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

Нулиране на известия на потребител Internal Link

Параметри

Name Type Location Required Description
tenantId string query Да
afterId string query Не
afterCreatedAt integer query Не
unreadOnly boolean query Не
dmOnly boolean query Не
noDm boolean query Не
sso string query Не

Отговор

Връща: ResetUserNotifications200Response

Пример

Пример за resetUserNotifications
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Ако искате да използвате потребителски HTTP клиент, предайте вашия клиент, който имплементира `GuzzleHttp\ClientInterface`.
9 // Това е незадължително, по подразбиране ще се използва `GuzzleHttp\Client`.
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

Актуализиране на статуса на абонацията на потребителя за коментари Internal Link


Включване или изключване на известия за конкретен коментар.

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
notificationId string path Да
optedInOrOut string path Да
commentId string query Да
sso string query Не

Отговор

Връща: UpdateUserNotificationStatus200Response

Пример

updateUserNotificationCommentSubscriptionStatus Пример
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Ако искате да използвате персонализиран HTTP клиент, подайте вашия клиент, който имплементира `GuzzleHttp\ClientInterface`.
9 // Това е по избор, по подразбиране ще се използва `GuzzleHttp\Client`.
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

Актуализиране на статуса на абонацията на потребителя за страници Internal Link

Активиране или деактивиране на известия за страница. Когато потребителите са абонирани за страница, се създават известия за нови коренни коментари, както и

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Yes
urlId string query Yes
url string query Yes
pageTitle string query Yes
subscribedOrUnsubscribed string path Yes
sso string query No

Отговор

Връща: UpdateUserNotificationStatus200Response

Пример

Пример за updateUserNotificationPageSubscriptionStatus
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Ако искате да използвате персонализиран HTTP клиент, подайте клиента си, който имплементира `GuzzleHttp\ClientInterface`.
9 // Това е по избор, по подразбиране ще се използва `GuzzleHttp\Client`.
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

Актуализиране на статуса на известието на потребителя Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
notificationId string path Да
newStatus string path Да
sso string query Не

Отговор

Връща: UpdateUserNotificationStatus200Response

Пример

Пример за updateUserNotificationStatus
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Ако искате да използвате персонализиран HTTP клиент, предайте вашия клиент, който имплементира `GuzzleHttp\ClientInterface`.
9 // Това е по избор, по подразбиране ще се използва `GuzzleHttp\Client`.
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

Получаване на статуси на присъствието на потребителя Internal Link

Параметри

Име Тип Location Задължително Описание
tenantId string query Да
urlIdWS string query Да
userIds string query Да

Отговор

Връща: GetUserPresenceStatuses200Response

Пример

Пример за getUserPresenceStatuses
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Ако искате да използвате персонален http клиент, подайте вашия клиент, който имплементира `GuzzleHttp\ClientInterface`.
9 // Това е по избор, `GuzzleHttp\Client` ще бъде използван по подразбиране.
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

Търсене на потребители Internal Link

Параметри

Name Type Location Required Description
tenantId string path Yes
urlId string query Yes
usernameStartsWith string query Yes
mentionGroupIds array query No
sso string query No

Отговор

Връща: SearchUsers200Response

Пример

Пример за searchUsers
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Ако искате да използвате персонализиран HTTP клиент, предайте вашия клиент, който реализира `GuzzleHttp\ClientInterface`.
9 // Това е незадължително, по подразбиране ще се използва `GuzzleHttp\Client`.
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

Получаване на потребител Internal Link

Параметри

Name Type Location Required Description
tenantId string query Да
id string path Да

Отговор

Връща: GetUser200Response

Пример

Пример за getUser
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7// Конфигуриране на удостоверяване чрез API ключ: api_key
8$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
9// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
10// Разкоментирайте по-долу, за да зададете префикс (например Bearer) за API ключа, ако е необходимо
11// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
12
13
14$apiInstance = new FastComments\Client\Api\DefaultApi(
15 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
16 // Ако искате да използвате собствен HTTP клиент, подайте вашия клиент, който имплементира `GuzzleHttp\ClientInterface`.
17 // This is optional, `GuzzleHttp\Client` will be used as default.
18 // Това е по избор, по подразбиране ще се използва `GuzzleHttp\Client`.
19 new GuzzleHttp\Client(),
20 $config
21);
22$tenant_id = 'tenant_id_example'; // string
23$id = 'id_example'; // string
24
25try {
26 $result = $apiInstance->getUser($tenant_id, $id);
27 print_r($result);
28} catch (Exception $e) {
29 echo 'Exception when calling DefaultApi->getUser: ', $e->getMessage(), PHP_EOL;
30}
31

Създаване на глас Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
commentId string query Да
direction string query Да
userId string query Не
anonUserId string query Не

Отговор

Връща: VoteComment200Response

Пример

Пример за createVote
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7// Конфигуриране на удостоверяване с API ключ: api_key
8$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
9// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
10// Премахнете коментара по-долу, за да зададете префикс (например Bearer) за API ключа, ако е необходимо
11// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
12
13
14$apiInstance = new FastComments\Client\Api\DefaultApi(
15 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
16 // Това е по избор, `GuzzleHttp\Client` ще бъде използван по подразбиране.
17 // Ако искате да използвате потребителски http клиент, подайте своя клиент, който имплементира `GuzzleHttp\ClientInterface`.
18 // This is optional, `GuzzleHttp\Client` will be used as default.
19 new GuzzleHttp\Client(),
20 $config
21);
22$tenant_id = 'tenant_id_example'; // string
23$comment_id = 'comment_id_example'; // string
24$direction = 'direction_example'; // string
25$user_id = 'user_id_example'; // string
26$anon_user_id = 'anon_user_id_example'; // string
27
28try {
29 $result = $apiInstance->createVote($tenant_id, $comment_id, $direction, $user_id, $anon_user_id);
30 print_r($result);
31} catch (Exception $e) {
32 echo 'Exception when calling DefaultApi->createVote: ', $e->getMessage(), PHP_EOL;
33}
34

Изтриване на глас Internal Link

Parameters

Name Type Location Required Description
tenantId string query Да
id string path Да
editKey string query Не

Response

Връща: DeleteCommentVote200Response

Example

Пример на deleteVote
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на удостоверяване с API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Разкоментирайте по-долу, за да зададете префикс (напр. Bearer) за API ключа, ако е необходим
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате собствен HTTP клиент, подайте ваш клиент, който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е по избор, по подразбиране ще се използва `GuzzleHttp\Client`.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$edit_key = 'edit_key_example'; // string
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

Получаване на гласове Internal Link

Параметри

Name Type Location Required Description
tenantId string query Да
urlId string query Да

Отговор

Връща: GetVotes200Response

Пример

Пример за getVotes
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
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

Получаване на гласовете за потребител Internal Link

Параметри

Name Type Location Required Description
tenantId string query Да
urlId string query Да
userId string query Не
anonUserId string query Не

Отговор

Връща: GetVotesForUser200Response

Пример

Пример за getVotesForUser
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Конфигуриране на удостоверяване чрез API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Премахнете коментара по-долу, за да настроите префикс (напр. Bearer) за API ключа, ако е необходимо
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Ако искате да използвате потребителски HTTP клиент, предайте вашия клиент, който имплементира `GuzzleHttp\ClientInterface`.
14 // Това е по избор; по подразбиране ще се използва `GuzzleHttp\Client`.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // низ
19$url_id = 'url_id_example'; // низ
20$user_id = 'user_id_example'; // низ
21$anon_user_id = 'anon_user_id_example'; // низ
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

Нужна помощ?

Ако срещнете проблеми или имате въпроси относно PHP SDK, моля:

Принос

Приносите са добре дошли! Моля посетете GitHub хранилището за указания за приноси.