FastComments SDK ל-PHP
זה ה-SDK הרשמי ב-PHP עבור FastComments.
ה-SDK הרשמי ב-PHP עבור ממשק ה-API של FastComments
מאגר
התקנה ושימוש 
דרישות
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');התחלה
אנא פעל לפי הליך ההתקנה ואז הרץ את הקוד הבא:
<?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;
}נקודות קצה של API
כל כתובות ה-URI יחסיות ל https://fastcomments.com
| Class | Method | HTTP request | Description |
|---|---|---|---|
| DefaultApi | addDomainConfig | POST /api/v1/domain-configs | |
| DefaultApi | addHashTag | POST /api/v1/hash-tags | |
| DefaultApi | addHashTagsBulk | POST /api/v1/hash-tags/bulk | |
| DefaultApi | addPage | POST /api/v1/pages | |
| DefaultApi | addSSOUser | POST /api/v1/sso-users | |
| DefaultApi | aggregate | POST /api/v1/aggregate | |
| DefaultApi | aggregateQuestionResults | GET /api/v1/question-results-aggregation | |
| DefaultApi | blockUserFromComment | POST /api/v1/comments/{id}/block | |
| DefaultApi | bulkAggregateQuestionResults | POST /api/v1/question-results-aggregation/bulk | |
| DefaultApi | changeTicketState | PATCH /api/v1/tickets/{id}/state | |
| DefaultApi | combineCommentsWithQuestionResults | GET /api/v1/question-results-aggregation/combine/comments | |
| DefaultApi | createEmailTemplate | POST /api/v1/email-templates | |
| DefaultApi | createFeedPost | POST /api/v1/feed-posts | |
| DefaultApi | createModerator | POST /api/v1/moderators | |
| DefaultApi | createQuestionConfig | POST /api/v1/question-configs | |
| DefaultApi | createQuestionResult | POST /api/v1/question-results | |
| DefaultApi | createSubscription | POST /api/v1/subscriptions | |
| DefaultApi | createTenant | POST /api/v1/tenants | |
| DefaultApi | createTenantPackage | POST /api/v1/tenant-packages | |
| DefaultApi | createTenantUser | POST /api/v1/tenant-users | |
| DefaultApi | createTicket | POST /api/v1/tickets | |
| DefaultApi | createUserBadge | POST /api/v1/user-badges | |
| DefaultApi | createVote | POST /api/v1/votes | |
| DefaultApi | deleteComment | DELETE /api/v1/comments/{id} | |
| DefaultApi | deleteDomainConfig | DELETE /api/v1/domain-configs/{domain} | |
| DefaultApi | deleteEmailTemplate | DELETE /api/v1/email-templates/{id} | |
| DefaultApi | deleteEmailTemplateRenderError | DELETE /api/v1/email-templates/{id}/render-errors/{errorId} | |
| DefaultApi | deleteHashTag | DELETE /api/v1/hash-tags/{tag} | |
| DefaultApi | deleteModerator | DELETE /api/v1/moderators/{id} | |
| DefaultApi | deleteNotificationCount | DELETE /api/v1/notification-count/{id} | |
| DefaultApi | deletePage | DELETE /api/v1/pages/{id} | |
| DefaultApi | deletePendingWebhookEvent | DELETE /api/v1/pending-webhook-events/{id} | |
| DefaultApi | deleteQuestionConfig | DELETE /api/v1/question-configs/{id} | |
| DefaultApi | deleteQuestionResult | DELETE /api/v1/question-results/{id} | |
| DefaultApi | deleteSSOUser | DELETE /api/v1/sso-users/{id} | |
| DefaultApi | deleteSubscription | DELETE /api/v1/subscriptions/{id} | |
| DefaultApi | deleteTenant | DELETE /api/v1/tenants/{id} | |
| DefaultApi | deleteTenantPackage | DELETE /api/v1/tenant-packages/{id} | |
| DefaultApi | deleteTenantUser | DELETE /api/v1/tenant-users/{id} | |
| DefaultApi | deleteUserBadge | DELETE /api/v1/user-badges/{id} | |
| DefaultApi | deleteVote | DELETE /api/v1/votes/{id} | |
| DefaultApi | flagComment | POST /api/v1/comments/{id}/flag | |
| DefaultApi | getAuditLogs | GET /api/v1/audit-logs | |
| DefaultApi | getCachedNotificationCount | GET /api/v1/notification-count/{id} | |
| DefaultApi | getComment | GET /api/v1/comments/{id} | |
| DefaultApi | getComments | GET /api/v1/comments | |
| DefaultApi | getDomainConfig | GET /api/v1/domain-configs/{domain} | |
| DefaultApi | getDomainConfigs | GET /api/v1/domain-configs | |
| DefaultApi | getEmailTemplate | GET /api/v1/email-templates/{id} | |
| DefaultApi | getEmailTemplateDefinitions | GET /api/v1/email-templates/definitions | |
| DefaultApi | getEmailTemplateRenderErrors | GET /api/v1/email-templates/{id}/render-errors | |
| DefaultApi | getEmailTemplates | GET /api/v1/email-templates | |
| DefaultApi | getFeedPosts | GET /api/v1/feed-posts | |
| DefaultApi | getHashTags | GET /api/v1/hash-tags | |
| DefaultApi | getModerator | GET /api/v1/moderators/{id} | |
| DefaultApi | getModerators | GET /api/v1/moderators | |
| DefaultApi | getNotificationCount | GET /api/v1/notifications/count | |
| DefaultApi | getNotifications | GET /api/v1/notifications | |
| DefaultApi | getPageByURLId | GET /api/v1/pages/by-url-id | |
| DefaultApi | getPages | GET /api/v1/pages | |
| DefaultApi | getPendingWebhookEventCount | GET /api/v1/pending-webhook-events/count | |
| DefaultApi | getPendingWebhookEvents | GET /api/v1/pending-webhook-events | |
| DefaultApi | getQuestionConfig | GET /api/v1/question-configs/{id} | |
| DefaultApi | getQuestionConfigs | GET /api/v1/question-configs | |
| DefaultApi | getQuestionResult | GET /api/v1/question-results/{id} | |
| DefaultApi | getQuestionResults | GET /api/v1/question-results | |
| DefaultApi | getSSOUserByEmail | GET /api/v1/sso-users/by-email/{email} | |
| DefaultApi | getSSOUserById | GET /api/v1/sso-users/by-id/{id} | |
| DefaultApi | getSSOUsers | GET /api/v1/sso-users | |
| DefaultApi | getSubscriptions | GET /api/v1/subscriptions | |
| DefaultApi | getTenant | GET /api/v1/tenants/{id} | |
| DefaultApi | getTenantDailyUsages | GET /api/v1/tenant-daily-usage | |
| DefaultApi | getTenantPackage | GET /api/v1/tenant-packages/{id} | |
| DefaultApi | getTenantPackages | GET /api/v1/tenant-packages | |
| DefaultApi | getTenantUser | GET /api/v1/tenant-users/{id} | |
| DefaultApi | getTenantUsers | GET /api/v1/tenant-users | |
| DefaultApi | getTenants | GET /api/v1/tenants | |
| DefaultApi | getTicket | GET /api/v1/tickets/{id} | |
| DefaultApi | getTickets | GET /api/v1/tickets | |
| DefaultApi | getUser | GET /api/v1/users/{id} | |
| DefaultApi | getUserBadge | GET /api/v1/user-badges/{id} | |
| DefaultApi | getUserBadgeProgressById | GET /api/v1/user-badge-progress/{id} | |
| DefaultApi | getUserBadgeProgressByUserId | GET /api/v1/user-badge-progress/user/{userId} | |
| DefaultApi | getUserBadgeProgressList | GET /api/v1/user-badge-progress | |
| DefaultApi | getUserBadges | GET /api/v1/user-badges | |
| DefaultApi | getVotes | GET /api/v1/votes | |
| DefaultApi | getVotesForUser | GET /api/v1/votes/for-user | |
| DefaultApi | patchDomainConfig | PATCH /api/v1/domain-configs/{domainToUpdate} | |
| DefaultApi | patchHashTag | PATCH /api/v1/hash-tags/{tag} | |
| DefaultApi | patchPage | PATCH /api/v1/pages/{id} | |
| DefaultApi | patchSSOUser | PATCH /api/v1/sso-users/{id} | |
| DefaultApi | putDomainConfig | PUT /api/v1/domain-configs/{domainToUpdate} | |
| DefaultApi | putSSOUser | PUT /api/v1/sso-users/{id} | |
| DefaultApi | renderEmailTemplate | POST /api/v1/email-templates/render | |
| DefaultApi | replaceTenantPackage | PUT /api/v1/tenant-packages/{id} | |
| DefaultApi | replaceTenantUser | PUT /api/v1/tenant-users/{id} | |
| DefaultApi | saveComment | POST /api/v1/comments | |
| DefaultApi | saveCommentsBulk | POST /api/v1/comments/bulk | |
| DefaultApi | sendInvite | POST /api/v1/moderators/{id}/send-invite | |
| DefaultApi | sendLoginLink | POST /api/v1/tenant-users/{id}/send-login-link | |
| DefaultApi | unBlockUserFromComment | POST /api/v1/comments/{id}/un-block | |
| DefaultApi | unFlagComment | POST /api/v1/comments/{id}/un-flag | |
| DefaultApi | updateComment | PATCH /api/v1/comments/{id} | |
| DefaultApi | updateEmailTemplate | PATCH /api/v1/email-templates/{id} | |
| DefaultApi | updateFeedPost | PATCH /api/v1/feed-posts/{id} | |
| DefaultApi | updateModerator | PATCH /api/v1/moderators/{id} | |
| DefaultApi | updateNotification | PATCH /api/v1/notifications/{id} | |
| DefaultApi | updateQuestionConfig | PATCH /api/v1/question-configs/{id} | |
| DefaultApi | updateQuestionResult | PATCH /api/v1/question-results/{id} | |
| DefaultApi | updateSubscription | PATCH /api/v1/subscriptions/{id} | |
| DefaultApi | updateTenant | PATCH /api/v1/tenants/{id} | |
| DefaultApi | updateTenantPackage | PATCH /api/v1/tenant-packages/{id} | |
| DefaultApi | updateTenantUser | PATCH /api/v1/tenant-users/{id} | |
| DefaultApi | updateUserBadge | PUT /api/v1/user-badges/{id} | |
| PublicApi | blockFromCommentPublic | POST /block-from-comment/{commentId} | |
| PublicApi | checkedCommentsForBlocked | GET /check-blocked-comments | |
| PublicApi | createCommentPublic | POST /comments/{tenantId} | |
| PublicApi | createFeedPostPublic | POST /feed-posts/{tenantId} | |
| PublicApi | deleteCommentPublic | DELETE /comments/{tenantId}/{commentId} | |
| PublicApi | deleteCommentVote | DELETE /comments/{tenantId}/{commentId}/vote/{voteId} | |
| PublicApi | deleteFeedPostPublic | DELETE /feed-posts/{tenantId}/{postId} | |
| PublicApi | flagCommentPublic | POST /flag-comment/{commentId} | |
| PublicApi | getCommentText | GET /comments/{tenantId}/{commentId}/text | |
| PublicApi | getCommentVoteUserNames | GET /comments/{tenantId}/{commentId}/votes | |
| PublicApi | getCommentsPublic | GET /comments/{tenantId} | |
| PublicApi | getEventLog | GET /event-log/{tenantId} | |
| PublicApi | getFeedPostsPublic | GET /feed-posts/{tenantId} | |
| PublicApi | getFeedPostsStats | GET /feed-posts/{tenantId}/stats | |
| PublicApi | getGlobalEventLog | GET /event-log/global/{tenantId} | |
| PublicApi | getUserNotificationCount | GET /user-notifications/get-count | |
| PublicApi | getUserNotifications | GET /user-notifications | |
| PublicApi | getUserPresenceStatuses | GET /user-presence-status | |
| PublicApi | getUserReactsPublic | GET /feed-posts/{tenantId}/user-reacts | |
| PublicApi | lockComment | POST /comments/{tenantId}/{commentId}/lock | |
| PublicApi | pinComment | POST /comments/{tenantId}/{commentId}/pin | |
| PublicApi | reactFeedPostPublic | POST /feed-posts/{tenantId}/react/{postId} | |
| PublicApi | resetUserNotificationCount | POST /user-notifications/reset-count | |
| PublicApi | resetUserNotifications | POST /user-notifications/reset | |
| PublicApi | searchUsers | GET /user-search/{tenantId} | |
| PublicApi | setCommentText | POST /comments/{tenantId}/{commentId}/update-text | |
| PublicApi | unBlockCommentPublic | DELETE /block-from-comment/{commentId} | |
| PublicApi | unLockComment | POST /comments/{tenantId}/{commentId}/unlock | |
| PublicApi | unPinComment | POST /comments/{tenantId}/{commentId}/unpin | |
| PublicApi | updateFeedPostPublic | PUT /feed-posts/{tenantId}/{postId} | |
| PublicApi | updateUserNotificationCommentSubscriptionStatus | POST /user-notifications/{notificationId}/mark-opted/{optedInOrOut} | |
| PublicApi | updateUserNotificationPageSubscriptionStatus | POST /user-notifications/set-subscription-state/{subscribedOrUnsubscribed} | |
| PublicApi | updateUserNotificationStatus | POST /user-notifications/{notificationId}/mark/{newStatus} | |
| PublicApi | uploadImage | POST /upload-image/{tenantId} | |
| PublicApi | voteComment | POST /comments/{tenantId}/{commentId}/vote |
מודלים
- APIAuditLog
- APIComment
- APICommentBase
- APICommentBaseMeta
- APICreateUserBadgeResponse
- APIDomainConfiguration
- APIEmptyResponse
- APIEmptySuccessResponse
- APIError
- APIGetCommentResponse
- APIGetCommentsResponse
- APIGetUserBadgeProgressListResponse
- APIGetUserBadgeProgressResponse
- APIGetUserBadgeResponse
- APIGetUserBadgesResponse
- APIPage
- APISSOUser
- APIStatus
- APITenant
- APITenantDailyUsage
- APITicket
- APITicketDetail
- APITicketFile
- APIUserSubscription
- AddDomainConfig200Response
- AddDomainConfig200ResponseAnyOf
- AddDomainConfigParams
- AddHashTag200Response
- AddHashTagsBulk200Response
- AddPageAPIResponse
- AddSSOUserAPIResponse
- AggregateQuestionResults200Response
- AggregateQuestionResultsResponse
- AggregateTimeBucket
- AggregationItem
- AggregationOpType
- AggregationOperation
- AggregationRequest
- AggregationRequestSort
- AggregationResponse
- AggregationResponseStats
- AggregationValue
- BillingInfo
- BlockFromCommentParams
- BlockFromCommentPublic200Response
- BlockSuccess
- BulkAggregateQuestionItem
- BulkAggregateQuestionResults200Response
- BulkAggregateQuestionResultsRequest
- BulkAggregateQuestionResultsResponse
- BulkCreateHashTagsBody
- BulkCreateHashTagsBodyTagsInner
- BulkCreateHashTagsResponse
- ChangeCommentPinStatusResponse
- ChangeTicketState200Response
- ChangeTicketStateBody
- ChangeTicketStateResponse
- CheckBlockedCommentsResponse
- CheckedCommentsForBlocked200Response
- CombineCommentsWithQuestionResults200Response
- CombineQuestionResultsWithCommentsResponse
- CommentData
- CommentHTMLRenderingMode
- CommentLogData
- CommentLogEntry
- CommentLogType
- CommentQuestionResultsRenderingType
- CommentQuestionsRequired
- CommentTextUpdateRequest
- CommentThreadDeletionMode
- CommentUserBadgeInfo
- CommentUserHashTagInfo
- CommentUserMentionInfo
- CommenterNameFormats
- CreateAPIPageData
- CreateAPISSOUserData
- CreateAPIUserSubscriptionData
- CreateCommentParams
- CreateCommentPublic200Response
- CreateEmailTemplate200Response
- CreateEmailTemplateBody
- CreateEmailTemplateResponse
- CreateFeedPost200Response
- CreateFeedPostParams
- CreateFeedPostPublic200Response
- CreateFeedPostResponse
- CreateFeedPostsResponse
- CreateHashTagBody
- CreateHashTagResponse
- CreateModerator200Response
- CreateModeratorBody
- CreateModeratorResponse
- CreateQuestionConfig200Response
- CreateQuestionConfigBody
- CreateQuestionConfigResponse
- CreateQuestionResult200Response
- CreateQuestionResultBody
- CreateQuestionResultResponse
- CreateSubscriptionAPIResponse
- CreateTenant200Response
- CreateTenantBody
- CreateTenantPackage200Response
- CreateTenantPackageBody
- CreateTenantPackageResponse
- CreateTenantResponse
- CreateTenantUser200Response
- CreateTenantUserBody
- CreateTenantUserResponse
- CreateTicket200Response
- CreateTicketBody
- CreateTicketResponse
- CreateUserBadge200Response
- CreateUserBadgeParams
- CustomConfigParameters
- CustomEmailTemplate
- DeleteComment200Response
- DeleteCommentAction
- DeleteCommentPublic200Response
- DeleteCommentResult
- DeleteCommentVote200Response
- DeleteDomainConfig200Response
- DeleteFeedPostPublic200Response
- DeleteFeedPostPublic200ResponseAnyOf
- DeleteHashTagRequest
- DeletePageAPIResponse
- DeleteSSOUserAPIResponse
- DeleteSubscriptionAPIResponse
- DeletedCommentResultComment
- DigestEmailFrequency
- EmailTemplateDefinition
- EmailTemplateRenderErrorResponse
- EventLogEntry
- FComment
- FCommentMeta
- FeedPost
- FeedPostLink
- FeedPostMediaItem
- FeedPostMediaItemAsset
- FeedPostStats
- FeedPostsStatsResponse
- FindCommentsByRangeItem
- FindCommentsByRangeResponse
- FlagComment200Response
- FlagCommentPublic200Response
- FlagCommentResponse
- GetAuditLogs200Response
- GetAuditLogsResponse
- GetCachedNotificationCount200Response
- GetCachedNotificationCountResponse
- GetComment200Response
- GetCommentText200Response
- GetCommentVoteUserNames200Response
- GetCommentVoteUserNamesSuccessResponse
- GetComments200Response
- GetCommentsPublic200Response
- GetCommentsResponsePublicComment
- GetCommentsResponseWithPresencePublicComment
- GetDomainConfig200Response
- GetDomainConfigs200Response
- GetDomainConfigs200ResponseAnyOf
- GetDomainConfigs200ResponseAnyOf1
- GetEmailTemplate200Response
- GetEmailTemplateDefinitions200Response
- GetEmailTemplateDefinitionsResponse
- GetEmailTemplateRenderErrors200Response
- GetEmailTemplateRenderErrorsResponse
- GetEmailTemplateResponse
- GetEmailTemplates200Response
- GetEmailTemplatesResponse
- GetEventLog200Response
- GetEventLogResponse
- GetFeedPosts200Response
- GetFeedPostsPublic200Response
- GetFeedPostsResponse
- GetFeedPostsStats200Response
- GetHashTags200Response
- GetHashTagsResponse
- GetModerator200Response
- GetModeratorResponse
- GetModerators200Response
- GetModeratorsResponse
- GetMyNotificationsResponse
- GetNotificationCount200Response
- GetNotificationCountResponse
- GetNotifications200Response
- GetNotificationsResponse
- GetPageByURLIdAPIResponse
- GetPagesAPIResponse
- GetPendingWebhookEventCount200Response
- GetPendingWebhookEventCountResponse
- GetPendingWebhookEvents200Response
- GetPendingWebhookEventsResponse
- GetPublicFeedPostsResponse
- GetQuestionConfig200Response
- GetQuestionConfigResponse
- GetQuestionConfigs200Response
- GetQuestionConfigsResponse
- GetQuestionResult200Response
- GetQuestionResultResponse
- GetQuestionResults200Response
- GetQuestionResultsResponse
- GetSSOUserByEmailAPIResponse
- GetSSOUserByIdAPIResponse
- GetSSOUsers200Response
- GetSubscriptionsAPIResponse
- GetTenant200Response
- GetTenantDailyUsages200Response
- GetTenantDailyUsagesResponse
- GetTenantPackage200Response
- GetTenantPackageResponse
- GetTenantPackages200Response
- GetTenantPackagesResponse
- GetTenantResponse
- GetTenantUser200Response
- GetTenantUserResponse
- GetTenantUsers200Response
- GetTenantUsersResponse
- GetTenants200Response
- GetTenantsResponse
- GetTicket200Response
- GetTicketResponse
- GetTickets200Response
- GetTicketsResponse
- GetUser200Response
- GetUserBadge200Response
- GetUserBadgeProgressById200Response
- GetUserBadgeProgressList200Response
- GetUserBadges200Response
- GetUserNotificationCount200Response
- GetUserNotificationCountResponse
- GetUserNotifications200Response
- GetUserPresenceStatuses200Response
- GetUserPresenceStatusesResponse
- GetUserReactsPublic200Response
- GetUserResponse
- GetVotes200Response
- GetVotesForUser200Response
- GetVotesForUserResponse
- GetVotesResponse
- GifRating
- HeaderAccountNotification
- HeaderState
- IgnoredResponse
- ImageContentProfanityLevel
- ImportedSiteType
- LiveEvent
- LiveEventExtraInfo
- LiveEventType
- LockComment200Response
- MediaAsset
- MentionAutoCompleteMode
- MetaItem
- Moderator
- NotificationAndCount
- NotificationObjectType
- NotificationType
- PatchDomainConfigParams
- PatchHashTag200Response
- PatchPageAPIResponse
- PatchSSOUserAPIResponse
- PendingCommentToSyncOutbound
- PinComment200Response
- PubSubComment
- PubSubCommentBase
- PubSubVote
- PublicAPIDeleteCommentResponse
- PublicAPIGetCommentTextResponse
- PublicAPISetCommentTextResponse
- PublicBlockFromCommentParams
- PublicComment
- PublicCommentBase
- PublicFeedPostsResponse
- PublicVote
- PutSSOUserAPIResponse
- QueryPredicate
- QueryPredicateValue
- QuestionConfig
- QuestionConfigCustomOptionsInner
- QuestionDatum
- QuestionRenderingType
- QuestionResult
- QuestionResultAggregationOverall
- QuestionSubQuestionVisibility
- QuestionWhenSave
- ReactBodyParams
- ReactFeedPostPublic200Response
- ReactFeedPostResponse
- RecordStringBeforeStringOrNullAfterStringOrNullValue
- RecordStringStringOrNumberValue
- RenderEmailTemplate200Response
- RenderEmailTemplateBody
- RenderEmailTemplateResponse
- RenderableUserNotification
- RepeatCommentCheckIgnoredReason
- RepeatCommentHandlingAction
- ReplaceTenantPackageBody
- ReplaceTenantUserBody
- ResetUserNotifications200Response
- ResetUserNotificationsResponse
- SORTDIR
- SSOSecurityLevel
- SaveComment200Response
- SaveCommentResponse
- SaveCommentResponseOptimized
- SaveCommentsResponseWithPresence
- SearchUsers200Response
- SearchUsersResponse
- SearchUsersSectionedResponse
- SetCommentText200Response
- SetCommentTextResult
- SizePreset
- SortDirections
- SpamRule
- TOSConfig
- TenantHashTag
- TenantPackage
- UnBlockCommentPublic200Response
- UnBlockFromCommentParams
- UnblockSuccess
- UpdatableCommentParams
- UpdateAPIPageData
- UpdateAPISSOUserData
- UpdateAPIUserSubscriptionData
- UpdateDomainConfigParams
- UpdateEmailTemplateBody
- UpdateFeedPostParams
- UpdateHashTagBody
- UpdateHashTagResponse
- UpdateModeratorBody
- UpdateNotificationBody
- UpdateQuestionConfigBody
- UpdateQuestionResultBody
- UpdateSubscriptionAPIResponse
- UpdateTenantBody
- UpdateTenantPackageBody
- UpdateTenantUserBody
- UpdateUserBadge200Response
- UpdateUserBadgeParams
- UpdateUserNotificationStatus200Response
- UploadImageResponse
- User
- UserBadge
- UserBadgeProgress
- UserNotification
- UserNotificationCount
- UserNotificationWriteResponse
- UserPresenceData
- UserReactsResponse
- UserSearchResult
- UserSearchSection
- UserSearchSectionResult
- UserSessionInfo
- VoteBodyParams
- VoteComment200Response
- VoteDeleteResponse
- VoteResponse
- VoteResponseStatus
- VoteResponseUser
- VoteStyle
הרשאה
שיטות אימות שהוגדרו עבור ה-API:
api_key
- Type: API key
- API key parameter name: x-api-key
- Location: HTTP header
מחבר
support@fastcomments.com
אגרגציה
מאגד מסמכים על ידי קיבוץ שלהם (אם מסופק groupBy) ויישום מספר פעולות. נתמכות פעולות שונות (למשל sum, countDistinct, avg וכו').
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| parentTenantId | string | query | No | |
| includeStats | boolean | query | No |
תשובה
מחזיר: AggregationResponse
דוגמה
דוגמת aggregate
Copy 
1
2
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
קבלת יומני ביקורת
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| limit | number | query | לא | |
| skip | number | query | לא | |
| order | string | query | לא | |
| after | number | query | לא | |
| before | number | query | לא |
תגובה
מחזיר: GetAuditLogs200Response
דוגמה
דוגמה ל-getAuditLogs
Copy
1
2
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$limit = 3.4; // מספר עשרוני
20$skip = 3.4; // מספר עשרוני
21$order = new \FastComments\Client\Model\\FastComments\Client\Model\SORTDIR(); // \FastComments\Client\Model\SORTDIR
22$after = 3.4; // מספר עשרוני
23$before = 3.4; // מספר עשרוני
24
25try {
26 $result = $apiInstance->getAuditLogs($tenant_id, $limit, $skip, $order, $after, $before);
27 print_r($result);
28} catch (Exception $e) {
29 echo 'Exception when calling DefaultApi->getAuditLogs: ', $e->getMessage(), PHP_EOL;
30}
31
חסום מתגובה (ציבורי)
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| commentId | string | path | כן | |
| sso | string | query | לא |
תגובה
מחזיר: BlockFromCommentPublic200Response
דוגמה
דוגמה ל-blockFromCommentPublic
Copy
1
2
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
בטל חסימה מתגובה (ציבורי)
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| commentId | string | path | כן | |
| sso | string | query | לא |
תגובה
מחזיר: UnBlockCommentPublic200Response
דוגמה
דוגמה ל-unBlockCommentPublic
Copy
1
2
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
בדיקת תגובות לחסימה
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| commentIds | string | query | כן | רשימת מזהי תגובות מופרדת בפסיקים. |
| sso | string | query | לא |
תגובה
מחזיר: CheckedCommentsForBlocked200Response
דוגמה
דוגמה ל-checkedCommentsForBlocked
Copy
1
2
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 | רשימת מזהי תגובות מופרדת בפסיקים.
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
חסום משתמש מתגובה
פרמטרים
| שם | סוג | Location | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן | |
| userId | string | query | לא | |
| anonUserId | string | query | לא |
תגובה
מחזיר: BlockFromCommentPublic200Response
דוגמה
דוגמת blockUserFromComment
Copy
1
2
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 // אם ברצונך להשתמש בלקוח HTTP מותאם אישית, העבר את הלקוח שלך שמממש את `GuzzleHttp\ClientInterface`.
15 // This is optional, `GuzzleHttp\Client` will be used as default.
16 // זה אופציונלי, `GuzzleHttp\Client` ישמש כברירת מחדל.
17 new GuzzleHttp\Client(),
18 $config
19);
20$tenant_id = 'tenant_id_example'; // string
21$id = 'id_example'; // string
22$block_from_comment_params = new \FastComments\Client\Model\BlockFromCommentParams(); // \FastComments\Client\Model\BlockFromCommentParams
23$user_id = 'user_id_example'; // string
24$anon_user_id = 'anon_user_id_example'; // string
25
26try {
27 $result = $apiInstance->blockUserFromComment($tenant_id, $id, $block_from_comment_params, $user_id, $anon_user_id);
28 print_r($result);
29} catch (Exception $e) {
30 echo 'Exception when calling DefaultApi->blockUserFromComment: ', $e->getMessage(), PHP_EOL;
31}
32
צור תגובה (ציבורית)
פרמטרים
| שם | Type | Location | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| urlId | string | query | כן | |
| broadcastId | string | query | כן | |
| sessionId | string | query | לא | |
| sso | string | query | לא |
תשובה
מחזיר: CreateCommentPublic200Response
דוגמה
דוגמה ל-createCommentPublic
Copy
1
2
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
מחק תגובה
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן | |
| contextUserId | string | query | לא | |
| isLive | boolean | query | לא |
תגובה
מחזיר: DeleteComment200Response
דוגמה
דוגמה ל-deleteComment
Copy
1
2
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 // אם ברצונך להשתמש ב-client HTTP מותאם, העבר את ה-client שמממש את `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
מחק תגובה (ציבורית)
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| commentId | string | path | כן | |
| broadcastId | string | query | כן | |
| editKey | string | query | לא | |
| sso | string | query | לא |
תגובה
מחזיר: DeleteCommentPublic200Response
דוגמה
דוגמה ל-deleteCommentPublic
Copy
1
2
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
מחק הצבעת תגובה
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| commentId | string | path | כן | |
| voteId | string | path | כן | |
| urlId | string | query | כן | |
| broadcastId | string | query | כן | |
| editKey | string | query | לא | |
| sso | string | query | לא |
תגובה
מחזיר: DeleteCommentVote200Response
דוגמה
דוגמה ל-deleteCommentVote
Copy
1
2
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 'Exception when calling PublicApi->deleteCommentVote: ', $e->getMessage(), PHP_EOL;
25}
26
דווח על תגובה
פרמטרים
| שם | Type | Location | דרוש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן | |
| userId | string | query | לא | |
| anonUserId | string | query | לא |
תגובה
מחזיר: FlagComment200Response
דוגמה
דוגמה ל-flagComment
Copy
1
2
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 // אם ברצונך להשתמש ב-client HTTP מותאם אישית, העבר את ה-client שלך שמממש את `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
קבל תגובה
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: GetComment200Response
דוגמה
דוגמה ל-getComment
Copy
1
2
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->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
קבל תגובות
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| 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
1
2
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
קבל תגובות (ציבוריות)
req tenantId urlId
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| urlId | string | query | כן | |
| page | integer | query | לא | |
| direction | string | query | לא | |
| sso | string | query | לא | |
| skip | integer | query | לא | |
| skipChildren | integer | query | לא | |
| limit | integer | query | לא | |
| limitChildren | integer | query | לא | |
| countChildren | boolean | query | לא | |
| fetchPageForCommentId | string | query | לא | |
| includeConfig | boolean | query | לא | |
| countAll | boolean | query | לא | |
| includei10n | boolean | query | לא | |
| locale | string | query | לא | |
| modules | string | query | לא | |
| isCrawler | boolean | query | לא | |
| includeNotificationCount | boolean | query | לא | |
| asTree | boolean | query | לא | |
| maxTreeDepth | integer | query | לא | |
| useFullTranslationIds | boolean | query | לא | |
| parentId | string | query | לא | |
| searchText | string | query | לא | |
| hashTags | array | query | לא | |
| userId | string | query | לא | |
| customConfigStr | string | query | לא | |
| afterCommentId | string | query | לא | |
| beforeCommentId | string | query | לא |
תגובה
מחזיר: GetCommentsPublic200Response
דוגמה
דוגמת getCommentsPublic
Copy
1
2
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
קבל טקסט של תגובה
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | נתיב | כן | |
| commentId | string | נתיב | כן | |
| editKey | string | שאילתה | לא | |
| sso | string | שאילתה | לא |
תגובה
מחזיר: GetCommentText200Response
דוגמה
דוגמה ל-getCommentText
Copy
1
2
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$edit_key = 'edit_key_example'; // מחרוזת
15$sso = 'sso_example'; // מחרוזת
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
קבל שמות משתמשים שהצביעו על תגובה
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| commentId | string | path | כן | |
| dir | integer | query | כן | |
| sso | string | query | לא |
תגובה
מחזיר: GetCommentVoteUserNames200Response
דוגמה
דוגמה ל-getCommentVoteUserNames
Copy
1
2
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$dir = 56; // מספר שלם
15$sso = 'sso_example'; // מחרוזת
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
נעל תגובה
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| commentId | string | path | כן | |
| broadcastId | string | query | כן | |
| sso | string | query | לא |
תגובה
מחזיר: LockComment200Response
דוגמה
דוגמה ל-lockComment
Copy
1
2
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
הצמד תגובה
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| commentId | string | path | כן | |
| broadcastId | string | query | כן | |
| sso | string | query | לא |
תגובה
מחזיר: PinComment200Response
דוגמה
דוגמה ל-pinComment
Copy
1
2
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
שמור תגובה
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| isLive | boolean | query | לא | |
| doSpamCheck | boolean | query | לא | |
| sendEmails | boolean | query | לא | |
| populateNotifications | boolean | query | לא |
תגובה
מחזיר: SaveComment200Response
דוגמה
saveComment דוגמה
Copy
1
2
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$create_comment_params = new \FastComments\Client\Model\CreateCommentParams(); // \FastComments\Client\Model\CreateCommentParams
23$is_live = True; // bool
24$do_spam_check = True; // bool
25$send_emails = True; // bool
26$populate_notifications = True; // bool
27
28try {
29 $result = $apiInstance->saveComment($tenant_id, $create_comment_params, $is_live, $do_spam_check, $send_emails, $populate_notifications);
30 print_r($result);
31} catch (Exception $e) {
32 echo 'Exception when calling DefaultApi->saveComment: ', $e->getMessage(), PHP_EOL;
33}
34
שמור תגובות באופן גורף
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| isLive | boolean | query | לא | |
| doSpamCheck | boolean | query | לא | |
| sendEmails | boolean | query | לא | |
| populateNotifications | boolean | query | לא |
תגובה
מחזיר: SaveComment200Response
דוגמה
דוגמה ל-saveCommentsBulk
Copy
1
2
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 = 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
הגדר טקסט תגובה
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| commentId | string | path | כן | |
| broadcastId | string | query | כן | |
| editKey | string | query | לא | |
| sso | string | query | לא |
תגובה
מחזיר: SetCommentText200Response
דוגמה
דוגמה ל-setCommentText
Copy
1
2
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
בטל חסימת משתמש מתגובה
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן | |
| userId | string | query | לא | |
| anonUserId | string | query | לא |
תגובה
מחזיר: UnBlockCommentPublic200Response
דוגמה
דוגמה ל-unBlockUserFromComment
Copy
1
2
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
הסר דיווח על תגובה
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן | |
| userId | string | query | לא | |
| anonUserId | string | query | לא |
תגובה
מחזיר: FlagComment200Response
דוגמה
דוגמה ל-unFlagComment
Copy
1
2
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->unFlagComment($tenant_id, $id, $user_id, $anon_user_id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->unFlagComment: ', $e->getMessage(), PHP_EOL;
28}
29
בטל נעילה של תגובה
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | נתיב | כן | |
| commentId | string | נתיב | כן | |
| broadcastId | string | שאילתה | כן | |
| sso | string | שאילתה | לא |
תגובה
מחזיר: LockComment200Response
דוגמה
דוגמה ל-unLockComment
Copy
1
2
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
ביטל הצמדה של תגובה
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| commentId | string | path | כן | |
| broadcastId | string | query | כן | |
| sso | string | query | לא |
תגובה
מחזיר: PinComment200Response
דוגמה
דוגמה ל-unPinComment
Copy
1
2
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->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
עדכן תגובה
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן | |
| contextUserId | string | query | לא | |
| doSpamCheck | boolean | query | לא | |
| isLive | boolean | query | לא |
תגובה
מחזיר: FlagCommentPublic200Response
דוגמה
דוגמת updateComment
Copy
1
2
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
הצביע על תגובה
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| commentId | string | path | כן | |
| urlId | string | query | כן | |
| broadcastId | string | query | כן | |
| sessionId | string | query | לא | |
| sso | string | query | לא |
תגובה
מחזיר: VoteComment200Response
דוגמה
דוגמת voteComment
Copy
1
2
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
הוסף תצורת דומיין
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן |
תגובה
מחזיר: AddDomainConfig200Response
דוגמה
דוגמה ל-addDomainConfig
Copy
1
2
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 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
14 // אם ברצונך להשתמש בלקוח HTTP מותאם, העבר את הלקוח שלך שמממש את `GuzzleHttp\ClientInterface`.
15 // This is optional, `GuzzleHttp\Client` will be used as default.
16 new GuzzleHttp\Client(),
17 $config
18);
19$tenant_id = 'tenant_id_example'; // string
20$add_domain_config_params = new \FastComments\Client\Model\AddDomainConfigParams(); // \FastComments\Client\Model\AddDomainConfigParams
21
22try {
23 $result = $apiInstance->addDomainConfig($tenant_id, $add_domain_config_params);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->addDomainConfig: ', $e->getMessage(), PHP_EOL;
27}
28
מחק תצורת דומיין
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| domain | string | path | כן |
תגובה
מחזיר: DeleteDomainConfig200Response
דוגמה
דוגמה ל-deleteDomainConfig
Copy
1
2
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
קבל תצורת דומיין
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| domain | string | path | כן |
תגובה
מחזיר: GetDomainConfig200Response
דוגמה
דוגמה ל-getDomainConfig
Copy
1
2
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// בטל את ההערה למטה כדי להגדיר קידומת (למשל 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$domain = 'domain_example'; // string
23
24try {
25 $result = $apiInstance->getDomainConfig($tenant_id, $domain);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->getDomainConfig: ', $e->getMessage(), PHP_EOL;
29}
30
קבל תצורות דומיין
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן |
תגובה
מחזיר: GetDomainConfigs200Response
דוגמה
דוגמה ל-getDomainConfigs
Copy
1
2
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->getDomainConfigs($tenant_id);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling DefaultApi->getDomainConfigs: ', $e->getMessage(), PHP_EOL;
25}
26
עדכן חלקית תצורת דומיין
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| domainToUpdate | string | path | כן |
תגובה
מחזיר: GetDomainConfig200Response
דוגמה
דוגמת patchDomainConfig
Copy
1
2
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
החלף תצורת דומיין
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| domainToUpdate | string | path | כן |
תגובה
מחזיר: GetDomainConfig200Response
דוגמה
דוגמה ל-putDomainConfig
Copy
1
2
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
צור תבנית אימייל
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן |
תגובה
מחזיר: CreateEmailTemplate200Response
דוגמה
דוגמה ל-createEmailTemplate
Copy
1
2
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_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
מחק תבנית אימייל
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | שאילתה | כן | |
| id | string | נתיב | כן |
תגובה
מחזיר: FlagCommentPublic200Response
דוגמה
דוגמה ל-deleteEmailTemplate
Copy
1
2
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
מחק שגיאת רינדור של תבנית אימייל
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן | |
| errorId | string | path | כן |
תגובה
מחזיר: FlagCommentPublic200Response
דוגמה
דוגמה ל-deleteEmailTemplateRenderError
Copy
1
2
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$error_id = 'error_id_example'; // מחרוזת
21
22try {
23 $result = $apiInstance->deleteEmailTemplateRenderError($tenant_id, $id, $error_id);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->deleteEmailTemplateRenderError: ', $e->getMessage(), PHP_EOL;
27}
28
קבל תבנית אימייל
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: GetEmailTemplate200Response
דוגמה
דוגמת getEmailTemplate
Copy
1
2
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->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
קבל הגדרות תבניות אימייל
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן |
תגובה
מחזיר: GetEmailTemplateDefinitions200Response
דוגמה
דוגמה ל-getEmailTemplateDefinitions
Copy
1
2
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->getEmailTemplateDefinitions($tenant_id);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling DefaultApi->getEmailTemplateDefinitions: ', $e->getMessage(), PHP_EOL;
25}
26
קבל שגיאות רינדור של תבניות אימייל
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן | |
| skip | number | query | לא |
תגובה
מחזיר: GetEmailTemplateRenderErrors200Response
דוגמה
דוגמה ל-getEmailTemplateRenderErrors
Copy
1
2
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
קבל תבניות אימייל
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| skip | number | query | לא |
תגובה
מחזיר: GetEmailTemplates200Response
דוגמה
דוגמה ל-getEmailTemplates
Copy
1
2
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 // 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'; // מחרוזת
19$skip = 3.4; // מספר עם נקודה צפה
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
בצע רינדור של תבנית אימייל
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| locale | string | query | לא |
תגובה
מחזיר: RenderEmailTemplate200Response
דוגמה
דוגמה ל-renderEmailTemplate
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: 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 // אם ברצונך להשתמש בלקוח HTTP מותאם אישית, העבר את הלקוח שלך שמממש את `GuzzleHttp\ClientInterface`.
14 // This is optional, `GuzzleHttp\Client` will be used as default.
15 // זה אופציונלי, `GuzzleHttp\Client` ישמש כברירת מחדל.
16 new GuzzleHttp\Client(),
17 $config
18);
19$tenant_id = 'tenant_id_example'; // string
20$render_email_template_body = new \FastComments\Client\Model\RenderEmailTemplateBody(); // \FastComments\Client\Model\RenderEmailTemplateBody
21$locale = 'locale_example'; // string
22
23try {
24 $result = $apiInstance->renderEmailTemplate($tenant_id, $render_email_template_body, $locale);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->renderEmailTemplate: ', $e->getMessage(), PHP_EOL;
28}
29
עדכן תבנית אימייל
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: FlagCommentPublic200Response
דוגמה
דוגמה ל-updateEmailTemplate
Copy
1
2
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_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
קבל יומן אירועים
req tenantId urlId userIdWS
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| userIdWS | string | query | Yes | |
| startTime | integer | query | Yes | |
| endTime | integer | query | Yes |
תגובה
מחזיר: GetEventLog200Response
דוגמה
דוגמה ל-getEventLog
Copy
1
2
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->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
קבל יומן אירועים גלובלי
req tenantId urlId userIdWS
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| urlId | string | query | כן | |
| userIdWS | string | query | כן | |
| startTime | integer | query | כן | |
| endTime | integer | query | כן |
תגובה
מחזיר: GetEventLog200Response
דוגמה
דוגמה ל-getGlobalEventLog
Copy
1
2
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
צור פוסט בפיד
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| broadcastId | string | query | לא | |
| isLive | boolean | query | לא | |
| doSpamCheck | boolean | query | לא | |
| skipDupCheck | boolean | query | לא |
תגובה
מחזיר: CreateFeedPost200Response
דוגמה
דוגמה ל-createFeedPost
Copy
1
2
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_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
צור פוסט בפיד (ציבורי)
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| broadcastId | string | query | לא | |
| sso | string | query | לא |
תגובה
מחזיר: CreateFeedPostPublic200Response
דוגמה
דוגמה ל-createFeedPostPublic
Copy
1
2
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
מחק פוסט בפיד (ציבורי)
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| postId | string | path | כן | |
| broadcastId | string | query | לא | |
| sso | string | query | לא |
תגובה
מחזיר: DeleteFeedPostPublic200Response
דוגמה
דוגמת deleteFeedPostPublic
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // אם ברצונך להשתמש ב-client http מותאם אישית, העבר את ה-client שמממש את `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
קבל פוסטים בפיד
req tenantId afterId
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| afterId | string | query | לא | |
| limit | integer | query | לא | |
| tags | array | query | לא |
תגובה
מחזיר: GetFeedPosts200Response
דוגמה
דוגמה ל-getFeedPosts
Copy
1
2
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 // אם ברצונך להשתמש ב-client HTTP מותאם, העבר את ה-client המממש את `GuzzleHttp\ClientInterface`.
14 // זה אופציונלי — `GuzzleHttp\Client` ישמש כברירת מחדל.
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
קבל פוסטים בפיד (ציבוריים)
req tenantId afterId
פרמטרים
| 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 | לא |
תגובה
מחזיר: GetFeedPostsPublic200Response
דוגמה
דוגמה ל-getFeedPostsPublic
Copy
1
2
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$after_id = 'after_id_example'; // מחרוזת
14$limit = 56; // מספר שלם
15$tags = array('tags_example'); // מערך מחרוזות
16$sso = 'sso_example'; // מחרוזת
17$is_crawler = True; // בוליאני
18$include_user_info = True; // בוליאני
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
קבל סטטיסטיקות פוסטים בפיד
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| postIds | array | query | כן | |
| sso | string | query | לא |
תגובה
מחזיר: GetFeedPostsStats200Response
דוגמה
דוגמה ל-getFeedPostsStats
Copy
1
2
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
קבל ריאקציות משתמש (ציבוריות)
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| postIds | array | query | לא | |
| sso | string | query | לא |
תגובה
מחזיר: GetUserReactsPublic200Response
דוגמה
דוגמה ל-getUserReactsPublic
Copy
1
2
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
הגב בריאקציה לפוסט בפיד (ציבורי)
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postId | string | path | Yes | |
| isUndo | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
תגובה
מחזיר: ReactFeedPostPublic200Response
דוגמה
דוגמה ל-reactFeedPostPublic
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // אם אתה רוצה להשתמש ב-client HTTP מותאם, העבר את ה-client שלך שמממש את `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
עדכן פוסט בפיד
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | שאילתה | כן | |
| id | string | נתיב | כן |
תגובה
מחזיר: FlagCommentPublic200Response
דוגמה
דוגמה ל-updateFeedPost
Copy
1
2
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 // אם ברצונך להשתמש ב-clien http מותאם אישית, העבר את הלקוח שמממש את `GuzzleHttp\ClientInterface`.
15 // This is optional, `GuzzleHttp\Client` will be used as default.
16 // זה אופציונלי, `GuzzleHttp\Client` ישמש כברירת מחדל.
17 new GuzzleHttp\Client(),
18 $config
19);
20$tenant_id = 'tenant_id_example'; // מחרוזת
21$id = 'id_example'; // מחרוזת
22$feed_post = new \FastComments\Client\Model\FeedPost(); // \FastComments\Client\Model\FeedPost
23
24try {
25 $result = $apiInstance->updateFeedPost($tenant_id, $id, $feed_post);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->updateFeedPost: ', $e->getMessage(), PHP_EOL;
29}
30
עדכן פוסט בפיד (ציבורי)
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| postId | string | path | כן | |
| broadcastId | string | query | לא | |
| sso | string | query | לא |
תגובה
מחזיר: CreateFeedPostPublic200Response
דוגמה
דוגמה ל-updateFeedPostPublic
Copy
1
2
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
דווח על תגובה (ציבורי)
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| commentId | string | path | כן | |
| isFlagged | boolean | query | כן | |
| sso | string | query | לא |
תגובה
מחזיר: FlagCommentPublic200Response
דוגמה
דוגמה ל-flagCommentPublic
Copy
1
2
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
הוסף האשטאג
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | לא |
תגובה
מחזיר: AddHashTag200Response
דוגמה
דוגמה ל-addHashTag
Copy
1
2
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_hash_tag_body = new \FastComments\Client\Model\CreateHashTagBody(); // \FastComments\Client\Model\CreateHashTagBody
24
25try {
26 $result = $apiInstance->addHashTag($tenant_id, $create_hash_tag_body);
27 print_r($result);
28} catch (Exception $e) {
29 echo 'Exception when calling DefaultApi->addHashTag: ', $e->getMessage(), PHP_EOL;
30}
31
הוסף האשטאגים באופן גורף
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | לא |
תגובה
מחזיר: AddHashTagsBulk200Response
דוגמה
דוגמה ל-addHashTagsBulk
Copy
1
2
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$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
מחק האשטאג
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tag | string | path | כן | |
| tenantId | string | query | לא |
תשובה
מחזיר: FlagCommentPublic200Response
דוגמה
דוגמה ל-deleteHashTag
Copy
1
2
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 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
14 // This is optional, `GuzzleHttp\Client` will be used as default.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tag = 'tag_example'; // string
19$tenant_id = 'tenant_id_example'; // string
20$delete_hash_tag_request = new \FastComments\Client\Model\DeleteHashTagRequest(); // \FastComments\Client\Model\DeleteHashTagRequest
21
22try {
23 $result = $apiInstance->deleteHashTag($tag, $tenant_id, $delete_hash_tag_request);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->deleteHashTag: ', $e->getMessage(), PHP_EOL;
27}
28
קבל האשטאגים
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| page | number | query | לא |
תגובה
מחזיר: GetHashTags200Response
דוגמה
דוגמה ל-getHashTags
Copy
1
2
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 = 3.4; // float
20
21try {
22 $result = $apiInstance->getHashTags($tenant_id, $page);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getHashTags: ', $e->getMessage(), PHP_EOL;
26}
27
עדכן חלקית האשטאג
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tag | string | path | כן | |
| tenantId | string | query | לא |
תגובה
מחזיר: PatchHashTag200Response
דוגמה
דוגמה ל-patchHashTag
Copy
1
2
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'; // מחרוזת
19$tenant_id = 'tenant_id_example'; // מחרוזת
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
צור מודרטור
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן |
תגובה
מחזיר: CreateModerator200Response
דוגמה
דוגמה ל-createModerator
Copy
1
2
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_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
מחק מודרטור
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן | |
| sendEmail | string | query | לא |
תגובה
מחזיר: FlagCommentPublic200Response
דוגמה
דוגמה ל-deleteModerator
Copy
1
2
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 // אם ברצונך להשתמש ב-cliënt 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
קבל מודרטור
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: GetModerator200Response
דוגמה
דוגמה ל-getModerator
Copy
1
2
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 // אם ברצונך להשתמש ב-client 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
קבל מודרטורים
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| skip | number | query | לא |
תגובה
מחזיר: GetModerators200Response
דוגמה
דוגמה ל-getModerators
Copy
1
2
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->getModerators($tenant_id, $skip);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getModerators: ', $e->getMessage(), PHP_EOL;
26}
27
שלח הזמנה
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן | |
| fromName | string | query | כן |
תגובה
מחזיר: FlagCommentPublic200Response
דוגמה
דוגמה ל-sendInvite
Copy
1
2
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$from_name = 'from_name_example'; // string
25
26try {
27 $result = $apiInstance->sendInvite($tenant_id, $id, $from_name);
28 print_r($result);
29} catch (Exception $e) {
30 echo 'Exception when calling DefaultApi->sendInvite: ', $e->getMessage(), PHP_EOL;
31}
32
עדכן מודרטור
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: FlagCommentPublic200Response
דוגמה
דוגמה ל-updateModerator
Copy
1
2
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
מחק ספירת התראות
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: FlagCommentPublic200Response
דוגמה
deleteNotificationCount דוגמה
Copy
1
2
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 // אם ברצונך להשתמש ב-client HTTP מותאם אישית, העבר את ה-client שלך שמממש את `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
קבל ספירת התראות במטמון
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: GetCachedNotificationCount200Response
דוגמה
דוגמה ל-getCachedNotificationCount
Copy
1
2
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->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
קבל ספירת התראות
פרמטרים
| 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
1
2
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$url_id = 'url_id_example'; // מחרוזת
21$from_comment_id = 'from_comment_id_example'; // מחרוזת
22$viewed = True; // בוליאני
23$type = 'type_example'; // מחרוזת
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
קבל התראות
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| userId | string | query | לא | |
| urlId | string | query | לא | |
| fromCommentId | string | query | לא | |
| viewed | boolean | query | לא | |
| type | string | query | לא | |
| skip | number | query | לא |
תגובה
מחזיר: GetNotifications200Response
דוגמה
דוגמה ל-getNotifications
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
14 // This is optional, `GuzzleHttp\Client` will be used as default.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$user_id = 'user_id_example'; // string
20$url_id = 'url_id_example'; // string
21$from_comment_id = 'from_comment_id_example'; // string
22$viewed = True; // bool
23$type = 'type_example'; // string
24$skip = 3.4; // float
25
26try {
27 $result = $apiInstance->getNotifications($tenant_id, $user_id, $url_id, $from_comment_id, $viewed, $type, $skip);
28 print_r($result);
29} catch (Exception $e) {
30 echo 'Exception when calling DefaultApi->getNotifications: ', $e->getMessage(), PHP_EOL;
31}
32
עדכן התראה
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן | |
| userId | string | query | לא |
תגובה
מחזיר: FlagCommentPublic200Response
דוגמה
דוגמה ל-updateNotification
Copy
1
2
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_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
הוסף דף
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן |
תגובה
מחזיר: AddPageAPIResponse
דוגמה
דוגמה ל-addPage
Copy
1
2
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 // אם ברצונך להשתמש ב-client HTTP מותאם, העבר את ה-client שלך שמממש את `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
מחק דף
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: DeletePageAPIResponse
דוגמה
דוגמה של deletePage
Copy
1
2
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 // אם ברצונך להשתמש ב-client HTTP מותאם, העבר את ה-client שלך שמממש את `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
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| urlId | string | query | כן |
תגובה
מחזיר: GetPageByURLIdAPIResponse
דוגמה
דוגמה ל-getPageByURLId
Copy
1
2
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
קבל דפים
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן |
תגובה
מחזיר: GetPagesAPIResponse
דוגמה
דוגמה ל-getPages
Copy
1
2
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->getPages($tenant_id);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling DefaultApi->getPages: ', $e->getMessage(), PHP_EOL;
25}
26
עדכן חלקית דף
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: PatchPageAPIResponse
דוגמה
דוגמה ל-patchPage
Copy
1
2
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_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
מחק אירוע webhook ממתין
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: FlagCommentPublic200Response
דוגמה
דוגמה ל-deletePendingWebhookEvent
Copy
1
2
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 // אם ברצונך להשתמש ב-client HTTP מותאם אישית, העבר את ה-client שמממש את `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->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
קבל ספירת אירועי webhook ממתינים
פרמטרים
| 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 | לא |
תגובה
מחזיר: GetPendingWebhookEventCount200Response
דוגמה
דוגמה ל-getPendingWebhookEventCount
Copy
1
2
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$comment_id = 'comment_id_example'; // string
20$external_id = 'external_id_example'; // string
21$event_type = 'event_type_example'; // string
22$type = 'type_example'; // string
23$domain = 'domain_example'; // string
24$attempt_count_gt = 3.4; // float
25
26try {
27 $result = $apiInstance->getPendingWebhookEventCount($tenant_id, $comment_id, $external_id, $event_type, $type, $domain, $attempt_count_gt);
28 print_r($result);
29} catch (Exception $e) {
30 echo 'Exception when calling DefaultApi->getPendingWebhookEventCount: ', $e->getMessage(), PHP_EOL;
31}
32
קבל אירועי webhook ממתינים
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| commentId | string | query | לא | |
| externalId | string | query | לא | |
| eventType | string | query | לא | |
| type | string | query | לא | |
| domain | string | query | לא | |
| attemptCountGT | number | query | לא | |
| skip | number | query | לא |
תגובה
מחזיר: GetPendingWebhookEvents200Response
דוגמה
דוגמה ל-getPendingWebhookEvents
Copy
1
2
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$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
צור תצורת שאלה
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן |
תגובה
מחזיר: CreateQuestionConfig200Response
דוגמה
דוגמת createQuestionConfig
Copy
1
2
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$create_question_config_body = new \FastComments\Client\Model\CreateQuestionConfigBody(); // \FastComments\Client\Model\CreateQuestionConfigBody
20
21try {
22 $result = $apiInstance->createQuestionConfig($tenant_id, $create_question_config_body);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->createQuestionConfig: ', $e->getMessage(), PHP_EOL;
26}
27
מחק תצורת שאלה
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: FlagCommentPublic200Response
דוגמה
דוגמה ל-deleteQuestionConfig
Copy
1
2
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->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
קבל תצורת שאלה
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: GetQuestionConfig200Response
דוגמה
דוגמה ל-getQuestionConfig
Copy
1
2
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'; // מחרוזת
19$id = 'id_example'; // מחרוזת
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
קבל תצורות שאלות
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| skip | number | query | No |
תגובה
מחזיר: GetQuestionConfigs200Response
דוגמה
דוגמה ל-getQuestionConfigs
Copy
1
2
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$skip = 3.4; // float
20
21try {
22 $result = $apiInstance->getQuestionConfigs($tenant_id, $skip);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getQuestionConfigs: ', $e->getMessage(), PHP_EOL;
26}
27
עדכן תצורת שאלה
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: FlagCommentPublic200Response
דוגמה
updateQuestionConfig דוגמה
Copy
1
2
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
צור תוצאת שאלה
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן |
תגובה
מחזיר: CreateQuestionResult200Response
דוגמה
דוגמה ל-createQuestionResult
Copy
1
2
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_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
מחק תוצאת שאלה
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: FlagCommentPublic200Response
דוגמה
דוגמה ל-deleteQuestionResult
Copy
1
2
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->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
קבל תוצאת שאלה
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: GetQuestionResult200Response
דוגמה
דוגמת getQuestionResult
Copy
1
2
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->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
קבל תוצאות שאלות
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| urlId | string | query | לא | |
| userId | string | query | לא | |
| startDate | string | query | לא | |
| questionId | string | query | לא | |
| questionIds | string | query | לא | |
| skip | number | query | לא |
תגובה
מחזיר: GetQuestionResults200Response
דוגמה
דוגמה ל-getQuestionResults
Copy
1
2
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
עדכן תוצאת שאלה
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
תגובה
מחזיר: FlagCommentPublic200Response
דוגמה
דוגמה ל-updateQuestionResult
Copy
1
2
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$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
אגרגציה של תוצאות שאלות
פרמטרים
| 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
1
2
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$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
אגרגציה גורפת של תוצאות שאלות
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| forceRecalculate | boolean | query | לא |
Response
מחזיר: BulkAggregateQuestionResults200Response
דוגמה
דוגמה עבור bulkAggregateQuestionResults
Copy
1
2
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$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
שילוב תגובות עם תוצאות שאלות
פרמטרים
| 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 | לא |
Response
מחזיר: CombineCommentsWithQuestionResults200Response
דוגמה
דוגמה ל-combineCommentsWithQuestionResults
Copy
1
2
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$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
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן |
תגובה
מחזיר: AddSSOUserAPIResponse
דוגמה
דוגמה ל-addSSOUser
Copy
1
2
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 // אם ברצונך להשתמש ב-client HTTP מותאם, העבר את ה-client שלך שמממש את `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
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן | |
| deleteComments | boolean | query | לא | |
| commentDeleteMode | string | query | לא |
תשובה
מחזיר: DeleteSSOUserAPIResponse
דוגמה
דוגמה ל-deleteSSOUser
Copy
1
2
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 // אם ברצונך להשתמש ב-client HTTP מותאם, העבר את ה-client שמממש את `GuzzleHttp\ClientInterface`.
14 // זה אופציונלי, `GuzzleHttp\Client` ישמש כברירת מחדל.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // מחרוזת
19$id = 'id_example'; // מחרוזת
20$delete_comments = True; // בוליאני
21$comment_delete_mode = 'comment_delete_mode_example'; // מחרוזת
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 לפי אימייל
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| string | path | כן |
תגובה
מחזיר: GetSSOUserByEmailAPIResponse
דוגמה
דוגמה ל-getSSOUserByEmail
Copy
1
2
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$email = 'email_example'; // מחרוזת
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 לפי מזהה
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | שאילתה | כן | |
| id | string | נתיב | כן |
תגובה
מחזיר: GetSSOUserByIdAPIResponse
דוגמה
דוגמה ל-getSSOUserById
Copy
1
2
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 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
14 // This is optional, `GuzzleHttp\Client` will be used as default.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20
21try {
22 $result = $apiInstance->getSSOUserById($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getSSOUserById: ', $e->getMessage(), PHP_EOL;
26}
27
קבל משתמשי SSO
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| skip | integer | query | לא |
תגובה
מחזיר: GetSSOUsers200Response
דוגמה
דוגמה ל-getSSOUsers
Copy
1
2
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 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
14 // אם ברצונך להשתמש בלקוח HTTP מותאם אישית, העבר את הלקוח שמממש את `GuzzleHttp\ClientInterface`.
15 // This is optional, `GuzzleHttp\Client` will be used as default.
16 // זה אופציונלי, `GuzzleHttp\Client` ישמש כברירת מחדל.
17 new GuzzleHttp\Client(),
18 $config
19);
20$tenant_id = 'tenant_id_example'; // מחרוזת
21$skip = 56; // מספר שלם
22
23try {
24 $result = $apiInstance->getSSOUsers($tenant_id, $skip);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getSSOUsers: ', $e->getMessage(), PHP_EOL;
28}
29
עדכן חלקית משתמש SSO
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן | |
| updateComments | boolean | query | לא |
תגובה
מחזיר: PatchSSOUserAPIResponse
דוגמה
דוגמה ל-patchSSOUser
Copy
1
2
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 // אם ברצונך להשתמש ב-client HTTP מותאם, העבר את ה-client שלך שמממש את `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
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| updateComments | boolean | query | No |
תגובה
מחזיר: PutSSOUserAPIResponse
דוגמה
דוגמה ל-putSSOUser
Copy
1
2
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_apisso_user_data = new \FastComments\Client\Model\UpdateAPISSOUserData(); // \FastComments\Client\Model\UpdateAPISSOUserData
21$update_comments = True; // בוליאני
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
צור מנוי
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן |
תגובה
מחזיר: CreateSubscriptionAPIResponse
דוגמה
דוגמה ל-createSubscription
Copy
1
2
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_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
מחק מנוי
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן | |
| userId | string | query | לא |
תגובה
מחזיר: DeleteSubscriptionAPIResponse
דוגמה
דוגמה של deleteSubscription
Copy
1
2
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
קבל מנויים
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| userId | string | query | לא |
תגובה
מחזיר: GetSubscriptionsAPIResponse
דוגמה
דוגמה ל-getSubscriptions
Copy
1
2
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 // אם ברצונך להשתמש ב-client HTTP מותאם, העבר את ה-client שלך שמממש את `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->getSubscriptions($tenant_id, $user_id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getSubscriptions: ', $e->getMessage(), PHP_EOL;
26}
27
עדכן מנוי
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן | |
| userId | string | query | לא |
תגובה
מחזיר: UpdateSubscriptionAPIResponse
דוגמה
דוגמה ל-updateSubscription
Copy
1
2
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 // אם ברצונך להשתמש ב-client HTTP מותאם אישית, העבר את ה-client שלך שמממש את `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_user_subscription_data = new \FastComments\Client\Model\UpdateAPIUserSubscriptionData(); // \FastComments\Client\Model\UpdateAPIUserSubscriptionData
21$user_id = 'user_id_example'; // string
22
23try {
24 $result = $apiInstance->updateSubscription($tenant_id, $id, $update_api_user_subscription_data, $user_id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->updateSubscription: ', $e->getMessage(), PHP_EOL;
28}
29
קבל שימוש יומי של שוכר
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| yearNumber | number | query | No | |
| monthNumber | number | query | No | |
| dayNumber | number | query | No | |
| skip | number | query | No |
תגובה
מחזיר: GetTenantDailyUsages200Response
דוגמה
דוגמה ל-getTenantDailyUsages
Copy
1
2
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 // אם ברצונך להשתמש ב-client http מותאם, העבר את ה-client שלך שמממש את `GuzzleHttp\ClientInterface`.
14 // זה אופציונלי, `GuzzleHttp\Client` ישמש כברירת מחדל.
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 'חריגה בעת קריאה ל-DefaultApi->getTenantDailyUsages: ', $e->getMessage(), PHP_EOL;
29}
30
צור חבילת שוכר
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | שאילתה | כן |
תגובה
מחזיר: CreateTenantPackage200Response
דוגמה
דוגמה ל-createTenantPackage
Copy
1
2
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_package_body = new \FastComments\Client\Model\CreateTenantPackageBody(); // \FastComments\Client\Model\CreateTenantPackageBody
20
21try {
22 $result = $apiInstance->createTenantPackage($tenant_id, $create_tenant_package_body);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->createTenantPackage: ', $e->getMessage(), PHP_EOL;
26}
27
מחק חבילת שוכר
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: FlagCommentPublic200Response
דוגמה
דוגמה ל-deleteTenantPackage
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: 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'; // מחרוזת
18$id = 'id_example'; // מחרוזת
19
20try {
21 $result = $apiInstance->deleteTenantPackage($tenant_id, $id);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling DefaultApi->deleteTenantPackage: ', $e->getMessage(), PHP_EOL;
25}
26
קבל חבילת שוכר
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: GetTenantPackage200Response
דוגמה
דוגמה ל-getTenantPackage
Copy
1
2
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->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
קבל חבילות שוכר
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| skip | number | query | לא |
תגובה
מחזיר: GetTenantPackages200Response
דוגמה
דוגמת getTenantPackages
Copy
1
2
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 client מותאם אישית, העבר את הלקוח שלך שמממש את `GuzzleHttp\ClientInterface`.
14 // זה אופציונלי, `GuzzleHttp\Client` ישמש כברירת מחדל.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // מחרוזת
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
החלף חבילת שוכר
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: FlagCommentPublic200Response
דוגמה
דוגמה ל-replaceTenantPackage
Copy
1
2
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_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
עדכן חבילת שוכר
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: FlagCommentPublic200Response
דוגמה
דוגמה ל-updateTenantPackage
Copy
1
2
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_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
צור משתמש שוכר
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן |
תגובה
מחזיר: CreateTenantUser200Response
דוגמה
דוגמה ל-createTenantUser
Copy
1
2
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 // אם ברצונך להשתמש ב-custom http client, העבר את הלקוח שלך שמממש את `GuzzleHttp\ClientInterface`.
14 // זה אופציונלי, `GuzzleHttp\Client` ישמש כברירת מחדל.
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
מחק משתמש שוכר
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן | |
| deleteComments | string | query | לא | |
| commentDeleteMode | string | query | לא |
תגובה
מחזיר: FlagCommentPublic200Response
דוגמה
דוגמה ל-deleteTenantUser
Copy
1
2
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 = 'delete_comments_example'; // string
21$comment_delete_mode = 'comment_delete_mode_example'; // string
22
23try {
24 $result = $apiInstance->deleteTenantUser($tenant_id, $id, $delete_comments, $comment_delete_mode);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->deleteTenantUser: ', $e->getMessage(), PHP_EOL;
28}
29
קבל משתמש שוכר
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: GetTenantUser200Response
דוגמה
דוגמה ל-getTenantUser
Copy
1
2
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
קבל משתמשי שוכר
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| skip | number | query | לא |
תגובה
מחזיר: GetTenantUsers200Response
דוגמה
דוגמה ל-getTenantUsers
Copy
1
2
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 = 3.4; // מספר עשרוני
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
החלף משתמש שוכר
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן | |
| updateComments | string | query | לא |
תגובה
מחזיר: FlagCommentPublic200Response
דוגמה
דוגמה ל-replaceTenantUser
Copy
1
2
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
שלח קישור התחברות
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| redirectURL | string | query | No |
תגובה
מחזיר: FlagCommentPublic200Response
דוגמה
דוגמה ל-sendLoginLink
Copy
1
2
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 // אם ברצונך להשתמש ב-cliet 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
עדכן משתמש שוכר
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן | |
| updateComments | string | query | לא |
תגובה
מחזיר: FlagCommentPublic200Response
דוגמה
דוגמה ל-updateTenantUser
Copy
1
2
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
צור שוכר
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן |
תגובה
מחזיר: CreateTenant200Response
דוגמה
דוגמת createTenant
Copy
1
2
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
מחק שוכר
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| sure | string | query | No |
תגובה
מחזיר: FlagCommentPublic200Response
דוגמה
דוגמה ל-deleteTenant
Copy
1
2
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$sure = 'sure_example'; // string
21
22try {
23 $result = $apiInstance->deleteTenant($tenant_id, $id, $sure);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->deleteTenant: ', $e->getMessage(), PHP_EOL;
27}
28
קבל שוכר
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | שאילתה | כן | |
| id | string | נתיב | כן |
תגובה
מחזיר: GetTenant200Response
דוגמה
דוגמה ל-getTenant
Copy
1
2
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->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
קבל שוכרים
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| meta | string | query | לא | |
| skip | number | query | לא |
תגובה
מחזיר: GetTenants200Response
דוגמה
דוגמה ל-getTenants
Copy
1
2
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$meta = 'meta_example'; // string
20$skip = 3.4; // float
21
22try {
23 $result = $apiInstance->getTenants($tenant_id, $meta, $skip);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->getTenants: ', $e->getMessage(), PHP_EOL;
27}
28
עדכן שוכר
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
תגובה
מחזיר: FlagCommentPublic200Response
דוגמה
דוגמה ל-updateTenant
Copy
1
2
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_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
שנה מצב כרטיס
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| userId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: ChangeTicketState200Response
דוגמה
דוגמה ל-changeTicketState
Copy
1
2
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$id = 'id_example'; // string
21$change_ticket_state_body = new \FastComments\Client\Model\ChangeTicketStateBody(); // \FastComments\Client\Model\ChangeTicketStateBody
22
23try {
24 $result = $apiInstance->changeTicketState($tenant_id, $user_id, $id, $change_ticket_state_body);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->changeTicketState: ', $e->getMessage(), PHP_EOL;
28}
29
צור כרטיס
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| userId | string | query | כן |
תגובה
מחזיר: CreateTicket200Response
דוגמה
דוגמה ל-createTicket
Copy
1
2
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$create_ticket_body = new \FastComments\Client\Model\CreateTicketBody(); // \FastComments\Client\Model\CreateTicketBody
21
22try {
23 $result = $apiInstance->createTicket($tenant_id, $user_id, $create_ticket_body);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->createTicket: ', $e->getMessage(), PHP_EOL;
27}
28
קבל כרטיס
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן | |
| userId | string | query | לא |
תגובה
מחזיר: GetTicket200Response
דוגמה
דוגמת getTicket
Copy
1
2
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$user_id = 'user_id_example'; // string
21
22try {
23 $result = $apiInstance->getTicket($tenant_id, $id, $user_id);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->getTicket: ', $e->getMessage(), PHP_EOL;
27}
28
קבל כרטיסים
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| userId | string | query | לא | |
| state | number | query | לא | |
| skip | number | query | לא | |
| limit | number | query | לא |
תגובה
מחזיר: GetTickets200Response
דוגמה
דוגמה ל-getTickets
Copy
1
2
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 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
14 // This is optional, `GuzzleHttp\Client` will be used as default.
15 new GuzzleHttp\Client(),
16 $config
17);
18$tenant_id = 'tenant_id_example'; // string
19$user_id = 'user_id_example'; // string
20$state = 3.4; // float
21$skip = 3.4; // float
22$limit = 3.4; // float
23
24try {
25 $result = $apiInstance->getTickets($tenant_id, $user_id, $state, $skip, $limit);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->getTickets: ', $e->getMessage(), PHP_EOL;
29}
30
העלה תמונה
העלאה ושינוי גודל של תמונה
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| sizePreset | string | query | לא | הגדרת גודל: "Default" (1000x1000px) או "CrossPlatform" (יוצר גדלים למכשירים פופולריים) |
| urlId | string | query | לא | מזהה הדף שממנו מתבצעת ההעלאה, לצורך קונפיגורציה |
תשובה
מחזיר: UploadImageResponse
דוגמה
דוגמה ל-uploadImage
Copy
1
2
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 | מזהה הדף שממנו מתבצעת ההעלאה, לצורך קונפיגורציה
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
קבל התקדמות תג משתמש לפי מזהה
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: GetUserBadgeProgressById200Response
דוגמה
דוגמה ל-getUserBadgeProgressById
Copy
1
2
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->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
קבל התקדמות תג משתמש לפי מזהה משתמש
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| userId | string | path | כן |
תגובה
מחזיר: GetUserBadgeProgressById200Response
דוגמה
דוגמה ל-getUserBadgeProgressByUserId
Copy
1
2
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
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
קבל רשימת התקדמות תגי משתמש
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| userId | string | query | לא | |
| limit | number | query | לא | |
| skip | number | query | לא |
תגובה
מחזיר: GetUserBadgeProgressList200Response
דוגמה
דוגמה ל-getUserBadgeProgressList
Copy
1
2
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 client מותאם, העבר את ה-client שלך שמממש את `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$limit = 3.4; // float
21$skip = 3.4; // float
22
23try {
24 $result = $apiInstance->getUserBadgeProgressList($tenant_id, $user_id, $limit, $skip);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getUserBadgeProgressList: ', $e->getMessage(), PHP_EOL;
28}
29
צור תג משתמש
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן |
Response
מחזיר: CreateUserBadge200Response
דוגמה
דוגמה ל-createUserBadge
Copy
1
2
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_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
מחק תג משתמש
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: UpdateUserBadge200Response
דוגמה
דוגמה ל-deleteUserBadge
Copy
1
2
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 // אם ברצונך להשתמש ב-client HTTP מותאם אישית, העבר את ה-client המממש את `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->deleteUserBadge($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->deleteUserBadge: ', $e->getMessage(), PHP_EOL;
26}
27
קבל תג משתמש
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: GetUserBadge200Response
דוגמה
דוגמת getUserBadge
Copy
1
2
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->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
קבל תגי משתמש
פרמטרים
| שם | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| userId | string | query | לא | |
| badgeId | string | query | לא | |
| type | number | query | לא | |
| displayedOnComments | boolean | query | לא | |
| limit | number | query | לא | |
| skip | number | query | לא |
תגובה
מחזיר: GetUserBadges200Response
דוגמה
דוגמה ל-getUserBadges
Copy
1
2
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
עדכן תג משתמש
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: UpdateUserBadge200Response
דוגמה
דוגמה ל-updateUserBadge
Copy
1
2
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_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
קבל ספירת התראות למשתמש
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | שאילתה | כן | |
| sso | string | שאילתה | לא |
תגובה
מחזיר: GetUserNotificationCount200Response
דוגמה
דוגמה ל-getUserNotificationCount
Copy
1
2
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
קבל התראות משתמש
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| 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
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // אם ברצונך להשתמש ב-client HTTP מותאם אישית, העבר את ה-client שלך שמממש את `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
אפס ספירת התראות של משתמש
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| sso | string | query | לא |
תגובה
מחזיר: ResetUserNotifications200Response
דוגמה
דוגמה ל-resetUserNotificationCount
Copy
1
2
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
אפס התראות משתמש
פרמטרים
| 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
1
2
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
עדכן סטטוס מנוי להודעות תגובות של משתמש
הפעל או השבת התראות עבור תגובה מסוימת.
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| notificationId | string | path | כן | |
| optedInOrOut | string | path | כן | |
| commentId | string | query | כן | |
| sso | string | query | לא |
תגובה
מחזיר: UpdateUserNotificationStatus200Response
דוגמה
updateUserNotificationCommentSubscriptionStatus דוגמה
Copy
1
2
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$notification_id = 'notification_id_example'; // מחרוזת
14$opted_in_or_out = 'opted_in_or_out_example'; // מחרוזת
15$comment_id = 'comment_id_example'; // מחרוזת
16$sso = 'sso_example'; // מחרוזת
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
עדכן סטטוס מנוי להודעות דף של משתמש
הפעל או השבת התראות עבור עמוד. כאשר משתמשים נרשמים לעמוד, נוצרות התראות עבור תגובות שורש חדשות, וגם
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| urlId | string | query | כן | |
| url | string | query | כן | |
| pageTitle | string | query | כן | |
| subscribedOrUnsubscribed | string | path | כן | |
| sso | string | query | לא |
תגובה
מחזיר: UpdateUserNotificationStatus200Response
דוגמה
דוגמה ל-updateUserNotificationPageSubscriptionStatus
Copy
1
2
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
עדכן סטטוס התראה של משתמש
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| notificationId | string | path | כן | |
| newStatus | string | path | כן | |
| sso | string | query | לא |
תגובה
מחזיר: UpdateUserNotificationStatus200Response
דוגמה
דוגמה של updateUserNotificationStatus
Copy
1
2
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$notification_id = 'notification_id_example'; // מחרוזת
14$new_status = 'new_status_example'; // מחרוזת
15$sso = 'sso_example'; // מחרוזת
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
קבל מצבי נוכחות של משתמש
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| urlIdWS | string | query | כן | |
| userIds | string | query | כן |
תגובה
מחזיר: GetUserPresenceStatuses200Response
דוגמה
getUserPresenceStatuses דוגמה
Copy
1
2
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_ws = 'url_id_ws_example'; // מחרוזת
14$user_ids = 'user_ids_example'; // מחרוזת
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
חפש משתמשים
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| urlId | string | query | כן | |
| usernameStartsWith | string | query | לא | |
| mentionGroupIds | array | query | לא | |
| sso | string | query | לא | |
| searchSection | string | query | לא |
תגובה
מחזיר: SearchUsers200Response
דוגמה
דוגמת searchUsers
Copy
1
2
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$search_section = 'search_section_example'; // string
18
19try {
20 $result = $apiInstance->searchUsers($tenant_id, $url_id, $username_starts_with, $mention_group_ids, $sso, $search_section);
21 print_r($result);
22} catch (Exception $e) {
23 echo 'Exception when calling PublicApi->searchUsers: ', $e->getMessage(), PHP_EOL;
24}
25
קבל משתמש
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: GetUser200Response
דוגמה
דוגמה ל-getUser
Copy
1
2
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->getUser($tenant_id, $id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->getUser: ', $e->getMessage(), PHP_EOL;
26}
27
צור הצבעה
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| commentId | string | query | כן | |
| direction | string | query | כן | |
| userId | string | query | לא | |
| anonUserId | string | query | לא |
תגובה
מחזיר: VoteComment200Response
דוגמה
דוגמה ל-createVote
Copy
1
2
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'; // מחרוזת
19$comment_id = 'comment_id_example'; // מחרוזת
20$direction = 'direction_example'; // מחרוזת
21$user_id = 'user_id_example'; // מחרוזת
22$anon_user_id = 'anon_user_id_example'; // מחרוזת
23
24try {
25 $result = $apiInstance->createVote($tenant_id, $comment_id, $direction, $user_id, $anon_user_id);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->createVote: ', $e->getMessage(), PHP_EOL;
29}
30
מחק הצבעה
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן | |
| editKey | string | query | לא |
תגובה
מחזיר: DeleteCommentVote200Response
דוגמה
דוגמה ל-deleteVote
Copy
1
2
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
קבל הצבעות
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes |
תגובה
Returns: GetVotes200Response
דוגמה
דוגמה של getVotes
Copy
1
2
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 // אם ברצונך להשתמש ב-client HTTP מותאם אישית, העבר את ה-client שלך שמממש את `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->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
קבל הצבעות עבור משתמש
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| urlId | string | query | כן | |
| userId | string | query | לא | |
| anonUserId | string | query | לא |
תגובה
מחזיר: GetVotesForUser200Response
דוגמה
דוגמה ל-getVotesForUser
Copy
1
2
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 לקבלת הנחיות לתרומה.