FastComments PHP SDK
Dit is de officiële PHP SDK voor FastComments.
Officiële PHP SDK voor de FastComments API
Repository
Installatie en Gebruik 
Vereisten
PHP 7.4 en later. Zou ook moeten werken met PHP 8.0.
Composer
Om de bindings via Composer te installeren, voeg het volgende toe aan composer.json:
{
"repositories": [
{
"type": "vcs",
"url": "https://github.com/fastcomments/fastcomments-php.git"
}
],
"require": {
"fastcomments/fastcomments-php": "*@dev"
}
}Voer vervolgens composer install uit
Handmatige installatie
Download de bestanden en voeg autoload.php toe:
<?php
require_once('/path/to/fastcomments/client/vendor/autoload.php');Aan de slag
Volg de installation procedure en voer vervolgens het volgende uit:
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Haal de commentaarregel hieronder weg om een prefix in te stellen (bijv. Bearer) voor de API-sleutel, indien nodig
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
// Als u een aangepaste HTTP-client wilt gebruiken, geef dan uw client door die `GuzzleHttp\ClientInterface` implementeert.
// Dit is optioneel; `GuzzleHttp\Client` wordt standaard gebruikt.
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-clients
The SDK biedt drie API‑clientklassen:
DefaultApi– API‑sleutel‑geauthenticeerde methoden voor server‑side gebruik. Configureer een API‑sleutel zoals weergegeven in Getting Started.PublicApi– openbare methoden die geen API‑sleutel vereisen, veilig om aan te roepen vanuit browsers en mobiele apps.ModerationApi– een uitgebreide reeks live en snelle moderatie‑API’s. ElkeModerationApi‑methode accepteert een$sso‑parameter en kan authenticeren via SSO of een FastComments.com‑sessie‑cookie.
PublicApi gebruiken
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Publieke methoden vereisen geen API-sleutel.
$apiInstance = new FastComments\Client\Api\PublicApi(
new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$url_id = 'url_id_example'; // string
try {
$result = $apiInstance->getCommentsPublic($tenant_id, $url_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling PublicApi->getCommentsPublic: ', $e->getMessage(), PHP_EOL;
}ModerationApi gebruiken
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
new GuzzleHttp\Client()
);
$sso = 'sso_example'; // string - SSO payload die de moderator authenticeert
try {
$result = $apiInstance->getCount([
'sso' => $sso,
]);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ModerationApi->getCount: ', $e->getMessage(), PHP_EOL;
}API-methoden
Alle URI's zijn relatief ten opzichte van https://fastcomments.com
| Klasse | Methode | HTTP-verzoek | Beschrijving |
|---|---|---|---|
| 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} | |
| ModerationApi | deleteModerationVote | DELETE /auth/my-account/moderate-comments/vote/{commentId}/{voteId} | |
| ModerationApi | getApiComments | GET /auth/my-account/moderate-comments/api/comments | |
| ModerationApi | getApiExportStatus | GET /auth/my-account/moderate-comments/api/export/status | |
| ModerationApi | getApiIds | GET /auth/my-account/moderate-comments/api/ids | |
| ModerationApi | getBanUsersFromComment | GET /auth/my-account/moderate-comments/ban-users/from-comment/{commentId} | |
| ModerationApi | getCommentBanStatus | GET /auth/my-account/moderate-comments/get-comment-ban-status/{commentId} | |
| ModerationApi | getCommentChildren | GET /auth/my-account/moderate-comments/comment-children/{commentId} | |
| ModerationApi | getCount | GET /auth/my-account/moderate-comments/count | |
| ModerationApi | getCounts | GET /auth/my-account/moderate-comments/banned-users/counts | |
| ModerationApi | getLogs | GET /auth/my-account/moderate-comments/logs/{commentId} | |
| ModerationApi | getManualBadges | GET /auth/my-account/moderate-comments/get-manual-badges | |
| ModerationApi | getManualBadgesForUser | GET /auth/my-account/moderate-comments/get-manual-badges-for-user | |
| ModerationApi | getModerationComment | GET /auth/my-account/moderate-comments/comment/{commentId} | |
| ModerationApi | getModerationCommentText | GET /auth/my-account/moderate-comments/get-comment-text/{commentId} | |
| ModerationApi | getPreBanSummary | GET /auth/my-account/moderate-comments/pre-ban-summary/{commentId} | |
| ModerationApi | getSearchCommentsSummary | GET /auth/my-account/moderate-comments/search/comments/summary | |
| ModerationApi | getSearchPages | GET /auth/my-account/moderate-comments/search/pages | |
| ModerationApi | getSearchSites | GET /auth/my-account/moderate-comments/search/sites | |
| ModerationApi | getSearchSuggest | GET /auth/my-account/moderate-comments/search/suggest | |
| ModerationApi | getSearchUsers | GET /auth/my-account/moderate-comments/search/users | |
| ModerationApi | getTrustFactor | GET /auth/my-account/moderate-comments/get-trust-factor | |
| ModerationApi | getUserBanPreference | GET /auth/my-account/moderate-comments/user-ban-preference | |
| ModerationApi | getUserInternalProfile | GET /auth/my-account/moderate-comments/get-user-internal-profile | |
| ModerationApi | postAdjustCommentVotes | POST /auth/my-account/moderate-comments/adjust-comment-votes/{commentId} | |
| ModerationApi | postApiExport | POST /auth/my-account/moderate-comments/api/export | |
| ModerationApi | postBanUserFromComment | POST /auth/my-account/moderate-comments/ban-user/from-comment/{commentId} | |
| ModerationApi | postBanUserUndo | POST /auth/my-account/moderate-comments/ban-user/undo | |
| ModerationApi | postBulkPreBanSummary | POST /auth/my-account/moderate-comments/bulk-pre-ban-summary | |
| ModerationApi | postCommentsByIds | POST /auth/my-account/moderate-comments/comments-by-ids | |
| ModerationApi | postFlagComment | POST /auth/my-account/moderate-comments/flag-comment/{commentId} | |
| ModerationApi | postRemoveComment | POST /auth/my-account/moderate-comments/remove-comment/{commentId} | |
| ModerationApi | postRestoreDeletedComment | POST /auth/my-account/moderate-comments/restore-deleted-comment/{commentId} | |
| ModerationApi | postSetCommentApprovalStatus | POST /auth/my-account/moderate-comments/set-comment-approval-status/{commentId} | |
| ModerationApi | postSetCommentReviewStatus | POST /auth/my-account/moderate-comments/set-comment-review-status/{commentId} | |
| ModerationApi | postSetCommentSpamStatus | POST /auth/my-account/moderate-comments/set-comment-spam-status/{commentId} | |
| ModerationApi | postSetCommentText | POST /auth/my-account/moderate-comments/set-comment-text/{commentId} | |
| ModerationApi | postUnFlagComment | POST /auth/my-account/moderate-comments/un-flag-comment/{commentId} | |
| ModerationApi | postVote | POST /auth/my-account/moderate-comments/vote/{commentId} | |
| ModerationApi | putAwardBadge | PUT /auth/my-account/moderate-comments/award-badge | |
| ModerationApi | putCloseThread | PUT /auth/my-account/moderate-comments/close-thread | |
| ModerationApi | putRemoveBadge | PUT /auth/my-account/moderate-comments/remove-badge | |
| ModerationApi | putReopenThread | PUT /auth/my-account/moderate-comments/reopen-thread | |
| ModerationApi | setTrustFactor | PUT /auth/my-account/moderate-comments/set-trust-factor | |
| 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 | createV1PageReact | POST /page-reacts/v1/likes/{tenantId} | |
| PublicApi | createV2PageReact | POST /page-reacts/v2/{tenantId} | |
| PublicApi | deleteCommentPublic | DELETE /comments/{tenantId}/{commentId} | |
| PublicApi | deleteCommentVote | DELETE /comments/{tenantId}/{commentId}/vote/{voteId} | |
| PublicApi | deleteFeedPostPublic | DELETE /feed-posts/{tenantId}/{postId} | |
| PublicApi | deleteV1PageReact | DELETE /page-reacts/v1/likes/{tenantId} | |
| PublicApi | deleteV2PageReact | DELETE /page-reacts/v2/{tenantId} | |
| PublicApi | flagCommentPublic | POST /flag-comment/{commentId} | |
| PublicApi | getCommentText | GET /comments/{tenantId}/{commentId}/text | |
| PublicApi | getCommentVoteUserNames | GET /comments/{tenantId}/{commentId}/votes | |
| PublicApi | getCommentsForUser | GET /comments-for-user | |
| 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 | getGifLarge | GET /gifs/get-large/{tenantId} | |
| PublicApi | getGifsSearch | GET /gifs/search/{tenantId} | |
| PublicApi | getGifsTrending | GET /gifs/trending/{tenantId} | |
| PublicApi | getGlobalEventLog | GET /event-log/global/{tenantId} | |
| PublicApi | getOfflineUsers | GET /pages/{tenantId}/users/offline | |
| PublicApi | getOnlineUsers | GET /pages/{tenantId}/users/online | |
| PublicApi | getPagesPublic | GET /pages/{tenantId} | |
| PublicApi | getTranslations | GET /translations/{namespace}/{component} | |
| 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 | getUsersInfo | GET /pages/{tenantId}/users/info | |
| PublicApi | getV1PageLikes | GET /page-reacts/v1/likes/{tenantId} | |
| PublicApi | getV2PageReactUsers | GET /page-reacts/v2/{tenantId}/list | |
| PublicApi | getV2PageReacts | GET /page-reacts/v2/{tenantId} | |
| PublicApi | lockComment | POST /comments/{tenantId}/{commentId}/lock | |
| PublicApi | logoutPublic | PUT /auth/logout | |
| 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 |
Modellen
- APIAuditLog
- APIBanUserChangeLog
- APIBanUserChangedValues
- APIBannedUser
- APIBannedUserWithMultiMatchInfo
- APIComment
- APICommentBase
- APICommentBaseMeta
- APICommentCommonBannedUser
- APICreateUserBadgeResponse
- APIDomainConfiguration
- APIEmptyResponse
- APIEmptySuccessResponse
- APIError
- APIGetCommentResponse
- APIGetCommentsResponse
- APIGetUserBadgeProgressListResponse
- APIGetUserBadgeProgressResponse
- APIGetUserBadgeResponse
- APIGetUserBadgesResponse
- APIModerateGetUserBanPreferencesResponse
- APIModerateUserBanPreferences
- APIPage
- APISSOUser
- APISaveCommentResponse
- APIStatus
- APITenant
- APITenantDailyUsage
- APITicket
- APITicketDetail
- APITicketFile
- APIUserSubscription
- AddDomainConfigParams
- AddDomainConfigResponse
- AddDomainConfigResponseAnyOf
- AddPageAPIResponse
- AddSSOUserAPIResponse
- AdjustCommentVotesParams
- AdjustVotesResponse
- AggregateQuestionResultsResponse
- AggregateResponse
- AggregateTimeBucket
- AggregationAPIError
- AggregationItem
- AggregationOpType
- AggregationOperation
- AggregationRequest
- AggregationRequestSort
- AggregationResponse
- AggregationResponseStats
- AggregationValue
- AwardUserBadgeResponse
- BanUserFromCommentResult
- BanUserUndoParams
- BannedUserMatch
- BannedUserMatchMatchedOnValue
- BannedUserMatchType
- BillingInfo
- BlockFromCommentParams
- BlockSuccess
- BuildModerationFilterParams
- BuildModerationFilterResponse
- BulkAggregateQuestionItem
- BulkAggregateQuestionResultsRequest
- BulkAggregateQuestionResultsResponse
- BulkCreateHashTagsBody
- BulkCreateHashTagsBodyTagsInner
- BulkCreateHashTagsResponse
- BulkCreateHashTagsResponseResultsInner
- BulkPreBanParams
- BulkPreBanSummary
- ChangeCommentPinStatusResponse
- ChangeTicketStateBody
- ChangeTicketStateResponse
- CheckBlockedCommentsResponse
- CombineQuestionResultsWithCommentsResponse
- CommentData
- CommentHTMLRenderingMode
- CommentLogData
- CommentLogEntry
- CommentLogType
- CommentQuestionResultsRenderingType
- CommentQuestionsRequired
- CommentTextUpdateRequest
- CommentThreadDeletionMode
- CommentUserBadgeInfo
- CommentUserHashTagInfo
- CommentUserMentionInfo
- CommenterNameFormats
- CommentsByIdsParams
- CreateAPIPageData
- CreateAPISSOUserData
- CreateAPIUserSubscriptionData
- CreateCommentParams
- CreateEmailTemplateBody
- CreateEmailTemplateResponse
- CreateFeedPostParams
- CreateFeedPostResponse
- CreateFeedPostsResponse
- CreateHashTagBody
- CreateHashTagResponse
- CreateModeratorBody
- CreateModeratorResponse
- CreateQuestionConfigBody
- CreateQuestionConfigResponse
- CreateQuestionResultBody
- CreateQuestionResultResponse
- CreateSubscriptionAPIResponse
- CreateTenantBody
- CreateTenantPackageBody
- CreateTenantPackageResponse
- CreateTenantResponse
- CreateTenantUserBody
- CreateTenantUserResponse
- CreateTicketBody
- CreateTicketResponse
- CreateUserBadgeParams
- CreateV1PageReact
- CustomConfigParameters
- CustomEmailTemplate
- DeleteCommentAction
- DeleteCommentResult
- DeleteDomainConfigResponse
- DeleteFeedPostPublicResponse
- DeleteHashTagRequestBody
- DeletePageAPIResponse
- DeleteSSOUserAPIResponse
- DeleteSubscriptionAPIResponse
- DeletedCommentResultComment
- DigestEmailFrequency
- EmailTemplateDefinition
- EmailTemplateRenderErrorResponse
- EventLogEntry
- FComment
- FCommentMeta
- FeedPost
- FeedPostLink
- FeedPostMediaItem
- FeedPostMediaItemAsset
- FeedPostStats
- FeedPostsStatsResponse
- FindCommentsByRangeItem
- FindCommentsByRangeResponse
- FlagCommentResponse
- GetAuditLogsResponse
- GetBannedUsersCountResponse
- GetBannedUsersFromCommentResponse
- GetCachedNotificationCountResponse
- GetCommentBanStatusResponse
- GetCommentTextResponse
- GetCommentVoteUserNamesSuccessResponse
- GetCommentsForUserResponse
- GetCommentsResponsePublicComment
- GetCommentsResponseWithPresencePublicComment
- GetDomainConfigResponse
- GetDomainConfigsResponse
- GetDomainConfigsResponseAnyOf
- GetDomainConfigsResponseAnyOf1
- GetEmailTemplateDefinitionsResponse
- GetEmailTemplateRenderErrorsResponse
- GetEmailTemplateResponse
- GetEmailTemplatesResponse
- GetEventLogResponse
- GetFeedPostsResponse
- GetGifsSearchResponse
- GetGifsTrendingResponse
- GetHashTagsResponse
- GetModeratorResponse
- GetModeratorsResponse
- GetMyNotificationsResponse
- GetNotificationCountResponse
- GetNotificationsResponse
- GetPageByURLIdAPIResponse
- GetPagesAPIResponse
- GetPendingWebhookEventCountResponse
- GetPendingWebhookEventsResponse
- GetPublicFeedPostsResponse
- GetPublicPagesResponse
- GetQuestionConfigResponse
- GetQuestionConfigsResponse
- GetQuestionResultResponse
- GetQuestionResultsResponse
- GetSSOUserByEmailAPIResponse
- GetSSOUserByIdAPIResponse
- GetSSOUsersResponse
- GetSubscriptionsAPIResponse
- GetTenantDailyUsagesResponse
- GetTenantManualBadgesResponse
- GetTenantPackageResponse
- GetTenantPackagesResponse
- GetTenantResponse
- GetTenantUserResponse
- GetTenantUsersResponse
- GetTenantsResponse
- GetTicketResponse
- GetTicketsResponse
- GetTranslationsResponse
- GetUserInternalProfileResponse
- GetUserInternalProfileResponseProfile
- GetUserManualBadgesResponse
- GetUserNotificationCountResponse
- GetUserPresenceStatusesResponse
- GetUserResponse
- GetUserTrustFactorResponse
- GetV1PageLikes
- GetV2PageReactUsersResponse
- GetV2PageReacts
- GetVotesForUserResponse
- GetVotesResponse
- GifGetLargeResponse
- GifRating
- GifSearchInternalError
- GifSearchResponse
- GifSearchResponseImagesInnerInner
- HeaderAccountNotification
- HeaderState
- IgnoredResponse
- ImageContentProfanityLevel
- ImportedAgentApprovalNotificationFrequency
- ImportedSiteType
- LiveEvent
- LiveEventExtraInfo
- LiveEventType
- MediaAsset
- MentionAutoCompleteMode
- MetaItem
- ModerationAPIChildCommentsResponse
- ModerationAPIComment
- ModerationAPICommentLog
- ModerationAPICommentResponse
- ModerationAPICountCommentsResponse
- ModerationAPIGetCommentIdsResponse
- ModerationAPIGetCommentsResponse
- ModerationAPIGetLogsResponse
- ModerationCommentSearchResponse
- ModerationExportResponse
- ModerationExportStatusResponse
- ModerationFilter
- ModerationPageSearchProjected
- ModerationPageSearchResponse
- ModerationSiteSearchProjected
- ModerationSiteSearchResponse
- ModerationSuggestResponse
- ModerationUserSearchProjected
- ModerationUserSearchResponse
- Moderator
- NotificationAndCount
- NotificationObjectType
- NotificationType
- PageUserEntry
- PageUsersInfoResponse
- PageUsersOfflineResponse
- PageUsersOnlineResponse
- PagesSortBy
- PatchDomainConfigParams
- PatchDomainConfigResponse
- PatchPageAPIResponse
- PatchSSOUserAPIResponse
- PendingCommentToSyncOutbound
- PostRemoveCommentResponse
- PreBanSummary
- PubSubComment
- PubSubCommentBase
- PubSubVote
- PublicAPIDeleteCommentResponse
- PublicAPIGetCommentTextResponse
- PublicAPISetCommentTextResponse
- PublicBlockFromCommentParams
- PublicComment
- PublicCommentBase
- PublicFeedPostsResponse
- PublicPage
- PublicVote
- PutDomainConfigResponse
- PutSSOUserAPIResponse
- QueryPredicate
- QueryPredicateValue
- QuestionConfig
- QuestionConfigCustomOptionsInner
- QuestionDatum
- QuestionRenderingType
- QuestionResult
- QuestionResultAggregationOverall
- QuestionSubQuestionVisibility
- QuestionWhenSave
- ReactBodyParams
- ReactFeedPostResponse
- RecordStringBeforeStringOrNullAfterStringOrNullValue
- RemoveCommentActionResponse
- RemoveUserBadgeResponse
- RenderEmailTemplateBody
- RenderEmailTemplateResponse
- RenderableUserNotification
- RepeatCommentCheckIgnoredReason
- RepeatCommentHandlingAction
- ReplaceTenantPackageBody
- ReplaceTenantUserBody
- ResetUserNotificationsResponse
- SORTDIR
- SSOSecurityLevel
- SaveCommentResponseOptimized
- SaveCommentsBulkResponse
- SaveCommentsResponseWithPresence
- SearchUsersResponse
- SearchUsersResult
- SearchUsersSectionedResponse
- SetCommentApprovedResponse
- SetCommentTextParams
- SetCommentTextResponse
- SetCommentTextResult
- SetUserTrustFactorResponse
- SizePreset
- SortDirections
- SpamRule
- TOSConfig
- TenantBadge
- TenantHashTag
- TenantPackage
- UnBlockFromCommentParams
- UnblockSuccess
- UpdatableCommentParams
- UpdateAPIPageData
- UpdateAPISSOUserData
- UpdateAPIUserSubscriptionData
- UpdateDomainConfigParams
- UpdateEmailTemplateBody
- UpdateFeedPostParams
- UpdateHashTagBody
- UpdateHashTagResponse
- UpdateModeratorBody
- UpdateNotificationBody
- UpdateQuestionConfigBody
- UpdateQuestionResultBody
- UpdateSubscriptionAPIResponse
- UpdateTenantBody
- UpdateTenantPackageBody
- UpdateTenantUserBody
- UpdateUserBadgeParams
- UpdateUserNotificationCommentSubscriptionStatusResponse
- UpdateUserNotificationPageSubscriptionStatusResponse
- UpdateUserNotificationStatusResponse
- UploadImageResponse
- User
- UserBadge
- UserBadgeProgress
- UserNotification
- UserNotificationCount
- UserNotificationWriteResponse
- UserPresenceData
- UserReactsResponse
- UserSearchResult
- UserSearchSection
- UserSearchSectionResult
- UserSessionInfo
- UsersListLocation
- VoteBodyParams
- VoteDeleteResponse
- VoteResponse
- VoteResponseStatus
- VoteResponseUser
- VoteStyle
Autorisatie
Authenticatieschema's die voor de API zijn gedefinieerd:
api_key
- Type: API key
- API key parameter name: x-api-key
- Location: HTTP header
Auteur
support@fastcomments.com
Aggregeren
Aggregates documents by grouping them (if groupBy is provided) and applying multiple operations. Different operations (e.g. sum, countDistinct, avg, etc.) are supported.
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| parentTenantId | string | query | No | |
| includeStats | boolean | query | No |
Response
Returns: AggregateResponse
Example
aggregatie Voorbeeld
Copy 
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutel autorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommentarieer de onderstaande regel om een prefix (bijv. Bearer) voor de API-sleutel in te stellen, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$aggregation_request = new \FastComments\Client\Model\AggregationRequest(); // \FastComments\Client\Model\AggregationRequest
21$options = [
22 'parent_tenant_id' => 'parent_tenant_id_example', // string
23 'include_stats' => True, // bool
24];
25
26
27try {
28 $result = $apiInstance->aggregate($tenant_id, $aggregation_request, $options);
29 print_r($result);
30} catch (Exception $e) {
31 echo 'Exception when calling DefaultApi->aggregate: ', $e->getMessage(), PHP_EOL;
32}
33
Auditlogs ophalen
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| limit | number | query | No | |
| skip | number | query | No | |
| order | string | query | No | |
| after | number | query | No | |
| before | number | query | No |
Response
Retourneert: GetAuditLogsResponse
Example
getAuditLogs Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutautorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Verwijder de commentaartekens hieronder om een prefix (bijv. Bearer) in te stellen voor de API-sleutel, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$options = [
21 'limit' => 3.4, // float
22 'skip' => 3.4, // float
23 'order' => new \FastComments\Client\Model\\FastComments\Client\Model\SORTDIR(), // \FastComments\Client\Model\SORTDIR
24 'after' => 3.4, // float
25 'before' => 3.4, // float
26];
27
28
29try {
30 $result = $apiInstance->getAuditLogs($tenant_id, $options);
31 print_r($result);
32} catch (Exception $e) {
33 echo 'Exception when calling DefaultApi->getAuditLogs: ', $e->getMessage(), PHP_EOL;
34}
35
Uitloggen (Openbaar)
Respons
Retourneert: APIEmptyResponse
Voorbeeld
logoutPublic Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Als je een aangepaste HTTP-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13
14
15try {
16 $result = $apiInstance->logoutPublic();
17 print_r($result);
18} catch (Exception $e) {
19 echo 'Exception when calling PublicApi->logoutPublic: ', $e->getMessage(), PHP_EOL;
20}
21
Blokkeren vanaf opmerking (Openbaar)
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nee |
Respons
Retourneert: BlockSuccess
Voorbeeld
blockFromCommentPublic Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Als je een aangepaste http-client wilt gebruiken, geef je je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt gebruikt als standaard.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$public_block_from_comment_params = new \FastComments\Client\Model\PublicBlockFromCommentParams(); // \FastComments\Client\Model\PublicBlockFromCommentParams
16$sso = 'sso_example'; // string
17
18
19try {
20 $result = $apiInstance->blockFromCommentPublic($tenant_id, $comment_id, $public_block_from_comment_params, $sso);
21 print_r($result);
22} catch (Exception $e) {
23 echo 'Exception when calling PublicApi->blockFromCommentPublic: ', $e->getMessage(), PHP_EOL;
24}
25
Opmerking ontblokkeren (Openbaar)
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nee |
Response
Retourneert: UnblockSuccess
Example
unBlockCommentPublic Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Als je een aangepaste HTTP-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$public_block_from_comment_params = new \FastComments\Client\Model\PublicBlockFromCommentParams(); // \FastComments\Client\Model\PublicBlockFromCommentParams
16$sso = 'sso_example'; // string
17
18
19try {
20 $result = $apiInstance->unBlockCommentPublic($tenant_id, $comment_id, $public_block_from_comment_params, $sso);
21 print_r($result);
22} catch (Exception $e) {
23 echo 'Exception when calling PublicApi->unBlockCommentPublic: ', $e->getMessage(), PHP_EOL;
24}
25
Controleren op geblokkeerde opmerkingen
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentIds | string | query | Ja | Een door komma's gescheiden lijst van comment ids. |
| sso | string | query | Nee |
Response
Retourneert: CheckBlockedCommentsResponse
Voorbeeld
checkedCommentsForBlocked Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_ids = 'comment_ids_example'; // string | Een door komma's gescheiden lijst van comment ids.
15$sso = 'sso_example'; // string
16
17
18try {
19 $result = $apiInstance->checkedCommentsForBlocked($tenant_id, $comment_ids, $sso);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling PublicApi->checkedCommentsForBlocked: ', $e->getMessage(), PHP_EOL;
23}
24
Gebruiker blokkeren vanaf opmerking
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nee | |
| anonUserId | string | query | Nee |
Response
Returns: BlockSuccess
Example
blockUserFromComment Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5// Configureer API-sleutel autorisatie: api_key
6$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
7// Verwijder de commentaar onder om een prefix (bijv. Bearer) voor de API-sleutel in te stellen, indien nodig
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Als je een aangepaste http-client wilt gebruiken, geef dan je client door die `GuzzleHttp\ClientInterface` implementeert.
13 // Dit is optioneel, `GuzzleHttp\Client` wordt als standaard gebruikt.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$block_from_comment_params = new \FastComments\Client\Model\BlockFromCommentParams(); // \FastComments\Client\Model\BlockFromCommentParams
21$options = [
22 'user_id' => 'user_id_example', // string
23 'anon_user_id' => 'anon_user_id_example', // string
24];
25
26
27try {
28 $result = $apiInstance->blockUserFromComment($tenant_id, $id, $block_from_comment_params, $options);
29 print_r($result);
30} catch (Exception $e) {
31 echo 'Exception when calling DefaultApi->blockUserFromComment: ', $e->getMessage(), PHP_EOL;
32}
33
Opmerking maken (Openbaar)
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| broadcastId | string | query | Ja | |
| sessionId | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: SaveCommentsResponseWithPresence
Voorbeeld
Voorbeeld createCommentPublic
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt als standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$url_id = 'url_id_example'; // string
15$broadcast_id = 'broadcast_id_example'; // string
16$comment_data = new \FastComments\Client\Model\CommentData(); // \FastComments\Client\Model\CommentData
17$options = [
18 'session_id' => 'session_id_example', // string
19 'sso' => 'sso_example', // string
20];
21
22
23try {
24 $result = $apiInstance->createCommentPublic($tenant_id, $url_id, $broadcast_id, $comment_data, $options);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling PublicApi->createCommentPublic: ', $e->getMessage(), PHP_EOL;
28}
29
Opmerking verwijderen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| contextUserId | string | query | Nee | |
| isLive | boolean | query | Nee |
Respons
Retourneert: DeleteCommentResult
Voorbeeld
deleteComment Voorbeeld
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
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$options = [
22 'context_user_id' => 'context_user_id_example', // string
23 'is_live' => True, // bool
24];
25
26
27try {
28 $result = $apiInstance->deleteComment($tenant_id, $id, $options);
29 print_r($result);
30} catch (Exception $e) {
31 echo 'Exception when calling DefaultApi->deleteComment: ', $e->getMessage(), PHP_EOL;
32}
33
Opmerking verwijderen (Openbaar)
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Ja | |
| editKey | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: PublicAPIDeleteCommentResponse
Voorbeeld
deleteCommentPublic Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Als je een aangepaste HTTP-client wilt gebruiken, geef je je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$broadcast_id = 'broadcast_id_example'; // string
16$options = [
17 'edit_key' => 'edit_key_example', // string
18 'sso' => 'sso_example', // string
19];
20
21
22try {
23 $result = $apiInstance->deleteCommentPublic($tenant_id, $comment_id, $broadcast_id, $options);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling PublicApi->deleteCommentPublic: ', $e->getMessage(), PHP_EOL;
27}
28
Opmerkingstem verwijderen
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| voteId | string | path | Yes | |
| urlId | string | query | Yes | |
| broadcastId | string | query | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
Response
Returns: VoteDeleteResponse
Example
deleteCommentVote Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$vote_id = 'vote_id_example'; // string
16$url_id = 'url_id_example'; // string
17$broadcast_id = 'broadcast_id_example'; // string
18$options = [
19 'edit_key' => 'edit_key_example', // string
20 'sso' => 'sso_example', // string
21];
22
23
24try {
25 $result = $apiInstance->deleteCommentVote($tenant_id, $comment_id, $vote_id, $url_id, $broadcast_id, $options);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling PublicApi->deleteCommentVote: ', $e->getMessage(), PHP_EOL;
29}
30
Opmerking markeren
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nee | |
| anonUserId | string | query | Nee |
Response
Retourneert: FlagCommentResponse
Voorbeeld
flagComment Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutelauthorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Verwijder de commentaar hieronder om een prefix (bijv. Bearer) voor de API-sleutel in te stellen, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste http-client wilt gebruiken, geef je je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt gebruikt als standaard.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$options = [
22 'user_id' => 'user_id_example', // string
23 'anon_user_id' => 'anon_user_id_example', // string
24];
25
26
27try {
28 $result = $apiInstance->flagComment($tenant_id, $id, $options);
29 print_r($result);
30} catch (Exception $e) {
31 echo 'Exception when calling DefaultApi->flagComment: ', $e->getMessage(), PHP_EOL;
32}
33
Opmerking ophalen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Response
Retourneert: APIGetCommentResponse
Voorbeeld
getComment Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutel autorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Ontcomment de onderstaande om een prefix (bijv. Bearer) voor de API-sleutel in te stellen, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21
22
23try {
24 $result = $apiInstance->getComment($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getComment: ', $e->getMessage(), PHP_EOL;
28}
29
Opmerkingen ophalen
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| page | integer | query | Nee | |
| limit | integer | query | Nee | |
| skip | integer | query | Nee | |
| asTree | boolean | query | Nee | |
| skipChildren | integer | query | Nee | |
| limitChildren | integer | query | Nee | |
| maxTreeDepth | integer | query | Nee | |
| urlId | string | query | Nee | |
| userId | string | query | Nee | |
| anonUserId | string | query | Nee | |
| contextUserId | string | query | Nee | |
| hashTag | string | query | Nee | |
| parentId | string | query | Nee | |
| direction | string | query | Nee | |
| fromDate | integer | query | Nee | |
| toDate | integer | query | Nee |
Respons
Retourneert: APIGetCommentsResponse
Voorbeeld
getComments Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutelautorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Verwijder commentaar hieronder om prefix (bijv. Bearer) voor API-sleutel in te stellen, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste HTTP-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$options = [
21 'page' => 56, // int
22 'limit' => 56, // int
23 'skip' => 56, // int
24 'as_tree' => True, // bool
25 'skip_children' => 56, // int
26 'limit_children' => 56, // int
27 'max_tree_depth' => 56, // int
28 'url_id' => 'url_id_example', // string
29 'user_id' => 'user_id_example', // string
30 'anon_user_id' => 'anon_user_id_example', // string
31 'context_user_id' => 'context_user_id_example', // string
32 'hash_tag' => 'hash_tag_example', // string
33 'parent_id' => 'parent_id_example', // string
34 'direction' => new \FastComments\Client\Model\\FastComments\Client\Model\SortDirections(), // \FastComments\Client\Model\SortDirections
35 'from_date' => 56, // int
36 'to_date' => 56, // int
37];
38
39
40try {
41 $result = $apiInstance->getComments($tenant_id, $options);
42 print_r($result);
43} catch (Exception $e) {
44 echo 'Exception when calling DefaultApi->getComments: ', $e->getMessage(), PHP_EOL;
45}
46
Opmerkingen ophalen (Openbaar)
req tenantId urlId
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| page | integer | query | Nee | |
| direction | string | query | Nee | |
| sso | string | query | Nee | |
| skip | integer | query | Nee | |
| skipChildren | integer | query | Nee | |
| limit | integer | query | Nee | |
| limitChildren | integer | query | Nee | |
| countChildren | boolean | query | Nee | |
| fetchPageForCommentId | string | query | Nee | |
| includeConfig | boolean | query | Nee | |
| countAll | boolean | query | Nee | |
| includei10n | boolean | query | Nee | |
| locale | string | query | Nee | |
| modules | string | query | Nee | |
| isCrawler | boolean | query | Nee | |
| includeNotificationCount | boolean | query | Nee | |
| asTree | boolean | query | Nee | |
| maxTreeDepth | integer | query | Nee | |
| useFullTranslationIds | boolean | query | Nee | |
| parentId | string | query | Nee | |
| searchText | string | query | Nee | |
| hashTags | array | query | Nee | |
| userId | string | query | Nee | |
| customConfigStr | string | query | Nee | |
| afterCommentId | string | query | Nee | |
| beforeCommentId | string | query | Nee |
Antwoord
Retourneert: GetCommentsResponseWithPresencePublicComment
Voorbeeld
getCommentsPublic Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Als u een aangepaste http-client wilt gebruiken, geef uw client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$url_id = 'url_id_example'; // string
15$options = [
16 'page' => 56, // int
17 'direction' => new \FastComments\Client\Model\\FastComments\Client\Model\SortDirections(), // \FastComments\Client\Model\SortDirections
18 'sso' => 'sso_example', // string
19 'skip' => 56, // int
20 'skip_children' => 56, // int
21 'limit' => 56, // int
22 'limit_children' => 56, // int
23 'count_children' => True, // bool
24 'fetch_page_for_comment_id' => 'fetch_page_for_comment_id_example', // string
25 'include_config' => True, // bool
26 'count_all' => True, // bool
27 'includei10n' => True, // bool
28 'locale' => 'locale_example', // string
29 'modules' => 'modules_example', // string
30 'is_crawler' => True, // bool
31 'include_notification_count' => True, // bool
32 'as_tree' => True, // bool
33 'max_tree_depth' => 56, // int
34 'use_full_translation_ids' => True, // bool
35 'parent_id' => 'parent_id_example', // string
36 'search_text' => 'search_text_example', // string
37 'hash_tags' => array('hash_tags_example'), // string[]
38 'user_id' => 'user_id_example', // string
39 'custom_config_str' => 'custom_config_str_example', // string
40 'after_comment_id' => 'after_comment_id_example', // string
41 'before_comment_id' => 'before_comment_id_example', // string
42];
43
44
45try {
46 $result = $apiInstance->getCommentsPublic($tenant_id, $url_id, $options);
47 print_r($result);
48} catch (Exception $e) {
49 echo 'Exception when calling PublicApi->getCommentsPublic: ', $e->getMessage(), PHP_EOL;
50}
51
Opmerkingstekst ophalen
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| editKey | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: PublicAPIGetCommentTextResponse
Voorbeeld
getCommentText Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$options = [
16 'edit_key' => 'edit_key_example', // string
17 'sso' => 'sso_example', // string
18];
19
20
21try {
22 $result = $apiInstance->getCommentText($tenant_id, $comment_id, $options);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling PublicApi->getCommentText: ', $e->getMessage(), PHP_EOL;
26}
27
Opmerkingstem gebruikersnamen ophalen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| dir | integer | query | Yes | |
| sso | string | query | No |
Response
Returns: GetCommentVoteUserNamesSuccessResponse
Example
getCommentVoteUserNames Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Als u een aangepaste HTTP-client wilt gebruiken, geef dan uw client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel; `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$dir = 56; // int
16$sso = 'sso_example'; // string
17
18
19try {
20 $result = $apiInstance->getCommentVoteUserNames($tenant_id, $comment_id, $dir, $sso);
21 print_r($result);
22} catch (Exception $e) {
23 echo 'Exception when calling PublicApi->getCommentVoteUserNames: ', $e->getMessage(), PHP_EOL;
24}
25
Opmerking vergrendelen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Ja | |
| sso | string | query | Nee |
Respons
Retourneert: APIEmptyResponse
Voorbeeld
lockComment Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$broadcast_id = 'broadcast_id_example'; // string
16$sso = 'sso_example'; // string
17
18
19try {
20 $result = $apiInstance->lockComment($tenant_id, $comment_id, $broadcast_id, $sso);
21 print_r($result);
22} catch (Exception $e) {
23 echo 'Exception when calling PublicApi->lockComment: ', $e->getMessage(), PHP_EOL;
24}
25
Opmerking vastzetten
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| sso | string | query | No |
Response
Returns: ChangeCommentPinStatusResponse
Example
pinComment Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Als je een aangepaste http-client wilt gebruiken, geef je jouw client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$broadcast_id = 'broadcast_id_example'; // string
16$sso = 'sso_example'; // string
17
18
19try {
20 $result = $apiInstance->pinComment($tenant_id, $comment_id, $broadcast_id, $sso);
21 print_r($result);
22} catch (Exception $e) {
23 echo 'Exception when calling PublicApi->pinComment: ', $e->getMessage(), PHP_EOL;
24}
25
Opmerking opslaan
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| isLive | boolean | query | Nee | |
| doSpamCheck | boolean | query | Nee | |
| sendEmails | boolean | query | Nee | |
| populateNotifications | boolean | query | Nee |
Respons
Retourneert: APISaveCommentResponse
Voorbeeld
saveComment Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5// Configureer API-sleutel autorisatie: api_key
6$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
7// Verwijder commentaar hieronder om prefix in te stellen (bijv. Bearer) voor API-sleutel, indien nodig
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Als je een aangepaste HTTP-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
13 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // string
19$create_comment_params = new \FastComments\Client\Model\CreateCommentParams(); // \FastComments\Client\Model\CreateCommentParams
20$options = [
21 'is_live' => True, // bool
22 'do_spam_check' => True, // bool
23 'send_emails' => True, // bool
24 'populate_notifications' => True, // bool
25];
26
27
28try {
29 $result = $apiInstance->saveComment($tenant_id, $create_comment_params, $options);
30 print_r($result);
31} catch (Exception $e) {
32 echo 'Exception when calling DefaultApi->saveComment: ', $e->getMessage(), PHP_EOL;
33}
34
Opmerkingen bulk opslaan
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| sendEmails | boolean | query | No | |
| populateNotifications | boolean | query | No |
Respons
Retourneert: SaveCommentsBulkResponse
Voorbeeld
Voorbeeld saveCommentsBulk
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutel autorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment onderstaande regel om prefix (bijv. Bearer) voor de API-sleutel in te stellen, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$create_comment_params = array(new \FastComments\Client\Model\CreateCommentParams()); // \FastComments\Client\Model\CreateCommentParams[]
21$options = [
22 'is_live' => True, // bool
23 'do_spam_check' => True, // bool
24 'send_emails' => True, // bool
25 'populate_notifications' => True, // bool
26];
27
28
29try {
30 $result = $apiInstance->saveCommentsBulk($tenant_id, $create_comment_params, $options);
31 print_r($result);
32} catch (Exception $e) {
33 echo 'Exception when calling DefaultApi->saveCommentsBulk: ', $e->getMessage(), PHP_EOL;
34}
35
Opmerkingstekst instellen
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Ja | |
| editKey | string | query | Nee | |
| sso | string | query | Nee |
Response
Retourneert: PublicAPISetCommentTextResponse
Voorbeeld
setCommentText Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Als je een aangepaste HTTP-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$broadcast_id = 'broadcast_id_example'; // string
16$comment_text_update_request = new \FastComments\Client\Model\CommentTextUpdateRequest(); // \FastComments\Client\Model\CommentTextUpdateRequest
17$options = [
18 'edit_key' => 'edit_key_example', // string
19 'sso' => 'sso_example', // string
20];
21
22
23try {
24 $result = $apiInstance->setCommentText($tenant_id, $comment_id, $broadcast_id, $comment_text_update_request, $options);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling PublicApi->setCommentText: ', $e->getMessage(), PHP_EOL;
28}
29
Gebruiker ontblokkeren vanaf opmerking
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Respons
Retourneert: UnblockSuccess
Voorbeeld
unBlockUserFromComment Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutautorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Ontcommentaar onderstaande regel om een prefix (bijv. Bearer) voor API-sleutel in te stellen, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt als standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$un_block_from_comment_params = new \FastComments\Client\Model\UnBlockFromCommentParams(); // \FastComments\Client\Model\UnBlockFromCommentParams
22$options = [
23 'user_id' => 'user_id_example', // string
24 'anon_user_id' => 'anon_user_id_example', // string
25];
26
27
28try {
29 $result = $apiInstance->unBlockUserFromComment($tenant_id, $id, $un_block_from_comment_params, $options);
30 print_r($result);
31} catch (Exception $e) {
32 echo 'Exception when calling DefaultApi->unBlockUserFromComment: ', $e->getMessage(), PHP_EOL;
33}
34
Opmerking markering verwijderen
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nee | |
| anonUserId | string | query | Nee |
Respons
Retourneert: FlagCommentResponse
Voorbeeld
unFlagComment Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutautorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment hieronder om een prefix in te stellen (bijv. Bearer) voor de API-sleutel, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$options = [
22 'user_id' => 'user_id_example', // string
23 'anon_user_id' => 'anon_user_id_example', // string
24];
25
26
27try {
28 $result = $apiInstance->unFlagComment($tenant_id, $id, $options);
29 print_r($result);
30} catch (Exception $e) {
31 echo 'Exception when calling DefaultApi->unFlagComment: ', $e->getMessage(), PHP_EOL;
32}
33
Opmerking ontgrendelen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Ja | |
| sso | string | query | Nee |
Respons
Retourneert: APIEmptyResponse
Voorbeeld
unLockComment Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$broadcast_id = 'broadcast_id_example'; // string
16$sso = 'sso_example'; // string
17
18
19try {
20 $result = $apiInstance->unLockComment($tenant_id, $comment_id, $broadcast_id, $sso);
21 print_r($result);
22} catch (Exception $e) {
23 echo 'Exception when calling PublicApi->unLockComment: ', $e->getMessage(), PHP_EOL;
24}
25
Opmerking losmaken
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Ja | |
| sso | string | query | Nee |
Reactie
Retourneert: ChangeCommentPinStatusResponse
Voorbeeld
unPinComment Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt gebruikt als standaard.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$broadcast_id = 'broadcast_id_example'; // string
16$sso = 'sso_example'; // string
17
18
19try {
20 $result = $apiInstance->unPinComment($tenant_id, $comment_id, $broadcast_id, $sso);
21 print_r($result);
22} catch (Exception $e) {
23 echo 'Exception when calling PublicApi->unPinComment: ', $e->getMessage(), PHP_EOL;
24}
25
Opmerking bijwerken
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| contextUserId | string | query | Nee | |
| doSpamCheck | boolean | query | Nee | |
| isLive | boolean | query | Nee |
Respons
Retourneert: APIEmptyResponse
Voorbeeld
updateComment Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutel autorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Ontcommentarieer hieronder om een prefix (bijv. Bearer) voor de API-sleutel in te stellen, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste HTTP-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt als standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$updatable_comment_params = new \FastComments\Client\Model\UpdatableCommentParams(); // \FastComments\Client\Model\UpdatableCommentParams
22$options = [
23 'context_user_id' => 'context_user_id_example', // string
24 'do_spam_check' => True, // bool
25 'is_live' => True, // bool
26];
27
28
29try {
30 $result = $apiInstance->updateComment($tenant_id, $id, $updatable_comment_params, $options);
31 print_r($result);
32} catch (Exception $e) {
33 echo 'Exception when calling DefaultApi->updateComment: ', $e->getMessage(), PHP_EOL;
34}
35
Opmerking stemmen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| urlId | string | query | Ja | |
| broadcastId | string | query | Ja | |
| sessionId | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: VoteResponse
Voorbeeld
voteComment Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Als je een aangepaste HTTP-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt als standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$url_id = 'url_id_example'; // string
16$broadcast_id = 'broadcast_id_example'; // string
17$vote_body_params = new \FastComments\Client\Model\VoteBodyParams(); // \FastComments\Client\Model\VoteBodyParams
18$options = [
19 'session_id' => 'session_id_example', // string
20 'sso' => 'sso_example', // string
21];
22
23
24try {
25 $result = $apiInstance->voteComment($tenant_id, $comment_id, $url_id, $broadcast_id, $vote_body_params, $options);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling PublicApi->voteComment: ', $e->getMessage(), PHP_EOL;
29}
30
Opmerkingen voor gebruiker ophalen
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| userId | string | query | Nee | |
| direction | string | query | Nee | |
| repliesToUserId | string | query | Nee | |
| page | number | query | Nee | |
| includei10n | boolean | query | Nee | |
| locale | string | query | Nee | |
| isCrawler | boolean | query | Nee |
Response
Retourneert: GetCommentsForUserResponse
Voorbeeld
Voorbeeld getCommentsForUser
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$options = [
14 'user_id' => 'user_id_example', // string
15 'direction' => new \FastComments\Client\Model\\FastComments\Client\Model\SortDirections(), // \FastComments\Client\Model\SortDirections
16 'replies_to_user_id' => 'replies_to_user_id_example', // string
17 'page' => 3.4, // float
18 'includei10n' => True, // bool
19 'locale' => 'locale_example', // string
20 'is_crawler' => True, // bool
21];
22
23
24try {
25 $result = $apiInstance->getCommentsForUser($options);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling PublicApi->getCommentsForUser: ', $e->getMessage(), PHP_EOL;
29}
30
Domeinconfiguratie toevoegen
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Respons
Returns: AddDomainConfigResponse
Voorbeeld
addDomainConfig Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5// Configureer API-sleutelautorisatie: api_key
6$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
7// Verwijder de commentaartekens hieronder om een prefix (bijv. Bearer) voor de API-sleutel in te stellen, indien nodig
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Als je een aangepaste HTTP-client wilt gebruiken, geef dan je client door die `GuzzleHttp\ClientInterface` implementeert.
13 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // string
19$add_domain_config_params = new \FastComments\Client\Model\AddDomainConfigParams(); // \FastComments\Client\Model\AddDomainConfigParams
20
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
Domeinconfiguratie verwijderen
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| domain | string | path | Ja |
Response
Retourneert: DeleteDomainConfigResponse
Example
deleteDomainConfig Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5// Configureer API-sleutautorisatie: api_key
6// Haal de commentaar hieronder weg om een prefix in te stellen (bijv. Bearer) voor de API-sleutel, indien nodig
7// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
8
9
10$apiInstance = new FastComments\Client\Api\DefaultApi(
11 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
12 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
13 new GuzzleHttp\Client(),
14 $config
15);
16
17$tenant_id = 'tenant_id_example'; // string
18$domain = 'domain_example'; // string
19
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
Domeinconfiguratie ophalen
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| domain | string | path | Yes |
Respons
Retourneert: GetDomainConfigResponse
Voorbeeld
getDomainConfig Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutel autorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Verwijder commentaar hieronder om prefix (bijv. Bearer) voor API-sleutel in te stellen, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$domain = 'domain_example'; // string
21
22
23try {
24 $result = $apiInstance->getDomainConfig($tenant_id, $domain);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getDomainConfig: ', $e->getMessage(), PHP_EOL;
28}
29
Domeinconfiguraties ophalen
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Respons
Retourneert: GetDomainConfigsResponse
Voorbeeld
Voorbeeld getDomainConfigs
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutelautorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Verwijder de commentaartekens hieronder om een prefix (bijv. Bearer) voor de API-sleutel in te stellen, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepast http-client wilt gebruiken, geef dan je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt als standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20
21
22try {
23 $result = $apiInstance->getDomainConfigs($tenant_id);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->getDomainConfigs: ', $e->getMessage(), PHP_EOL;
27}
28
Domeinconfiguratie gedeeltelijk bijwerken
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| domainToUpdate | string | path | Ja |
Respons
Retourneert: PatchDomainConfigResponse
Voorbeeld
patchDomainConfig Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureren van API-sleutel autorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Verwijder commentaar hieronder om een prefix (bijv. Bearer) voor de API-sleutel in te stellen, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste HTTP-client wilt gebruiken, geef dan je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$domain_to_update = 'domain_to_update_example'; // string
21$patch_domain_config_params = new \FastComments\Client\Model\PatchDomainConfigParams(); // \FastComments\Client\Model\PatchDomainConfigParams
22
23
24try {
25 $result = $apiInstance->patchDomainConfig($tenant_id, $domain_to_update, $patch_domain_config_params);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->patchDomainConfig: ', $e->getMessage(), PHP_EOL;
29}
30
Domeinconfiguratie vervangen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| domainToUpdate | string | path | Ja |
Response
Retourneert: PutDomainConfigResponse
Example
putDomainConfig Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutelautorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Verwijder commentaar hieronder om een prefix (bijv. Bearer) voor de API-sleutel in te stellen, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste HTTP-client wilt gebruiken, geef dan je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$domain_to_update = 'domain_to_update_example'; // string
21$update_domain_config_params = new \FastComments\Client\Model\UpdateDomainConfigParams(); // \FastComments\Client\Model\UpdateDomainConfigParams
22
23
24try {
25 $result = $apiInstance->putDomainConfig($tenant_id, $domain_to_update, $update_domain_config_params);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->putDomainConfig: ', $e->getMessage(), PHP_EOL;
29}
30
E-mailsjabloon maken
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Respons
Retourneert: CreateEmailTemplateResponse
Voorbeeld
createEmailTemplate Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutel autorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment hieronder om prefix in te stellen (bijv. Bearer) voor API-sleutel, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste http-client wilt gebruiken, geef je je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` zal als standaard worden gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$create_email_template_body = new \FastComments\Client\Model\CreateEmailTemplateBody(); // \FastComments\Client\Model\CreateEmailTemplateBody
21
22
23try {
24 $result = $apiInstance->createEmailTemplate($tenant_id, $create_email_template_body);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->createEmailTemplate: ', $e->getMessage(), PHP_EOL;
28}
29
E-mailsjabloon verwijderen
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Response
Retourneert: APIEmptyResponse
Example
deleteEmailTemplate Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutautorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Verwijder de commentaartekens hieronder om een prefix (bijv. Bearer) voor de API-sleutel in te stellen, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21
22
23try {
24 $result = $apiInstance->deleteEmailTemplate($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->deleteEmailTemplate: ', $e->getMessage(), PHP_EOL;
28}
29
E-mailsjabloon renderfout verwijderen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| errorId | string | path | Ja |
Respons
Retourneert: APIEmptyResponse
Voorbeeld
deleteEmailTemplateRenderError Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API‑sleutel autorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Haal de commentaar hieronder uit om een prefix (bijv. Bearer) voor de API‑sleutel in te stellen, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste http‑client wilt gebruiken, geef dan jouw client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$error_id = 'error_id_example'; // string
22
23
24try {
25 $result = $apiInstance->deleteEmailTemplateRenderError($tenant_id, $id, $error_id);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->deleteEmailTemplateRenderError: ', $e->getMessage(), PHP_EOL;
29}
30
E-mailsjabloon ophalen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Reactie
Retourneert: GetEmailTemplateResponse
Voorbeeld
getEmailTemplate Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer autorisatie voor API-sleutel: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Verwijder commentaar hieronder om een prefix (bijv. Bearer) voor API-sleutel in te stellen, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21
22
23try {
24 $result = $apiInstance->getEmailTemplate($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getEmailTemplate: ', $e->getMessage(), PHP_EOL;
28}
29
E-mailsjabloon definities ophalen
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Response
Retourneert: GetEmailTemplateDefinitionsResponse
Example
getEmailTemplateDefinitions Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutel autorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Verwijder commentaar hieronder om een prefix (bijv. Bearer) voor de API-sleutel in te stellen, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt als standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20
21
22try {
23 $result = $apiInstance->getEmailTemplateDefinitions($tenant_id);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->getEmailTemplateDefinitions: ', $e->getMessage(), PHP_EOL;
27}
28
E-mailsjabloon renderfouten ophalen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| skip | number | query | Nee |
Response
Retourneert: GetEmailTemplateRenderErrorsResponse
Example
getEmailTemplateRenderErrors Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutel autorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment hieronder om prefix (bijv. Bearer) voor API-sleutel in te stellen, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als u een aangepaste http-client wilt gebruiken, geef uw client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt als standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$skip = 3.4; // float
22
23
24try {
25 $result = $apiInstance->getEmailTemplateRenderErrors($tenant_id, $id, $skip);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->getEmailTemplateRenderErrors: ', $e->getMessage(), PHP_EOL;
29}
30
E-mailsjablonen ophalen
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nee |
Respons
Returns: GetEmailTemplatesResponse
Voorbeeld
getEmailTemplates Voorbeeld
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 // Als je een aangepaste HTTP-client wilt gebruiken, geef dan je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$skip = 3.4; // float
21
22
23try {
24 $result = $apiInstance->getEmailTemplates($tenant_id, $skip);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getEmailTemplates: ', $e->getMessage(), PHP_EOL;
28}
29
E-mailsjabloon renderen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| locale | string | query | Nee |
Respons
Retourneert: RenderEmailTemplateResponse
Voorbeeld
renderEmailTemplate Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutelauthorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment hieronder om een prefix in te stellen (bijv. Bearer) voor API-sleutel, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste http-client wilt gebruiken, geef je je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
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
23
24try {
25 $result = $apiInstance->renderEmailTemplate($tenant_id, $render_email_template_body, $locale);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->renderEmailTemplate: ', $e->getMessage(), PHP_EOL;
29}
30
E-mailsjabloon bijwerken
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Retourneert: APIEmptyResponse
Voorbeeld
updateEmailTemplate Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5// Configureer API-sleutautorisatie: api_key
6$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
7// Verwijder de commentaartekens hieronder om een prefix (bijv. Bearer) voor de API-sleutel in te stellen, indien nodig
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Als je een aangepaste HTTP-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
13 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
14 new GuzzleHttp\Client(),
15 $config
16);
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
22
23try {
24 $result = $apiInstance->updateEmailTemplate($tenant_id, $id, $update_email_template_body);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->updateEmailTemplate: ', $e->getMessage(), PHP_EOL;
28}
29
Gebeurtenislog ophalen
req tenantId urlId userIdWS
Parameters
| Naam | Type | Locatie | Verplicht | Omschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| userIdWS | string | query | Ja | |
| startTime | integer | query | Ja | |
| endTime | integer | query | Nee |
Respons
Retourneert: GetEventLogResponse
Voorbeeld
getEventLog Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Als je een aangepaste HTTP-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$url_id = 'url_id_example'; // string
15$user_id_ws = 'user_id_ws_example'; // string
16$start_time = 56; // int
17$end_time = 56; // int
18
19
20try {
21 $result = $apiInstance->getEventLog($tenant_id, $url_id, $user_id_ws, $start_time, $end_time);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling PublicApi->getEventLog: ', $e->getMessage(), PHP_EOL;
25}
26
Globaal gebeurtenislog ophalen
req tenantId urlId userIdWS
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| userIdWS | string | query | Ja | |
| startTime | integer | query | Ja | |
| endTime | integer | query | Nee |
Response
Retourneert: GetEventLogResponse
Voorbeeld
getGlobalEventLog Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$url_id = 'url_id_example'; // string
15$user_id_ws = 'user_id_ws_example'; // string
16$start_time = 56; // int
17$end_time = 56; // int
18
19
20try {
21 $result = $apiInstance->getGlobalEventLog($tenant_id, $url_id, $user_id_ws, $start_time, $end_time);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling PublicApi->getGlobalEventLog: ', $e->getMessage(), PHP_EOL;
25}
26
Feedbericht maken
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| broadcastId | string | query | Nee | |
| isLive | boolean | query | Nee | |
| doSpamCheck | boolean | query | Nee | |
| skipDupCheck | boolean | query | Nee |
Respons
Retourneert: CreateFeedPostResponse
Voorbeeld
createFeedPost Voorbeeld
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
19$tenant_id = 'tenant_id_example'; // string
20$create_feed_post_params = new \FastComments\Client\Model\CreateFeedPostParams(); // \FastComments\Client\Model\CreateFeedPostParams
21$options = [
22 'broadcast_id' => 'broadcast_id_example', // string
23 'is_live' => True, // bool
24 'do_spam_check' => True, // bool
25 'skip_dup_check' => True, // bool
26];
27
28
29try {
30 $result = $apiInstance->createFeedPost($tenant_id, $create_feed_post_params, $options);
31 print_r($result);
32} catch (Exception $e) {
33 echo 'Exception when calling DefaultApi->createFeedPost: ', $e->getMessage(), PHP_EOL;
34}
35
Feedbericht maken (Openbaar)
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Response
Retourneert: CreateFeedPostResponse
Voorbeeld
createFeedPostPublic Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$create_feed_post_params = new \FastComments\Client\Model\CreateFeedPostParams(); // \FastComments\Client\Model\CreateFeedPostParams
15$options = [
16 'broadcast_id' => 'broadcast_id_example', // string
17 'sso' => 'sso_example', // string
18];
19
20
21try {
22 $result = $apiInstance->createFeedPostPublic($tenant_id, $create_feed_post_params, $options);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling PublicApi->createFeedPostPublic: ', $e->getMessage(), PHP_EOL;
26}
27
Feedbericht verwijderen (Openbaar)
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Respons
Retourneert: DeleteFeedPostPublicResponse
Voorbeeld
deleteFeedPostPublic Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$post_id = 'post_id_example'; // string
15$options = [
16 'broadcast_id' => 'broadcast_id_example', // string
17 'sso' => 'sso_example', // string
18];
19
20
21try {
22 $result = $apiInstance->deleteFeedPostPublic($tenant_id, $post_id, $options);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling PublicApi->deleteFeedPostPublic: ', $e->getMessage(), PHP_EOL;
26}
27
Feedberichten ophalen
req tenantId afterId
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| afterId | string | query | No | |
| limit | integer | query | No | |
| tags | array | query | No |
Response
Retourneert: GetFeedPostsResponse
Voorbeeld
getFeedPosts Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutel autorisatie: api_key
7// Verwijder commentaar onderstaand om prefix in te stellen (bijv. Bearer) voor API-sleutel, indien nodig
8// Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9// Dit is optioneel, `GuzzleHttp\Client` wordt gebruikt als standaard.
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
13 // This is optional, `GuzzleHttp\Client` will be used as default.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // string
19$options = [
20 'after_id' => 'after_id_example', // string
21 'limit' => 56, // int
22 'tags' => array('tags_example'), // string[]
23];
24
25
26try {
27 $result = $apiInstance->getFeedPosts($tenant_id, $options);
28 print_r($result);
29} catch (Exception $e) {
30 echo 'Exception when calling DefaultApi->getFeedPosts: ', $e->getMessage(), PHP_EOL;
31}
32
Feedberichten ophalen (Openbaar)
req tenantId afterId
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| afterId | string | query | Nee | |
| limit | integer | query | Nee | |
| tags | array | query | Nee | |
| sso | string | query | Nee | |
| isCrawler | boolean | query | Nee | |
| includeUserInfo | boolean | query | Nee |
Respons
Retourneert: PublicFeedPostsResponse
Voorbeeld
getFeedPostsPublic Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Als je een aangepaste HTTP‑client wilt gebruiken, geef dan je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$options = [
15 'after_id' => 'after_id_example', // string
16 'limit' => 56, // int
17 'tags' => array('tags_example'), // string[]
18 'sso' => 'sso_example', // string
19 'is_crawler' => True, // bool
20 'include_user_info' => True, // bool
21];
22
23
24try {
25 $result = $apiInstance->getFeedPostsPublic($tenant_id, $options);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling PublicApi->getFeedPostsPublic: ', $e->getMessage(), PHP_EOL;
29}
30
Feedberichten statistieken ophalen
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postIds | array | query | Ja | |
| sso | string | query | Nee |
Respons
Retourneert: FeedPostsStatsResponse
Voorbeeld
Voorbeeld getFeedPostsStats
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Als je een aangepaste HTTP-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$post_ids = array('post_ids_example'); // string[]
15$sso = 'sso_example'; // string
16
17
18try {
19 $result = $apiInstance->getFeedPostsStats($tenant_id, $post_ids, $sso);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling PublicApi->getFeedPostsStats: ', $e->getMessage(), PHP_EOL;
23}
24
Gebruikerreacties ophalen (Openbaar)
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postIds | array | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: UserReactsResponse
Voorbeeld
getUserReactsPublic Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$options = [
15 'post_ids' => array('post_ids_example'), // string[]
16 'sso' => 'sso_example', // string
17];
18
19
20try {
21 $result = $apiInstance->getUserReactsPublic($tenant_id, $options);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception bij het aanroepen van PublicApi->getUserReactsPublic: ', $e->getMessage(), PHP_EOL;
25}
26
Reactie op feedbericht (Openbaar)
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postId | string | path | Ja | |
| isUndo | boolean | query | Nee | |
| broadcastId | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: ReactFeedPostResponse
Voorbeeld
reactFeedPostPublic Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Als je een aangepaste HTTP-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` zal als standaard worden gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$post_id = 'post_id_example'; // string
15$react_body_params = new \FastComments\Client\Model\ReactBodyParams(); // \FastComments\Client\Model\ReactBodyParams
16$options = [
17 'is_undo' => True, // bool
18 'broadcast_id' => 'broadcast_id_example', // string
19 'sso' => 'sso_example', // string
20];
21
22
23try {
24 $result = $apiInstance->reactFeedPostPublic($tenant_id, $post_id, $react_body_params, $options);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling PublicApi->reactFeedPostPublic: ', $e->getMessage(), PHP_EOL;
28}
29
Feedbericht bijwerken
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Retourneert: APIEmptyResponse
Voorbeeld
Voorbeeld updateFeedPost
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutelautorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Verwijder de commentaar op de onderstaande regel om een prefix (bijv. Bearer) voor de API-sleutel in te stellen, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$feed_post = new \FastComments\Client\Model\FeedPost(); // \FastComments\Client\Model\FeedPost
22
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
Feedbericht bijwerken (Openbaar)
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Respons
Retourneert: CreateFeedPostResponse
Voorbeeld
updateFeedPostPublic Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
9 // This is optional, `GuzzleHttp\Client` will be used as default.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$post_id = 'post_id_example'; // string
15$update_feed_post_params = new \FastComments\Client\Model\UpdateFeedPostParams(); // \FastComments\Client\Model\UpdateFeedPostParams
16$options = [
17 'broadcast_id' => 'broadcast_id_example', // string
18 'sso' => 'sso_example', // string
19];
20
21
22try {
23 $result = $apiInstance->updateFeedPostPublic($tenant_id, $post_id, $update_feed_post_params, $options);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling PublicApi->updateFeedPostPublic: ', $e->getMessage(), PHP_EOL;
27}
28
Opmerking markeren (Openbaar)
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| isFlagged | boolean | query | Yes | |
| sso | string | query | No |
Response
Retourneert: APIEmptyResponse
Voorbeeld
flagCommentPublic Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$is_flagged = True; // bool
16$sso = 'sso_example'; // string
17
18
19try {
20 $result = $apiInstance->flagCommentPublic($tenant_id, $comment_id, $is_flagged, $sso);
21 print_r($result);
22} catch (Exception $e) {
23 echo 'Exception when calling PublicApi->flagCommentPublic: ', $e->getMessage(), PHP_EOL;
24}
25
Grote GIF ophalen
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| largeInternalURLSanitized | string | query | Yes |
Respons
Retourneert: GifGetLargeResponse
Voorbeeld
Voorbeeld getGifLarge
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Als je een aangepaste HTTP-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$large_internal_url_sanitized = 'large_internal_url_sanitized_example'; // string
15
16
17try {
18 $result = $apiInstance->getGifLarge($tenant_id, $large_internal_url_sanitized);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->getGifLarge: ', $e->getMessage(), PHP_EOL;
22}
23
GIFs zoeken
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| search | string | query | Yes | |
| locale | string | query | No | |
| rating | string | query | No | |
| page | number | query | No |
Respons
Retourneert: GetGifsSearchResponse
Voorbeeld
Voorbeeld getGifsSearch
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Als je een aangepaste HTTP-client wilt gebruiken, geef dan jouw client op die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$search = 'search_example'; // string
15$options = [
16 'locale' => 'locale_example', // string
17 'rating' => 'rating_example', // string
18 'page' => 3.4, // float
19];
20
21
22try {
23 $result = $apiInstance->getGifsSearch($tenant_id, $search, $options);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling PublicApi->getGifsSearch: ', $e->getMessage(), PHP_EOL;
27}
28
Trending GIFs ophalen
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| locale | string | query | No | |
| rating | string | query | No | |
| page | number | query | No |
Respons
Retourneert: GetGifsTrendingResponse
Voorbeeld
getGifsTrending Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$options = [
15 'locale' => 'locale_example', // string
16 'rating' => 'rating_example', // string
17 'page' => 3.4, // float
18];
19
20
21try {
22 $result = $apiInstance->getGifsTrending($tenant_id, $options);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling PublicApi->getGifsTrending: ', $e->getMessage(), PHP_EOL;
26}
27
Hashtag toevoegen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Respons
Retourneert: CreateHashTagResponse
Voorbeeld
addHashTag Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutel authorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Verwijder commentaar hieronder om prefix in te stellen (bijv. Bearer) voor API-sleutel, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste HTTP-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$create_hash_tag_body = new \FastComments\Client\Model\CreateHashTagBody(); // \FastComments\Client\Model\CreateHashTagBody
21
22
23try {
24 $result = $apiInstance->addHashTag($tenant_id, $create_hash_tag_body);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->addHashTag: ', $e->getMessage(), PHP_EOL;
28}
29
Hashtags bulk toevoegen
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Respons
Retourneert: BulkCreateHashTagsResponse
Voorbeeld
addHashTagsBulk Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutel autorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Verwijder commentaar hieronder om een prefix in te stellen (bijv. Bearer) voor API-sleutel, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt als standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$bulk_create_hash_tags_body = new \FastComments\Client\Model\BulkCreateHashTagsBody(); // \FastComments\Client\Model\BulkCreateHashTagsBody
21
22
23try {
24 $result = $apiInstance->addHashTagsBulk($tenant_id, $bulk_create_hash_tags_body);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->addHashTagsBulk: ', $e->getMessage(), PHP_EOL;
28}
29
Hashtag verwijderen
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| tag | string | path | Ja |
Respons
Retourneert: APIEmptyResponse
Voorbeeld
deleteHashTag Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorisatie: 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 // Als je een aangepaste http-client wilt gebruiken, geef je jouw client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$tag = 'tag_example'; // string
21$delete_hash_tag_request_body = new \FastComments\Client\Model\DeleteHashTagRequestBody(); // \FastComments\Client\Model\DeleteHashTagRequestBody
22
23
24try {
25 $result = $apiInstance->deleteHashTag($tenant_id, $tag, $delete_hash_tag_request_body);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->deleteHashTag: ', $e->getMessage(), PHP_EOL;
29}
30
Hashtags ophalen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| page | number | query | Nee |
Respons
Retourneert: GetHashTagsResponse
Voorbeeld
getHashTags Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutautorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment hieronder om een prefix in te stellen (bijv. Bearer) voor de API-sleutel, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste HTTP-client wilt gebruiken, geef dan je client mee die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$page = 3.4; // float
21
22
23try {
24 $result = $apiInstance->getHashTags($tenant_id, $page);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getHashTags: ', $e->getMessage(), PHP_EOL;
28}
29
Hashtag gedeeltelijk bijwerken
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| tag | string | path | Yes |
Respons
Returns: UpdateHashTagResponse
Voorbeeld
patchHashTag Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutel autorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment hieronder om prefix (bijv. Bearer) voor API-sleutel in te stellen, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$tag = 'tag_example'; // string
21$update_hash_tag_body = new \FastComments\Client\Model\UpdateHashTagBody(); // \FastComments\Client\Model\UpdateHashTagBody
22
23
24try {
25 $result = $apiInstance->patchHashTag($tenant_id, $tag, $update_hash_tag_body);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->patchHashTag: ', $e->getMessage(), PHP_EOL;
29}
30
Moderatiestem verwijderen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| voteId | string | path | Ja | |
| broadcastId | string | query | Nee | |
| sso | string | query | Nee |
Response
Retourneert: VoteDeleteResponse
Voorbeeld
deleteModerationVote Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Als je een aangepaste HTTP-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt als standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$vote_id = 'vote_id_example'; // string
16$options = [
17 'broadcast_id' => 'broadcast_id_example', // string
18 'sso' => 'sso_example', // string
19];
20
21
22try {
23 $result = $apiInstance->deleteModerationVote($tenant_id, $comment_id, $vote_id, $options);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling ModerationApi->deleteModerationVote: ', $e->getMessage(), PHP_EOL;
27}
28
API-opmerkingen ophalen
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| page | number | query | Nee | |
| count | number | query | Nee | |
| text-search | string | query | Nee | |
| byIPFromComment | string | query | Nee | |
| filters | string | query | Nee | |
| searchFilters | string | query | Nee | |
| sorts | string | query | Nee | |
| demo | boolean | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: ModerationAPIGetCommentsResponse
Voorbeeld
getApiComments Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt als standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$options = [
15 'page' => 3.4, // float
16 'count' => 3.4, // float
17 'text_search' => 'text_search_example', // string
18 'by_ip_from_comment' => 'by_ip_from_comment_example', // string
19 'filters' => 'filters_example', // string
20 'search_filters' => 'search_filters_example', // string
21 'sorts' => 'sorts_example', // string
22 'demo' => True, // bool
23 'sso' => 'sso_example', // string
24];
25
26
27try {
28 $result = $apiInstance->getApiComments($tenant_id, $options);
29 print_r($result);
30} catch (Exception $e) {
31 echo 'Exception when calling ModerationApi->getApiComments: ', $e->getMessage(), PHP_EOL;
32}
33
API-exportstatus ophalen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| batchJobId | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: ModerationExportStatusResponse
Voorbeeld
Voorbeeld getApiExportStatus
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Als je een aangepaste HTTP-client wilt gebruiken, geef je je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$options = [
15 'batch_job_id' => 'batch_job_id_example', // string
16 'sso' => 'sso_example', // string
17];
18
19
20try {
21 $result = $apiInstance->getApiExportStatus($tenant_id, $options);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling ModerationApi->getApiExportStatus: ', $e->getMessage(), PHP_EOL;
25}
26
API-ids ophalen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| text-search | string | query | Nee | |
| byIPFromComment | string | query | Nee | |
| filters | string | query | Nee | |
| searchFilters | string | query | Nee | |
| afterId | string | query | Nee | |
| demo | boolean | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: ModerationAPIGetCommentIdsResponse
Voorbeeld
getApiIds Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$options = [
15 'text_search' => 'text_search_example', // string
16 'by_ip_from_comment' => 'by_ip_from_comment_example', // string
17 'filters' => 'filters_example', // string
18 'search_filters' => 'search_filters_example', // string
19 'after_id' => 'after_id_example', // string
20 'demo' => True, // bool
21 'sso' => 'sso_example', // string
22];
23
24
25try {
26 $result = $apiInstance->getApiIds($tenant_id, $options);
27 print_r($result);
28} catch (Exception $e) {
29 echo 'Exception when calling ModerationApi->getApiIds: ', $e->getMessage(), PHP_EOL;
30}
31
Geblokkeerde gebruikers van opmerking ophalen
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nee |
Respons
Retourneert: GetBannedUsersFromCommentResponse
Voorbeeld
getBanUsersFromComment Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Als u een aangepaste HTTP-client wilt gebruiken, geef uw client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$sso = 'sso_example'; // string
16
17
18try {
19 $result = $apiInstance->getBanUsersFromComment($tenant_id, $comment_id, $sso);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling ModerationApi->getBanUsersFromComment: ', $e->getMessage(), PHP_EOL;
23}
24
Banstatus van opmerking ophalen
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nee |
Respons
Retourneert: GetCommentBanStatusResponse
Voorbeeld
Voorbeeld getCommentBanStatus
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$sso = 'sso_example'; // string
16
17
18try {
19 $result = $apiInstance->getCommentBanStatus($tenant_id, $comment_id, $sss);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exceptie bij het aanroepen van ModerationApi->getCommentBanStatus: ', $e->getMessage(), PHP_EOL;
23}
24
Kindopmerkingen ophalen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nee |
Response
Retourneert: ModerationAPIChildCommentsResponse
Voorbeeld
getCommentChildren Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$sso = 'sso_example'; // string
16
17
18try {
19 $result = $apiInstance->getCommentChildren($tenant_id, $comment_id, $sso);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling ModerationApi->getCommentChildren: ', $e->getMessage(), PHP_EOL;
23}
24
Telling ophalen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| text-search | string | query | Nee | |
| byIPFromComment | string | query | Nee | |
| filter | string | query | Nee | |
| searchFilters | string | query | Nee | |
| demo | boolean | query | Nee | |
| sso | string | query | Nee |
Response
Retourneert: ModerationAPICountCommentsResponse
Voorbeeld
getCount Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Als u een aangepaste HTTP-client wilt gebruiken, geeft u uw client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$options = [
15 'text_search' => 'text_search_example', // string
16 'by_ip_from_comment' => 'by_ip_from_comment_example', // string
17 'filter' => 'filter_example', // string
18 'search_filters' => 'search_filters_example', // string
19 'demo' => True, // bool
20 'sso' => 'sso_example', // string
21];
22
23
24try {
25 $result = $apiInstance->getCount($tenant_id, $options);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling ModerationApi->getCount: ', $e->getMessage(), PHP_EOL;
29}
30
Tellings ophalen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nee |
Reactie
Retourneert: GetBannedUsersCountResponse
Voorbeeld
getCounts Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$sso = 'sso_example'; // string
15
16
17try {
18 $result = $apiInstance->getCounts($tenant_id, $sso);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling ModerationApi->getCounts: ', $e->getMessage(), PHP_EOL;
22}
23
Logs ophalen
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nee |
Response
Retourneert: ModerationAPIGetLogsResponse
Example
Voorbeeld getLogs
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Als je een aangepaste http client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` zal als standaard worden gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$sso = 'sso_example'; // string
16
17
18try {
19 $result = $apiInstance->getLogs($tenant_id, $comment_id, $sso);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling ModerationApi->getLogs: ', $e->getMessage(), PHP_EOL;
23}
24
Handmatige badges ophalen
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nee |
Respons
Retourneert: GetTenantManualBadgesResponse
Voorbeeld
getManualBadges Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Als je een aangepaste HTTP-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$sso = 'sso_example'; // string
15
16
17try {
18 $result = $apiInstance->getManualBadges($tenant_id, $sso);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling ModerationApi->getManualBadges: ', $e->getMessage(), PHP_EOL;
22}
23
Handmatige badges voor gebruiker ophalen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| badgesUserId | string | query | Nee | |
| commentId | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: GetUserManualBadgesResponse
Voorbeeld
getManualBadgesForUser Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$options = [
15 'badges_user_id' => 'badges_user_id_example', // string
16 'comment_id' => 'comment_id_example', // string
17 'sso' => 'sso_example', // string
18];
19
20
21try {
22 $result = $apiInstance->getManualBadgesForUser($tenant_id, $options);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling ModerationApi->getManualBadgesForUser: ', $e->getMessage(), PHP_EOL;
26}
27
Moderatieopmerking ophalen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| includeEmail | boolean | query | Nee | |
| includeIP | boolean | query | Nee | |
| sso | string | query | Nee |
Response
Retourneert: ModerationAPICommentResponse
Voorbeeld
getModerationComment Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$options = [
16 'include_email' => True, // bool
17 'include_ip' => True, // bool
18 'sso' => 'sso_example', // string
19];
20
21
22try {
23 $result = $apiInstance->getModerationComment($tenant_id, $comment_id, $options);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling ModerationApi->getModerationComment: ', $e->getMessage(), PHP_EOL;
27}
28
Moderatieopmerkingstekst ophalen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Response
Retourneert: GetCommentTextResponse
Example
getModerationCommentText Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$sso = 'sso_example'; // string
16
17
18try {
19 $result = $apiInstance->getModerationCommentText($tenant_id, $comment_id, $sso);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling ModerationApi->getModerationCommentText: ', $e->getMessage(), PHP_EOL;
23}
24
Voorban-samenvatting ophalen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| includeByUserIdAndEmail | boolean | query | No | |
| includeByIP | boolean | query | No | |
| includeByEmailDomain | boolean | query | No | |
| sso | string | query | No |
Respons
Retourneert: PreBanSummary
Voorbeeld
getPreBanSummary Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Als je een aangepaste HTTP-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt als standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$options = [
16 'include_by_user_id_and_email' => True, // bool
17 'include_by_ip' => True, // bool
18 'include_by_email_domain' => True, // bool
19 'sso' => 'sso_example', // string
20];
21
22
23try {
24 $result = $apiInstance->getPreBanSummary($tenant_id, $comment_id, $options);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling ModerationApi->getPreBanSummary: ', $e->getMessage(), PHP_EOL;
28}
29
Samenvatting zoekopmerkingen ophalen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| value | string | query | Nee | |
| filters | string | query | Nee | |
| searchFilters | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: ModerationCommentSearchResponse
Voorbeeld
Voorbeeld getSearchCommentsSummary
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` zal standaard worden gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$options = [
15 'value' => 'value_example', // string
16 'filters' => 'filters_example', // string
17 'search_filters' => 'search_filters_example', // string
18 'sso' => 'sso_example', // string
19];
20
21
22try {
23 $result = $apiInstance->getSearchCommentsSummary($tenant_id, $options);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling ModerationApi->getSearchCommentsSummary: ', $e->getMessage(), PHP_EOL;
27}
28
Zoekpagina's ophalen
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| value | string | query | Nee | |
| sso | string | query | nee |
Response
Returns: ModerationPageSearchResponse
Example
getSearchPages Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Als je een aangepaste HTTP-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$options = [
15 'value' => 'value_example', // string
16 'sso' => 'sso_example', // string
17];
18
19
20try {
21 $result = $apiInstance->getSearchPages($tenant_id, $options);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling ModerationApi->getSearchPages: ', $e->getMessage(), PHP_EOL;
25}
26
Zoeksites ophalen
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| sso | string | query | No |
Respons
Returns: ModerationSiteSearchResponse
Voorbeeld
getSearchSites Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` zal standaard worden gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$options = [
15 'value' => 'value_example', // string
16 'sso' => 'sso_example', // string
17];
18
19
20try {
21 $result = $apiInstance->getSearchSites($tenant_id, $options);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling ModerationApi->getSearchSites: ', $e->getMessage(), PHP_EOL;
25}
26
Zoeksuggesties ophalen
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| text-search | string | query | Nee | |
| sso | string | query | Nee |
Reactie
Retourneert: ModerationSuggestResponse
Voorbeeld
getSearchSuggest voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$options = [
15 'text_search' => 'text_search_example', // string
16 'sso' => 'sso_example', // string
17];
18
19
20try {
21 $result = $apiInstance->getSearchSuggest($tenant_id, $options);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling ModerationApi->getSearchSuggest: ', $e->getMessage(), PHP_EOL;
25}
26
Zoekgebruikers ophalen
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| value | string | query | Nee | |
| sso | string | query | Nee |
Respons
Returns: ModerationUserSearchResponse
Voorbeeld
getSearchUsers Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Als je een aangepaste http-client wilt gebruiken, geef je je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$options = [
15 'value' => 'value_example', // string
16 'sso' => 'sso_example', // string
17];
18
19
20try {
21 $result = $apiInstance->getSearchUsers($tenant_id, $options);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception bij het aanroepen van ModerationApi->getSearchUsers: ', $e->getMessage(), PHP_EOL;
25}
26
Vertrouwensfactor ophalen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| sso | string | query | No |
Reactie
Retourneert: GetUserTrustFactorResponse
Voorbeeld
Voorbeeld getTrustFactor
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Als je een aangepaste http-client wilt gebruiken, geef dan je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$options = [
15 'user_id' => 'user_id_example', // string
16 'sso' => 'sso_example', // string
17];
18
19
20try {
21 $result = $apiInstance->getTrustFactor($tenant_id, $options);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling ModerationApi->getTrustFactor: ', $e->getMessage(), PHP_EOL;
25}
26
Gebruikersbanvoorkeur ophalen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nee |
Respons
Retourneert: APIModerateGetUserBanPreferencesResponse
Voorbeeld
getUserBanPreference Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7// $apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Als u een aangepaste http-client wilt gebruiken, geef uw client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$sso = 'sso_example'; // string
15
16
17try {
18 $result = $apiInstance->getUserBanPreference($tenant_id, $sso);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling ModerationApi->getUserBanPreference: ', $e->getMessage(), PHP_EOL;
22}
23
Interne gebruikersprofiel ophalen
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: GetUserInternalProfileResponse
Voorbeeld
getUserInternalProfile Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Als je een aangepaste http-client wilt gebruiken, geef je jouw client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$options = [
15 'comment_id' => 'comment_id_example', // string
16 'sso' => 'sso_example', // string
17];
18
19
20try {
21 $result = $apiInstance->getUserInternalProfile($tenant_id, $options);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling ModerationApi->getUserInternalProfile: ', $e->getMessage(), PHP_EOL;
25}
26
Aangepaste opmerkingstemmen instellen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Nee | |
| sso | string | query | Nee |
Respons
Returns: AdjustVotesResponse
Voorbeeld
postAdjustCommentVotes Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Als je een aangepaste HTTP-client wilt gebruiken, geef je je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$adjust_comment_votes_params = new \FastComments\Client\Model\AdjustCommentVotesParams(); // \FastComments\Client\Model\AdjustCommentVotesParams
16$options = [
17 'broadcast_id' => 'broadcast_id_example', // string
18 'sso' => 'sso_example', // string
19];
20
21
22try {
23 $result = $apiInstance->postAdjustCommentVotes($tenant_id, $comment_id, $adjust_comment_votes_params, $options);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling ModerationApi->postAdjustCommentVotes: ', $e->getMessage(), PHP_EOL;
27}
28
API-export starten
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| text-search | string | query | Nee | |
| byIPFromComment | string | query | Nee | |
| filters | string | query | Nee | |
| searchFilters | string | query | Nee | |
| sorts | string | query | Nee | |
| sso | string | query | Nee |
Response
Retourneert: ModerationExportResponse
Voorbeeld
postApiExport Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Als je een aangepaste http-client wilt gebruiken, geef dan je client mee die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$options = [
15 'text_search' => 'text_search_example', // string
16 'by_ip_from_comment' => 'by_ip_from_comment_example', // string
17 'filters' => 'filters_example', // string
18 'search_filters' => 'search_filters_example', // string
19 'sorts' => 'sorts_example', // string
20 'sso' => 'sso_example', // string
21];
22
23
24try {
25 $result = $apiInstance->postApiExport($tenant_id, $options);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling ModerationApi->postApiExport: ', $e->getMessage(), PHP_EOL;
29}
30
Gebruiker verbannen vanaf opmerking
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| banEmail | boolean | query | Nee | |
| banEmailDomain | boolean | query | Nee | |
| banIP | boolean | query | Nee | |
| deleteAllUsersComments | boolean | query | Nee | |
| bannedUntil | string | query | Nee | |
| isShadowBan | boolean | query | Nee | |
| updateId | string | query | Nee | |
| banReason | string | query | Nee | |
| sso | string | query | Nee |
Reactie
Retourneert: BanUserFromCommentResult
Voorbeeld
postBanUserFromComment Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Als je een aangepaste http-client wilt gebruiken, geef dan je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$options = [
16 'ban_email' => True, // bool
17 'ban_email_domain' => True, // bool
18 'ban_ip' => True, // bool
19 'delete_all_users_comments' => True, // bool
20 'banned_until' => 'banned_until_example', // string
21 'is_shadow_ban' => True, // bool
22 'update_id' => 'update_id_example', // string
23 'ban_reason' => 'ban_reason_example', // string
24 'sso' => 'sso_example', // string
25];
26
27
28try {
29 $result = $apiInstance->postBanUserFromComment($tenant_id, $comment_id, $options);
30 print_r($result);
31} catch (Exception $e) {
32 echo 'Exception when calling ModerationApi->postBanUserFromComment: ', $e->getMessage(), PHP_EOL;
33}
34
Gebruiker ban ongedaan maken
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nee |
Response
Retourneert: APIEmptyResponse
Example
postBanUserUndo Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Als je een aangepaste http-client wilt gebruiken, geef je je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$ban_user_undo_params = new \FastComments\Client\Model\BanUserUndoParams(); // \FastComments\Client\Model\BanUserUndoParams
15$sso = 'sso_example'; // string
16
17
18try {
19 $result = $apiInstance->postBanUserUndo($tenant_id, $ban_user_undo_params, $sso);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling ModerationApi->postBanUserUndo: ', $e->getMessage(), PHP_EOL;
23}
24
Bulk voorban-samenvatting plaatsen
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| includeByUserIdAndEmail | boolean | query | No | |
| includeByIP | boolean | query | No | |
| includeByEmailDomain | boolean | query | No | |
| sso | string | query | No |
Response
Retourneert: BulkPreBanSummary
Example
postBulkPreBanSummary Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt als standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$bulk_pre_ban_params = new \FastComments\Client\Model\BulkPreBanParams(); // \FastComments\Client\Model\BulkPreBanParams
15$options = [
16 'include_by_user_id_and_email' => True, // bool
17 'include_by_ip' => True, // bool
18 'include_by_email_domain' => True, // bool
19 'sso' => 'sso_example', // string
20];
21
22
23try {
24 $result = $apiInstance->postBulkPreBanSummary($tenant_id, $bulk_pre_ban_params, $options);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling ModerationApi->postBulkPreBanSummary: ', $e->getMessage(), PHP_EOL;
28}
29
Opmerkingen opvragen per id's
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nee |
Respons
Retourneert: ModerationAPIChildCommentsResponse
Voorbeeld
postCommentsByIds Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Als je een aangepaste HTTP-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comments_by_ids_params = new \FastComments\Client\Model\CommentsByIdsParams(); // \FastComments\Client\Model\CommentsByIdsParams
15$sso = 'sso_example'; // string
16
17
18try {
19 $result = $apiInstance->postCommentsByIds($tenant_id, $comments_by_ids_params, $sso);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling ModerationApi->postCommentsByIds: ', $e->getMessage(), PHP_EOL;
23}
24
Opmerking markeren (Moderatie)
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: APIEmptyResponse
Voorbeeld
postFlagComment Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Als u een aangepaste http-client wilt gebruiken, geef uw client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt als standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$options = [
16 'broadcast_id' => 'broadcast_id_example', // string
17 'sso' => 'sso_example', // string
18];
19
20
21try {
22 $result = $apiInstance->postFlagComment($tenant_id, $comment_id, $options);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling ModerationApi->postFlagComment: ', $e->getMessage(), PHP_EOL;
26}
27
Opmerking verwijderen (Moderatie)
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: PostRemoveCommentApiResponse
Voorbeeld
postRemoveComment Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt als standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$options = [
16 'broadcast_id' => 'broadcast_id_example', // string
17 'sso' => 'sso_example', // string
18];
19
20
21try {
22 $result = $apiInstance->postRemoveComment($tenant_id, $comment_id, $options);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling ModerationApi->postRemoveComment: ', $e->getMessage(), PHP_EOL;
26}
27
Verwijderde opmerking herstellen
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: APIEmptyResponse
Voorbeeld
postRestoreDeletedComment Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Als je een aangepaste HTTP-client wilt gebruiken, geef dan je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` zal als standaard worden gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$options = [
16 'broadcast_id' => 'broadcast_id_example', // string
17 'sso' => 'sso_example', // string
18];
19
20
21try {
22 $result = $apiInstance->postRestoreDeletedComment($tenant_id, $comment_id, $options);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling ModerationApi->postRestoreDeletedComment: ', $e->getMessage(), PHP_EOL;
26}
27
Commentaargoedkeuringsstatus instellen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| approved | boolean | query | Nee | |
| broadcastId | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: SetCommentApprovedResponse
Voorbeeld
postSetCommentApprovalStatus voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$options = [
16 'approved' => True, // bool
17 'broadcast_id' => 'broadcast_id_example', // string
18 'sso' => 'sso_example', // string
19];
20
21
22try {
23 $result = $apiInstance->postSetCommentApprovalStatus($tenant_id, $comment_id, $options);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling ModerationApi->postSetCommentApprovalStatus: ', $e->getMessage(), PHP_EOL;
27}
28
Commentaarbeoordelingsstatus instellen
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| reviewed | boolean | query | Nee | |
| broadcastId | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: APIEmptyResponse
Voorbeeld
postSetCommentReviewStatus Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Als je een aangepaste HTTP-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$options = [
16 'reviewed' => True, // bool
17 'broadcast_id' => 'broadcast_id_example', // string
18 'sso' => 'sso_example', // string
19];
20
21
22try {
23 $result = $apiInstance->postSetCommentReviewStatus($tenant_id, $comment_id, $options);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling ModerationApi->postSetCommentReviewStatus: ', $e->getMessage(), PHP_EOL;
27}
28
Spamstatus van opmerking instellen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| spam | boolean | query | No | |
| permNotSpam | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Response
Retourneert: APIEmptyResponse
Example
postSetCommentSpamStatus Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Als u een aangepaste http-client wilt gebruiken, geef uw client mee die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$options = [
16 'spam' => True, // bool
17 'perm_not_spam' => True, // bool
18 'broadcast_id' => 'broadcast_id_example', // string
19 'sso' => 'sso_example', // string
20];
21
22
23try {
24 $result = $apiInstance->postSetCommentSpamStatus($tenant_id, $comment_id, $options);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling ModerationApi->postSetCommentSpamStatus: ', $e->getMessage(), PHP_EOL;
28}
29
Opmerkingstekst instellen (Moderatie)
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Nee | |
| sso | string | query | Nee |
Response
Retourneert: SetCommentTextResponse
Example
postSetCommentText Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt als standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$set_comment_text_params = new \FastComments\Client\Model\SetCommentTextParams(); // \FastComments\Client\Model\SetCommentTextParams
16$options = [
17 'broadcast_id' => 'broadcast_id_example', // string
18 'sso' => 'sso_example', // string
19];
20
21
22try {
23 $result = $apiInstance->postSetCommentText($tenant_id, $comment_id, $set_comment_text_params, $options);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling ModerationApi->postSetCommentText: ', $e->getMessage(), PHP_EOL;
27}
28
Opmerking ont-markeren
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: APIEmptyResponse
Voorbeeld
postUnFlagComment Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Als je een aangepaste HTTP-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$options = [
16 'broadcast_id' => 'broadcast_id_example', // string
17 'sso' => 'sso_example', // string
18];
19
20
21try {
22 $result = $apiInstance->postUnFlagComment($tenant_id, $comment_id, $options);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling ModerationApi->postUnFlagComment: ', $e->getMessage(), PHP_EOL;
26}
27
Stem plaatsen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| direction | string | query | Nee | |
| broadcastId | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: VoteResponse
Voorbeeld
postVote Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Als je een aangepaste HTTP-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$options = [
16 'direction' => 'direction_example', // string
17 'broadcast_id' => 'broadcast_id_example', // string
18 'sso' => 'sso_example', // string
19];
20
21
22try {
23 $result = $apiInstance->postVote($tenant_id, $comment_id, $options);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling ModerationApi->postVote: ', $e->getMessage(), PHP_EOL;
27}
28
Badge toekennen
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgeId | string | query | Yes | |
| userId | string | query | No | |
| commentId | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Response
Retourneert: AwardUserBadgeResponse
Example
putAwardBadge Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Als u een aangepaste HTTP-client wilt gebruiken, geef uw client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt als standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$badge_id = 'badge_id_example'; // string
15$options = [
16 'user_id' => 'user_id_example', // string
17 'comment_id' => 'comment_id_example', // string
18 'broadcast_id' => 'broadcast_id_example', // string
19 'sso' => 'sso_example', // string
20];
21
22
23try {
24 $result = $apiInstance->putAwardBadge($tenant_id, $badge_id, $options);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling ModerationApi->putAwardBadge: ', $e->getMessage(), PHP_EOL;
28}
29
Discussie sluiten
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja | |
| sso | string | query | Nee |
Respons
Retourneert: APIEmptyResponse
Voorbeeld
putCloseThread Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$url_id = 'url_id_example'; // string
15$sso = 'sso_example'; // string
16
17
18try {
19 $result = $apiInstance->putCloseThread($tenant_id, $url_id, $sso);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling ModerationApi->putCloseThread: ', $e->getMessage(), PHP_EOL;
23}
24
Badge verwijderen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgeId | string | query | Yes | |
| userId | string | query | No | |
| commentId | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Respons
Returns: RemoveUserBadgeResponse
Voorbeeld
putRemoveBadge Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Als je een aangepaste HTTP-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$badge_id = 'badge_id_example'; // string
15$options = [
16 'user_id' => 'user_id_example', // string
17 'comment_id' => 'comment_id_example', // string
18 'broadcast_id' => 'broadcast_id_example', // string
19 'sso' => 'sso_example', // string
20];
21
22
23try {
24 $result = $apiInstance->putRemoveBadge($tenant_id, $badge_id, $options);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling ModerationApi->putRemoveBadge: ', $e->getMessage(), PHP_EOL;
28}
29
Discussie heropenen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja | |
| sso | string | query | Nee |
Response
Retourneert: APIEmptyResponse
Voorbeeld
putReopenThread Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Als je een aangepaste http-client wilt gebruiken, geef dan je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$url_id = 'url_id_example'; // string
15$sso = 'sso_example'; // string
16
17
18try {
19 $result = $apiInstance->putReopenThread($tenant_id, $url_id, $sso);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling ModerationApi->putReopenThread: ', $e->getMessage(), PHP_EOL;
23}
24
Vertrouwensfactor instellen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nee | |
| trustFactor | string | query | Nee | |
| sso | string | query | Nee |
Response
Retourneert: SetUserTrustFactorResponse
Voorbeeld
setTrustFactor Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt als standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$options = [
15 'user_id' => 'user_id_example', // string
16 'trust_factor' => 'trust_factor_example', // string
17 'sso' => 'sso_example', // string
18];
19
20
21try {
22 $result = $apiInstance->setTrustFactor($tenant_id, $options);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling ModerationApi->setTrustFactor: ', $e->getMessage(), PHP_EOL;
26}
27
Moderator aanmaken
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Respons
Returns: CreateModeratorResponse
Voorbeeld
createModerator voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutautorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Verwijder de commentaar hieronder om een prefix (bijv. Bearer) voor de API-sleutel in te stellen, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als u een aangepast HTTP-client wilt gebruiken, geef dan uw client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt als standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$create_moderator_body = new \FastComments\Client\Model\CreateModeratorBody(); // \FastComments\Client\Model\CreateModeratorBody
21
22
23try {
24 $result = $apiInstance->createModerator($tenant_id, $create_moderator_body);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->createModerator: ', $e->getMessage(), PHP_EOL;
28}
29
Moderator verwijderen
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| sendEmail | string | query | Nee |
Response
Returns: APIEmptyResponse
Example
deleteModerator Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutel autorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Verwijder de commentaar hieronder om een prefix in te stellen (bijv. Bearer) voor de API-sleutel, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste http-client wilt gebruiken, geef je je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt als standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$send_email = 'send_email_example'; // string
22
23
24try {
25 $result = $apiInstance->deleteModerator($tenant_id, $id, $send_email);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->deleteModerator: ', $e->getMessage(), PHP_EOL;
29}
30
Moderator ophalen
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Response
Returns: GetModeratorResponse
Voorbeeld
getModerator Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5// Configureer API-sleutel autorisatie: api_key
6$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
7// Ontcommentarieer onderstaande om een prefix (bijv. Bearer) voor de API-sleutel in te stellen, indien nodig
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
13 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20
21
22try {
23 $result = $apiInstance->getModerator($tenant_id, $id);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->getModerator: ', $e->getMessage(), PHP_EOL;
27}
28
Moderators ophalen
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nee |
Respons
Retourneert: GetModeratorsResponse
Voorbeeld
getModerators Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutelautorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Verwijder commentaar hieronder om prefix (bijv. Bearer) voor API-sleutel in te stellen, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$skip = 3.4; // float
21
22
23try {
24 $result = $apiInstance->getModerators($tenant_id, $skip);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getModerators: ', $e->getMessage(), PHP_EOL;
28}
29
Uitnodiging verzenden
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| fromName | string | query | Yes |
Response
Retourneert: APIEmptyResponse
Example
sendInvite Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutel autorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Verwijder de commentaartekens hieronder om een prefix (bijv. Bearer) voor de API-sleutel in te stellen, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste HTTP-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$from_name = 'from_name_example'; // string
22
23
24try {
25 $result = $apiInstance->sendInvite($tenant_id, $id, $from_name);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->sendInvite: ', $e->getMessage(), PHP_EOL;
29}
30
Moderator bijwerken
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Retourneert: APIEmptyResponse
Voorbeeld
updateModerator Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutel autorisatie: api_key
7// Uncomment hieronder om prefix (bijv. Bearer) voor API-sleutel in te stellen, indien nodig
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Als je een aangepaste HTTP-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
13 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
14 new GuzzleHttp\Client(),
15 $config
16);
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
22
23try {
24 $result = $apiInstance->updateModerator($tenant_id, $id, $update_moderator_body);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->updateModerator: ', $e->getMessage(), PHP_EOL;
28}
29
Aantallen van notificaties verwijderen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Retourneert: APIEmptyResponse
Voorbeeld
deleteNotificationCount Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutelautorisatie: api_key
7// Verwijder commentaar hieronder om prefix in te stellen (bijv. Bearer) voor API-sleutel, indien nodig
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Als je een aangepaste HTTP-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
13 // Dit is optioneel, `GuzzleHttp\Client` wordt als standaard gebruikt.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20
21
22try {
23 $result = $apiInstance->deleteNotificationCount($tenant_id, $id);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->deleteNotificationCount: ', $e->getMessage(), PHP_EOL;
27}
28
Gecachte notificatie-aantallen ophalen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Retourneert: GetCachedNotificationCountResponse
Voorbeeld
Voorbeeld getCachedNotificationCount
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutel autorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Verwijder commentaar hieronder om prefix (bijv. Bearer) voor API-sleutel in te stellen, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als u een aangepaste http-client wilt gebruiken, geef dan uw client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21
22
23try {
24 $result = $apiInstance->getCachedNotificationCount($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getCachedNotificationCount: ', $e->getMessage(), PHP_EOL;
28}
29
Notificatie-aantal ophalen
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nee | |
| urlId | string | query | Nee | |
| fromCommentId | string | query | Nee | |
| viewed | boolean | query | Nee | |
| type | string | query | Nee |
Respons
Retourneert: GetNotificationCountResponse
Voorbeeld
getNotificationCount Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutel autorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Verwijder commentaar hieronder om prefix (bijv. Bearer) voor API-sleutel in te stellen, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$options = [
21 'user_id' => 'user_id_example', // string
22 'url_id' => 'url_id_example', // string
23 'from_comment_id' => 'from_comment_id_example', // string
24 'viewed' => True, // bool
25 'type' => 'type_example', // string
26];
27
28
29try {
30 $result = $apiInstance->getNotificationCount($tenant_id, $options);
31 print_r($result);
32} catch (Exception $e) {
33 echo 'Exception when calling DefaultApi->getNotificationCount: ', $e->getMessage(), PHP_EOL;
34}
35
Notificaties ophalen
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| urlId | string | query | No | |
| fromCommentId | string | query | No | |
| viewed | boolean | query | No | |
| type | string | query | No | |
| skip | number | query | No |
Response
Retourneert: GetNotificationsResponse
Voorbeeld
getNotifications Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutel autorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Verwijder de commentaartekens hieronder om een prefix (bijv. Bearer) voor de API‑sleutel in te stellen, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als u een aangepaste HTTP‑client wilt gebruiken, geef dan uw client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$options = [
21 'user_id' => 'user_id_example', // string
22 'url_id' => 'url_id_example', // string
23 'from_comment_id' => 'from_comment_id_example', // string
24 'viewed' => True, // bool
25 'type' => 'type_example', // string
26 'skip' => 3.4, // float
27];
28
29
30try {
31 $result = $apiInstance->getNotifications($tenant_id, $options);
32 print_r($result);
33} catch (Exception $e) {
34 echo 'Exception when calling DefaultApi->getNotifications: ', $e->getMessage(), PHP_EOL;
35}
36
Notificatie bijwerken
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No |
Respons
Retourneert: APIEmptyResponse
Voorbeeld
updateNotification Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7// Configureren van API-sleutel autorisatie: api_key
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// Uncomment onderstaande om een prefix in te stellen (bijv. Bearer) voor API-sleutel, indien nodig
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 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
16 // This is optional, `GuzzleHttp\Client` will be used as default.
17 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
18 new GuzzleHttp\Client(),
19 $config
20);
21
22$tenant_id = 'tenant_id_example'; // string
23$id = 'id_example'; // string
24$update_notification_body = new \FastComments\Client\Model\UpdateNotificationBody(); // \FastComments\Client\Model\UpdateNotificationBody
25$user_id = 'user_id_example'; // string
26
27
28try {
29 $result = $apiInstance->updateNotification($tenant_id, $id, $update_notification_body, $user_id);
30 print_r($result);
31} catch (Exception $e) {
32 echo 'Exception when calling DefaultApi->updateNotification: ', $e->getMessage(), PHP_EOL;
33}
34
Pagina-reactie v1 aanmaken
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| title | string | query | No |
Respons
Retourneert: CreateV1PageReact
Voorbeeld
createV1PageReact Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Als je een aangepaste HTTP-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$url_id = 'url_id_example'; // string
15$title = 'title_example'; // string
16
17
18try {
19 $result = $apiInstance->createV1PageReact($tenant_id, $url_id, $title);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling PublicApi->createV1PageReact: ', $e->getMessage(), PHP_EOL;
23}
24
Pagina-reactie v2 aanmaken
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| id | string | query | Ja | |
| title | string | query | Nee |
Respons
Retourneert: CreateV1PageReact
Voorbeeld
createV2PageReact Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7// $apiInstance = new FastComments\Client\Api\PublicApi(
8 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt als standaard gebruikt.
10 // new GuzzleHttp\Client()
11// );
12
13$tenant_id = 'tenant_id_example'; // string
14$url_id = 'url_id_example'; // string
15$id = 'id_example'; // string
16$title = 'title_example'; // string
17
18
19try {
20 $result = $apiInstance->createV2PageReact($tenant_id, $url_id, $id, $title);
21 print_r($result);
22} catch (Exception $e) {
23 echo 'Exception when calling PublicApi->createV2PageReact: ', $e->getMessage(), PHP_EOL;
24}
25
Pagina-reactie v1 verwijderen
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja |
Respons
Retourneert: CreateV1PageReact
Voorbeeld
deleteV1PageReact Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt als standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$url_id = 'url_id_example'; // string
15
16
17try {
18 $result = $apiInstance->deleteV1PageReact($tenant_id, $url_id);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->deleteV1PageReact: ', $e->getMessage(), PHP_EOL;
22}
23
Pagina-reactie v2 verwijderen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| id | string | query | Yes |
Respons
Retourneert: CreateV1PageReact
Voorbeeld
deleteV2PageReact Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Als u een aangepaste http-client wilt gebruiken, geef dan uw client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$url_id = 'url_id_example'; // string
15$id = 'id_example'; // string
16
17
18try {
19 $result = $apiInstance->deleteV2PageReact($tenant_id, $url_id, $id);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling PublicApi->deleteV2PageReact: ', $e->getMessage(), PHP_EOL;
23}
24
Pagina-likes v1 ophalen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes |
Response
Retourneert: GetV1PageLikes
Voorbeeld
getV1PageLikes Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Als je een aangepaste HTTP-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$url_id = 'url_id_example'; // string
15
16
17try {
18 $result = $apiInstance->getV1PageLikes($tenant_id, $url_id);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->getV1PageLikes: ', $e->getMessage(), PHP_EOL;
22}
23
Pagina-reacties v2 ophalen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja |
Respons
Retourneert: GetV2PageReacts
Voorbeeld
getV2PageReacts Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Als je een aangepaste HTTP-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$url_id = 'url_id_example'; // string
15
16
17try {
18 $result = $apiInstance->getV2PageReacts($tenant_id, $url_id);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->getV2PageReacts: ', $e->getMessage(), PHP_EOL;
22}
23
Pagina-reactgebruikers v2 ophalen
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| id | string | query | Yes |
Respons
Retourneert: GetV2PageReactUsersResponse
Voorbeeld
getV2PageReactUsers Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Als je een aangepaste HTTP-client wilt gebruiken, geef dan je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$url_id = 'url_id_example'; // string
15$id = 'id_example'; // string
16
17
18try {
19 $result = $apiInstance->getV2PageReactUsers($tenant_id, $url_id, $id);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling PublicApi->getV2PageReactUsers: ', $e->getMessage(), PHP_EOL;
23}
24
Pagina toevoegen
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Respons
Retourneert: AddPageAPIResponse
Voorbeeld
addPage Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5// Configureer API-sleutel autorisatie: api_key
6$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
7// Uncomment de onderstaande regel om een prefix (bijv. Bearer) in te stellen voor de API-sleutel, indien nodig
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Als je een aangepaste HTTP-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
13 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // string
19$create_api_page_data = new \FastComments\Client\Model\CreateAPIPageData(); // \FastComments\Client\Model\CreateAPIPageData
20
21
22try {
23 $result = $apiInstance->addPage($tenant_id, $create_api_page_data);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->addPage: ', $e->getMessage(), PHP_EOL;
27}
28
Pagina verwijderen
Parameters
| Name | Type | Location | Required | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Respons
Retourneert: DeletePageAPIResponse
Voorbeeld
deletePage Voorbeeld
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 // Als je een aangepaste HTTP-client wilt gebruiken, geef dan je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21
22
23try {
24 $result = $apiInstance->deletePage($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->deletePage: ', $e->getMessage(), PHP_EOL;
28}
29
Offline gebruikers ophalen
Past commenters op de pagina die NIET momenteel online zijn. Gesorteerd op displayName.
Gebruik dit nadat /users/online is uitgeput om een “Members” sectie weer te geven.
Cursor‑paginering op commenterName: server doorloopt de gedeeltelijke {tenantId, urlId, commenterName} index vanaf afterName vooruit via $gt, zonder $skip‑kosten.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | Pagina‑URL‑identifier (aan de serverzijde opgeschoond). |
| afterName | string | query | Nee | Cursor: geef nextAfterName door uit de vorige respons. |
| afterUserId | string | query | Nee | Cursor tiebreaker: geef nextAfterUserId door uit de vorige respons. Vereist wanneer afterName is ingesteld zodat naam‑gelijkstanden geen items laten vallen. |
Response
Returns: PageUsersOfflineResponse
Example
getOfflineUsers Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Als je een aangepaste http‑client wilt gebruiken, geef je client mee die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$url_id = 'url_id_example'; // string | Pagina‑URL‑identifier (aan de serverzijde opgeschoond).
15$options = [
16 'after_name' => 'after_name_example', // string | Cursor: geef nextAfterName door uit de vorige respons.
17 'after_user_id' => 'after_user_id_example', // string | Cursor tiebreaker: geef nextAfterUserId door uit de vorige respons. Vereist wanneer afterName is ingesteld zodat naam‑gelijkstanden geen items laten vallen.
18];
19
20
21try {
22 $result = $apiInstance->getOfflineUsers($tenant_id, $url_id, $options);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling PublicApi->getOfflineUsers: ', $e->getMessage(), PHP_EOL;
26}
27
Online gebruikers ophalen
Momenteel-online kijkers van een pagina: mensen waarvan de websocket‑sessie op dit moment op de pagina is geabonneerd.
Retourneert anonCount + totalCount (abonnees in de hele ruimte, inclusief anonieme kijkers die we niet opsommen).
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | Pagina‑URL‑identificatie (server‑side opgeschoond). |
| afterName | string | query | Nee | Cursor: geef nextAfterName door van de vorige respons. |
| afterUserId | string | query | Nee | Cursor‑tiebreaker: geef nextAfterUserId door van de vorige respons. Vereist wanneer afterName is ingesteld zodat naam‑gelijkstellingen geen items laten vallen. |
Response
Retourneert: PageUsersOnlineResponse
Voorbeeld
Voorbeeld getOnlineUsers
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Als je een aangepaste HTTP‑client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$url_id = 'url_id_example'; // string | Pagina‑URL‑identificatie (server‑side opgeschoond).
15$options = [
16 'after_name' => 'after_name_example', // string | Cursor: geef nextAfterName door van de vorige respons.
17 'after_user_id' => 'after_user_id_example', // string | Cursor‑tiebreaker: geef nextAfterUserId door van de vorige respons. Vereist wanneer afterName is ingesteld zodat naam‑gelijkstellingen geen items laten vallen.
18];
19
20
21try {
22 $result = $apiInstance->getOnlineUsers($tenant_id, $url_id, $options);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling PublicApi->getOnlineUsers: ', $e->getMessage(), PHP_EOL;
26}
27
Pagina ophalen via URL-id
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes |
Response
Retourneert: GetPageByURLIdAPIResponse
Example
getPageByURLId Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutautorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Haal het commentaar hieronder weg om een prefix (bijv. Bearer) voor de API-sleutel in te stellen, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste http-client wilt gebruiken, geef dan je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$url_id = 'url_id_example'; // string
21
22
23try {
24 $result = $apiInstance->getPageByURLId($tenant_id, $url_id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getPageByURLId: ', $e->getMessage(), PHP_EOL;
28}
29
Pagina's ophalen
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Respons
Retourneert: GetPagesAPIResponse
Voorbeeld
getPages Voorbeeld
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
19$tenant_id = 'tenant_id_example'; // string
20
21
22try {
23 $result = $apiInstance->getPages($tenant_id);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->getPages: ', $e->getMessage(), PHP_EOL;
27}
28
Pagina's openbaar ophalen
List pagina's voor een tenant. Gebruikt door de FChat desktopclient om zijn kamerlijst te vullen.
Vereist dat enableFChat true is in de opgeloste aangepaste configuratie voor elke pagina.
Paginas die SSO vereisen worden gefilterd op basis van de groepstoegang van de vraagende gebruiker.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| cursor | string | query | No | Opaque paginatiecursor geretourneerd als nextCursor van een eerdere aanvraag. Gebonden aan dezelfde sortBy. |
| limit | integer | query | No | 1..200, standaard 50 |
| q | string | query | No | Optionele hoofdletterongevoelige titelvoorvoegselfilter. |
| sortBy | string | query | No | Sorteervolgorde. updatedAt (standaard, nieuwste eerst), commentCount (meeste reacties eerst), of title (alfabetisch). |
| hasComments | boolean | query | No | Als true, alleen pagina's retourneren met ten minste één reactie. |
Response
Returns: GetPublicPagesResponse
Example
getPagesPublic Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Als u een aangepaste HTTP-client wilt gebruiken, geef dan uw client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$options = [
15 'cursor' => 'cursor_example', // string | Opaque paginatiecursor geretourneerd als `nextCursor` van een eerdere aanvraag. Gebonden aan dezelfde `sortBy`.
16 'limit' => 56, // int | 1..200, standaard 50
17 'q' => 'q_example', // string | Optionele hoofdletterongevoelige titelvoorvoegselfilter.
18 'sort_by' => new \FastComments\Client\Model\\FastComments\Client\Model\PagesSortBy(), // \FastComments\Client\Model\PagesSortBy | Sorteervolgorde. `updatedAt` (standaard, nieuwste eerst), `commentCount` (meeste reacties eerst), of `title` (alfabetisch).
19 'has_comments' => True, // bool | Als true, alleen pagina's retourneren met ten minste één reactie.
20];
21
22
23try {
24 $result = $apiInstance->getPagesPublic($tenant_id, $options);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling PublicApi->getPagesPublic: ', $e->getMessage(), PHP_EOL;
28}
29
Gebruikersinformatie ophalen
Bulk gebruikersinformatie voor een tenant. Gegeven userIds, retourneert weergave‑informatie van User / SSOUser.
Gebruikt door de commentaarwidget om gebruikers die net verschenen via een aanwezigheidsevenement te verrijken.
Geen paginacontext: privacy wordt uniform afgedwongen (privéprofielen worden gemaskeerd).
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| ids | string | query | Ja | Door komma’s gescheiden userIds. |
Response
Retourneert: PageUsersInfoResponse
Example
getUsersInfo Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Als je een aangepaste HTTP-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$ids = 'ids_example'; // string | Door komma’s gescheiden userIds.
15
16
17try {
18 $result = $apiInstance->getUsersInfo($tenant_id, $ids);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->getUsersInfo: ', $e->getMessage(), PHP_EOL;
22}
23
Pagina gedeeltelijk bijwerken
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Reactie
Retourneert: PatchPageAPIResponse
Voorbeeld
patchPage Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutel autorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Verwijder de commentaartekens hieronder om een prefix (bijv. Bearer) voor de API-sleutel in te stellen, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste HTTP-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$update_api_page_data = new \FastComments\Client\Model\UpdateAPIPageData(); // \FastComments\Client\Model\UpdateAPIPageData
22
23
24try {
25 $result = $apiInstance->patchPage($tenant_id, $id, $update_api_page_data);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->patchPage: ', $e->getMessage(), PHP_EOL;
29}
30
Wachtende webhook-gebeurtenis verwijderen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Reactie
Retourneert: APIEmptyResponse
Voorbeeld
deletePendingWebhookEvent Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutel autorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Verwijder de commentaar hieronder om een prefix (bijv. Bearer) voor de API-sleutel in te stellen, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste http-client wilt gebruiken, geef dan je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21
22
23try {
24 $result = $apiInstance->deletePendingWebhookEvent($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->deletePendingWebhookEvent: ', $e->getMessage(), PHP_EOL;
28}
29
Aantal wachtende webhook-gebeurtenissen ophalen
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | query | Nee | |
| externalId | string | query | Nee | |
| eventType | string | query | Nee | |
| type | string | query | Nee | |
| domain | string | query | Nee | |
| attemptCountGT | number | query | Nee |
Response
Retourneert: GetPendingWebhookEventCountResponse
Voorbeeld
getPendingWebhookEventCount Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutel autorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Verwijder commentaar hieronder om prefix (bijv. Bearer) voor API-sleutel in te stellen, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$options = [
21 'comment_id' => 'comment_id_example', // string
22 'external_id' => 'external_id_example', // string
23 'event_type' => 'event_type_example', // string
24 'type' => 'type_example', // string
25 'domain' => 'domain_example', // string
26 'attempt_count_gt' => 3.4, // float
27];
28
29
30try {
31 $result = $apiInstance->getPendingWebhookEventCount($tenant_id, $options);
32 print_r($result);
33} catch (Exception $e) {
34 echo 'Uitzondering bij het aanroepen van DefaultApi->getPendingWebhookEventCount: ', $e->getMessage(), PHP_EOL;
35}
36
Wachtende webhook-gebeurtenissen ophalen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | No | |
| externalId | string | query | No | |
| eventType | string | query | No | |
| type | string | query | No | |
| domain | string | query | No | |
| attemptCountGT | number | query | No | |
| skip | number | query | No |
Response
Retourneert: GetPendingWebhookEventsResponse
Example
getPendingWebhookEvents Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutel autorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Verwijder commentaar hieronder om prefix in te stellen (bijv. Bearer) voor API-sleutel, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt als standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$options = [
21 'comment_id' => 'comment_id_example', // string
22 'external_id' => 'external_id_example', // string
23 'event_type' => 'event_type_example', // string
24 'type' => 'type_example', // string
25 'domain' => 'domain_example', // string
26 'attempt_count_gt' => 3.4, // float
27 'skip' => 3.4, // float
28];
29
30
31try {
32 $result = $apiInstance->getPendingWebhookEvents($tenant_id, $options);
33 print_r($result);
34} catch (Exception $e) {
35 echo 'Uitzondering bij het aanroepen van DefaultApi->getPendingWebhookEvents: ', $e->getMessage(), PHP_EOL;
36}
37
Vraagconfiguratie maken
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Response
Retourneert: CreateQuestionConfigResponse
Voorbeeld
createQuestionConfig Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutel autorisatie: api_key
7// Haal hieronder commentaar weg om een prefix in te stellen (e.g. Bearer) voor API sleutel, indien nodig
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
13 // Dit is optioneel, `GuzzleHttp\Client` wordt als standaard gebruikt.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // string
19$create_question_config_body = new \FastComments\Client\Model\CreateQuestionConfigBody(); // \FastComments\Client\Model\CreateQuestionConfigBody
20
21
22try {
23 $result = $apiInstance->createQuestionConfig($tenant_id, $create_question_config_body);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->createQuestionConfig: ', $e->getMessage(), PHP_EOL;
27}
28
Vraagconfiguratie verwijderen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Respons
Returns: APIEmptyResponse
Voorbeeld
deleteQuestionConfig Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7// Configureer API-sleutelautorisatie: api_key
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// Uncomment hieronder om een prefix (bijv. Bearer) voor de API-sleutel in te stellen, indien nodig
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 // Als je een aangepaste HTTP-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
16 // This is optional, `GuzzleHttp\Client` will be used as default.
17 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
18 new GuzzleHttp\Client(),
19 $config
20);
21
22$tenant_id = 'tenant_id_example'; // string
23// string
24$id = 'id_example'; // string
25// string
26
27
28try {
29 $result = $apiInstance->deleteQuestionConfig($tenant_id, $id);
30 print_r($result);
31} catch (Exception $e) {
32 echo 'Exception when calling DefaultApi->deleteQuestionConfig: ', $e->getMessage(), PHP_EOL;
33}
34
Vraagconfiguratie ophalen
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Returns: GetQuestionConfigResponse
Voorbeeld
getQuestionConfig Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutel autorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Schakel onderstaande uitcommentaar om prefix (bijv. Bearer) voor API-sleutel in te stellen, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` zal als standaard worden gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21
22
23try {
24 $result = $apiInstance->getQuestionConfig($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getQuestionConfig: ', $e->getMessage(), PHP_EOL;
28}
29
Vraagconfiguraties ophalen
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nee |
Respons
Retourneert: GetQuestionConfigsResponse
Voorbeeld
Voorbeeld getQuestionConfigs
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutel autorisatie: api_key
7// Verwijder de commentaartekens hieronder om een prefix (bijv. Bearer) voor de API-sleutel in te stellen, indien nodig
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Als je een aangepaste HTTP-client wilt gebruiken, geef dan je client mee die `GuzzleHttp\ClientInterface` implementeert.
13 // Dit is optioneel, `GuzzleHttp\Client` wordt als standaard gebruikt.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // string
19$skip = 3.4; // float
20
21
22try {
23 $result = $apiInstance->getQuestionConfigs($tenant_id, $skip);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->getQuestionConfigs: ', $e->getMessage(), PHP_EOL;
27}
28
Vraagconfiguratie bijwerken
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Returns: APIEmptyResponse
Voorbeeld
updateQuestionConfig Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutelauthorisatie: api_key
7// Verwijder commentaar hieronder om een prefix (bijv. Bearer) voor de API-sleutel in te stellen, indien nodig
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Als je een aangepaste http-client wilt gebruiken, geef dan je client door die `GuzzleHttp\ClientInterface` implementeert.
13 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
14 new GuzzleHttp\Client(),
15 $config
16);
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
22
23try {
24 $result = $apiInstance->updateQuestionConfig($tenant_id, $id, $update_question_config_body);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->updateQuestionConfig: ', $e->getMessage(), PHP_EOL;
28}
29
Vraagresultaat maken
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Response
Retourneert: CreateQuestionResultResultResponse
Example
createQuestionResult Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutel autorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Haal onderstaande commentaar weg om prefix (bijv. Bearer) voor API-sleutel in te stellen, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste http-client wilt gebruiken, geef dan je client mee die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$create_question_result_body = new \FastComments\Client\Model\CreateQuestionResultBody(); // \FastComments\Client\Model\CreateQuestionResultBody
21
22
23try {
24 $result = $apiInstance->createQuestionResult($tenant_id, $create_question_result_body);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->createQuestionResult: ', $e->getMessage(), PHP_EOL;
28}
29
Vraagresultaat verwijderen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Response
Retourneert: APIEmptyResponse
Example
deleteQuestionResult Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutel autorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Verwijder commentaar hieronder om een prefix (bijv. Bearer) in te stellen voor de API-sleutel, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21
22
23try {
24 $result = $apiInstance->deleteQuestionResult($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->deleteQuestionResult: ', $e->getMessage(), PHP_EOL;
28}
29
Vraagresultaat ophalen
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Retourneert: GetQuestionResultResponse
Voorbeeld
getQuestionResult Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutel autorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Verwijder de commentaar hieronder om een prefix (bijv. Bearer) voor de API-sleutel in te stellen, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21
22
23try {
24 $result = $apiInstance->getQuestionResult($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getQuestionResult: ', $e->getMessage(), PHP_EOL;
28}
29
Vraagresultaten ophalen
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Nee | |
| userId | string | query | Nee | |
| startDate | string | query | Nee | |
| questionId | string | query | Nee | |
| questionIds | string | query | Nee | |
| skip | number | query | Nee |
Respons
Retourneert: GetQuestionResultsResponse
Voorbeeld
getQuestionResults Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutel autorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Verwijder commentaar hieronder om prefix in te stellen (bijv. Bearer) voor API-sleutel, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$options = [
21 'url_id' => 'url_id_example', // string
22 'user_id' => 'user_id_example', // string
23 'start_date' => 'start_date_example', // string
24 'question_id' => 'question_id_example', // string
25 'question_ids' => 'question_ids_example', // string
26 'skip' => 3.4, // float
27];
28
29
30try {
31 $result = $apiInstance->getQuestionResults($tenant_id, $options);
32 print_r($result);
33} catch (Exception $e) {
34 echo 'Exception when calling DefaultApi->getQuestionResults: ', $e->getMessage(), PHP_EOL;
35}
36
Vraagresultaat bijwerken
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Retourneert: APIEmptyResponse
Voorbeeld
updateQuestionResult Voorbeeld
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 // Als je een aangepaste http-client wilt gebruiken, geef je client mee die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$update_question_result_body = new \FastComments\Client\Model\UpdateQuestionResultBody(); // \FastComments\Client\Model\UpdateQuestionResultBody
22
23
24try {
25 $result = $apiInstance->updateQuestionResult($tenant_id, $id, $update_question_result_body);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->updateQuestionResult: ', $e->getMessage(), PHP_EOL;
29}
30
Vraagresultaten aggregeren
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| questionId | string | query | No | |
| questionIds | array | query | No | |
| urlId | string | query | No | |
| timeBucket | string | query | No | |
| startDate | string | query | No | |
| forceRecalculate | boolean | query | No |
Respons
Retourneert: AggregateQuestionResultsResponse
Voorbeeld
aggregateQuestionResults Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutel autorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Verwijder commentaar hieronder om een prefix (bijv. Bearer) voor de API-sleutel in te stellen, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt gebruikt als standaard.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$options = [
21 'question_id' => 'question_id_example', // string
22 'question_ids' => array('question_ids_example'), // string[]
23 'url_id' => 'url_id_example', // string
24 'time_bucket' => new \FastComments\Client\Model\\FastComments\Client\Model\AggregateTimeBucket(), // \FastComments\Client\Model\AggregateTimeBucket
25 'start_date' => new \DateTime('2013-10-20T19:20:30+01:00'), // \DateTime
26 'force_recalculate' => True, // bool
27];
28
29
30try {
31 $result = $apiInstance->aggregateQuestionResults($tenant_id, $options);
32 print_r($result);
33} catch (Exception $e) {
34 echo 'Exception when calling DefaultApi->aggregateQuestionResults: ', $e->getMessage(), PHP_EOL;
35}
36
Bulk aggregeren van vraagresultaten
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| forceRecalculate | boolean | query | Nee |
Response
Retourneert: BulkAggregateQuestionResultsResponse
Example
bulkAggregateQuestionResults Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutelauthorisatie: 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 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$bulk_aggregate_question_results_request = new \FastComments\Client\Model\BulkAggregateQuestionResultsRequest(); // \FastComments\Client\Model\BulkAggregateQuestionResultsRequest
21$force_recalculate = True; // bool
22
23
24try {
25 $result = $apiInstance->bulkAggregateQuestionResults($tenant_id, $bulk_aggregate_question_results_request, $force_recalculate);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->bulkAggregateQuestionResults: ', $e->getMessage(), PHP_EOL;
29}
30
Opmerkingen combineren met vraagresultaten
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| questionId | string | query | No | |
| questionIds | array | query | No | |
| urlId | string | query | No | |
| startDate | string | query | No | |
| forceRecalculate | boolean | query | No | |
| minValue | number | query | No | |
| maxValue | number | query | No | |
| limit | number | query | No |
Respons
Retourneert: CombineQuestionResultsWithCommentsResponse
Voorbeeld
combineCommentsWithQuestionResults voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutautorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Verwijder commentaar hieronder om een prefix (bijv. Bearer) voor de API-sleutel in te stellen, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste HTTP-client wilt gebruiken, geef dan je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$options = [
21 'question_id' => 'question_id_example', // string
22 'question_ids' => array('question_ids_example'), // string[]
23 'url_id' => 'url_id_example', // string
24 'start_date' => new \DateTime('2013-10-20T19:20:30+01:00'), // \DateTime
25 'force_recalculate' => True, // bool
26 'min_value' => 3.4, // float
27 'max_value' => 3.4, // float
28 'limit' => 3.4, // float
29];
30
31
32try {
33 $result = $apiInstance->combineCommentsWithQuestionResults($tenant_id, $options);
34 print_r($result);
35} catch (Exception $e) {
36 echo 'Exception when calling DefaultApi->combineCommentsWithQuestionResults: ', $e->getMessage(), PHP_EOL;
37}
38
SSO-gebruiker toevoegen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Response
Retourneert: AddSSOUserAPIResponse
Example
addSSOUser Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutelautorisatie: api_key
7// Verwijder de commentaartekens hieronder om een prefix (bijv. Bearer) voor de API-sleutel in te stellen, indien nodig
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
13 // Dit is optioneel, `GuzzleHttp\Client` wordt gebruikt als standaard.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // string
19$create_apisso_user_data = new \FastComments\Client\Model\CreateAPISSOUserData(); // \FastComments\Client\Model\CreateAPISSOUserData
20
21
22try {
23 $result = $apiInstance->addSSOUser($tenant_id, $create_apisso_user_data);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->addSSOUser: ', $e->getMessage(), PHP_EOL;
27}
28
SSO-gebruiker verwijderen
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| deleteComments | boolean | query | Nee | |
| commentDeleteMode | string | query | Nee |
Respons
Retourneert: DeleteSSOUserAPIResponse
Voorbeeld
deleteSSOUser Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutel autorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Ontcommentarieer hieronder om een prefix (bijv. Bearer) voor de API-sleutel in te stellen, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste http-client wilt gebruiken, geef dan je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt als standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$options = [
22 'delete_comments' => True, // bool
23 'comment_delete_mode' => 'comment_delete_mode_example', // string
24];
25
26
27try {
28 $result = $apiInstance->deleteSSOUser($tenant_id, $id, $options);
29 print_r($result);
30} catch (Exception $e) {
31 echo 'Exception when calling DefaultApi->deleteSSOUser: ', $e->getMessage(), PHP_EOL;
32}
33
SSO-gebruiker ophalen op e-mail
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| string | path | Ja |
Respons
Retourneert: GetSSOUserByEmailAPIResponse
Voorbeeld
getSSOUserByEmail Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutel autorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Haal de commentaar hieronder weg om een prefix (bijv. Bearer) voor de API-sleutel in te stellen, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepast http-client wilt gebruiken, geef dan je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt als standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$email = 'email_example'; // string
21
22
23try {
24 $result = $apiInstance->getSSOUserByEmail($tenant_id, $email);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getSSOUserByEmail: ', $e->getMessage(), PHP_EOL;
28}
29
SSO-gebruiker ophalen op id
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Retourneert: GetSSOUserByIdAPIResponse
Voorbeeld
getSSOUserById Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutel autorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Ontcommentarieer onderstaande om prefix (bijv. Bearer) voor API-sleutel in te stellen, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste HTTP-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21
22
23try {
24 $result = $apiInstance->getSSOUserById($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getSSOUserById: ', $e->getMessage(), PHP_EOL;
28}
29
SSO-gebruikers ophalen
Parameters
| Naam | Type | Locatie | Vereist | Omschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | integer | query | Nee |
Respons
Retourneert: GetSSOUsersResponse
Voorbeeld
getSSOUsers Voorbeeld
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
19$tenant_id = 'tenant_id_example'; // string
20$skip = 56; // int
21
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-gebruiker gedeeltelijk bijwerken
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| updateComments | boolean | query | Nee |
Response
Retourneert: PatchSSOUserAPIResponse
Example
patchSSOUser Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// // Configureer API sleutel autorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// // Haal de commentaar hieronder weg om een prefix (bijv. Bearer) voor de API-sleutel in te stellen, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // // Als je een aangepaste HTTP-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // // Dit is optioneel, `GuzzleHttp\Client` wordt als standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$update_apisso_user_data = new \FastComments\Client\Model\UpdateAPISSOUserData(); // \FastComments\Client\Model\UpdateAPISSOUserData
22$update_comments = True; // bool
23
24
25try {
26 $result = $apiInstance->patchSSOUser($tenant_id, $id, $update_apisso_user_data, $update_comments);
27 print_r($result);
28} catch (Exception $e) {
29 echo 'Exception when calling DefaultApi->patchSSOUser: ', $e->getMessage(), PHP_EOL;
30}
31
SSO-gebruiker vervangen/aanmaken
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| updateComments | boolean | query | Nee |
Respons
Retourneert: PutSSOUserAPIResponse
Voorbeeld
putSSOUser Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutel autorisatie: 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 // Als je een aangepaste http-client wilt gebruiken, geef je je client mee die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$update_apisso_user_data = new \FastComments\Client\Model\UpdateAPISSOUserData(); // \FastComments\Client\Model\UpdateAPISSOUserData
22$update_comments = True; // bool
23
24
25try {
26 $result = $apiInstance->putSSOUser($tenant_id, $id, $update_apisso_user_data, $update_comments);
27 print_r($result);
28} catch (Exception $e) {
29 echo 'Exception when calling DefaultApi->putSSOUser: ', $e->getMessage(), PHP_EOL;
30}
31
Abonnement aanmaken
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Respons
Retourneert: CreateSubscriptionAPIResponse
Voorbeeld
createSubscription Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API key autorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Verwijder het commentaar hieronder om een prefix (bijv. Bearer) in te stellen voor API key, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste http-client wilt gebruiken, geef je client mee die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt als standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$create_api_user_subscription_data = new \FastComments\Client\Model\CreateAPIUserSubscriptionData(); // \FastComments\Client\Model\CreateAPIUserSubscriptionData
21
22
23try {
24 $result = $apiInstance->createSubscription($tenant_id, $create_api_user_subscription_data);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->createSubscription: ', $e->getMessage(), PHP_EOL;
28}
29
Abonnement verwijderen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nee |
Respons
Retourneert: DeleteSubscriptionAPIResponse
Voorbeeld
deleteSubscription Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutel autorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Verwijder commentaar hieronder om een prefix (e.g. Bearer) voor de API-sleutel in te stellen, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste HTTP-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$user_id = 'user_id_example'; // string
22
23
24try {
25 $result = $apiInstance->deleteSubscription($tenant_id, $id, $user_id);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->deleteSubscription: ', $e->getMessage(), PHP_EOL;
29}
30
Abonnementen ophalen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No |
Respons
Retourneert: GetSubscriptionsAPIResponse
Voorbeeld
getSubscriptions Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutelauthorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Verwijder de commentaartekens hieronder om een prefix (bijv. Bearer) voor de API-sleutel in te stellen, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste HTTP-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$user_id = 'user_id_example'; // string
21
22
23try {
24 $result = $apiInstance->getSubscriptions($tenant_id, $user_id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getSubscriptions: ', $e->getMessage(), PHP_EOL;
28}
29
Abonnement bijwerken
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | pad | Ja | |
| userId | string | query | Nee |
Respons
Retourneert: UpdateSubscriptionAPIResponse
Voorbeeld
updateSubscription Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutel autorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Haal de onderliggende regel weg om een prefix (bijv. Bearer) voor de API-sleutel in te stellen, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste http-client wilt gebruiken, geef je jouw client mee die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$update_api_user_subscription_data = new \FastComments\Client\Model\UpdateAPIUserSubscriptionData(); // \FastComments\Client\Model\UpdateAPIUserSubscriptionData
22$user_id = 'user_id_example'; // string
23
24
25try {
26 $result = $apiInstance->updateSubscription($tenant_id, $id, $update_api_user_subscription_data, $user_id);
27 print_r($result);
28} catch (Exception $e) {
29 echo 'Exceptie bij het aanroepen DefaultApi->updateSubscription: ', $e->getMessage(), PHP_EOL;
30}
31
Dagelijkse gebruiksgegevens tenant ophalen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| yearNumber | number | query | Nee | |
| monthNumber | number | query | Nee | |
| dayNumber | number | query | Nee | |
| skip | number | query | Nee |
Respons
Retourneert: GetTenantDailyUsagesResponse
Voorbeeld
getTenantDailyUsages Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutelautorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment hieronder om een prefix (bijv. Bearer) voor de API-sleutel in te stellen, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste http-client wilt gebruiken, geef je je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` zal standaard worden gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$options = [
21 'year_number' => 3.4, // float
22 'month_number' => 3.4, // float
23 'day_number' => 3.4, // float
24 'skip' => 3.4, // float
25];
26
27
28try {
29 $result = $apiInstance->getTenantDailyUsages($tenant_id, $options);
30 print_r($result);
31} catch (Exception $e) {
32 echo 'Exception when calling DefaultApi->getTenantDailyUsages: ', $e->getMessage(), PHP_EOL;
33}
34
Tenantpakket aanmaken
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Respons
Retourneert: CreateTenantPackageResponse
Voorbeeld
createTenantPackage Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutel autorisatie: api_key
7// Verwijder de commentaartekens hieronder om een prefix (bijv. Bearer) voor de API-sleutel in te stellen, indien nodig
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Als je een aangepaste HTTP-client wilt gebruiken, geef dan je client door die `GuzzleHttp\ClientInterface` implementeert.
13 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // string
19$create_tenant_package_body = new \FastComments\Client\Model\CreateTenantPackageBody(); // \FastComments\Client\Model\CreateTenantPackageBody
20
21
22try {
23 $result = $apiInstance->createTenantPackage($tenant_id, $create_tenant_package_body);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->createTenantPackage: ', $e->getMessage(), PHP_EOL;
27}
28
Tenantpakket verwijderen
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Retourneert: APIEmptyResponse
Voorbeeld
deleteTenantPackage Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureren API-sleutauthenticatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommentarieer onderstaande om een prefix (bijv. Bearer) voor de API-sleutel in te stellen, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste http-client wilt gebruiken, geef dan je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21
22
23try {
24 $result = $apiInstance->deleteTenantPackage($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->deleteTenantPackage: ', $e->getMessage(), PHP_EOL;
28}
29
Tenantpakket ophalen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Response
Retourneert: GetTenantPackageResponse
Example
getTenantPackage Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutautorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Verwijder de commentaartekens hieronder om een prefix (bijv. Bearer) voor de API-sleutel in te stellen, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Dit is optioneel, `GuzzleHttp\Client` zal als standaard worden gebruikt.
14 // Als je een aangepaste http-client wilt gebruiken, geef dan je client door die `GuzzleHttp\ClientInterface` implementeert.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21
22
23try {
24 $result = $apiInstance->getTenantPackage($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getTenantPackage: ', $e->getMessage(), PHP_EOL;
28}
29
Tenantpakketten ophalen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nee |
Reactie
Retourneert: GetTenantPackagesResponse
Voorbeeld
getTenantPackages Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutel autorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Verwijder de commentaartekens hieronder om een prefix (bijv. Bearer) voor de API-sleutel in te stellen, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste HTTP-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$skip = 3.4; // float
21
22
23try {
24 $result = $apiInstance->getTenantPackages($tenant_id, $skip);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getTenantPackages: ', $e->getMessage(), PHP_EOL;
28}
29
Tenantpakket vervangen
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Respons
Retourneert: APIEmptyResponse
Voorbeeld
replaceTenantPackage Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutel autorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Ontcommentaar onderstaande regel om een prefix in te stellen (bijv. Bearer) voor API-sleutel, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste http-client wilt gebruiken, geef je je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$replace_tenant_package_body = new \FastComments\Client\Model\ReplaceTenantPackageBody(); // \FastComments\Client\Model\ReplaceTenantPackageBody
22
23
24try {
25 $result = $apiInstance->replaceTenantPackage($tenant_id, $id, $replace_tenant_package_body);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->replaceTenantPackage: ', $e->getMessage(), PHP_EOL;
29}
30
Tenantpakket bijwerken
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Retourneert: APIEmptyResponse
Voorbeeld
updateTenantPackage Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7// Configureer API-sleutel autorisatie: api_key
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// Ontcommentarieer onderstaande om een prefix in te stellen (bijv. Bearer) voor de API-sleutel, indien nodig
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 // Als je een aangepaste HTTP-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
15 // This is optional, `GuzzleHttp\Client` will be used as default.
16 // Dit is optioneel, `GuzzleHttp\Client` wordt als standaard gebruikt.
17 new GuzzleHttp\Client(),
18 $config
19);
20
21$tenant_id = 'tenant_id_example'; // string
22$id = 'id_example'; // string
23$update_tenant_package_body = new \FastComments\Client\Model\UpdateTenantPackageBody(); // \FastComments\Client\Model\UpdateTenantPackageBody
24
25
26try {
27 $result = $apiInstance->updateTenantPackage($tenant_id, $id, $update_tenant_package_body);
28 print_r($result);
29} catch (Exception $e) {
30 echo 'Exception when calling DefaultApi->updateTenantPackage: ', $e->getMessage(), PHP_EOL;
31}
32
Tenantgebruiker aanmaken
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Respons
Retourneert: CreateTenantUserResponse
Voorbeeld
createTenantUser Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutel autorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Haal onderstaande commentaar weg om prefix (bijv. Bearer) voor API-sleutel in te stellen, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$create_tenant_user_body = new \FastComments\Client\Model\CreateTenantUserBody(); // \FastComments\Client\Model\CreateTenantUserBody
21
22
23try {
24 $result = $apiInstance->createTenantUser($tenant_id, $create_tenant_user_body);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->createTenantUser: ', $e->getMessage(), PHP_EOL;
28}
29
Tenantgebruiker verwijderen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| deleteComments | string | query | Nee | |
| commentDeleteMode | string | query | Nee |
Response
Retourneert: APIEmptyResponse
Voorbeeld
deleteTenantUser Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutel autorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Verwijder commentaar hieronder om een prefix (bijv. Bearer) in te stellen voor de API-sleutel, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$options = [
22 'delete_comments' => 'delete_comments_example', // string
23 'comment_delete_mode' => 'comment_delete_mode_example', // string
24];
25
26
27try {
28 $result = $apiInstance->deleteTenantUser($tenant_id, $id, $options);
29 print_r($result);
30} catch (Exception $e) {
31 echo 'Exception when calling DefaultApi->deleteTenantUser: ', $e->getMessage(), PHP_EOL;
32}
33
Tenantgebruiker ophalen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Response
Retourneert: GetTenantUserResponse
Voorbeeld
getTenantUser Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutel autorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Ontcommentaar onderstaande regel om prefix (bijv. Bearer) voor API-sleutel in te stellen, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste http-client wilt gebruiken, geef dan je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt als standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21
22
23try {
24 $result = $apiInstance->getTenantUser($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getTenantUser: ', $e->getMessage(), PHP_EOL;
28}
29
Tenantgebruikers ophalen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nee |
Respons
Retourneert: GetTenantUsersResponse
Voorbeeld
Voorbeeld getTenantUsers
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5// Configureer API-sleutel autorisatie: api_key
6// Verwijder commentaar hieronder om een prefix in te stellen (bijv. Bearer) voor de API-sleutel, indien nodig
7// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
8
9$apiInstance = new FastComments\Client\Api\DefaultApi(
10 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
11 // Dit is optioneel, `GuzzleHttp\Client` wordt gebruikt als standaard.
12 new GuzzleHttp\Client(),
13 $config
14);
15
16$tenant_id = 'tenant_id_example'; // string
17$skip = 3.4; // float
18
19try {
20 $result = $apiInstance->getTenantUsers($tenant_id, $skip);
21 print_r($result);
22} catch (Exception $e) {
23 echo 'Exception when calling DefaultApi->getTenantUsers: ', $e->getMessage(), PHP_EOL;
24}
25
Tenantgebruiker vervangen
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| updateComments | string | query | Nee |
Response
Returns: APIEmptyResponse
Voorbeeld
replaceTenantUser voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5// Configureer API-sleutel autorisatie: api_key
6$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
7// Ontcommentarieer onderstaande om een prefix (bijv. Bearer) in te stellen voor de API-sleutel, indien nodig
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Als je een aangepaste HTTP-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
13 // Dit is optioneel, `GuzzleHttp\Client` zal als standaard worden gebruikt.
14 new GuzzleHttp\Client(),
15 $config
16);
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
23
24try {
25 $result = $apiInstance->replaceTenantUser($tenant_id, $id, $replace_tenant_user_body, $update_comments);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->replaceTenantUser: ', $e->getMessage(), PHP_EOL;
29}
30
Inloglink verzenden
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| redirectURL | string | query | No |
Response
Retourneert: APIEmptyResponse
Voorbeeld
sendLoginLink Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API‑sleutel autorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Verwijder de commentaarteken om hieronder de prefix (bijv. Bearer) voor de API‑sleutel in te stellen, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepast HTTP‑client wilt gebruiken, geef dan je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$redirect_url = 'redirect_url_example'; // string
22
23
24try {
25 $result = $apiInstance->sendLoginLink($tenant_id, $id, $redirect_url);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->sendLoginLink: ', $e->getMessage(), PHP_EOL;
29}
30
Tenantgebruiker bijwerken
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| updateComments | string | query | Nee |
Respons
Retourneert: APIEmptyResponse
Voorbeeld
updateTenantUser Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutel autorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Ontcommentarieer onderstaande regel om prefix (bijv. Bearer) voor API-sleutel in te stellen, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepast http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$update_tenant_user_body = new \FastComments\Client\Model\UpdateTenantUserBody(); // \FastComments\Client\Model\UpdateTenantUserBody
22$update_comments = 'update_comments_example'; // string
23
24
25try {
26 $result = $apiInstance->updateTenantUser($tenant_id, $id, $update_tenant_user_body, $update_comments);
27 print_r($result);
28} catch (Exception $e) {
29 echo 'Exception when calling DefaultApi->updateTenantUser: ', $e->getMessage(), PHP_EOL;
30}
31
Tenant aanmaken
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Respons
Retourneert: CreateTenantResponse
Voorbeeld
createTenant Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutel autorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Verwijder commentaar hieronder om prefix (bijv. Bearer) voor API-sleutel in te stellen, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt als standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$create_tenant_body = new \FastComments\Client\Model\CreateTenantBody(); // \FastComments\Client\Model\CreateTenantBody
21
22
23try {
24 $result = $apiInstance->createTenant($tenant_id, $create_tenant_body);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->createTenant: ', $e->getMessage(), PHP_EOL;
28}
29
Tenant verwijderen
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| sure | string | query | No |
Response
Retourneert: APIEmptyResponse
Example
deleteTenant Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutelauthorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Verwijder commentaar hieronder om prefix (bijv. Bearer) voor API-sleutel in te stellen, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$sure = 'sure_example'; // string
22
23
24try {
25 $result = $apiInstance->deleteTenant($tenant_id, $id, $sure);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->deleteTenant: ', $e->getMessage(), PHP_EOL;
29}
30
Tenant ophalen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Retourneert: GetTenantResponse
Voorbeeld
getTenant Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutel autorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Verwijder commentaar hieronder om prefix (bijv. Bearer) voor API-sleutel in te stellen, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste HTTP-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21
22
23try {
24 $result = $apiInstance->getTenant($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getTenant: ', $e->getMessage(), PHP_EOL;
28}
29
Tenants ophalen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| meta | string | query | Nee | |
| skip | number | query | Nee |
Response
Retourneert: GetTenantsResponse
Voorbeeld
getTenants Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5// Configureer API-sleutel autorisatie: api_key
6$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
7// Verwijder commentaar hieronder om een prefix (bijv. Bearer) in te stellen voor de API-sleutel, indien nodig
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
13 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // string
19$options = [
20 'meta' => 'meta_example', // string
21 'skip' => 3.4, // float
22];
23
24
25try {
26 $result = $apiInstance->getTenants($tenant_id, $options);
27 print_r($result);
28} catch (Exception $e) {
29 echo 'Exception when calling DefaultApi->getTenants: ', $e->getMessage(), PHP_EOL;
30}
31
Tenant bijwerken
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Retourneert: APIEmptyResponse
Voorbeeld
updateTenant Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutel autorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Haal commentaar weg hieronder om een prefix (bijv. Bearer) voor de API-sleutel in te stellen, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste HTTP-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt als standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$update_tenant_body = new \FastComments\Client\Model\UpdateTenantBody(); // \FastComments\Client\Model\UpdateTenantBody
22
23
24try {
25 $result = $apiInstance->updateTenant($tenant_id, $id, $update_tenant_body);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->updateTenant: ', $e->getMessage(), PHP_EOL;
29}
30
Ticketstatus wijzigen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Ja | |
| id | string | path | Ja |
Respons
Retourneert: ChangeTicketStateResponse
Voorbeeld
changeTicketState voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutautorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Verwijder de commentaartekens hieronder om een prefix (bijv. Bearer) voor de API-sleutel in te stellen, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$user_id = 'user_id_example'; // string
21$id = 'id_example'; // string
22$change_ticket_state_body = new \FastComments\Client\Model\ChangeTicketStateBody(); // \FastComments\Client\Model\ChangeTicketStateBody
23
24
25try {
26 $result = $apiInstance->changeTicketState($tenant_id, $user_id, $id, $change_ticket_state_body);
27 print_r($result);
28} catch (Exception $e) {
29 echo 'Exception when calling DefaultApi->changeTicketState: ', $e->getMessage(), PHP_EOL;
30}
31
Ticket aanmaken
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Ja |
Respons
Returns: CreateTicketResponse
Voorbeeld
createTicket Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutautorisatie: api_key
7// Verwijder de commentaar op de onderstaande regel om een prefix (bijv. Bearer) voor de API-sleutel in te stellen, indien nodig
8$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste HTTP-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$user_id = 'user_id_example'; // string
21$create_ticket_body = new \FastComments\Client\Model\CreateTicketBody(); // \FastComments\Client\Model\CreateTicketBody
22
23
24try {
25 $result = $apiInstance->createTicket($tenant_id, $user_id, $create_ticket_body);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->createTicket: ', $e->getMessage(), PHP_EOL;
29}
30
Ticket ophalen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nee |
Respons
Retourneert: GetTicketResponse
Voorbeeld
getTicket Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutel autorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Ontcommentarieer hieronder om een prefix in te stellen (bijv. Bearer) voor de API-sleutel, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt als standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$user_id = 'user_id_example'; // string
22
23
24try {
25 $result = $apiInstance->getTicket($tenant_id, $id, $user_id);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->getTicket: ', $e->getMessage(), PHP_EOL;
29}
30
Tickets ophalen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| state | number | query | No | |
| skip | number | query | No | |
| limit | number | query | No |
Reactie
Retourneert: GetTicketsResponse
Voorbeeld
getTickets Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutelautorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Verwijder de commentaarregel hieronder om een prefix (bijv. Bearer) voor de API-sleutel in te stellen, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt als standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$options = [
21 'user_id' => 'user_id_example', // string
22 'state' => 3.4, // float
23 'skip' => 3.4, // float
24 'limit' => 3.4, // float
25];
26
27
28try {
29 $result = $apiInstance->getTickets($tenant_id, $options);
30 print_r($result);
31} catch (Exception $e) {
32 echo 'Exception when calling DefaultApi->getTickets: ', $e->getMessage(), PHP_EOL;
33}
34
Vertalingen ophalen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| namespace | string | path | Ja | |
| component | string | path | Ja | |
| locale | string | query | Nee | |
| useFullTranslationIds | boolean | query | Nee |
Respons
Retourneert: GetTranslationsResponse
Voorbeeld
getTranslations Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$namespace = 'namespace_example'; // string
14$component = 'component_example'; // string
15$options = [
16 'locale' => 'locale_example', // string
17 'use_full_translation_ids' => True, // bool
18];
19
20
21try {
22 $result = $apiInstance->getTranslations($namespace, $component, $options);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling PublicApi->getTranslations: ', $e->getMessage(), PHP_EOL;
26}
27
Afbeelding uploaden
Upload en verkleinen van een afbeelding
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| sizePreset | string | query | Nee | Groottepreset: "Default" (1000x1000px) of "CrossPlatform" (maakt formaten voor populaire apparaten) |
| urlId | string | query | Nee | Pagina-id waarvan de upload plaatsvindt, voor configuratie |
Respons
Retourneert: UploadImageResponse
Voorbeeld
uploadImage Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$file = '/path/to/file.txt'; // \SplFileObject
15$options = [
16 'size_preset' => new \FastComments\Client\Model\\FastComments\Client\Model\SizePreset(), // \FastComments\Client\Model\SizePreset | Groottepreset: "Default" (1000x1000px) of "CrossPlatform" (maakt formaten voor populaire apparaten)
17 'url_id' => 'url_id_example', // string | Pagina-id waarvan de upload plaatsvindt, voor configuratie
18];
19
20
21try {
22 $result = $apiInstance->uploadImage($tenant_id, $file, $options);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling PublicApi->uploadImage: ', $e->getMessage(), PHP_EOL;
26}
27
Badgevoortgang gebruiker ophalen op id
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Response
Retourneert: APIGetUserBadgeProgressResponse
Voorbeeld
getUserBadgeProgressById Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutel autorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Verwijder commentaar hieronder om prefix (bijv. Bearer) voor API-sleutel in te stellen, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste HTTP-client wilt gebruiken, geef je jouw client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21
22
23try {
24 $result = $apiInstance->getUserBadgeProgressById($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exceptie bij het aanroepen van DefaultApi->getUserBadgeProgressById: ', $e->getMessage(), PHP_EOL;
28}
29
Badgevoortgang gebruiker ophalen op gebruiker-id
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | path | Ja |
Respons
Retourneert: APIGetUserBadgeProgressResponse
Voorbeeld
Voorbeeld getUserBadgeProgressByUserId
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureren van API‑sleutel autorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Verwijder commentaar hieronder om een prefix (bijv. Bearer) voor de API‑sleutel in te stellen, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste http‑client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt als standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$user_id = 'user_id_example'; // string
21
22
23try {
24 $result = $apiInstance->getUserBadgeProgressByUserId($tenant_id, $user_id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getUserBadgeProgressByUserId: ', $e->getMessage(), PHP_EOL;
28}
29
Lijst met badgevoortgang voor gebruiker ophalen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| limit | number | query | No | |
| skip | number | query | No |
Respons
Retourneert: APIGetUserBadgeProgressListResponse
Voorbeeld
getUserBadgeProgressList Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutel autorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Verwijder commentaar op de onderstaande regel om een prefix in te stellen (bijv. Bearer) voor de API‑sleutel, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste HTTP‑client wilt gebruiken, geef dan je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$options = [
21 'user_id' => 'user_id_example', // string
22 'limit' => 3.4, // float
23 'skip' => 3.4, // float
24];
25
26
27try {
28 $result = $apiInstance->getUserBadgeProgressList($tenant_id, $options);
29 print_r($result);
30} catch (Exception $e) {
31 echo 'Exception when calling DefaultApi->getUserBadgeProgressList: ', $e->getMessage(), PHP_EOL;
32}
33
Gebruikersbadge aanmaken
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Response
Retourneert: APICreateUserBadgeResponse
Voorbeeld
Voorbeeld createUserBadge
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutautorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Haal onderstaande commentaar weg om een prefix in te stellen (bijv. Bearer) voor de API-sleutel, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste HTTP-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$create_user_badge_params = new \FastComments\Client\Model\CreateUserBadgeParams(); // \FastComments\Client\Model\CreateUserBadgeParams
21
22
23try {
24 $result = $apiInstance->createUserBadge($tenant_id, $create_user_badge_params);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->createUserBadge: ', $e->getMessage(), PHP_EOL;
28}
29
Gebruikersbadge verwijderen
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Retourneert: APIEmptySuccessResponse
Voorbeeld
deleteUserBadge Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutelautorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Verwijder commentaar hieronder om een prefix (bijv. Bearer) voor de API-sleutel in te stellen, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21
22
23try {
24 $result = $apiInstance->deleteUserBadge($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->deleteUserBadge: ', $e->getMessage(), PHP_EOL;
28}
29
Gebruikersbadge ophalen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Response
Retourneert: APIGetUserBadgeResponse
Voorbeeld
getUserBadge Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutelauthorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment hieronder om een prefix in te stellen (bijv. Bearer) voor de API-sleutel, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste http-client wilt gebruiken, geef dan jouw client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21
22
23try {
24 $result = $apiInstance->getUserBadge($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception bij het aanroepen van DefaultApi->getUserBadge: ', $e->getMessage(), PHP_EOL;
28}
29
Gebruikersbadges ophalen
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nee | |
| badgeId | string | query | Nee | |
| type | number | query | Nee | |
| displayedOnComments | boolean | query | Nee | |
| limit | number | query | Nee | |
| skip | number | query | Nee |
Respons
Retourneert: APIGetUserBadgesResponse
Voorbeeld
Voorbeeld getUserBadges
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutel autorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Verwijder commentaar hieronder om prefix (bijv. Bearer) in te stellen voor API-sleutel, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste http-client wilt gebruiken, geef dan je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt als standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$options = [
21 'user_id' => 'user_id_example', // string
22 'badge_id' => 'badge_id_example', // string
23 'type' => 3.4, // float
24 'displayed_on_comments' => True, // bool
25 'limit' => 3.4, // float
26 'skip' => 3.4, // float
27];
28
29
30try {
31 $result = $apiInstance->getUserBadges($tenant_id, $options);
32 print_r($result);
33} catch (Exception $e) {
34 echo 'Exception when calling DefaultApi->getUserBadges: ', $e->getMessage(), PHP_EOL;
35}
36
Gebruikersbadge bijwerken
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Retourneert: APIEmptySuccessResponse
Voorbeeld
updateUserBadge Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutautorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Verwijder commentaar hieronder om prefix (bijv. Bearer) in te stellen voor API-sleutel, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste HTTP-client wilt gebruiken, geef dan je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$update_user_badge_params = new \FastComments\Client\Model\UpdateUserBadgeParams(); // \FastComments\Client\Model\UpdateUserBadgeParams
22
23
24try {
25 $result = $apiInstance->updateUserBadge($tenant_id, $id, $update_user_badge_params);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->updateUserBadge: ', $e->getMessage(), PHP_EOL;
29}
30
Aantal gebruikersnotificaties ophalen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nee |
Respons
Returns: GetUserNotificationCountResponse
Voorbeeld
getUserNotificationCount Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Als je een aangepaste HTTP-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$sso = 'sso_example'; // string
15
16
17try {
18 $result = $apiInstance->getUserNotificationCount($tenant_id, $sso);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->getUserNotificationCount: ', $e->getMessage(), PHP_EOL;
22}
23
Gebruikersnotificaties ophalen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Nee | Gebruikt om te bepalen of de huidige pagina geabonneerd is. |
| pageSize | integer | query | Nee | |
| afterId | string | query | Nee | |
| includeContext | boolean | query | Nee | |
| afterCreatedAt | integer | query | Nee | |
| unreadOnly | boolean | query | Nee | |
| dmOnly | boolean | query | Nee | |
| noDm | boolean | query | Nee | |
| includeTranslations | boolean | query | Nee | |
| includeTenantNotifications | boolean | query | Nee | |
| sso | string | query | Nee |
Response
Retourneert: GetMyNotificationsResponse
Example
getUserNotifications Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Als je een aangepaste http-client wilt gebruiken, geef je jouw client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$options = [
15 'url_id' => 'url_id_example', // string | Gebruikt om te bepalen of de huidige pagina geabonneerd is.
16 'page_size' => 56, // int
17 'after_id' => 'after_id_example', // string
18 'include_context' => True, // bool
19 'after_created_at' => 56, // int
20 'unread_only' => True, // bool
21 'dm_only' => True, // bool
22 'no_dm' => True, // bool
23 'include_translations' => True, // bool
24 'include_tenant_notifications' => True, // bool
25 'sso' => 'sso_example', // string
26];
27
28
29try {
30 $result = $apiInstance->getUserNotifications($tenant_id, $options);
31 print_r($result);
32} catch (Exception $e) {
33 echo 'Exception when calling PublicApi->getUserNotifications: ', $e->getMessage(), PHP_EOL;
34}
35
Aantal gebruikersnotificaties resetten
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nee |
Respons
Retourneert: ResetUserNotificationsResponse
Voorbeeld
resetUserNotificationCount Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Als je een aangepaste HTTP-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$sso = 'sso_example'; // string
15
16
17try {
18 $result = $apiInstance->resetUserNotificationCount($tenant_id, $sso);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->resetUserNotificationCount: ', $e->getMessage(), PHP_EOL;
22}
23
Gebruikersnotificaties resetten
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| afterId | string | query | No | |
| afterCreatedAt | integer | query | No | |
| unreadOnly | boolean | query | No | |
| dmOnly | boolean | query | No | |
| noDm | boolean | query | No | |
| sso | string | query | No |
Respons
Returns: ResetUserNotificationsResponse
Voorbeeld
resetUserNotifications Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt als standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$options = [
15 'after_id' => 'after_id_example', // string
16 'after_created_at' => 56, // int
17 'unread_only' => True, // bool
18 'dm_only' => True, // bool
19 'no_dm' => True, // bool
20 'sso' => 'sso_example', // string
21];
22
23
24try {
25 $result = $apiInstance->resetUserNotifications($tenant_id, $options);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling PublicApi->resetUserNotifications: ', $e->getMessage(), PHP_EOL;
29}
30
Opmerking-abonnementsstatus gebruiker bijwerken
Enable of uitschakelen van meldingen voor een specifieke opmerking.
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| notificationId | string | path | Yes | |
| optedInOrOut | string | path | Yes | |
| commentId | string | query | Yes | |
| sso | string | query | No |
Respons
Retourneert: UpdateUserNotificationCommentSubscriptionStatusResponse
Voorbeeld
updateUserNotificationCommentSubscriptionStatus Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Als je een aangepaste HTTP-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` zal als standaard worden gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$notification_id = 'notification_id_example'; // string
15$opted_in_or_out = 'opted_in_or_out_example'; // string
16$comment_id = 'comment_id_example'; // string
17$sso = 'sso_example'; // string
18
19
20try {
21 $result = $apiInstance->updateUserNotificationCommentSubscriptionStatus($tenant_id, $notification_id, $opted_in_or_out, $comment_id, $sso);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling PublicApi->updateUserNotificationCommentSubscriptionStatus: ', $e->getMessage(), PHP_EOL;
25}
26
Pagina-abonnementsstatus gebruiker bijwerken
Enable of schakel meldingen voor een pagina in of uit. Wanneer gebruikers zich op een pagina hebben geabonneerd, worden meldingen aangemaakt voor nieuwe hoofdreacties, en ook
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| url | string | query | Yes | |
| pageTitle | string | query | Yes | |
| subscribedOrUnsubscribed | string | path | Yes | |
| sso | string | query | No |
Response
Retourneert: UpdateUserNotificationPageSubscriptionStatusResponse
Voorbeeld
Voorbeeld van updateUserNotificationPageSubscriptionStatus
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Als je een aangepaste HTTP-client wilt gebruiken, geef dan je client mee die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$url_id = 'url_id_example'; // string
15$url = 'url_example'; // string
16$page_title = 'page_title_example'; // string
17$subscribed_or_unsubscribed = 'subscribed_or_unsubscribed_example'; // string
18$sso = 'sso_example'; // string
19
20
21try {
22 $result = $apiInstance->updateUserNotificationPageSubscriptionStatus($tenant_id, $url_id, $url, $page_title, $subscribed_or_unsubscribed, $sso);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling PublicApi->updateUserNotificationPageSubscriptionStatus: ', $e->getMessage(), PHP_EOL;
26}
27
Notificatiestatus gebruiker bijwerken
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| notificationId | string | path | Ja | |
| newStatus | string | path | Ja | |
| sso | string | query | Nee |
Respons
Retourneert: UpdateUserNotificationStatusResponse
Voorbeeld
updateUserNotificationStatus Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
9 // This is optional, `GuzzleHttp\Client` will be used as default.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$notification_id = 'notification_id_example'; // string
15$new_status = 'new_status_example'; // string
16$sso = 'sso_example'; // string
17
18
19try {
20 $result = $apiInstance->updateUserNotificationStatus($tenant_id, $notification_id, $new_status, $sso);
21 print_r($result);
22} catch (Exception $e) {
23 echo 'Exception when calling PublicApi->updateUserNotificationStatus: ', $e->getMessage(), PHP_EOL;
24}
25
Aanwezigheidsstatussen van gebruiker ophalen
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlIdWS | string | query | Ja | |
| userIds | string | query | Ja |
Reactie
Retourneert: GetUserPresenceStatusesResponse
Voorbeeld
getUserPresenceStatuses Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$url_id_ws = 'url_id_ws_example'; // string
15$user_ids = 'user_ids_example'; // string
16
17
18try {
19 $result = $apiInstance->getUserPresenceStatuses($tenant_id, $url_id_ws, $user_ids);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling PublicApi->getUserPresenceStatuses: ', $e->getMessage(), PHP_EOL;
23}
24
Gebruikers zoeken
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | pad | Ja | |
| urlId | string | query | Ja | |
| usernameStartsWith | string | query | Nee | |
| mentionGroupIds | array | query | Nee | |
| sso | string | query | Nee | |
| searchSection | string | query | Nee |
Respons
Returns: SearchUsersResult
Voorbeeld
searchUsers Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Als je een aangepaste http-client wilt gebruiken, geef dan je client door die `GuzzleHttp\ClientInterface` implementeert.
9 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$url_id = 'url_id_example'; // string
15$options = [
16 'username_starts_with' => 'username_starts_with_example', // string
17 'mention_group_ids' => array('mention_group_ids_example'), // string[]
18 'sso' => 'sso_example', // string
19 'search_section' => 'search_section_example', // string
20];
21
22
23try {
24 $result = $apiInstance->searchUsers($tenant_id, $url_id, $options);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling PublicApi->searchUsers: ', $e->getMessage(), PHP_EOL;
28}
29
Gebruiker ophalen
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Response
Returns: GetUserResponse
Example
getUser Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutelauthenticatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Haal de ondercode hieronder uit commentaar om een prefix (bijv. Bearer) voor de API-sleutel in te stellen, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als u een aangepaste HTTP-client wilt gebruiken, geef dan uw client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` wordt als standaard gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21
22
23try {
24 $result = $apiInstance->getUser($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getUser: ', $e->getMessage(), PHP_EOL;
28}
29
Stem creëren
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | query | Ja | |
| direction | string | query | Ja | |
| userId | string | query | Nee | |
| anonUserId | string | query | Nee |
Response
Retourneert: VoteResponse
Example
createVote Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5// Configureer API-sleutel autorisatie: api_key
6$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
7// Haal de onderstaande commentaar weg om een prefix (bijv. Bearer) voor de API-sleutel in te stellen, indien nodig
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
13 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // string
19$comment_id = 'comment_id_example'; // string
20$direction = 'direction_example'; // string
21$options = [
22 'user_id' => 'user_id_example', // string
23 'anon_user_id' => 'anon_user_id_example', // string
24];
25
26
27try {
28 $result = $apiInstance->createVote($tenant_id, $comment_id, $direction, $options);
29 print_r($result);
30} catch (Exception $e) {
31 echo 'Exception when calling DefaultApi->createVote: ', $e->getMessage(), PHP_EOL;
32}
33
Stem verwijderen
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| editKey | string | query | Nee |
Respons
Retourneert: VoteDeleteResponse
Voorbeeld
deleteVote Voorbeeld
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configureer API-sleutautorisatie: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Verwijder commentaar hieronder om een prefix in te stellen (bijv. Bearer) voor de API-sleutel, indien nodig
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Als je een aangepaste HTTP-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
14 // Dit is optioneel, `GuzzleHttp\Client` zal als standaard worden gebruikt.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$edit_key = 'edit_key_example'; // string
22
23
24try {
25 $result = $apiInstance->deleteVote($tenant_id, $id, $edit_key);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->deleteVote: ', $e->getMessage(), PHP_EOL;
29}
30
Stemmen ophalen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes |
Reactie
Retourneert: GetVotesResponse
Voorbeeld
getVotes Voorbeeld
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
19$tenant_id = 'tenant_id_example'; // string
20$url_id = 'url_id_example'; // string
21
22
23try {
24 $result = $apiInstance->getVotes($tenant_id, $url_id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getVotes: ', $e->getMessage(), PHP_EOL;
28}
29
Stemmen voor gebruiker ophalen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja | |
| userId | string | query | Nee | |
| anonUserId | string | query | Nee |
Reactie
Returns: GetVotesForUserResponse
Voorbeeld
Voorbeeld getVotesForUser
Copy
1
2
3require_once(__DIR__ . '/vendor/autoload.php');
4
5// Configureer API-sleutel autorisatie: api_key
6$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
7// Ontcommentarieer hieronder om prefix (bijv. Bearer) voor API-sleutel in te stellen, indien nodig
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Als je een aangepaste http-client wilt gebruiken, geef je client door die `GuzzleHttp\ClientInterface` implementeert.
13 // Dit is optioneel, `GuzzleHttp\Client` wordt standaard gebruikt.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // string
19$url_id = 'url_id_example'; // string
20$options = [
21 'user_id' => 'user_id_example', // string
22 'anon_user_id' => 'anon_user_id_example', // string
23];
24
25
26try {
27 $result = $apiInstance->getVotesForUser($tenant_id, $url_id, $options);
28 print_r($result);
29} catch (Exception $e) {
30 echo 'Exception when calling DefaultApi->getVotesForUser: ', $e->getMessage(), PHP_EOL;
31}
32
Hulp nodig?
Als u problemen ondervindt of vragen heeft over de PHP SDK, kunt u:
Bijdragen
Bijdragen zijn welkom! Bezoek de GitHub repository voor richtlijnen voor bijdragen.