
Język 🇵🇱 Polski
Pierwsze kroki
Dokumentacja
Referencja API
Agregacja
Dzienniki audytu
Blokowanie z komentarza
Sprawdzanie zablokowanych komentarzy
Komentarze
Konfiguracje domen
Szablony e-mail
Dziennik zdarzeń
Posty
Zgłaszanie komentarzy
Hashtagi
Moderatorzy
Liczba powiadomień
Powiadomienia
Strony
Oczekujące zdarzenia webhook
Konfiguracje pytań
Wyniki pytań
Agregacja wyników pytań
Użytkownicy SSO
Subskrypcje
Dzienne użycie najemcy
Pakiety najemcy
Użytkownicy najemcy
Najemcy
Prześlij obraz
Postęp odznak użytkownika
Odznaki użytkownika
Powiadomienia użytkownika
Status obecności użytkownika
Wyszukiwanie użytkowników
Użytkownicy
Głosy
FastComments Swift SDK
To oficjalne SDK Swift dla FastComments.
Oficjalne SDK Swift dla API FastComments
Repozytorium
Instalacja 
Menedżer pakietów Swift
Dodaj poniższe do pliku Package.swift:
dependencies: [
.package(url: "https://github.com/fastcomments/fastcomments-swift.git", from: "0.0.1")
]
Lub w Xcode:
- Plik > Dodaj pakiety...
- Wpisz adres URL repozytorium:
https://github.com/fastcomments/fastcomments-swift.git - Wybierz wersję, której chcesz użyć
Wymagania
- Swift 5.9+
- iOS 13.0+ / macOS 10.15+ / tvOS 13.0+ / watchOS 6.0+
Zawartość biblioteki 
FastComments Swift SDK składa się z kilku modułów:
Moduł klienta - Automatycznie wygenerowany klient API dla FastComments REST APIs
- Kompletne definicje typów dla wszystkich modeli API
- Zarówno uwierzytelnione (
DefaultAPI), jak i publiczne (PublicAPI) punkty końcowe - Pełne wsparcie dla async/await
- Zobacz client/README.md w celu uzyskania szczegółowej dokumentacji API
Moduł SSO - Narzędzia Single Sign-On po stronie serwera
- Bezpieczne generowanie tokenów do uwierzytelniania użytkowników
- Wsparcie zarówno dla prostego, jak i bezpiecznego trybu SSO
- Podpisywanie tokenów oparte na HMAC-SHA256 przy użyciu CryptoKit
Szybki start 
Korzystanie z publicznego API
import FastCommentsSwift
// Utwórz klienta API
let publicApi = PublicAPI()
// Pobierz komentarze dla strony
do {
let response = try await publicApi.getCommentsPublic(
tenantId: "your-tenant-id",
urlId: "page-url-id"
)
print("Found \(response.comments?.count ?? 0) comments")
for comment in response.comments ?? [] {
print("Comment: \(comment.comment ?? "")")
}
} catch {
print("Error fetching comments: \(error)")
}
Korzystanie z uwierzytelnionego API
import FastCommentsSwift
// Utwórz konfigurację z kluczem API
let defaultApi = DefaultAPI()
defaultApi.apiKey = "your-api-key"
// Pobierz komentarze używając uwierzytelnionego API
do {
let response = try await defaultApi.getComments(
tenantId: "your-tenant-id",
urlId: "page-url-id"
)
print("Total comments: \(response.count ?? 0)")
for comment in response.comments ?? [] {
print("Comment ID: \(comment.id ?? ""), Text: \(comment.comment ?? "")")
}
} catch {
print("Error: \(error)")
}
Korzystanie z SSO do uwierzytelniania
Bezpieczne SSO (zalecane dla produkcji)
import FastCommentsSwift
let apiKey = "your-api-key"
// Utwórz bezpieczne dane użytkownika SSO (tylko po stronie serwera!)
let userData = SecureSSOUserData(
id: "user-123", // ID użytkownika
email: "user@example.com", // E-mail
username: "johndoe", // Nazwa użytkownika
avatar: "https://example.com/avatar.jpg" // URL avatara
)
// Wygeneruj token SSO
do {
let sso = try FastCommentsSSO.createSecure(apiKey: apiKey, secureSSOUserData: userData)
let token = try sso.createToken()
print("SSO Token: \(token ?? "")")
// Przekaż ten token do frontendu w celu uwierzytelnienia
} catch {
print("Error creating SSO token: \(error)")
}
Proste SSO (do rozwoju/testów)
import FastCommentsSwift
// Utwórz proste dane użytkownika SSO (brak potrzeby klucza API)
let userData = SimpleSSOUserData(
username: "johndoe",
email: "user@example.com",
avatar: "https://example.com/avatar.jpg"
)
// Wygeneruj prosty token SSO
let sso = FastCommentsSSO.createSimple(simpleSSOUserData: userData)
do {
let token = try sso.createToken()
print("Simple SSO Token: \(token ?? "")")
} catch {
print("Error creating SSO token: \(error)")
}
API publiczne vs zabezpieczone 
FastComments SDK zapewnia dwa rodzaje punktów końcowych API:
PublicAPI - Punkty końcowe bezpieczne dla klienta
The PublicAPI contains endpoints that are safe to call from client-side code (aplikacje iOS/macOS). Te punkty końcowe:
- Nie wymagają API key
- Mogą używać SSO tokens do uwierzytelniania
- Podlegają ograniczeniom na użytkownika/urządzenie
- Nadają się do aplikacji skierowanych do użytkowników końcowych
Przykładowy przypadek użycia: Pobieranie i tworzenie komentarzy w twojej aplikacji iOS
DefaultAPI - Punkty końcowe po stronie serwera
The DefaultAPI contains authenticated endpoints that require an API key. Te punkty końcowe:
- Wymagają twojego FastComments API key
- Należy WYŁĄCZNIE wywoływać je z kodu po stronie serwera
- Zapewniają pełny dostęp do twoich danych FastComments
- Podlegają ograniczeniom na tenant
Przykładowy przypadek użycia: operacje administracyjne, eksport masowych danych, narzędzia do moderacji
WAŻNE: Nigdy nie ujawniaj swojego API key w kodzie po stronie klienta. API keys powinny być używane wyłącznie po stronie serwera.
Wywoływanie API 
SDK dla Swifta używa nowoczesnej składni async/await dla wszystkich wywołań API:
let response = try await publicApi.getCommentsPublic(
tenantId: "your-tenant-id",
urlId: "page-url-id"
)
Częste problemy 
401 — Brak autoryzacji
Jeśli otrzymujesz błędy 401 podczas korzystania z uwierzytelnionego API:
- Sprawdź swój klucz API: Upewnij się, że używasz poprawnego klucza API z panelu FastComments
- Zweryfikuj tenant ID: Upewnij się, że tenant ID odpowiada Twojemu kontu
- Format klucza API: Klucz API powinien być ustawiony w kliencie API:
let defaultApi = DefaultAPI()
defaultApi.apiKey = "YOUR_API_KEY"
- Używanie złego API: Upewnij się, że używasz
DefaultAPI(niePublicAPI) dla wywołań uwierzytelnionych
Problemy z tokenami SSO
Jeśli tokeny SSO nie działają:
- Używaj trybu bezpiecznego w produkcji: Zawsze używaj
FastCommentsSSO.createSecure()z kluczem API w środowisku produkcyjnym - Tylko po stronie serwera: Generuj bezpieczne tokeny SSO na swoim serwerze, nigdy nie ujawniaj klucza API klientom
- Sprawdź dane użytkownika: Upewnij się, że wszystkie wymagane pola (id, email, username) są dostarczone
- Wygasanie tokenów: Bezpieczne tokeny SSO zawierają znacznik czasu i mogą wygasnąć. Generuj nowe tokeny w razie potrzeby.
Błędy SSL/TLS
Jeśli napotkasz błędy SSL/TLS:
- Upewnij się, że Info.plist Twojej aplikacji pozwala na połączenia HTTPS z fastcomments.com
- Sprawdź, czy nie używasz wyjątków App Transport Security, które mogą blokować połączenie
Notatki 
Identyfikatory transmisji
Zobaczysz, że w niektórych wywołaniach API powinieneś przekazać broadcastId. Gdy otrzymasz zdarzenia, otrzymasz ten identyfikator z powrotem, dzięki czemu będziesz wiedzieć, aby zignorować zdarzenie, jeśli planujesz optymistycznie zastosować zmiany po stronie klienta (czego prawdopodobnie będziesz chciał zrobić, ponieważ daje to najlepsze doświadczenie). Przekaż tutaj UUID. Identyfikator powinien być wystarczająco unikalny, aby nie występował dwukrotnie w trakcie sesji.
let broadcastId = UUID().uuidString
Agreguj 
Agreguje dokumenty, grupując je (jeśli podano groupBy) i stosując wiele operacji. Obsługiwane są różne operacje (np. sum, countDistinct, avg itp.).
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| parentTenantId | string | query | Nie | |
| includeStats | boolean | query | Nie |
Odpowiedź
Zwraca: AggregationResponse
Przykład

Pobierz dzienniki audytu 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| limit | number | query | Nie | |
| skip | number | query | Nie | |
| order | string | query | Nie | |
| after | number | query | Nie | |
| before | number | query | Nie |
Odpowiedź
Zwraca: GetAuditLogs200Response
Przykład

Zablokuj z publicznego komentarza 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| commentId | string | path | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: BlockFromCommentPublic200Response
Przykład

Odblokuj komentarz publiczny 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| commentId | string | path | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: UnBlockCommentPublic200Response
Przykład

Sprawdź komentarze pod kątem zablokowania 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| commentIds | string | query | Tak | Lista identyfikatorów komentarzy rozdzielona przecinkami. |
| sso | string | query | Nie |
Odpowiedź
Zwraca: CheckedCommentsForBlocked200Response
Przykład

Zablokuj użytkownika na podstawie komentarza 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| userId | string | query | Nie | |
| anonUserId | string | query | Nie |
Odpowiedź
Zwraca: BlockFromCommentPublic200Response
Przykład

Utwórz komentarz publiczny 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| broadcastId | string | query | Yes | |
| sessionId | string | query | No | |
| sso | string | query | No |
Odpowiedź
Zwraca: CreateCommentPublic200Response
Przykład

Usuń komentarz 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| contextUserId | string | query | Nie | |
| isLive | boolean | query | Nie |
Odpowiedź
Zwraca: DeleteComment200Response
Przykład

Usuń komentarz publiczny 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| commentId | string | path | Tak | |
| broadcastId | string | query | Tak | |
| editKey | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: DeleteCommentPublic200Response
Przykład

Usuń głos komentarza 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| 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 |
Odpowiedź
Zwraca: DeleteCommentVote200Response
Przykład

Zgłoś komentarz 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| userId | string | query | Nie | |
| anonUserId | string | query | Nie |
Odpowiedź
Zwraca: FlagComment200Response
Przykład

Pobierz komentarz 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: GetComment200Response
Przykład

Pobierz komentarze 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| page | integer | query | Nie | |
| limit | integer | query | Nie | |
| skip | integer | query | Nie | |
| asTree | boolean | query | Nie | |
| skipChildren | integer | query | Nie | |
| limitChildren | integer | query | Nie | |
| maxTreeDepth | integer | query | Nie | |
| urlId | string | query | Nie | |
| userId | string | query | Nie | |
| anonUserId | string | query | Nie | |
| contextUserId | string | query | Nie | |
| hashTag | string | query | Nie | |
| parentId | string | query | Nie | |
| direction | string | query | Nie |
Odpowiedź
Zwraca: GetComments200Response
Przykład

Pobierz komentarze publiczne 
req tenantId urlId
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | ścieżka | Tak | |
| urlId | string | zapytanie | Tak | |
| page | integer | zapytanie | Nie | |
| direction | string | zapytanie | Nie | |
| sso | string | zapytanie | Nie | |
| skip | integer | zapytanie | Nie | |
| skipChildren | integer | zapytanie | Nie | |
| limit | integer | zapytanie | Nie | |
| limitChildren | integer | zapytanie | Nie | |
| countChildren | boolean | zapytanie | Nie | |
| fetchPageForCommentId | string | zapytanie | Nie | |
| includeConfig | boolean | zapytanie | Nie | |
| countAll | boolean | zapytanie | Nie | |
| includei10n | boolean | zapytanie | Nie | |
| locale | string | zapytanie | Nie | |
| modules | string | zapytanie | Nie | |
| isCrawler | boolean | zapytanie | Nie | |
| includeNotificationCount | boolean | zapytanie | Nie | |
| asTree | boolean | zapytanie | Nie | |
| maxTreeDepth | integer | zapytanie | Nie | |
| useFullTranslationIds | boolean | zapytanie | Nie | |
| parentId | string | zapytanie | Nie | |
| searchText | string | zapytanie | Nie | |
| hashTags | array | zapytanie | Nie | |
| userId | string | zapytanie | Nie | |
| customConfigStr | string | zapytanie | Nie | |
| afterCommentId | string | zapytanie | Nie | |
| beforeCommentId | string | zapytanie | Nie |
Odpowiedź
Zwraca: GetCommentsPublic200Response
Przykład

Pobierz tekst komentarza 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| commentId | string | path | Tak | |
| editKey | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: GetCommentText200Response
Przykład

Pobierz nazwy użytkowników głosujących na komentarz 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| commentId | string | path | Tak | |
| dir | integer | query | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: GetCommentVoteUserNames200Response
Przykład

Zablokuj komentarz 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| commentId | string | path | Tak | |
| broadcastId | string | query | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: LockComment200Response
Przykład

Przypnij komentarz 
Parametry
| Name | Type | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| commentId | string | path | Tak | |
| broadcastId | string | query | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: PinComment200Response
Przykład

Zapisz komentarz 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| isLive | boolean | query | Nie | |
| doSpamCheck | boolean | query | Nie | |
| sendEmails | boolean | query | Nie | |
| populateNotifications | boolean | query | Nie |
Odpowiedź
Zwraca: SaveComment200Response
Przykład

Zapisz komentarze hurtowo 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| isLive | boolean | query | Nie | |
| doSpamCheck | boolean | query | Nie | |
| sendEmails | boolean | query | Nie | |
| populateNotifications | boolean | query | Nie |
Odpowiedź
Zwraca: [SaveComment200Response]
Przykład

Ustaw tekst komentarza 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| commentId | string | path | Tak | |
| broadcastId | string | query | Tak | |
| editKey | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: SetCommentText200Response
Przykład

Odblokuj użytkownika na podstawie komentarza 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| userId | string | query | Nie | |
| anonUserId | string | query | Nie |
Odpowiedź
Zwraca: UnBlockCommentPublic200Response
Przykład

Wycofaj zgłoszenie komentarza 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| userId | string | query | Nie | |
| anonUserId | string | query | Nie |
Odpowiedź
Zwraca: FlagComment200Response
Przykład

Odblokuj komentarz 
Parametry
| Name | Type | Location | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| commentId | string | path | Tak | |
| broadcastId | string | query | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: LockComment200Response
Przykład

Odepnij komentarz 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| commentId | string | path | Tak | |
| broadcastId | string | query | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: PinComment200Response
Przykład

Aktualizuj komentarz 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| contextUserId | string | query | Nie | |
| doSpamCheck | boolean | query | Nie | |
| isLive | boolean | query | Nie |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

Oddaj głos na komentarz 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| commentId | string | path | Tak | |
| urlId | string | query | Tak | |
| broadcastId | string | query | Tak | |
| sessionId | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: VoteComment200Response
Przykład

Dodaj konfigurację domeny 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | zapytanie | Tak |
Odpowiedź
Zwraca: AddDomainConfig200Response
Przykład

Usuń konfigurację domeny 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| domain | string | path | Tak |
Odpowiedź
Zwraca: DeleteDomainConfig200Response
Przykład

Pobierz konfigurację domeny 
Parametry
| Name | Type | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| domain | string | path | Tak |
Odpowiedź
Zwraca: GetDomainConfig200Response
Przykład

Pobierz konfiguracje domen 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: GetDomainConfigs200Response
Przykład

Częściowo zaktualizuj konfigurację domeny 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| domainToUpdate | string | path | Yes |
Odpowiedź
Zwraca: GetDomainConfig200Response
Przykład

Zastąp konfigurację domeny 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| domainToUpdate | string | path | Yes |
Odpowiedź
Zwraca: GetDomainConfig200Response
Przykład

Utwórz szablon e-mail 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: CreateEmailTemplate200Response
Przykład

Usuń szablon e-mail 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

Usuń błąd renderowania szablonu e-mail 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| errorId | string | path | Tak |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

Pobierz szablon e-mail 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: GetEmailTemplate200Response
Przykład

Pobierz definicje szablonów e-mail 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: GetEmailTemplateDefinitions200Response
Przykład

Pobierz błędy renderowania szablonów e-mail 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetEmailTemplateRenderErrors200Response
Przykład

Pobierz szablony e-mail 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetEmailTemplates200Response
Przykład

Renderuj szablon e-mail 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| locale | string | query | Nie |
Odpowiedź
Zwraca: RenderEmailTemplate200Response
Przykład

Aktualizuj szablon e-mail 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

Pobierz dziennik zdarzeń 
req tenantId urlId userIdWS
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| urlId | string | query | Tak | |
| userIdWS | string | query | Tak | |
| startTime | integer | query | Tak | |
| endTime | integer | query | Tak |
Odpowiedź
Zwraca: GetEventLog200Response
Przykład

Pobierz globalny dziennik zdarzeń 
req tenantId urlId userIdWS
Parametry
| Name | Type | Location | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| urlId | string | query | Tak | |
| userIdWS | string | query | Tak | |
| startTime | integer | query | Tak | |
| endTime | integer | query | Tak |
Odpowiedź
Zwraca: GetEventLog200Response
Przykład

Utwórz wpis kanału 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| broadcastId | string | query | Nie | |
| isLive | boolean | query | Nie | |
| doSpamCheck | boolean | query | Nie | |
| skipDupCheck | boolean | query | Nie |
Odpowiedź
Zwraca: CreateFeedPost200Response
Przykład

Utwórz publiczny wpis kanału 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| broadcastId | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: CreateFeedPostPublic200Response
Przykład

Usuń publiczny wpis kanału 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | ścieżka | Tak | |
| postId | string | ścieżka | Tak | |
| broadcastId | string | zapytanie | Nie | |
| sso | string | zapytanie | Nie |
Odpowiedź
Zwraca: DeleteFeedPostPublic200Response
Przykład

Pobierz wpisy kanału 
żądanie tenantId afterId
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| afterId | string | query | Nie | |
| limit | integer | query | Nie | |
| tags | array | query | Nie |
Odpowiedź
Zwraca: GetFeedPosts200Response
Przykład

Pobierz publiczne wpisy kanału 
req tenantId afterId
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| afterId | string | query | Nie | |
| limit | integer | query | Nie | |
| tags | array | query | Nie | |
| sso | string | query | Nie | |
| isCrawler | boolean | query | Nie | |
| includeUserInfo | boolean | query | Nie |
Odpowiedź
Zwraca: GetFeedPostsPublic200Response
Przykład

Pobierz statystyki wpisów kanału 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| postIds | array | query | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: GetFeedPostsStats200Response
Przykład

Pobierz publiczne reakcje użytkowników 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postIds | array | query | No | |
| sso | string | query | No |
Odpowiedź
Zwraca: GetUserReactsPublic200Response
Przykład

Zareaguj na publiczny wpis kanału 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| postId | string | path | Tak | |
| isUndo | boolean | query | Nie | |
| broadcastId | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: ReactFeedPostPublic200Response
Przykład

Aktualizuj wpis kanału 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

Aktualizuj publiczny wpis kanału 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | ścieżka | Tak | |
| postId | string | ścieżka | Tak | |
| broadcastId | string | zapytanie | Nie | |
| sso | string | zapytanie | Nie |
Odpowiedź
Zwraca: CreateFeedPostPublic200Response
Przykład

Zgłoś publiczny komentarz 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| commentId | string | path | Tak | |
| isFlagged | boolean | query | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

Dodaj hashtag 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | No |
Odpowiedź
Zwraca: AddHashTag200Response
Przykład

Dodaj hashtagi hurtowo 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Nie |
Odpowiedź
Zwraca: AddHashTagsBulk200Response
Przykład

Usuń hashtag 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tag | string | path | Tak | |
| tenantId | string | query | Nie |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

Pobierz hashtagi 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| page | number | query | Nie |
Odpowiedź
Zwraca: GetHashTags200Response
Przykład

Częściowo zaktualizuj hashtag 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tag | string | path | Tak | |
| tenantId | string | query | Nie |
Odpowiedź
Zwraca: PatchHashTag200Response
Przykład

Utwórz moderatora 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | zapytanie | Tak |
Response
Zwraca: CreateModerator200Response
Przykład

Usuń moderatora 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| sendEmail | string | query | Nie |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

Pobierz moderatora 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: GetModerator200Response
Przykład

Pobierz moderatorów 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetModerators200Response
Przykład

Wyślij zaproszenie 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| fromName | string | query | Tak |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

Aktualizuj moderatora 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

Usuń licznik powiadomień 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

Pobierz zbuforowaną liczbę powiadomień 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: GetCachedNotificationCount200Response
Przykład

Pobierz liczbę powiadomień 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| urlId | string | query | No | |
| fromCommentId | string | query | No | |
| viewed | boolean | query | No | |
| type | string | query | No |
Odpowiedź
Zwraca: GetNotificationCount200Response
Przykład

Pobierz powiadomienia 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| userId | string | query | Nie | |
| urlId | string | query | Nie | |
| fromCommentId | string | query | Nie | |
| viewed | boolean | query | Nie | |
| type | string | query | Nie | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetNotifications200Response
Przykład

Aktualizuj powiadomienie 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| userId | string | query | Nie |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

Dodaj stronę 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: AddPageAPIResponse
Przykład

Usuń stronę 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: DeletePageAPIResponse
Przykład

Pobierz stronę po ID URL 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| urlId | string | query | Tak |
Odpowiedź
Zwraca: GetPageByURLIdAPIResponse
Przykład

Pobierz strony 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Odpowiedź
Zwraca: GetPagesAPIResponse
Przykład

Częściowo zaktualizuj stronę 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: PatchPageAPIResponse
Przykład

Usuń oczekujące zdarzenie webhook 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

Pobierz liczbę oczekujących zdarzeń webhook 
Parametry
| Name | Type | Location | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| commentId | string | query | Nie | |
| externalId | string | query | Nie | |
| eventType | string | query | Nie | |
| type | string | query | Nie | |
| domain | string | query | Nie | |
| attemptCountGT | number | query | Nie |
Odpowiedź
Zwraca: GetPendingWebhookEventCount200Response
Przykład

Pobierz oczekujące zdarzenia webhook 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| commentId | string | query | Nie | |
| externalId | string | query | Nie | |
| eventType | string | query | Nie | |
| type | string | query | Nie | |
| domain | string | query | Nie | |
| attemptCountGT | number | query | Nie | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetPendingWebhookEvents200Response
Przykład

Utwórz konfigurację pytania 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: CreateQuestionConfig200Response
Przykład

Usuń konfigurację pytania 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

Pobierz konfigurację pytania 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: GetQuestionConfig200Response
Przykład

Pobierz konfiguracje pytań 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetQuestionConfigs200Response
Przykład

Aktualizuj konfigurację pytania 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

Utwórz wynik pytania 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: CreateQuestionResult200Response
Przykład

Usuń wynik pytania 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

Pobierz wynik pytania 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: GetQuestionResult200Response
Przykład

Pobierz wyniki pytań 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| urlId | string | query | Nie | |
| userId | string | query | Nie | |
| startDate | string | query | Nie | |
| questionId | string | query | Nie | |
| questionIds | string | query | Nie | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetQuestionResults200Response
Przykład

Aktualizuj wynik pytania 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Response
Zwraca: FlagCommentPublic200Response
Przykład

Agreguj wyniki pytań 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| questionId | string | query | Nie | |
| questionIds | array | query | Nie | |
| urlId | string | query | Nie | |
| timeBucket | string | query | Nie | |
| startDate | string | query | Nie | |
| forceRecalculate | boolean | query | Nie |
Odpowiedź
Zwraca: AggregateQuestionResults200Response
Przykład

Hurtowa agregacja wyników pytań 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| forceRecalculate | boolean | query | Nie |
Odpowiedź
Zwraca: BulkAggregateQuestionResults200Response
Przykład

Połącz komentarze z wynikami pytań 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| questionId | string | query | Nie | |
| questionIds | array | query | Nie | |
| urlId | string | query | Nie | |
| startDate | string | query | Nie | |
| forceRecalculate | boolean | query | Nie | |
| minValue | number | query | Nie | |
| maxValue | number | query | Nie | |
| limit | number | query | Nie |
Odpowiedź
Zwraca: CombineCommentsWithQuestionResults200Response
Przykład

Dodaj użytkownika SSO 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Response
Zwraca: AddSSOUserAPIResponse
Przykład

Usuń użytkownika SSO 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| deleteComments | boolean | query | Nie | |
| commentDeleteMode | string | query | Nie |
Odpowiedź
Zwraca: DeleteSSOUserAPIResponse
Przykład

Pobierz użytkownika SSO po e-mailu 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| string | path | Tak |
Odpowiedź
Zwraca: GetSSOUserByEmailAPIResponse
Przykład

Pobierz użytkownika SSO po ID 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: GetSSOUserByIdAPIResponse
Przykład

Pobierz użytkowników SSO 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| skip | integer | query | Nie |
Odpowiedź
Zwraca: GetSSOUsers200Response
Przykład

Częściowo zaktualizuj użytkownika SSO 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| updateComments | boolean | query | Nie |
Odpowiedź
Zwraca: PatchSSOUserAPIResponse
Przykład

Zastąp użytkownika SSO 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| updateComments | boolean | query | Nie |
Odpowiedź
Zwraca: PutSSOUserAPIResponse
Przykład

Utwórz subskrypcję 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: CreateSubscriptionAPIResponse
Przykład

Usuń subskrypcję 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| userId | string | query | Nie |
Odpowiedź
Zwraca: DeleteSubscriptionAPIResponse
Przykład

Pobierz subskrypcje 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| userId | string | query | Nie |
Odpowiedź
Zwraca: GetSubscriptionsAPIResponse
Przykład

Pobierz dzienne użycie najemcy 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| yearNumber | number | query | Nie | |
| monthNumber | number | query | Nie | |
| dayNumber | number | query | Nie | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetTenantDailyUsages200Response
Przykład

Utwórz pakiet najemcy 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: CreateTenantPackage200Response
Przykład

Usuń pakiet najemcy 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

Pobierz pakiet najemcy 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: GetTenantPackage200Response
Przykład

Pobierz pakiety najemcy 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetTenantPackages200Response
Przykład

Zastąp pakiet najemcy 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

Aktualizuj pakiet najemcy 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

Utwórz użytkownika najemcy 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: CreateTenantUser200Response
Przykład

Usuń użytkownika najemcy 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| deleteComments | string | query | Nie | |
| commentDeleteMode | string | query | Nie |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

Pobierz użytkownika najemcy 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: GetTenantUser200Response
Przykład

Pobierz użytkowników najemcy 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetTenantUsers200Response
Przykład

Zastąp użytkownika najemcy 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| updateComments | string | query | Nie |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

Wyślij link logowania 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| redirectURL | string | query | No |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

Aktualizuj użytkownika najemcy 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| updateComments | string | query | Nie |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

Utwórz najemcę 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: CreateTenant200Response
Przykład

Usuń najemcę 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| sure | string | query | Nie |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

Pobierz najemcę 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: GetTenant200Response
Przykład

Pobierz najemców 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| meta | string | query | No | |
| skip | number | query | No |
Odpowiedź
Zwraca: GetTenants200Response
Przykład

Aktualizuj najemcę 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

Prześlij obraz 
Prześlij i zmień rozmiar obrazu
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| sizePreset | string | query | Nie | Predefiniowany rozmiar: "Default" (1000x1000px) lub "CrossPlatform" (tworzy rozmiary dla popularnych urządzeń) |
| urlId | string | query | Nie | Id strony, z której odbywa się przesyłanie, do konfiguracji |
Odpowiedź
Zwraca: UploadImageResponse
Przykład

Pobierz postęp odznaki użytkownika po ID 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: GetUserBadgeProgressById200Response
Przykład

Pobierz postęp odznaki użytkownika po ID użytkownika 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| userId | string | path | Tak |
Odpowiedź
Zwraca: GetUserBadgeProgressById200Response
Przykład

Pobierz listę postępów odznak użytkownika 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| userId | string | query | Nie | |
| limit | number | query | Nie | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetUserBadgeProgressList200Response
Przykład

Utwórz odznakę użytkownika 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: CreateUserBadge200Response
Przykład

Usuń odznakę użytkownika 
Parametry
| Name | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Response
Zwraca: UpdateUserBadge200Response
Przykład

Pobierz odznakę użytkownika 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: GetUserBadge200Response
Przykład

Pobierz odznaki użytkownika 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| userId | string | query | Nie | |
| badgeId | string | query | Nie | |
| type | number | query | Nie | |
| displayedOnComments | boolean | query | Nie | |
| limit | number | query | Nie | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetUserBadges200Response
Przykład

Aktualizuj odznakę użytkownika 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: UpdateUserBadge200Response
Przykład

Pobierz liczbę powiadomień użytkownika 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: GetUserNotificationCount200Response
Przykład

Pobierz powiadomienia użytkownika 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| pageSize | integer | query | Nie | |
| afterId | string | query | Nie | |
| includeContext | boolean | query | Nie | |
| afterCreatedAt | integer | query | Nie | |
| unreadOnly | boolean | query | Nie | |
| dmOnly | boolean | query | Nie | |
| noDm | boolean | query | Nie | |
| includeTranslations | boolean | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: GetUserNotifications200Response
Przykład

Zresetuj licznik powiadomień użytkownika 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: ResetUserNotifications200Response
Przykład

Zresetuj powiadomienia użytkownika 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| afterId | string | query | Nie | |
| afterCreatedAt | integer | query | Nie | |
| unreadOnly | boolean | query | Nie | |
| dmOnly | boolean | query | Nie | |
| noDm | boolean | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: ResetUserNotifications200Response
Przykład

Aktualizuj status subskrypcji powiadomień o komentarzach użytkownika 
Włącz lub wyłącz powiadomienia dla konkretnego komentarza.
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | zapytanie | Tak | |
| notificationId | string | ścieżka | Tak | |
| optedInOrOut | string | ścieżka | Tak | |
| commentId | string | zapytanie | Tak | |
| sso | string | zapytanie | Nie |
Odpowiedź
Zwraca: UpdateUserNotificationStatus200Response
Przykład

Aktualizuj status subskrypcji powiadomień o stronach użytkownika 
Włącz lub wyłącz powiadomienia dla strony. Gdy użytkownicy subskrybują stronę, tworzone są powiadomienia dla nowych głównych komentarzy, oraz
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| urlId | string | query | Tak | |
| url | string | query | Tak | |
| pageTitle | string | query | Tak | |
| subscribedOrUnsubscribed | string | path | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: UpdateUserNotificationStatus200Response
Przykład

Aktualizuj status powiadomień użytkownika 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| notificationId | string | path | Tak | |
| newStatus | string | path | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: UpdateUserNotificationStatus200Response
Przykład

Pobierz statusy obecności użytkowników 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| urlIdWS | string | query | Tak | |
| userIds | string | query | Tak |
Odpowiedź
Zwraca: GetUserPresenceStatuses200Response
Przykład

Wyszukaj użytkowników 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| urlId | string | query | Tak | |
| usernameStartsWith | string | query | Tak | |
| mentionGroupIds | array | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: SearchUsers200Response
Przykład

Pobierz użytkownika 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: GetUser200Response
Przykład

Utwórz głos 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| commentId | string | query | Tak | |
| direction | string | query | Tak | |
| userId | string | query | Nie | |
| anonUserId | string | query | Nie |
Odpowiedź
Zwraca: VoteComment200Response
Przykład

Usuń głos 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| editKey | string | query | Nie |
Odpowiedź
Zwraca: DeleteCommentVote200Response
Przykład

Pobierz głosy 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| urlId | string | query | Tak |
Odpowiedź
Zwraca: GetVotes200Response
Przykład

Pobierz głosy dla użytkownika 
Parametry
| Name | Type | Location | Wymagane | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| urlId | string | query | Tak | |
| userId | string | query | Nie | |
| anonUserId | string | query | Nie |
Response
Zwraca: GetVotesForUser200Response
Przykład

Potrzebujesz pomocy?
Jeśli napotkasz jakiekolwiek problemy lub masz pytania dotyczące Swift SDK, prosimy:
Współtworzenie
Wkłady są mile widziane! Odwiedź repozytorium GitHub, aby zapoznać się z wytycznymi dotyczącymi kontrybucji.